Class UIParameter
- java.lang.Object
-
- jakarta.faces.component.UIComponent
-
- jakarta.faces.component.UIComponentBase
-
- jakarta.faces.component.UIParameter
-
- All Implemented Interfaces:
PartialStateHolder
,StateHolder
,TransientStateHolder
,ComponentSystemEventListener
,FacesListener
,SystemEventListenerHolder
,EventListener
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 (viasetValue()
), 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 nestedUIParameter
child components should document their use of this property.
-
-
Field Summary
Fields Modifier and Type Field Description static String
COMPONENT_FAMILY
The standard component family for this component.static String
COMPONENT_TYPE
The standard component type for this component.-
Fields inherited from class jakarta.faces.component.UIComponent
ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, FACETS_KEY, VIEW_LOCATION_KEY
-
-
Constructor Summary
Constructors Constructor Description UIParameter()
Create a newUIParameter
instance with default property values.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getFamily()
Return the identifier of the component family to which this component belongs.String
getName()
Return the optional parameter name for this parameter.Object
getValue()
Returns thevalue
property of theUIParameter
.boolean
isDisable()
Return the value of thedisable
directive for this component.void
setDisable(boolean disable)
Sets thedisable
property of theUIParameter
.void
setName(String name)
Set the optional parameter name for this parameter.void
setValue(Object value)
Sets thevalue
property of the\UIParameter
.-
Methods inherited from class jakarta.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, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, subscribeToEvent, unsubscribeFromEvent
-
Methods inherited from class jakarta.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 Detail
-
COMPONENT_TYPE
public static final String COMPONENT_TYPE
The standard component type for this component.
- See Also:
- Constant Field Values
-
COMPONENT_FAMILY
public static final String COMPONENT_FAMILY
The standard component family for this component.
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
UIParameter
public UIParameter()
Create a new
UIParameter
instance with default property values.
-
-
Method Detail
-
getFamily
public String 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. Note this method should NOT returnnull
- Specified by:
getFamily
in classUIComponent
- Returns:
- the component family (not null).
-
getName
public String getName()
Return the optional parameter name for this parameter.
- Returns:
- the name.
-
setName
public void setName(String name)
Set the optional parameter name for this parameter.
- Parameters:
name
- The new parameter name, ornull
for no name
-
getValue
public Object getValue()
Returns the
value
property of theUIParameter
.- Returns:
- the value.
-
setValue
public void setValue(Object value)
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.- Returns:
true
if disabled,false
otherwise.- Since:
- 2.0
-
setDisable
public void setDisable(boolean disable)
Sets the
disable
property of theUIParameter
.- Parameters:
disable
- the value for the disable flag.- Since:
- 2.0
-
-