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

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:


Field Summary
static java.lang.String COMPONENT_FAMILY
          The standard component family for this component.
static java.lang.String COMPONENT_TYPE
          The standard component type for this component.
 
Constructor Summary
UISelectItem()
          Create a new UISelectItem instance with default property values.
 
Method Summary
 java.lang.String getFamily()
          Return the identifier of the component family to which this component belongs.
 java.lang.String getItemDescription()
          Return the description for this selection item.
 java.lang.String getItemLabel()
          Return the localized label for this selection item.
 java.lang.Object getItemValue()
          Return the server value for this selection item.
 java.lang.Object getValue()
          Returns the value property of the UISelectItem.
 boolean isItemDisabled()
          Return the disabled setting for this selection item.
 void restoreState(FacesContext context, java.lang.Object state)
           Perform any processing required to restore the state from the entries in the state Object.
 java.lang.Object saveState(FacesContext context)
           Gets the state of the instance as a Serializable Object.
 void setItemDescription(java.lang.String itemDescription)
          Set the description for this selection item.
 void setItemDisabled(boolean itemDisabled)
          Set the disabled value for this selection item.
 void setItemLabel(java.lang.String itemLabel)
          Set the localized label for this selection item.
 void setItemValue(java.lang.Object itemValue)
          Set the server value for this selection item.
 void setValue(java.lang.Object value)
          Sets the value property of the UISelectItem.
 
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, getValueExpression, invokeOnComponent, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, setValueExpression
 
Methods inherited from class javax.faces.component.UIComponent
encodeAll, getContainerClientId
 
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

The standard component type for this component.

See Also:
Constant Field Values

COMPONENT_FAMILY

public static final java.lang.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 java.lang.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 appropriate Renderer for this component instance.

Specified by:
getFamily in class UIComponent

getItemDescription

public java.lang.String getItemDescription()

Return the description for this selection item.


setItemDescription

public void setItemDescription(java.lang.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.


setItemDisabled

public void setItemDisabled(boolean itemDisabled)

Set the disabled value for this selection item.

Parameters:
itemDisabled - The new disabled flag

getItemLabel

public java.lang.String getItemLabel()

Return the localized label for this selection item.


setItemLabel

public void setItemLabel(java.lang.String itemLabel)

Set the localized label for this selection item.

Parameters:
itemLabel - The new localized label

getItemValue

public java.lang.Object getItemValue()

Return the server value for this selection item.


setItemValue

public void setItemValue(java.lang.Object itemValue)

Set the server value for this selection item.

Parameters:
itemValue - The new server value

getValue

public java.lang.Object getValue()

Returns the value property of the UISelectItem.


setValue

public void setValue(java.lang.Object value)

Sets the value property of the UISelectItem.

Parameters:
value - the new value

saveState

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

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

restoreState

public void restoreState(FacesContext context,
                         java.lang.Object state)
Description copied from interface: 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.

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


Copyright 2002-2006 Sun Microsystems, Inc. All Rights Reserved.