|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.faces.component.UIComponent
javax.faces.component.UIComponentBase
javax.faces.component.UISelectItem
public class UISelectItem
A component representing a single option that the user can choose.
The option attributes can either be defined directly on this component (via the itemValue, itemLabel, itemDescription properties) or the value property can reference a SelectItem object (directly or via an EL expression).
The value expression (if defined) is read-only; the parent select component will have a value attribute specifying where the value for the chosen selection will be stored. See Javadoc of JSF Specification
Field Summary | |
---|---|
static java.lang.String |
COMPONENT_FAMILY
|
static java.lang.String |
COMPONENT_TYPE
|
Constructor Summary | |
---|---|
UISelectItem()
|
Method Summary | |
---|---|
java.lang.String |
getFamily()
|
java.lang.String |
getItemDescription()
For use in development tools. |
java.lang.String |
getItemLabel()
Get the string which will be presented to the user for this option. |
java.lang.Object |
getItemValue()
|
java.lang.Object |
getValue()
|
boolean |
isItemDisabled()
Determine whether this item can be chosen by the user. |
void |
restoreState(FacesContext context,
java.lang.Object state)
Invoked in the "restore view" phase, this initialises this object's members from the values saved previously into the provided state object. |
java.lang.Object |
saveState(FacesContext context)
Invoked after the render phase has completed, this method returns an object which can be passed to the restoreState of some other instance of UIComponentBase to reset that object's state to the same values as this object currently has. |
void |
setItemDescription(java.lang.String itemDescription)
|
void |
setItemDisabled(boolean itemDisabled)
When true, this item cannot be chosen by the user. |
void |
setItemLabel(java.lang.String itemLabel)
|
void |
setItemValue(java.lang.Object itemValue)
|
void |
setValue(java.lang.Object value)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String COMPONENT_TYPE
public static final java.lang.String COMPONENT_FAMILY
Constructor Detail |
---|
public UISelectItem()
Method Detail |
---|
public java.lang.String getFamily()
getFamily
in class UIComponent
public void setItemDescription(java.lang.String itemDescription)
public java.lang.String getItemDescription()
Q: what use is an EL expression for this???
public void setItemDisabled(boolean itemDisabled)
public boolean isItemDisabled()
public void setItemLabel(java.lang.String itemLabel)
public java.lang.String getItemLabel()
public void setItemValue(java.lang.Object itemValue)
public java.lang.Object getItemValue()
public void setValue(java.lang.Object value)
public java.lang.Object getValue()
public java.lang.Object saveState(FacesContext context)
UIComponentBase
saveState
in interface StateHolder
saveState
in class UIComponentBase
public void restoreState(FacesContext context, java.lang.Object state)
UIComponentBase
restoreState
in interface StateHolder
restoreState
in class UIComponentBase
state
- is an object previously returned by
the saveState method of this class.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |