UISelectItem (Java EE 5 SDK) - Java Platform, Enterprise Edition v5.0 API Specifications

Overview

Package

Class

Tree

Deprecated

Index

Help

Java EE 5 SDK

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.faces.component
Class UISelectItem

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UISelectItem

All Implemented Interfaces:: StateHolder

public class UISelectItem
extends UIComponentBase
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:

The value attribute's value is an instance of SelectItem.
The associated ValueExpression points at a model data item of type SelectItem.
A new SelectItem instance is synthesized from the values of the itemDescription, itemDisabled, itemLabel, and itemValue attributes.

Field Summary

static String COMPONENT_FAMILY
          The standard component family for this component.

static String COMPONENT_TYPE
          The standard component type for this component.

Fields inherited from class javax.faces.component.UIComponent

bindings

Constructor Summary

UISelectItem()
          Create a new UISelectItem instance with default property values.

Method Summary

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.

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 Summary
`static String`	`COMPONENT_FAMILY` The standard component family for this component.
`static String`	`COMPONENT_TYPE` The standard component type for this component.

Fields inherited from class javax.faces.component.UIComponent
`bindings`

Constructor Summary
`UISelectItem()` Create a new `UISelectItem` instance with default property values.

Method Summary
`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`.

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 String COMPONENT_TYPE

The standard component type for this component.

See Also:: Constant Field Values

COMPONENT_FAMILY

public static final 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 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 String getItemDescription()

Return the description for this selection item.

setItemDescription

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

isItemEscaped

public boolean isItemEscaped()

Return the escape setting for the label of this selection item.

setItemEscaped

public void setItemEscaped(boolean itemEscaped)

Set the escape value for the label of this selection item.

Parameters:: itemEscaped - The new disabled flag

getItemLabel

public String getItemLabel()

Return the localized label for this selection item.

setItemLabel

public void setItemLabel(String itemLabel)

Set the localized label for this selection item.

Parameters:: itemLabel - The new localized label

getItemValue

public Object getItemValue()

Return the server value for this selection item.

setItemValue

public void setItemValue(Object itemValue)

Set the server value for this selection item.

Parameters:: itemValue - The new server value

getValue

public Object getValue()

Returns the value property of the UISelectItem.

setValue

public void setValue(Object value)

Sets the value property of the UISelectItem.

Parameters:: value - the new value

saveState

public 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,
                         Object state)