org.apache.myfaces.renderkit

Class RendererUtils

java.lang.Object

org.apache.myfaces.renderkit.RendererUtils

public class RendererUtils
extends java.lang.Object

Version:

$Revision: 267196 $ $Date: 2005-09-02 14:49:18 +0200 (Fri, 02 Sep 2005) $

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	EMPTY_STRING
static java.lang.Object	NOTHING
static java.lang.String	SELECT_ITEM_LIST_ATTR

Constructor Summary

Constructors

Constructor and Description
RendererUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static void	checkParamValidity(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent uiComponent, java.lang.Class compClass)
static void	copyHtmlInputTextAttributes(javax.faces.component.html.HtmlInputText src, javax.faces.component.html.HtmlInputText dest)
static javax.faces.component.UIForm	findParentForm(javax.faces.component.UIComponentBase comp)
static javax.faces.convert.Converter	findUIOutputConverter(javax.faces.context.FacesContext facesContext, javax.faces.component.UIOutput component) Find the proper Converter for the given UIOutput component.
static javax.faces.convert.Converter	findUISelectManyConverter(javax.faces.context.FacesContext facesContext, javax.faces.component.UISelectMany component) Find proper Converter for the entries in the associated List or Array of the given UISelectMany as specified in API Doc of UISelectMany.
static boolean	getBooleanAttribute(javax.faces.component.UIComponent component, java.lang.String attrName, boolean defaultValue)
static java.lang.Boolean	getBooleanValue(javax.faces.component.UIComponent component)
static java.lang.String	getConcatenatedId(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component)
static java.lang.String	getConcatenatedId(javax.faces.context.FacesContext context, javax.faces.component.UIComponent container, java.lang.String clientId)
static java.lang.String	getConvertedStringValue(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, javax.faces.convert.Converter converter, java.lang.Object value) Convenient utility method that returns the currently given value as String, using the given converter.
static java.lang.String	getConvertedStringValue(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, javax.faces.convert.Converter converter, javax.faces.model.SelectItem selectItem) Convenient utility method that returns the currently given SelectItem value as String, using the given converter.
static java.lang.Object	getConvertedUIOutputValue(javax.faces.context.FacesContext facesContext, javax.faces.component.UIOutput output, java.lang.Object submittedValue)
static java.lang.Object	getConvertedUISelectManyValue(javax.faces.context.FacesContext facesContext, javax.faces.component.UISelectMany selectMany, java.lang.Object submittedValue)
static java.util.Date	getDateValue(javax.faces.component.UIComponent component)
static int	getIntegerAttribute(javax.faces.component.UIComponent component, java.lang.String attrName, int defaultValue)
static java.lang.Object	getObjectValue(javax.faces.component.UIComponent component)
static java.lang.String	getPathToComponent(javax.faces.component.UIComponent component)
static java.util.Set	getSelectedValuesAsSet(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, javax.faces.convert.Converter converter, javax.faces.component.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 java.util.List	getSelectItemList(javax.faces.component.UISelectMany uiSelectMany)
static java.util.List	getSelectItemList(javax.faces.component.UISelectOne uiSelectOne)
static java.lang.String	getStringValue(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent component)
static java.util.Set	getSubmittedValuesAsSet(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, javax.faces.convert.Converter converter, javax.faces.component.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 boolean	isDefaultAttributeValue(java.lang.Object value) See JSF Spec. 8.5 Table 8-1
static void	renderChild(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent child)
static void	renderChildren(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent component)

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 java.lang.String SELECT_ITEM_LIST_ATTR

EMPTY_STRING

public static final java.lang.String EMPTY_STRING

NOTHING

public static final java.lang.Object NOTHING

Constructor Detail

RendererUtils

public RendererUtils()

Method Detail

getPathToComponent

public static java.lang.String getPathToComponent(javax.faces.component.UIComponent component)

getConcatenatedId

public static java.lang.String getConcatenatedId(javax.faces.context.FacesContext context,
                                 javax.faces.component.UIComponent container,
                                 java.lang.String clientId)

getConcatenatedId

public static java.lang.String getConcatenatedId(javax.faces.context.FacesContext context,
                                 javax.faces.component.UIComponent component)

getBooleanValue

public static java.lang.Boolean getBooleanValue(javax.faces.component.UIComponent component)

getDateValue

public static java.util.Date getDateValue(javax.faces.component.UIComponent component)

getObjectValue

public static java.lang.Object getObjectValue(javax.faces.component.UIComponent component)

getStringValue

public static java.lang.String getStringValue(javax.faces.context.FacesContext facesContext,
                              javax.faces.component.UIComponent component)

isDefaultAttributeValue

public static boolean isDefaultAttributeValue(java.lang.Object value)

See JSF Spec. 8.5 Table 8-1

Parameters:

value -

Returns:

boolean

findUIOutputConverter

public static javax.faces.convert.Converter findUIOutputConverter(javax.faces.context.FacesContext facesContext,
                                                  javax.faces.component.UIOutput component)
                                                           throws javax.faces.FacesException

Find the proper Converter for the given UIOutput component.

Returns:

the Converter or null if no Converter specified or needed

Throws:

javax.faces.FacesException - if the Converter could not be created

findUISelectManyConverter

public static javax.faces.convert.Converter findUISelectManyConverter(javax.faces.context.FacesContext facesContext,
                                                      javax.faces.component.UISelectMany component)

Find proper Converter for the entries in the associated List or Array of the given UISelectMany as specified in API Doc of UISelectMany.

Returns:

the Converter or null if no Converter specified or needed

Throws:

javax.faces.FacesException - if the Converter could not be created

checkParamValidity

public static void checkParamValidity(javax.faces.context.FacesContext facesContext,
                      javax.faces.component.UIComponent uiComponent,
                      java.lang.Class compClass)

renderChildren

public static void renderChildren(javax.faces.context.FacesContext facesContext,
                  javax.faces.component.UIComponent component)
                           throws java.io.IOException

Throws:

java.io.IOException

renderChild

public static void renderChild(javax.faces.context.FacesContext facesContext,
               javax.faces.component.UIComponent child)
                        throws java.io.IOException

Throws:

java.io.IOException

getSelectItemList

public static java.util.List getSelectItemList(javax.faces.component.UISelectOne uiSelectOne)

Parameters:

uiSelectOne -

Returns:

List of SelectItem Objects

getSelectItemList

public static java.util.List getSelectItemList(javax.faces.component.UISelectMany uiSelectMany)

Parameters:

uiSelectMany -

Returns:

List of SelectItem Objects

getSubmittedValuesAsSet

public static java.util.Set getSubmittedValuesAsSet(javax.faces.context.FacesContext context,
                                    javax.faces.component.UIComponent component,
                                    javax.faces.convert.Converter converter,
                                    javax.faces.component.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 java.util.Set getSelectedValuesAsSet(javax.faces.context.FacesContext context,
                                   javax.faces.component.UIComponent component,
                                   javax.faces.convert.Converter converter,
                                   javax.faces.component.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 java.lang.String getConvertedStringValue(javax.faces.context.FacesContext context,
                                       javax.faces.component.UIComponent component,
                                       javax.faces.convert.Converter converter,
                                       java.lang.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 java.lang.String getConvertedStringValue(javax.faces.context.FacesContext context,
                                       javax.faces.component.UIComponent component,
                                       javax.faces.convert.Converter converter,
                                       javax.faces.model.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.

getConvertedUIOutputValue

public static java.lang.Object getConvertedUIOutputValue(javax.faces.context.FacesContext facesContext,
                                         javax.faces.component.UIOutput output,
                                         java.lang.Object submittedValue)
                                                  throws javax.faces.convert.ConverterException

Throws:

javax.faces.convert.ConverterException

getConvertedUISelectManyValue

public static java.lang.Object getConvertedUISelectManyValue(javax.faces.context.FacesContext facesContext,
                                             javax.faces.component.UISelectMany selectMany,
                                             java.lang.Object submittedValue)
                                                      throws javax.faces.convert.ConverterException

Throws:

javax.faces.convert.ConverterException

getBooleanAttribute

public static boolean getBooleanAttribute(javax.faces.component.UIComponent component,
                          java.lang.String attrName,
                          boolean defaultValue)

getIntegerAttribute

public static int getIntegerAttribute(javax.faces.component.UIComponent component,
                      java.lang.String attrName,
                      int defaultValue)

findParentForm

public static javax.faces.component.UIForm findParentForm(javax.faces.component.UIComponentBase comp)

copyHtmlInputTextAttributes

public static void copyHtmlInputTextAttributes(javax.faces.component.html.HtmlInputText src,
                               javax.faces.component.html.HtmlInputText dest)