|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Skin
An interface to template skins.
Nested Class Summary | |
---|---|
static class |
Skin.Orientation
The orientation. |
Field Summary | |
---|---|
static String |
BODY_ALINK
The body alink attribute. |
static String |
BODY_BACKGROUND
The body background attribute. |
static String |
BODY_BGCOLOR
The body bgcolor attribute. |
static String |
BODY_LINK
The body link attribute. |
static String |
BODY_TEXT
The body text attribute. |
static String |
BODY_VLINK
The body vlink attribute. |
static String |
HTML_XMLNS
XMLNS html attribute. |
static String |
META_AUTHOR
The meta author attribute. |
static String |
META_DESCRIPTION
The meta description attribute. |
static String |
META_GENERATOR
The meta generator attribute. |
static String |
META_KEYWORDS
The meta keywords attribute. |
static String |
META_REVISED
The meta revised attribute. |
static String |
PAGE_ID
The page id attribute. |
Method Summary | |
---|---|
void |
addBodyAttribute(String name,
String value)
Adds a body attribute. |
void |
addBodyScript(String url,
boolean... localized)
Adds a body script. |
void |
addHeadScript(String url,
boolean... localized)
Adds a head script. |
void |
addStyleSheet(String url,
boolean... localized)
Adds a style sheet. |
void |
appendInlineBodyScript(String script)
Appends an inline body script. |
void |
appendInlineStyleSheet(String style)
Appends an inline style sheet. |
void |
clearAttributes()
Clears all page attributes. |
void |
clearBodyAttributes()
Clears all body attributes. |
void |
clearBodyScripts()
Clears the body scripts. |
void |
clearHeadScripts()
Clears the head scripts. |
void |
clearInlineBodyScript()
Clears the inline body script. |
void |
clearInlineStyleSheet()
Clears the inline style sheet. |
void |
clearMetaElements()
Clears all meta elements. |
void |
clearPluginAttributes()
Clears all plugin attributes. |
void |
clearStyleSheets()
Clears the style sheets. |
Boolean |
containsAttribute(String name)
Checks whether a page attribute is set. |
Boolean |
containsBodyAttribute(String name)
Checks whether a body attribute is set. |
Boolean |
containsBodyScript(String url)
Checks whether a body script is contained. |
Boolean |
containsHeadScript(String url)
Checks whether a head script is contained. |
Boolean |
containsMetaElement(String name)
Checks whether a meta element is set. |
Boolean |
containsPluginAttribute(String name)
Checks whether a plugin attribute is set. |
Boolean |
containsStyleSheet(String url)
Checks whether a style sheet is contained. |
Object |
getAttribute(String name)
Gets a page attribute. |
String |
getBaseName()
Gets the base name for localized resources. |
String |
getBodyAttribute(String name)
Gets a body attribute. |
Collection<String> |
getBodyScripts()
Gets the body scripts. |
String |
getDocType()
Gets the doctype. |
Collection<String> |
getHeadScripts()
Gets the head scripts. |
String |
getInlineBodyScript()
Gets the inline body script. |
String |
getInlineStyleSheet()
Gets the inline style sheet. |
String |
getLabel()
Gets the label. |
String |
getLink()
Gets the link. |
Boolean |
getLocalized()
Checks whether labels and URLs are localized. |
String |
getLogo()
Gets the logo. |
String |
getMetaElement(String name)
Gets a meta element. |
String |
getName()
Gets the name. |
Skin.Orientation |
getOrientation()
Gets the orientation. |
String |
getPluginAttribute(String name)
Gets a plugin attribute. |
String |
getShortcutIcon()
Gets the shortcut icon. |
Collection<String> |
getStyleSheets()
Gets the style sheets. |
String |
getSubtitle()
Gets the subtitle. |
String |
getTheme()
Gets the form theme. |
String |
getTitle()
Gets the title. |
String |
getXMLNs()
Gets the XML namespace. |
boolean |
mergeAttributes(ConcurrentMap<String,Object> map)
Merges page attributes to the specified map. |
boolean |
mergeBodyAttributes(ConcurrentMap<String,String> map)
Merges body attributes to the specified map. |
boolean |
mergeBodyScripts(OrderedMap<String,Boolean> map,
int... index)
Merges body scripts to the specified map. |
boolean |
mergeHeadScripts(OrderedMap<String,Boolean> map,
int... index)
Merges head scripts to the specified map. |
boolean |
mergeInlineBodyScript(StringBuilder builder,
int... index)
Merges the inline body script to the specified buffer. |
boolean |
mergeInlineStyleSheet(StringBuilder builder,
int... index)
Merges the inline style sheet to the specified buffer. |
boolean |
mergeMetaElements(ConcurrentMap<String,String> map)
Merges meta elements to the specified map. |
boolean |
mergePluginAttributes(ConcurrentMap<String,String> map)
Merges plugin attributes to the specified map. |
boolean |
mergeStyleSheets(OrderedMap<String,Boolean> map,
int... index)
Merges style sheets to the specified map. |
void |
removeAttribute(String name)
Removes a page attribute. |
void |
removeBodyAttribute(String name)
Removes a body attribute. |
void |
removeBodyScript(String url)
Removes a body script. |
void |
removeHeadScript(String url)
Removes a head script. |
void |
removeMetaElement(String name)
Removes a meta element. |
void |
removePluginAttribute(String name)
Removes a plugin attribute. |
void |
removeStyleSheet(String url)
Removes a style sheet. |
void |
setAttribute(String name,
Object value)
Sets a page attribute. |
void |
setBaseName(String name)
Sets the base name for localized resources. |
void |
setBodyAttribute(String name,
String value)
Sets a body attribute. |
void |
setBodyScripts(Collection<String> c,
boolean... localized)
Sets the body scripts. |
void |
setDocType(String type)
Sets the doctype. |
void |
setHeadScripts(Collection<String> c,
boolean... localized)
Sets the head scripts. |
void |
setInlineBodyScript(String script)
Sets the inline body script. |
void |
setInlineStyleSheet(String style)
Sets the inline style sheet. |
void |
setLabel(String label)
Sets the label. |
void |
setLink(String url)
Sets the link. |
void |
setLocalized(Boolean flag)
Sets whether labels and URLs are localized. |
void |
setLogo(String path)
Sets the logo. |
void |
setMetaElement(String name,
String value)
Sets a meta element. |
void |
setOrientation(Skin.Orientation o)
Sets the orientation. |
void |
setPluginAttribute(String name,
String value)
Sets a plugin attribute. |
void |
setShortcutIcon(String url)
Sets the shortcut icon. |
void |
setStyleSheets(Collection<String> c,
boolean... localized)
Sets the style sheets. |
void |
setSubtitle(String title)
Sets the subtitle. |
void |
setTheme(String theme)
Sets the form theme. |
void |
setTitle(String title)
Sets the title. |
void |
setXMLNs(String ns)
Sets the XML namespace. |
Field Detail |
---|
static final String META_DESCRIPTION
static final String META_KEYWORDS
static final String META_AUTHOR
static final String META_GENERATOR
static final String META_REVISED
static final String PAGE_ID
static final String HTML_XMLNS
static final String BODY_BACKGROUND
static final String BODY_BGCOLOR
static final String BODY_TEXT
static final String BODY_LINK
static final String BODY_VLINK
static final String BODY_ALINK
Method Detail |
---|
String getName()
String getLabel()
void setLabel(String label)
label
- the label.String getTheme()
void setTheme(String theme)
theme
- the name of the form theme.Boolean getLocalized()
void setLocalized(Boolean flag)
flag
- true for localized labels, false otherwise.String getBaseName()
void setBaseName(String name)
name
- the base name of the resource bundle.String getDocType()
void setDocType(String type)
type
- the doctype.String getXMLNs()
void setXMLNs(String ns)
ns
- the namespace.String getLink()
void setLink(String url)
url
- the URL of the link.String getLogo()
void setLogo(String path)
path
- the path of the logo.String getTitle()
void setTitle(String title)
title
- the title.String getSubtitle()
void setSubtitle(String title)
title
- the subtitle.Skin.Orientation getOrientation()
void setOrientation(Skin.Orientation o)
o
- the orientation.Collection<String> getHeadScripts()
Note that only local scripts are included, apply the merge method to get inherited scripts also.
void setHeadScripts(Collection<String> c, boolean... localized)
Note that inherited scripts are prohibited after set, apply the add method to keep the inherited scripts.
c
- a collection of URLs of the head scripts.localized
- true if localized, false otherwise.void addHeadScript(String url, boolean... localized)
url
- the URL of the head script.localized
- true if localized, false otherwise.Boolean containsHeadScript(String url)
url
- the URL of the head script.
void removeHeadScript(String url)
url
- the URL of the head script.void clearHeadScripts()
Note that only local scripts are cleared and inherited scripts are applied after clear.
boolean mergeHeadScripts(OrderedMap<String,Boolean> map, int... index)
map
- the script map.index
- the insertion index.
Collection<String> getBodyScripts()
Note that only local scripts are included, apply the merge method to get inherited scripts also.
void setBodyScripts(Collection<String> c, boolean... localized)
Note that inherited scripts are prohibited after set, apply the add method to keep the inherited scripts.
c
- a collection of URLs of the body scripts.localized
- true if localized, false otherwise.void addBodyScript(String url, boolean... localized)
url
- the URL of the body script.localized
- true if localized, false otherwise.Boolean containsBodyScript(String url)
url
- the URL of the body script.
void removeBodyScript(String url)
url
- the URL of the body script.void clearBodyScripts()
Note that only local scripts are cleared and inherited scripts are applied after clear.
boolean mergeBodyScripts(OrderedMap<String,Boolean> map, int... index)
map
- the script map.index
- the insertion index.
String getInlineBodyScript()
Note that only local scripts are included, apply the merge method to get inherited scripts, too.
void setInlineBodyScript(String script)
Note that inherited scripts are prohibited after set, apply the append method to keep the inherited scripts.
script
- the inline body script.void appendInlineBodyScript(String script)
script
- the inline body script.void clearInlineBodyScript()
Note that only local scripts are cleared and inherited scripts are applied after clear.
boolean mergeInlineBodyScript(StringBuilder builder, int... index)
builder
- the body script.index
- the insertion index.
Collection<String> getStyleSheets()
Note that only local styles are included, apply the merge method to get inherited styles, too.
void setStyleSheets(Collection<String> c, boolean... localized)
Note that inherited styles are prohibited after set, apply the add method to keep the inherited styles.
c
- a collection of URLs of the style sheets.localized
- true if localized, false otherwise.void addStyleSheet(String url, boolean... localized)
url
- the URL of the style sheet.localized
- true if localized, false otherwise.Boolean containsStyleSheet(String url)
url
- the URL of the style sheet.
void removeStyleSheet(String url)
url
- the URL of the style sheet.void clearStyleSheets()
Note that only local styles are cleared and inherited styles are applied after clear.
boolean mergeStyleSheets(OrderedMap<String,Boolean> map, int... index)
map
- the style map.index
- the insertion index.
String getInlineStyleSheet()
Note that only local styles are included, apply the merge method to get inherited styles, too.
void setInlineStyleSheet(String style)
Note that inherited styles are prohibited after set, apply the append method to keep the inherited styles.
style
- the inline style sheet.void appendInlineStyleSheet(String style)
style
- the inline style sheet.void clearInlineStyleSheet()
Note that only local styles are cleared and inherited styles are applied after clear.
boolean mergeInlineStyleSheet(StringBuilder builder, int... index)
builder
- the style buffer.index
- the insertion index.
String getShortcutIcon()
void setShortcutIcon(String url)
url
- the URL of the icon.String getMetaElement(String name)
name
- the name of the element.
void setMetaElement(String name, String value)
name
- the name of the element.value
- the value of the element.Boolean containsMetaElement(String name)
name
- the element name.
void removeMetaElement(String name)
name
- the name of the element.void clearMetaElements()
boolean mergeMetaElements(ConcurrentMap<String,String> map)
map
- the element map.
String getBodyAttribute(String name)
name
- the name of the attribute.
void setBodyAttribute(String name, String value)
name
- the name of the attribute.value
- the value of the attribute.void addBodyAttribute(String name, String value)
The body attribute is supposed to support values separated by semicolons.
name
- the name of the attribute.value
- the value of the attribute.Boolean containsBodyAttribute(String name)
name
- the attribute name.
void removeBodyAttribute(String name)
name
- the name of the attribute.void clearBodyAttributes()
boolean mergeBodyAttributes(ConcurrentMap<String,String> map)
map
- the attribute map.
String getPluginAttribute(String name)
name
- the name of the plugin.
void setPluginAttribute(String name, String value)
name
- the name of the plugin.value
- the plugin attribute.Boolean containsPluginAttribute(String name)
name
- the plugin name.
void removePluginAttribute(String name)
name
- the name of the plugin.void clearPluginAttributes()
boolean mergePluginAttributes(ConcurrentMap<String,String> map)
map
- the attribute map.
Object getAttribute(String name)
name
- the name of the attribute.
void setAttribute(String name, Object value)
name
- the name of the attribute.value
- the value of the attribute.Boolean containsAttribute(String name)
name
- the attribute name.
void removeAttribute(String name)
name
- the name of the attribute.void clearAttributes()
boolean mergeAttributes(ConcurrentMap<String,Object> map)
map
- the attribute map.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |