public class UISelectItem extends UIComponentBase
UISelectItem is a component that may be nested
inside a UISelectMany
or UISelectOne
component, and
causes the addition of a SelectItem
instance to the list of
available options for the parent component. The contents of the
SelectItem
can be specified in one of the following ways:
value
attribute's value is an instance of
SelectItem
.ValueExpression
points at a model data
item of type SelectItem
.SelectItem
instance is synthesized from the values
of the itemDescription
, itemDisabled
,
itemLabel
, and itemValue
attributes.Modifier and Type | Field and Description |
---|---|
static String |
COMPONENT_FAMILY
The standard component family for this component.
|
static String |
COMPONENT_TYPE
The standard component type for this component.
|
bindings
Constructor and Description |
---|
UISelectItem()
Create a new
UISelectItem instance with default property
values. |
Modifier and Type | Method and 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 the
value property of the
UISelectItem . |
boolean |
isItemDisabled()
Return the disabled setting for this selection item.
|
boolean |
isItemEscaped()
Return the escape setting for the label of this selection item.
|
void |
restoreState(FacesContext context,
Object state)
Perform any processing required to restore the state from the
entries in the state Object.
|
Object |
saveState(FacesContext context)
Gets the state of the instance as a
Serializable Object. |
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 |
setValue(Object value)
Sets the
value property of the
UISelectItem . |
addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding
encodeAll, getContainerClientId, getValueExpression, setValueExpression
public static final String COMPONENT_TYPE
The standard component type for this component.
public static final String COMPONENT_FAMILY
The standard component family for this component.
public UISelectItem()
Create a new UISelectItem
instance with default property
values.
public 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.
getFamily
in class UIComponent
public String getItemDescription()
Return the description for this selection item.
public void setItemDescription(String itemDescription)
Set the description for this selection item.
itemDescription
- The new descriptionpublic boolean isItemDisabled()
Return the disabled setting for this selection item.
public void setItemDisabled(boolean itemDisabled)
Set the disabled value for this selection item.
itemDisabled
- The new disabled flagpublic boolean isItemEscaped()
Return the escape setting for the label of this selection item.
public void setItemEscaped(boolean itemEscaped)
Set the escape value for the label of this selection item.
itemEscaped
- The new disabled flagpublic String getItemLabel()
Return the localized label for this selection item.
public void setItemLabel(String itemLabel)
Set the localized label for this selection item.
itemLabel
- The new localized labelpublic Object getItemValue()
Return the server value for this selection item.
public void setItemValue(Object itemValue)
Set the server value for this selection item.
itemValue
- The new server valuepublic Object getValue()
Returns the value
property of the
UISelectItem
.
public void setValue(Object value)
Sets the value
property of the
UISelectItem
.
value
- the new valuepublic Object saveState(FacesContext context)
StateHolder
Gets the state of the instance as a
Serializable
Object.
If the class that implements this interface has references to
instances that implement StateHolder (such as a
UIComponent
with event handlers, validators, etc.)
this method must call the StateHolder.saveState(javax.faces.context.FacesContext)
method on all those
instances as well. This method must not save the state
of children and facets. That is done via the StateManager
This method must not alter the state of the implementing object. In other words, after executing this code:
Object state = component.saveState(facesContext);
component
should be the same as before executing
it.
The return from this method must be Serializable
saveState
in interface StateHolder
saveState
in class UIComponentBase
public void restoreState(FacesContext context, Object state)
StateHolder
Perform any processing required to restore the state from the entries in the state Object.
If the class that implements this interface has references to
instances that also implement StateHolder (such as a
UIComponent
with event handlers, validators, etc.)
this method must call the StateHolder.restoreState(javax.faces.context.FacesContext, java.lang.Object)
method on all those
instances as well.
restoreState
in interface StateHolder
restoreState
in class UIComponentBase
Copyright © 2018 JBoss by Red Hat. All rights reserved.