Class UIParameter
- All Implemented Interfaces:
EventListener
,PartialStateHolder
,StateHolder
,TransientStateHolder
,ComponentSystemEventListener
,FacesListener
,SystemEventListenerHolder
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.
Renderer
s that support parameter names on their
nested UIParameter
child components should document
their use of this property.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The standard component family for this component.static final String
The standard component type for this component.Fields inherited from class javax.faces.component.UIComponent
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 Summary
-
Method Summary
Modifier and TypeMethodDescriptionReturn the identifier of the component family to which this component belongs.getName()
Return the optional parameter name for this parameter.getValue()
Returns thevalue
property of theUIParameter
.boolean
Return the value of thedisable
directive for this component.void
setDisable
(boolean disable) Sets thedisable
property of theUIParameter
.void
Set the optional parameter name for this parameter.void
Sets thevalue
property of the\UIParameter
.Methods inherited from class javax.faces.component.UIComponentBase
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, unsubscribeFromEvent
Methods inherited from class javax.faces.component.UIComponent
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, visitTree
-
Field Details
-
COMPONENT_TYPE
The standard component type for this component.
- See Also:
-
COMPONENT_FAMILY
The standard component family for this component.
- See Also:
-
-
Constructor Details
-
UIParameter
public UIParameter()Create a new
UIParameter
instance with default property values.
-
-
Method Details
-
getFamily
Description copied from class: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 appropriateRenderer
for this component instance.- Specified by:
getFamily
in classUIComponent
-
getName
Return the optional parameter name for this parameter.
-
setName
Set the optional parameter name for this parameter.
- Parameters:
name
- The new parameter name, ornull
for no name
-
getValue
Returns the
value
property of theUIParameter
. -
setValue
Sets the
value
property of the\UIParameter
.- Parameters:
value
- the new value
-
isDisable
public 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, thevalue
set on this component is ignored.- Since:
- 2.0
-
setDisable
public void setDisable(boolean disable) Sets the
disable
property of theUIParameter
.- Parameters:
disable
-- Since:
- 2.0
-