Class UISelectItem
- java.lang.Object
-
- jakarta.faces.component.UIComponent
-
- jakarta.faces.component.UIComponentBase
-
- jakarta.faces.component.UISelectItem
-
- All Implemented Interfaces:
PartialStateHolder
,StateHolder
,TransientStateHolder
,ComponentSystemEventListener
,FacesListener
,SystemEventListenerHolder
,EventListener
- Direct Known Subclasses:
UISelectItemGroup
public class UISelectItem extends UIComponentBase
UISelectItem is a component that may be nested inside a
UISelectMany
orUISelectOne
component, and causes the addition of aSelectItem
instance to the list of available options for the parent component. The contents of theSelectItem
can be specified in one of the following ways:- The
value
attribute's value is an instance ofSelectItem
. - The associated
ValueExpression
points at a model data item of typeSelectItem
. - A new
SelectItem
instance is synthesized from the values of theitemDescription
,itemDisabled
,itemLabel
,itemEscaped
, anditemValue
attributes.
-
-
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 UISelectItem()
Create a newUISelectItem
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
getItemDescription()
Return the description for this selection item.String
getItemLabel()
Return the localized label for this selection item.Object
getItemValue()
Return the server value for this selection item.Object
getValue()
Returns thevalue
property of theUISelectItem
.boolean
isItemDisabled()
Return the disabled setting for this selection item.boolean
isItemEscaped()
Return the escape setting for the label of this selection item.boolean
isNoSelectionOption()
Return the value of thenoSelectionOption
property.void
setItemDescription(String itemDescription)
Set the description for this selection item.void
setItemDisabled(boolean itemDisabled)
Set the disabled value for this selection item.void
setItemEscaped(boolean itemEscaped)
Set the escape value for the label of this selection item.void
setItemLabel(String itemLabel)
Set the localized label for this selection item.void
setItemValue(Object itemValue)
Set the server value for this selection item.void
setNoSelectionOption(boolean noSelectionOption)
Set the value of thenoSelectionOption
property.void
setValue(Object value)
Sets thevalue
property of theUISelectItem
.-
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
-
UISelectItem
public UISelectItem()
Create a new
UISelectItem
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).
-
getItemDescription
public String getItemDescription()
Return the description for this selection item.
- Returns:
- the item description.
-
setItemDescription
public void setItemDescription(String itemDescription)
Set the description for this selection item.
- Parameters:
itemDescription
- The new description
-
isItemDisabled
public boolean isItemDisabled()
Return the disabled setting for this selection item.
- Returns:
true
is the item disabled,false
otherwise.
-
setItemDisabled
public void setItemDisabled(boolean itemDisabled)
Set the disabled value for this selection item.
- Parameters:
itemDisabled
- The new disabled flag
-
isItemEscaped
public boolean isItemEscaped()
Return the escape setting for the label of this selection item.
- Returns:
true
if the item is escaped,false
otherwise.
-
setItemEscaped
public void setItemEscaped(boolean itemEscaped)
Set the escape value for the label of this selection item.
- Parameters:
itemEscaped
- The new disabled flag
-
getItemLabel
public String getItemLabel()
Return the localized label for this selection item.
- Returns:
- the item label.
-
setItemLabel
public void setItemLabel(String itemLabel)
Set the localized label for this selection item.
- Parameters:
itemLabel
- The new localized label
-
getItemValue
public Object getItemValue()
Return the server value for this selection item.
- Returns:
- the item value.
-
setItemValue
public void setItemValue(Object itemValue)
Set the server value for this selection item.
- Parameters:
itemValue
- The new server value
-
getValue
public Object getValue()
Returns the
value
property of theUISelectItem
.- Returns:
- the value.
-
setValue
public void setValue(Object value)
Sets the
value
property of theUISelectItem
.- Parameters:
value
- the new value
-
isNoSelectionOption
public boolean isNoSelectionOption()
Return the value of the
noSelectionOption
property. If the value of this property istrue
, the system interprets the option represented by thisUISelectItem
instance as representing a "no selection" option. SeeUISelectOne.validateValue(jakarta.faces.context.FacesContext, java.lang.Object)
andUISelectMany.validateValue(jakarta.faces.context.FacesContext, java.lang.Object)
for usage.- Returns:
- the no selection option.
- Since:
- 2.0
-
setNoSelectionOption
public void setNoSelectionOption(boolean noSelectionOption)
Set the value of the
noSelectionOption
property.- Parameters:
noSelectionOption
- the no selection option.- Since:
- 2.0
-
-