org.apache.myfaces.shared.renderkit

Class RendererUtils

java.lang.Object

org.apache.myfaces.shared.renderkit.RendererUtils

public final class RendererUtils
extends Object

Version:

$Revision: 1341540 $ $Date: 2012-05-22 10:47:08 -0500 (Tue, 22 May 2012) $

Author:

Manfred Geiler (latest modification by $Author: lu4242 $)

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACTION_FOR_LIST
static String	ACTION_FOR_PHASE_LIST
static String	EMPTY_STRING
static Object	NOTHING
static String	RES_NOT_FOUND
static String	SELECT_ITEM_LIST_ATTR
static String	SEQUENCE_PARAM

Method Summary

Methods

Modifier and Type	Method and Description
static void	addOrReplaceChild(UIInput component, UIComponent child)
static void	checkParamValidity(FacesContext facesContext, UIComponent uiComponent, Class compClass)
static List	convertIdsToClientIds(String actionFor, FacesContext facesContext, UIComponent component)
static List	convertPhasesToPhasesIds(String actionForPhase)
static void	copyHtmlInputTextAttributes(HtmlInputText src, HtmlInputText dest)
static UIComponent	findComponent(UIComponent headerComp, Class clazz)
static FormInfo	findNestingForm(UIComponent uiComponent, FacesContext facesContext) Find the enclosing form of a component in the view-tree.
static Converter	findUIOutputConverter(FacesContext facesContext, UIOutput component) Find the proper Converter for the given UIOutput component.
static Converter	findUISelectManyConverter(FacesContext facesContext, UISelectMany component) Calls findUISelectManyConverter with considerValueType = false.
static Converter	findUISelectManyConverter(FacesContext facesContext, UISelectMany component, boolean considerValueType) Find proper Converter for the entries in the associated Collection or array of the given UISelectMany as specified in API Doc of UISelectMany.
static boolean	getBooleanAttribute(UIComponent component, String attrName, boolean defaultValue)
static boolean	getBooleanValue(String attribute, Object value, boolean defaultValue)
static Boolean	getBooleanValue(UIComponent component)
static String	getClientId(FacesContext facesContext, UIComponent uiComponent, String forAttr)
static String	getConcatenatedId(FacesContext context, UIComponent component)
static String	getConcatenatedId(FacesContext context, UIComponent container, String clientId)
static String	getConvertedStringValue(FacesContext context, UIComponent component, Converter converter, Object value) Convenient utility method that returns the currently given value as String, using the given converter.
static String	getConvertedStringValue(FacesContext context, UIComponent component, Converter converter, SelectItem selectItem) Convenient utility method that returns the currently given SelectItem value as String, using the given converter.
static Object	getConvertedUIOutputValue(FacesContext facesContext, UIOutput output, Object submittedValue)
static Object	getConvertedUISelectManyValue(FacesContext facesContext, UISelectMany selectMany, Object submittedValue) Invokes getConvertedUISelectManyValue() with considerValueType = false, thus implementing the standard behavior of the spec (valueType comes from Tomahawk).
static Object	getConvertedUISelectManyValue(FacesContext facesContext, UISelectMany selectMany, Object submittedValue, boolean considerValueType) Gets the converted value of a UISelectMany component.
static Object	getConvertedUISelectOneValue(FacesContext facesContext, UISelectOne output, Object submittedValue)
static Date	getDateValue(UIComponent component)
static String	getIconSrc(FacesContext facesContext, UIComponent component, String attributeName) Checks for name/library attributes on component and if they are avaliable, creates Resource and returns it's path suitable for rendering.
static int	getIntegerAttribute(UIComponent component, String attrName, int defaultValue)
static Object	getObjectValue(UIComponent component)
static String	getPathToComponent(UIComponent component)
static ResponseStateManager	getResponseStateManager(FacesContext facesContext, String renderKitId) Deprecated. use FacesContext.getRenderKit() or getRenderKitFactory().getRenderKit( context, renderKitId).getResponseStateManager()
static Set	getSelectedValuesAsSet(FacesContext context, UIComponent component, Converter converter, UISelectMany uiSelectMany) Convenient utility method that returns the currently selected values of a UISelectMany component as a Set, of which the contains method can then be easily used to determine if a value is currently selected.
static List	getSelectItemList(UISelectMany uiSelectMany)
static List	getSelectItemList(UISelectMany uiSelectMany, FacesContext facesContext)
static List	getSelectItemList(UISelectOne uiSelectOne)
static List	getSelectItemList(UISelectOne uiSelectOne, FacesContext facesContext)
static String	getStringFromSubmittedValueOrLocalValueReturnNull(FacesContext facesContext, UIComponent component)
static String	getStringValue(FacesContext facesContext, UIComponent component)
static String	getStringValue(FacesContext context, ValueBinding vb) Deprecated.
static String	getStringValue(FacesContext context, javax.el.ValueExpression ve)
static Set	getSubmittedValuesAsSet(FacesContext context, UIComponent component, Converter converter, UISelectMany uiSelectMany) Convenient utility method that returns the currently submitted values of a UISelectMany component as a Set, of which the contains method can then be easily used to determine if a select item is currently selected.
static Integer	getViewSequence(FacesContext facescontext) Deprecated. Logic corrected and encapsulated better in org.apache.myfaces.renderkit.ServerSideStateCacheImpl
static void	initPartialValidationAndModelUpdate(UIComponent component, FacesContext facesContext) check for partial validation or model update attributes being set and initialize the request-map accordingly.
static boolean	isAdfOrTrinidadForm(UIComponent component)
static boolean	isDefaultAttributeValue(Object value) See JSF Spec.
static boolean	isRendered(FacesContext facesContext, UIComponent uiComponent) Call #pushComponentToEL(javax.faces.context.FacesContext,javax.faces.component.UIComponent), reads the isRendered property, call UIComponent.popComponentFromEL(javax.faces.context.FacesContext) and returns the value of isRendered.
static String	loadResourceFile(FacesContext ctx, String file) Helper method which loads a resource file (such as css) by a given context path and a file name.
static void	renderChild(FacesContext facesContext, UIComponent child) Deprecated. use UIComponent.encodeAll() instead
static void	renderChildren(FacesContext facesContext, UIComponent component)
static String	toResourceUri(FacesContext facesContext, Object o) Coerces an object into a resource URI, calling the view-handler.

