javax.faces.component
Class UIParameter

java.lang.Object
  javax.faces.component.UIComponentBase
      javax.faces.component.UIOutput
          javax.faces.component.UIParameter

All Implemented Interfaces:

java.io.Serializable, UIComponent

public class UIParameter

extends UIOutput

UIParameter is a UIComponent that represents an optionally named configuration parameter for a parent component.

Parent components should retrieve the value of a parameter by calling currentValue(). In this way, the parameter value can be set directly on the component (via setValue()), or retrieved indirectly via the model reference expression.

In some scenarios, it is necessary to provide a parameter name, in addition to the parameter value that is accessible via the currentValue() method. Renderers that support parameter names on their nested UIParameter child components should document their use of this property.

See Also:

Serialized Form

Field Summary

Fields inherited from interface javax.faces.component.UIComponent

SEPARATOR_CHAR

Constructor Summary

UIParameter()
Create a new UIParameter instance with default property values.

Method Summary

java.lang.String	getName() Return the optional parameter name for this parameter.
boolean	getRendersSelf() Return true to indicate that no Renderer needs to be associated with this component.
void	setName(java.lang.String name) Set the optional parameter name for this parameter.

Methods inherited from class javax.faces.component.UIOutput

currentValue, getValue, getValueRef, setValue, setValueRef

Methods inherited from class javax.faces.component.UIComponentBase

addChild, addChild, addFacet, addValidator, broadcast, clearChildren, clearFacets, clearValidators, containsChild, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttribute, getAttributeNames, getChild, getChildCount, getChildren, getClientId, getComponentId, getConverter, getFacet, getFacetNames, getFacetsAndChildren, getParent, getRendererType, getRendersChildren, getValidators, isRendered, isValid, processDecodes, processReconstitutes, processUpdates, processValidators, reconstitute, removeChild, removeChild, removeFacet, removeValidator, setAttribute, setComponentId, setConverter, setParent, setRendered, setRendererType, setValid, updateModel, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

UIParameter

public UIParameter()

Create a new UIParameter instance with default property values.

Method Detail

getName

public java.lang.String getName()

Return the optional parameter name for this parameter.

setName

public void setName(java.lang.String name)

Set the optional parameter name for this parameter.

Parameters:

name - The new parameter name, or null for no name

getRendersSelf

public boolean getRendersSelf()

Return true to indicate that no Renderer needs to be associated with this component.

Specified by:

getRendersSelf in interface UIComponent

Overrides:

getRendersSelf in class UIComponentBase