org.openfaces.util
Class Styles

java.lang.Object
  extended by org.openfaces.util.Styles

public class Styles
extends java.lang.Object


Method Summary
static void addStyleJsonParam(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, JSONObject paramsObject, java.lang.String jsonFieldName, java.lang.String style, java.lang.String styleClass)
          Add style parameter to JSON object for regular StyleGroup
static void addStyleJsonParam(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, JSONObject paramsObject, java.lang.String jsonFieldName, java.lang.String style, java.lang.String styleClass, StyleGroup styleGroup)
          Add style parameter to JSON object
static java.lang.String checkCSSStyleForSemicolon(java.lang.String style)
          Check css style declaration for semicolon ending and add it, if necessary
static java.util.List<java.lang.String> getAllStyleClassesForComponent(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component)
          Return list of all components css style classes
static java.util.Iterator<java.lang.String> getClassKeyIterator()
          Return iterator to iterate over all style groups
static java.util.Map getComponentStylesMap(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component)
          Return registered css style classes for given component
static java.lang.String getCSSClass_dontCascade(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, java.lang.String style, StyleGroup styleGroup, java.lang.String styleClass, java.lang.String defaultStyle)
          Renders default style in-place unless user has defined style or styleClass attributes
static java.lang.String getCSSClass(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, java.lang.String style)
          Return component css class for regular StyleGroup
static java.lang.String getCSSClass(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, java.lang.String style, java.lang.String defStyleClass)
          Return component css class for given component merged with given default css class and css style
static java.lang.String getCSSClass(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, java.lang.String style, java.lang.String defStyleClass, java.lang.String styleClass)
          Return component css class for given component merged with given css style and css style class
static java.lang.String getCSSClass(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, java.lang.String style, StyleGroup styleGroup)
          Return component css class for given StyleGroup
static java.lang.String getCSSClass(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, java.lang.String style, StyleGroup styleGroup, java.lang.String styleClass)
          Return component css class for given StyleGroup merged with given css style and css style class
static java.lang.String getCSSClass(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, java.lang.String style, StyleGroup styleGroup, java.lang.String styleClass, java.lang.String defStyleClass)
          Return component css class for given component and given StyleGroup merged with given css style and css style class
static long getNextStyleIndex()
           
static java.util.Map getRegisteredStyleClassesMap(javax.faces.context.FacesContext context)
          Return registered css style classes
static java.util.Set<java.lang.String> getRenderedStyleElementsIds(javax.faces.context.FacesContext context)
          Return ids of elements with rendered style
static java.lang.String getStyleClassesStr(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, java.lang.String style, java.lang.String styleClass, java.lang.String defaultStyle, StyleGroup styleGroup)
           
static void markStylesRenderedForComponent(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component)
          Remove all component registered styles
static java.lang.String mergeClassNames(java.lang.String class1, java.lang.String class2)
          This method check and merges two ccs classes into one
static java.lang.String mergeStyles(java.lang.String style1, java.lang.String style2)
          Merge css styles
static java.lang.String registerCssClass(javax.faces.context.FacesContext context, java.lang.String style, StyleGroup styleGroup, javax.faces.component.UIComponent component)
          Transform css style to css class and register css class for given component for given StyleGroup
static void renderStyleClasses(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component)
          Render style classes for given component
static void renderStyleClasses(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, boolean forcedStyleAsScript, boolean forceStyleAsOnloadScript)
          Render style classes for given component
static void writeCssClassesAsScriptElement(javax.faces.context.FacesContext context, java.util.List<java.lang.String> cssRules, boolean asOnloadScript)
          Render javascript, which add css rules
static void writeCssClassesAsStyleElement(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, java.lang.String stylesId, java.util.List<java.lang.String> cssClasses)
          Render inline styles
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

mergeClassNames

public static java.lang.String mergeClassNames(java.lang.String class1,
                                               java.lang.String class2)
This method check and merges two ccs classes into one

Parameters:
class1 - - first css class to merge
class2 - - second
Returns:
merged class name

getCSSClass

public static java.lang.String getCSSClass(javax.faces.context.FacesContext context,
                                           javax.faces.component.UIComponent component,
                                           java.lang.String style)
Return component css class for regular StyleGroup

Parameters:
context - FacesContext for the current request
component - The component
style - The style to merge with
Returns:
component css class
See Also:
getCSSClass(javax.faces.context.FacesContext, javax.faces.component.UIComponent, String, StyleGroup, String, String)

getCSSClass

public static java.lang.String getCSSClass(javax.faces.context.FacesContext context,
                                           javax.faces.component.UIComponent component,
                                           java.lang.String style,
                                           StyleGroup styleGroup)
Return component css class for given StyleGroup