Methods inherited from class java.lang.Object

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

Field Detail

SELECT_ITEM_LIST_ATTR

public static final String SELECT_ITEM_LIST_ATTR

EMPTY_STRING

public static final String EMPTY_STRING

See Also:

Constant Field Values

NOTHING

public static final Object NOTHING

ACTION_FOR_LIST

public static final String ACTION_FOR_LIST

See Also:

Constant Field Values

ACTION_FOR_PHASE_LIST

public static final String ACTION_FOR_PHASE_LIST

See Also:

Constant Field Values

SEQUENCE_PARAM

public static final String SEQUENCE_PARAM

See Also:

Constant Field Values

RES_NOT_FOUND

public static final String RES_NOT_FOUND

See Also:

Constant Field Values

Method Detail

getPathToComponent

public static String getPathToComponent(UIComponent component)

getConcatenatedId

public static String getConcatenatedId(FacesContext context,
                       UIComponent container,
                       String clientId)

getConcatenatedId

public static String getConcatenatedId(FacesContext context,
                       UIComponent component)

getBooleanValue

public static Boolean getBooleanValue(UIComponent component)

getDateValue

public static Date getDateValue(UIComponent component)

getObjectValue

public static Object getObjectValue(UIComponent component)

getStringValue

@Deprecated
public static String getStringValue(FacesContext context,
                               ValueBinding vb)

Deprecated.

getStringValue

public static String getStringValue(FacesContext context,
                    javax.el.ValueExpression ve)

getStringValue

public static String getStringValue(FacesContext facesContext,
                    UIComponent component)

getStringFromSubmittedValueOrLocalValueReturnNull

public static String getStringFromSubmittedValueOrLocalValueReturnNull(FacesContext facesContext,
                                                       UIComponent component)

isDefaultAttributeValue

public static boolean isDefaultAttributeValue(Object value)

See JSF Spec. 8.5 Table 8-1

Parameters:

value -

Returns:

boolean

findUIOutputConverter

public static Converter findUIOutputConverter(FacesContext facesContext,
                              UIOutput component)
                                       throws FacesException

Find the proper Converter for the given UIOutput component.

Returns:

