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


Field Summary
static java.lang.String COMPONENT_FAMILY
           
static java.lang.String COMPONENT_TYPE
           
 
Fields inherited from class javax.faces.component.UIComponent
bindings
 
Constructor Summary
UISelectItem()
          Construct an instance of the UISelectItem.
 
Method Summary
 java.lang.String getFamily()
           
 java.lang.String getItemDescription()
          Gets For use in development tools.
 java.lang.String getItemLabel()
          Gets The string which will be presented to the user for this option.
 java.lang.Object getItemValue()
          Gets The value for this Item.
 java.lang.Object getValue()
          Gets The initial value of this component.
 boolean isItemDisabled()
          Gets Determine whether this item can be chosen by the user.
 boolean isItemEscaped()
          Gets The escape setting for the label of this selection item.
 void restoreState(FacesContext facesContext, 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 facesContext)
          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)
          Sets For use in development tools.
 void setItemDisabled(boolean itemDisabled)
          Sets Determine whether this item can be chosen by the user.
 void setItemEscaped(boolean itemEscaped)
          Sets The escape setting for the label of this selection item.
 void setItemLabel(java.lang.String itemLabel)
          Sets The string which will be presented to the user for this option.
 void setItemValue(java.lang.Object itemValue)
          Sets The value for this Item.
 void setValue(java.lang.Object value)
          Sets The initial value of this component.
 
Methods inherited from class javax.faces.component.UIComponentBase
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
 
Methods inherited from class javax.faces.component.UIComponent
encodeAll, getContainerClientId, getValueExpression, setValueExpression
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

COMPONENT_FAMILY

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

COMPONENT_TYPE

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

UISelectItem

public UISelectItem()
Construct an instance of the UISelectItem.

Method Detail

getValue

public java.lang.Object getValue()
Gets The initial value of this component.

Returns:
the new value value

setValue

public void setValue(java.lang.Object value)
Sets The initial value of this component.

Parameters:
value - the new value value

isItemDisabled

public boolean isItemDisabled()
Gets Determine whether this item can be chosen by the user. 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.

Returns:
the new itemDisabled value

setItemDisabled

public void setItemDisabled(boolean itemDisabled)
Sets Determine whether this item can be chosen by the user. 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.

Parameters:
itemDisabled - the new itemDisabled value

isItemEscaped

public boolean isItemEscaped()
Gets The escape setting for the label of this selection item.

Returns:
the new itemEscaped value

setItemEscaped

public void setItemEscaped(boolean itemEscaped)
Sets The escape setting for the label of this selection item.

Parameters:
itemEscaped - the new itemEscaped value

getItemDescription

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

Returns:
the new itemDescription value

setItemDescription

public void setItemDescription(java.lang.String itemDescription)
Sets For use in development tools.

Parameters:
itemDescription - the new itemDescription value

getItemLabel

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

Returns:
the new itemLabel value

setItemLabel

public void setItemLabel(java.lang.String itemLabel)
Sets The string which will be presented to the user for this option.

Parameters:
itemLabel - the new itemLabel value

getItemValue

public java.lang.Object getItemValue()
Gets The value for this Item.

Returns:
the new itemValue value

setItemValue

public void setItemValue(java.lang.Object itemValue)
Sets The value for this Item.

Parameters:
itemValue - the new itemValue value

saveState

public java.lang.Object saveState(FacesContext facesContext)
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 facesContext,
                         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.

getFamily

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


Copyright © 2009 Apache Software Foundation. All Rights Reserved.