public class UIParameter extends UIComponentBase
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 getValue(). In this way, the
parameter value can be set directly on the component (via setValue()), or retrieved indirectly via the
value binding expression.
In some scenarios, it is necessary to provide a parameter name, in addition to the parameter value that is accessible
via the getValue() method. Renderers that support parameter names on their
nested UIParameter child components should document their use of this property.
| Modifier and Type | Field and Description |
|---|---|
static java.lang.String |
COMPONENT_FAMILY
The standard component family for this component.
|
static java.lang.String |
COMPONENT_TYPE
The standard component type for this component.
|
ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY| Constructor and Description |
|---|
UIParameter()
Create a new
UIParameter instance with default property values. |
| Modifier and Type | Method and Description |
|---|---|
java.lang.String |
getFamily()
Return the identifier of the component family to which this component belongs. |
java.lang.String |
getName()
Return the optional parameter name for this parameter.
|
java.lang.Object |
getValue()
Returns the
value property of the UIParameter. |
boolean |
isDisable()
Return the value of the |
void |
setDisable(boolean disable)
Sets the
disable property of the UIParameter. |
void |
setName(java.lang.String name)
Set the optional parameter name for this parameter.
|
void |
setValue(java.lang.Object value)
Sets the
value property of the\ UIParameter. |
addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEventencodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, visitTreepublic static final java.lang.String COMPONENT_TYPE
The standard component type for this component.
public static final java.lang.String COMPONENT_FAMILY
The standard component family for this component.
public UIParameter()
Create a new UIParameter instance with default property values.
public java.lang.String getFamily()
UIComponent
Return the identifier of the component family to which this component belongs. This identifier, in conjunction with
the value of the rendererType property, may be used to select the appropriate Renderer for this
component instance. Note this method should NOT return null
getFamily in class UIComponentpublic java.lang.String getName()
Return the optional parameter name for this parameter.
public void setName(java.lang.String name)
Set the optional parameter name for this parameter.
name - The new parameter name, or null for no namepublic java.lang.Object getValue()
Returns the value property of the UIParameter.
public void setValue(java.lang.Object value)
Sets the value property of the\ UIParameter.
value - the new valuepublic boolean isDisable()
Return the value of the disable directive for this component. This directive determines whether the
parameter value should be disabled by assigning it a null value. If true, the value set on this
component is ignored.
true if disabled, false otherwise.public void setDisable(boolean disable)
Sets the disable property of the UIParameter.
disable - the value for the disable flag.