Parameters:
context - FacesContext for the current request
component - The component
style - The style to merge with
styleGroup - The StyleGroup for which retrieve css class
Returns:
component css class
See Also:
getCSSClass(javax.faces.context.FacesContext, javax.faces.component.UIComponent, String, StyleGroup, String, String)

getCSSClass

public static java.lang.String getCSSClass(javax.faces.context.FacesContext context,
                                           javax.faces.component.UIComponent component,
                                           java.lang.String style,
                                           StyleGroup styleGroup,
                                           java.lang.String styleClass)
Return component css class for given StyleGroup merged with given css style and css style class

Parameters:
context - FacesContext for the current request
component - The component
style - The style to merge with
styleGroup - The StyleGroup for which retrieve css class
styleClass - The style class to merge with
Returns:
component css class
See Also:
getCSSClass(javax.faces.context.FacesContext, javax.faces.component.UIComponent, String, StyleGroup, String, String)

getCSSClass

public static java.lang.String getCSSClass(javax.faces.context.FacesContext context,
                                           javax.faces.component.UIComponent component,
                                           java.lang.String style,
                                           java.lang.String defStyleClass)
Return component css class for given component merged with given default css class and css style

Parameters:
context - FacesContext for the current request
component - The component
style - The style to merge with
defStyleClass - The default style class to merge with
Returns:
component css class
See Also:
getCSSClass(javax.faces.context.FacesContext, javax.faces.component.UIComponent, String, StyleGroup, String, String)

getCSSClass

public static java.lang.String getCSSClass(javax.faces.context.FacesContext context,
                                           javax.faces.component.UIComponent component,
                                           java.lang.String style,
                                           java.lang.String defStyleClass,
                                           java.lang.String styleClass)
Return component css class for given component merged with given css style and css style class

Parameters:
context - FacesContext for the current request
component - The component
style - The style to merge with
defStyleClass - The default style class to merge with
styleClass - The style class to merge with
Returns:
component css class
See Also:
getCSSClass(javax.faces.context.FacesContext, javax.faces.component.UIComponent, String, StyleGroup, String, String)

getCSSClass

public static java.lang.String getCSSClass(javax.faces.context.FacesContext context,
                                           javax.faces.component.UIComponent component,
                                           java.lang.String style,
                                           StyleGroup styleGroup,
                                           java.lang.String styleClass,
                                           java.lang.String defStyleClass)
Return component css class for given component and given StyleGroup merged with given css style and css style class

Parameters:
context - FacesContext for the current request
component - The component
style - The style to merge with
defStyleClass - The default style class to merge with
styleGroup - The StyleGroup for which retrieve css class
styleClass - The style class to merge with
Returns:
component css class
See Also:
getCSSClass(javax.faces.context.FacesContext, javax.faces.component.UIComponent, String, StyleGroup, String, String)

getCSSClass_dontCascade

public static java.lang.String getCSSClass_dontCascade(javax.faces.context.FacesContext context,
                                                       javax.faces.component.UIComponent component,
                                                       java.lang.String style,
                                                       StyleGroup styleGroup,
                                                       java.lang.String styleClass,
                                                       java.lang.String defaultStyle)
Renders default style in-place unless user has defined style or styleClass attributes


getStyleClassesStr

public static java.lang.String getStyleClassesStr(javax.faces.context.FacesContext context,
                                                  javax.faces.component.UIComponent component,
                                                  java.lang.String style,
                                                  java.lang.String styleClass,
                                                  java.lang.String defaultStyle,
                                                  StyleGroup styleGroup)

getRegisteredStyleClassesMap

public static java.util.Map getRegisteredStyleClassesMap(javax.faces.context.FacesContext context)
Return registered css style classes

Parameters:
context - FacesContext for the current request
Returns:
registered css style classes

getComponentStylesMap

public static java.util.Map getComponentStylesMap(javax.faces.context.FacesContext context,
                                                  javax.faces.component.UIComponent component)
Return registered css style classes for given component

Parameters:
context - FacesContext for the current request
component - The component for retrieve css style classes
Returns:
registered css style classes

registerCssClass

public static java.lang.String registerCssClass(javax.faces.context.FacesContext context,
                                                java.lang.String style,
                                                StyleGroup styleGroup,
                                                javax.faces.component.UIComponent component)
Transform css style to css class and register css class for given component for given StyleGroup

Parameters:
context - FacesContext for the current request
style - The style to be registered
styleGroup - The StyleGroup for which style is registered
component - The component for register css style classes
Returns:
generated css style class name

getNextStyleIndex

public static long getNextStyleIndex()

renderStyleClasses

public static void renderStyleClasses(javax.faces.context.FacesContext context,
                                      javax.faces.component.UIComponent component)
                               throws java.io.IOException
Render style classes for given component

