Package org.eclnt.jsfserver.util

Class StyleManager

java.lang.Object

org.eclnt.jsfserver.util.StyleManager

All Implemented Interfaces:

ICCServerConstants

public class StyleManager
extends Object
implements ICCServerConstants

Access to style definitions. In general the style information is read when starting the web application - so you should only access the get-methods in order to gather for style information.

Please also check class StyleUtil, which contains useful methods in the area of style management.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StyleManager.CSSStyleParser
static class	StyleManager.Style
static class	StyleManager.StyleAttributeValue	Concrete attribute-value-pair.
static class	StyleManager.StyleParser
static class	StyleManager.StyleTagGroup
static class	StyleManager.StyleTagInfo	Style information for a tag.
static class	StyleManager.StyleValue	Style value that is added to the style via:
static class	StyleManager.StyleVariant

Field Summary

Fields inherited from interface org.eclnt.jsfserver.util.ICCServerConstants

CLIENTDEVICETYPE_DESKTOP, CLIENTDEVICETYPE_MOBILE, CLIENTJAVATYPE_FX, CLIENTJAVATYPE_SWING, CLIENTTYPE_APPLET, CLIENTTYPE_APPLICATION, CLIENTTYPE_BROWSER, CLIENTTYPE_RISC, CLIENTTYPE_UI5, CLIENTTYPE_WEBSTART, EXPLICIT_EMPTY, EXPLICIT_NULL, FOCUSSEQUENCE_FIX_PREFIX, HEADER_ATTRIBUTE_CLIENT, HEADER_ATTRIBUTE_CLIENTJAVATYPE, HEADER_ATTRIBUTE_COOKIESENABLED, HEADER_ATTRIBUTE_COUNTRY, HEADER_ATTRIBUTE_DEVICESCREENHEIGHT, HEADER_ATTRIBUTE_DEVICESCREENWIDTH, HEADER_ATTRIBUTE_DEVICETYPE, HEADER_ATTRIBUTE_LANGUAGE, HEADER_ATTRIBUTE_MEDIADEVICES, HEADER_ATTRIBUTE_ORIGINALURL, HEADER_ATTRIBUTE_PERFORMANCEDATA, HEADER_ATTRIBUTE_REQUESTID, HEADER_ATTRIBUTE_TIMEZONEOFFSET, HEADER_ATTRIBUTE_USERAGENT, HEADER_ATTRIBUTE_XFRAMEOPTIONS, HEADER_RESPONSE_ATTRIBUTE_HTTPSESSIONID, HEADER_RESPONSE_ATTRIBUTE_HTTPSESSIONREFERENCEURL, HEADER_RESPONSE_ATTRIBUTE_HTTPSESSIONTRACKINGMODE, HEADER_RESPONSE_ATTRIBUTE_OVERRIDE, HEADER_RESPONSE_ATTRIBUTE_RELOAD, HEADER_RESPONSE_ATTRIBUTE_STYLE, INPUTMASK_VALUEMODE_WITHMASK, INPUTMASK_VALUEMODE_WITHOUTMASK, LAYOUTEXTENSION_JSP, LAYOUTEXTENSION_XML, LITERAL_LINK_PREFIX, LITERAL_TEMP_PREFIX, QP_CCSTYLE, QP_KEEPDIALOGSESSION, QP_SUBPAGEID, SECURITY_ROLE_CCADMIN, SESSION_TRACKING_COOKIE, SESSION_TRACKING_URL, SIZE_UNDEFINED, TEXTPANE_CONTENTTYPE_HTML, TEXTPANE_CONTENTTYPE_PLAIN

Constructor Summary

Constructors

Constructor	Description
StyleManager()

Method Summary