the Converter or null if no Converter specified or needed

Throws:

FacesException - if the Converter could not be created

findUISelectManyConverter

public static Converter findUISelectManyConverter(FacesContext facesContext,
                                  UISelectMany component)

Calls findUISelectManyConverter with considerValueType = false.

Parameters:

facesContext -

component -

Returns:

findUISelectManyConverter

public static Converter findUISelectManyConverter(FacesContext facesContext,
                                  UISelectMany component,
                                  boolean considerValueType)

Find proper Converter for the entries in the associated Collection or array of the given UISelectMany as specified in API Doc of UISelectMany. If considerValueType is true, the valueType attribute will be used in addition to the standard algorithm to get a valid converter.

Returns:

the Converter or null if no Converter specified or needed

Throws:

FacesException - if the Converter could not be created

checkParamValidity

public static void checkParamValidity(FacesContext facesContext,
                      UIComponent uiComponent,
                      Class compClass)

renderChildren

public static void renderChildren(FacesContext facesContext,
                  UIComponent component)
                           throws IOException

Throws:

IOException

renderChild

@Deprecated
public static void renderChild(FacesContext facesContext,
                          UIComponent child)
                        throws IOException

Deprecated. use UIComponent.encodeAll() instead

Parameters:

facesContext -

child -

Throws:

IOException

isRendered

public static boolean isRendered(FacesContext facesContext,
                 UIComponent uiComponent)

Call #pushComponentToEL(javax.faces.context.FacesContext,javax.faces.component.UIComponent), reads the isRendered property, call UIComponent.popComponentFromEL(javax.faces.context.FacesContext) and returns the value of isRendered.

getSelectItemList

public static List getSelectItemList(UISelectOne uiSelectOne)

getSelectItemList

public static List getSelectItemList(UISelectOne uiSelectOne,
                     FacesContext facesContext)

Parameters:

uiSelectOne -

facesContext -

Returns:

List of SelectItem Objects

getSelectItemList

public static List getSelectItemList(UISelectMany uiSelectMany)

getSelectItemList

public static List getSelectItemList(UISelectMany uiSelectMany,
                     FacesContext facesContext)

Parameters:

uiSelectMany -

facesContext -

Returns:

List of SelectItem Objects

getSubmittedValuesAsSet

public static Set getSubmittedValuesAsSet(FacesContext context,
                          UIComponent component,
                          Converter converter,
                          UISelectMany uiSelectMany)

Convenient utility method that returns the currently submitted values of a UISelectMany component as a Set, of which the contains method can then be easily used to determine if a select item is currently selected. Calling the contains method of this Set with the renderable (String converted) item value as argument returns true if this item is selected.

Parameters:

uiSelectMany -

Returns:

Set containing all currently selected values

getSelectedValuesAsSet

public static Set getSelectedValuesAsSet(FacesContext context,
                         UIComponent component,
                         Converter converter,
                         UISelectMany uiSelectMany)

Convenient utility method that returns the currently selected values of a UISelectMany component as a Set, of which the contains method can then be easily used to determine if a value is currently selected. Calling the contains method of this Set with the item value as argument returns true if this item is selected.

Parameters:

uiSelectMany -

Returns:

Set containing all currently selected values

getConvertedStringValue

public static String getConvertedStringValue(FacesContext context,
                             UIComponent component,
                             Converter converter,
                             Object value)

Convenient utility method that returns the currently given value as String, using the given converter. Especially usefull for dealing with primitive types.

getConvertedStringValue

public static String getConvertedStringValue(FacesContext context,
                             UIComponent component,
                             Converter converter,
                             SelectItem selectItem)

Convenient utility method that returns the currently given SelectItem value as String, using the given converter. Especially usefull for dealing with primitive types.

getConvertedUISelectOneValue

public static Object getConvertedUISelectOneValue(FacesContext facesContext,
                                  UISelectOne output,
                                  Object submittedValue)

getConvertedUIOutputValue

public static Object getConvertedUIOutputValue(FacesContext facesContext,
                               UIOutput output,
                               Object submittedValue)
                                        throws ConverterException

Throws:

ConverterException

getConvertedUISelectManyValue

public static Object getConvertedUISelectManyValue(FacesContext facesContext,
                                   UISelectMany selectMany,
                                   Object submittedValue)
                                            throws ConverterException