Parameters:
context - FacesContext for the current request
component - The component, which styles are rendered
Throws:
java.io.IOException - if an input/output error occurs while rendering
See Also:
renderStyleClasses(javax.faces.context.FacesContext, javax.faces.component.UIComponent, boolean, boolean)

renderStyleClasses

public static void renderStyleClasses(javax.faces.context.FacesContext context,
                                      javax.faces.component.UIComponent component,
                                      boolean forcedStyleAsScript,
                                      boolean forceStyleAsOnloadScript)
                               throws java.io.IOException
Render style classes for given component

Parameters:
context - FacesContext for the current request
component - The component, which styles are rendered
forcedStyleAsScript - The parameter, indicating way of rendering styles
Throws:
java.io.IOException - if an input/output error occurs while rendering

writeCssClassesAsScriptElement

public static void writeCssClassesAsScriptElement(javax.faces.context.FacesContext context,
                                                  java.util.List<java.lang.String> cssRules,
                                                  boolean asOnloadScript)
                                           throws java.io.IOException
Render javascript, which add css rules

Parameters:
context - FacesContext for the current request
cssRules - The list of css rules for rendering
Throws:
java.io.IOException - if an input/output error occurs while rendering

writeCssClassesAsStyleElement

public static void writeCssClassesAsStyleElement(javax.faces.context.FacesContext context,
                                                 javax.faces.component.UIComponent component,
                                                 java.lang.String stylesId,
                                                 java.util.List<java.lang.String> cssClasses)
                                          throws java.io.IOException
Render inline styles

Parameters:
context - FacesContext for the current request
cssClasses - The list of css rules for rendering
Throws:
java.io.IOException - if an input/output error occurs while rendering

markStylesRenderedForComponent

public static void markStylesRenderedForComponent(javax.faces.context.FacesContext context,
                                                  javax.faces.component.UIComponent component)
Remove all component registered styles

Parameters:
context - FacesContext for the current request
component - The component, which styles are removed

getRenderedStyleElementsIds

public static java.util.Set<java.lang.String> getRenderedStyleElementsIds(javax.faces.context.FacesContext context)
Return ids of elements with rendered style

Parameters:
context - FacesContext for the current request
Returns:
set of elements ids

getAllStyleClassesForComponent

public static java.util.List<java.lang.String> getAllStyleClassesForComponent(javax.faces.context.FacesContext context,
                                                                              javax.faces.component.UIComponent component)
Return list of all components css style classes

Parameters:
context - FacesContext for the current request
component - The component to analyse
Returns:
list of all components css style classes

getClassKeyIterator

public static java.util.Iterator<java.lang.String> getClassKeyIterator()
Return iterator to iterate over all style groups

Returns:
iterator to iterate over all style groups

checkCSSStyleForSemicolon

public static java.lang.String checkCSSStyleForSemicolon(java.lang.String style)
Check css style declaration for semicolon ending and add it, if necessary

Parameters:
style - The css style declaration to check
Returns:
css style with semicolon ending

mergeStyles

public static java.lang.String mergeStyles(java.lang.String style1,
                                           java.lang.String style2)
Merge css styles

Parameters:
style1 - The first css style for merge
style2 - The second css style for merge
Returns:
merged css style declaration

addStyleJsonParam

public static void addStyleJsonParam(javax.faces.context.FacesContext context,
                                     javax.faces.component.UIComponent component,
                                     JSONObject paramsObject,
                                     java.lang.String jsonFieldName,
                                     java.lang.String style,
                                     java.lang.String styleClass)
Add style parameter to JSON object for regular StyleGroup

Parameters:
context - FacesContext for the current request
component - The component, which style will be added
paramsObject - The JSON object, to which style parameter will be added
jsonFieldName - The key
style - The style to merge with component style
styleClass - The style class to merge with component style class
See Also:
addStyleJsonParam(javax.faces.context.FacesContext, javax.faces.component.UIComponent, org.openfaces.org.json.JSONObject, String, String, String, StyleGroup)

addStyleJsonParam

public static void addStyleJsonParam(javax.faces.context.FacesContext context,
                                     javax.faces.component.UIComponent component,
                                     JSONObject paramsObject,
                                     java.lang.String jsonFieldName,
                                     java.lang.String style,
                                     java.lang.String styleClass,
                                     StyleGroup styleGroup)
Add style parameter to JSON object

Parameters:
context - FacesContext for the current request
component - The component, which style will be added
paramsObject - The JSON object, to which style parameter will be added
jsonFieldName - The key
style - The style to merge with component style
styleClass - The style class to merge with component style class
styleGroup - The StyleGroup for which retrieve css class
See Also:
addStyleJsonParam(javax.faces.context.FacesContext, javax.faces.component.UIComponent, org.openfaces.org.json.JSONObject, String, String, String, StyleGroup)


Copyright © 1998-2010 TeamDev Ltd. All Rights Reserved.