javax.faces.component
Class UISelectItem

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by javax.faces.component.UISelectItem
All Implemented Interfaces:
StateHolder

public class UISelectItem
extends UIComponentBase

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

Version:
$Revision: 482726 $ $Date: 2006-12-05 19:02:43 +0100 (Di, 05 Dez 2006) $
Author:
Manfred Geiler (latest modification by $Author: grantsmith $)

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 javax.faces.component.UIComponentBase
addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE
See Also:
Constant Field Values

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY
See Also:
Constant Field Values
Constructor Detail

UISelectItem

public UISelectItem()
Method Detail

getFamily

public java.lang.String getFamily()
Specified by:
getFamily in class UIComponent

setItemDescription

public void setItemDescription(java.lang.String itemDescription)

getItemDescription

public java.lang.String getItemDescription()
For use in development tools.

Q: what use is an EL expression for this???


setItemDisabled

public void setItemDisabled(boolean itemDisabled)
When true, this item cannot be chosen by the user. If this method is ever called, then any EL-binding for the disabled property will be ignored.


isItemDisabled

public boolean isItemDisabled()
Determine whether this item can be chosen by the user.


setItemLabel

public void setItemLabel(java.lang.String itemLabel)

getItemLabel

public java.lang.String getItemLabel()
Get the string which will be presented to the user for this option.


setItemValue

public void setItemValue(java.lang.Object itemValue)

getItemValue

public java.lang.Object getItemValue()

setValue

public void setValue(java.lang.Object value)

getValue

public java.lang.Object getValue()

saveState

public java.lang.Object saveState(FacesContext context)
Description copied from class: UIComponentBase
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.

Specified by:
saveState in interface StateHolder
Overrides:
saveState in class UIComponentBase

restoreState

public void restoreState(FacesContext context,
                         java.lang.Object state)
Description copied from class: UIComponentBase
Invoked in the "restore view" phase, this initialises this object's members from the values saved previously into the provided state object.

Specified by:
restoreState in interface StateHolder
Overrides:
restoreState in class UIComponentBase
state - is an object previously returned by the saveState method of this class.


Copyright © 2009. All Rights Reserved.