Modifier and Type	Method	Description
static void	addCSSGlobalVariablesToDeignTimeStyle(StyleManager.Style style, String styleFileName)
static String	combineStyleWithAdditionalStyles(String xml, String styleName, ClassLoader cl)	Combines the CSS-style-xml with additional style information coming from additional styles coming from the classloader (page bean components).
static List<String>	getAvailableRuntimeStyles()
static StyleManager.Style	getStyle(String styleName)	Reads style at runtime.
static List<String>	getStyleExtensionSequence(String styleName)	Reads extension sequence for a given style.
static String	getStyleValue(String valueName)
static String	getStyleValue(String styleName, String valueName)	Get style value.
static String	getTagAttributeValue(String variantName, String tagNameWithPrefix, String attributeName)	Convenience method - returning the style value for a certain tag.
static StyleManager.StyleTagInfo	getTagInfo(String variantName, String tagNameWithPrefix)	Convenience method - returning the style information for the style that is used within the current session of the user.
static StyleManager.StyleTagInfo	getTagInfo(String styleName, String variantName, String tagNameWithPrefix)	Central method for getting style information for a certain tag.
static StyleManager.StyleTagInfo	getTagInfo(String styleName, String variantName, String includingPageName, String componentLayoutId, String tagNameWithPrefix)	Style access with cascading over styleVariant, includingPageName, componentId.
static StyleManager.StyleTagInfo	getTagInfoNoCSV(String styleName, String variantName, String tagNameWithPrefix)
static StyleManager.Style	readDesignTimeStyle(String styleName, String styleFileName)
static StyleManager.Style	readDesignTimeStyle(String styleName, String styleFileName, ClassLoader cl)
static void	registerStyle(String styleName)
static void	registerStyle(String styleName, boolean withError)
static void	reset()	Allows to reset the stlye manager without restarting Tomcat...
static String	updatePrefix(String tagName)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

StyleManager

public StyleManager()

Method Details

reset

public static void reset()

Allows to reset the stlye manager without restarting Tomcat...

updatePrefix

public static String updatePrefix(String tagName)

getTagInfo

public static StyleManager.StyleTagInfo getTagInfo(String variantName,
 String tagNameWithPrefix)

Convenience method - returning the style information for the style that is used within the current session of the user. This method must only be used within the context of a request processing.

getTagAttributeValue

public static String getTagAttributeValue(String variantName,
 String tagNameWithPrefix,
 String attributeName)

Convenience method - returning the style value for a certain tag.

Parameters:

variantName - e.g. "default"

tagNameWithPrefix - e.g. "t:field"

attributeName - e.g. "background"

Returns:

Style value, null if not defined.

getStyleValue

public static String getStyleValue(String valueName)

getStyleValue

public static String getStyleValue(String styleName,
 String valueName)

Get style value. Style values are the values defined via .

getStyle

public static StyleManager.Style getStyle(String styleName)

Reads style at runtime.

getStyleExtensionSequence

public static List<String> getStyleExtensionSequence(String styleName)

Reads extension sequence for a given style. The first style in the list is the most basic style, the last style in the list is the style passed via parameter "styleName". This is a runtime function.

getTagInfo

public static StyleManager.StyleTagInfo getTagInfo(String styleName,
 String variantName,
 String includingPageName,
 String componentLayoutId,
 String tagNameWithPrefix)

Style access with cascading over styleVariant, includingPageName, componentId.

getTagInfo

public static StyleManager.StyleTagInfo getTagInfo(String styleName,
 String variantName,
 String tagNameWithPrefix)

Central method for getting style information for a certain tag.

Parameters:

tagNameWithPrefix - Full tag name, including prefix, e.g. "t:field".

Returns:

Null if nothing found.

getTagInfoNoCSV

public static StyleManager.StyleTagInfo getTagInfoNoCSV(String styleName,
 String variantName,
 String tagNameWithPrefix)

registerStyle

public static void registerStyle(String styleName)

registerStyle

public static void registerStyle(String styleName,
 boolean withError)

getAvailableRuntimeStyles

public static List<String> getAvailableRuntimeStyles()

readDesignTimeStyle

public static StyleManager.Style readDesignTimeStyle(String styleName,
 String styleFileName)

readDesignTimeStyle

public static StyleManager.Style readDesignTimeStyle(String styleName,
 String styleFileName,
 ClassLoader cl)

addCSSGlobalVariablesToDeignTimeStyle

public static void addCSSGlobalVariablesToDeignTimeStyle(StyleManager.Style style,
 String styleFileName)

combineStyleWithAdditionalStyles

public static String combineStyleWithAdditionalStyles(String xml,
 String styleName,
 ClassLoader cl)

Combines the CSS-style-xml with additional style information coming from additional styles coming from the classloader (page bean components).