Invokes getConvertedUISelectManyValue() with considerValueType = false, thus implementing the standard behavior of the spec (valueType comes from Tomahawk).

Parameters:

facesContext -

selectMany -

submittedValue -

Returns:

Throws:

ConverterException

getConvertedUISelectManyValue

public static Object getConvertedUISelectManyValue(FacesContext facesContext,
                                   UISelectMany selectMany,
                                   Object submittedValue,
                                   boolean considerValueType)
                                            throws ConverterException

Gets the converted value of a UISelectMany component.

Parameters:

facesContext -

selectMany -

submittedValue -

considerValueType - if true, the valueType attribute of the component will also be used (applies for Tomahawk UISelectMany components)

Returns:

Throws:

ConverterException

getBooleanAttribute

public static boolean getBooleanAttribute(UIComponent component,
                          String attrName,
                          boolean defaultValue)

getIntegerAttribute

public static int getIntegerAttribute(UIComponent component,
                      String attrName,
                      int defaultValue)

findNestingForm

public static FormInfo findNestingForm(UIComponent uiComponent,
                       FacesContext facesContext)

Find the enclosing form of a component in the view-tree. All Subclasses of UIForm and all known form-families are searched for. Currently those are the Trinidad form family, and the (old) ADF Faces form family.

There might be additional form families which have to be explicitly entered here.

Parameters:

uiComponent -

facesContext -

Returns:

FormInfo Information about the form - the form itself and its name.

getBooleanValue

public static boolean getBooleanValue(String attribute,
                      Object value,
                      boolean defaultValue)

copyHtmlInputTextAttributes

public static void copyHtmlInputTextAttributes(HtmlInputText src,
                               HtmlInputText dest)

getViewSequence

@Deprecated
public static Integer getViewSequence(FacesContext facescontext)

Deprecated. Logic corrected and encapsulated better in org.apache.myfaces.renderkit.ServerSideStateCacheImpl

findComponent

public static UIComponent findComponent(UIComponent headerComp,
                        Class clazz)

addOrReplaceChild

public static void addOrReplaceChild(UIInput component,
                     UIComponent child)

getClientId

public static String getClientId(FacesContext facesContext,
                 UIComponent uiComponent,
                 String forAttr)

convertIdsToClientIds

public static List convertIdsToClientIds(String actionFor,
                         FacesContext facesContext,
                         UIComponent component)

convertPhasesToPhasesIds

public static List convertPhasesToPhasesIds(String actionForPhase)

loadResourceFile

public static String loadResourceFile(FacesContext ctx,
                      String file)

Helper method which loads a resource file (such as css) by a given context path and a file name. Useful to provide css files (or js files) inline.

Parameters:

ctx - FacesContext object to calculate the context path of the web application.

file - name of the resource file (e.g. foo.css).

Returns:

the content of the resource file, or null if no such file is available.

initPartialValidationAndModelUpdate

public static void initPartialValidationAndModelUpdate(UIComponent component,
                                       FacesContext facesContext)

check for partial validation or model update attributes being set and initialize the request-map accordingly. SubForms will work with this information.

isAdfOrTrinidadForm

public static boolean isAdfOrTrinidadForm(UIComponent component)

getResponseStateManager

@Deprecated
public static ResponseStateManager getResponseStateManager(FacesContext facesContext,
                                                      String renderKitId)
                                                    throws FacesException

Deprecated. use FacesContext.getRenderKit() or getRenderKitFactory().getRenderKit( context, renderKitId).getResponseStateManager()

Gets the ResponseStateManager for the renderKit Id provided

Throws:

FacesException

getIconSrc

public static String getIconSrc(FacesContext facesContext,
                UIComponent component,
                String attributeName)

Checks for name/library attributes on component and if they are avaliable, creates Resource and returns it's path suitable for rendering. If component doesn't have name/library gets value for attribute named attributeName returns it processed with CoreRenderer#toResourceUri(FacesContext, Object)

Parameters:

facesContext - a FacesContext

component - a UIComponent

attributeName - name of attribute that represents "image", "icon", "source", ...

Since:

4.0.1

toResourceUri

public static String toResourceUri(FacesContext facesContext,
                   Object o)

Coerces an object into a resource URI, calling the view-handler.