javax.faces.component: public class: UISelectItem

javax.faces.component
public class: UISelectItem [javadoc | source]

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

All Implemented Interfaces:
PartialStateHolder, ComponentSystemEventListener, SystemEventListenerHolder

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 javax.el.ValueExpression points at a model data item of type SelectItem .
A new SelectItem instance is synthesized from the values of the itemDescription, itemDisabled, itemLabel, itemEscaped, and itemValue attributes.

Nested Class Summary:
enum class	UISelectItem.PropertyKeys

Field Summary
public static final String	COMPONENT_TYPE	The standard component type for this component.
public static final String	COMPONENT_FAMILY	The standard component family for this component.

Fields inherited from javax.faces.component.UIComponent:
CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, BEANINFO_KEY, FACETS_KEY, VIEW_LOCATION_KEY, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, attributesThatAreSet, stateHelper, compositeParent, bindings, initialState, listenersByEventClass

Constructor:
public UISelectItem() { super(); setRendererType(null); } Create a new UISelectItem instance with default property values.

Constructor:

 public UISelectItem() {
        super();
        setRendererType(null);
}

Create a new UISelectItem instance with default property values.

Method from javax.faces.component.UISelectItem Summary:
getFamily, getItemDescription, getItemLabel, getItemValue, getValue, isItemDisabled, isItemEscaped, isNoSelectionOption, setItemDescription, setItemDisabled, setItemEscaped, setItemLabel, setItemValue, setNoSelectionOption, setValue

Methods from javax.faces.component.UIComponentBase:
addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getDescriptorMap, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding

Methods from javax.faces.component.UIComponentBase:

addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getDescriptorMap, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding

Methods from javax.faces.component.UIComponent:
addFacesListener, broadcast, clearInitialState, decode, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getFamily, getId, getListenersForEventClass, getNamingContainer, getParent, getRenderer, getRendererType, getRendersChildren, getResourceBundleMap, getStateHelper, getStateHelper, getValueBinding, getValueExpression, initialStateMarked, invokeOnComponent, isCompositeComponent, isInView, isRendered, isVisitable, markInitialState, popComponentFromEL, processDecodes, processEvent, processRestoreState, processSaveState, processUpdates, processValidators, pushComponentToEL, queueEvent, removeFacesListener, setId, setInView, setParent, setRendered, setRendererType, setValueBinding, setValueExpression, subscribeToEvent, unsubscribeFromEvent, visitTree

Methods from javax.faces.component.UIComponent:

addFacesListener, broadcast, clearInitialState, decode, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getFamily, getId, getListenersForEventClass, getNamingContainer, getParent, getRenderer, getRendererType, getRendersChildren, getResourceBundleMap, getStateHelper, getStateHelper, getValueBinding, getValueExpression, initialStateMarked, invokeOnComponent, isCompositeComponent, isInView, isRendered, isVisitable, markInitialState, popComponentFromEL, processDecodes, processEvent, processRestoreState, processSaveState, processUpdates, processValidators, pushComponentToEL, queueEvent, removeFacesListener, setId, setInView, setParent, setRendered, setRendererType, setValueBinding, setValueExpression, subscribeToEvent, unsubscribeFromEvent, visitTree

Methods from java.lang.Object:
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from javax.faces.component.UISelectItem Detail:
public String getFamily() { return (COMPONENT_FAMILY); }
public String getItemDescription() { return (String) getStateHelper().eval(PropertyKeys.itemDescription); } Return the description for this selection item.
public String getItemLabel() { return (String) getStateHelper().eval(PropertyKeys.itemLabel); } Return the localized label for this selection item.
public Object getItemValue() { return getStateHelper().eval(PropertyKeys.itemValue); } Return the server value for this selection item.
public Object getValue() { return getStateHelper().eval(PropertyKeys.value); } Returns the `value` property of the `UISelectItem`.
public boolean isItemDisabled() { return (Boolean) getStateHelper().eval(PropertyKeys.itemDisabled, false); } Return the disabled setting for this selection item.
public boolean isItemEscaped() { return (Boolean) getStateHelper().eval(PropertyKeys.itemEscaped, true); } Return the escape setting for the label of this selection item.
public boolean isNoSelectionOption() { return (Boolean) getStateHelper().eval(PropertyKeys.noSelectionOption, false); } Return the value of the `noSelectionOption` property. If the value of this property is `true`, the system interprets the option represented by this `UISelectItem` instance as representing a "no selection" option. See UISelectOne#validateValue and UISelectMany#validateValue for usage.
public void setItemDescription(String itemDescription) { getStateHelper().put(PropertyKeys.itemDescription, itemDescription); } Set the description for this selection item.
public void setItemDisabled(boolean itemDisabled) { getStateHelper().put(PropertyKeys.itemDisabled, itemDisabled); } Set the disabled value for this selection item.
public void setItemEscaped(boolean itemEscaped) { getStateHelper().put(PropertyKeys.itemEscaped, itemEscaped); } Set the escape value for the label of this selection item.
public void setItemLabel(String itemLabel) { getStateHelper().put(PropertyKeys.itemLabel, itemLabel); } Set the localized label for this selection item.
public void setItemValue(Object itemValue) { getStateHelper().put(PropertyKeys.itemValue, itemValue); } Set the server value for this selection item.
public void setNoSelectionOption(boolean noSelectionOption) { getStateHelper().put(PropertyKeys.noSelectionOption, noSelectionOption); } Set the value of the `noSelectionOption` property.
public void setValue(Object value) { getStateHelper().put(PropertyKeys.value, value); } Sets the `value` property of the `UISelectItem`.

Method from javax.faces.component.UISelectItem Detail:

 public String getFamily() {
        return (COMPONENT_FAMILY);
}

 public String getItemDescription() {
        return (String) getStateHelper().eval(PropertyKeys.itemDescription);
}

Return the description for this selection item.

 public String getItemLabel() {
        return (String) getStateHelper().eval(PropertyKeys.itemLabel);
}

Return the localized label for this selection item.

 public Object getItemValue() {
        return getStateHelper().eval(PropertyKeys.itemValue);
}

Return the server value for this selection item.

 public Object getValue() {
        return getStateHelper().eval(PropertyKeys.value);
}

Returns the value property of the UISelectItem.

 public boolean isItemDisabled() {
        return (Boolean) getStateHelper().eval(PropertyKeys.itemDisabled, false);
}

Return the disabled setting for this selection item.

 public boolean isItemEscaped() {
        return (Boolean) getStateHelper().eval(PropertyKeys.itemEscaped, true);
}

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

 public boolean isNoSelectionOption() {
        return (Boolean) getStateHelper().eval(PropertyKeys.noSelectionOption, false);
}

Return the value of the noSelectionOption property. If the value of this property is true, the system interprets the option represented by this UISelectItem instance as representing a "no selection" option. See UISelectOne#validateValue and UISelectMany#validateValue for usage.

 public  void setItemDescription(String itemDescription) {
        getStateHelper().put(PropertyKeys.itemDescription, itemDescription);
}

Set the description for this selection item.

 public  void setItemDisabled(boolean itemDisabled) {
        getStateHelper().put(PropertyKeys.itemDisabled, itemDisabled);
}

Set the disabled value for this selection item.

 public  void setItemEscaped(boolean itemEscaped) {
        getStateHelper().put(PropertyKeys.itemEscaped, itemEscaped);
}

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

 public  void setItemLabel(String itemLabel) {
        getStateHelper().put(PropertyKeys.itemLabel, itemLabel);
}

Set the localized label for this selection item.

 public  void setItemValue(Object itemValue) {
        getStateHelper().put(PropertyKeys.itemValue, itemValue);
}

Set the server value for this selection item.

 public  void setNoSelectionOption(boolean noSelectionOption) {
        getStateHelper().put(PropertyKeys.noSelectionOption, noSelectionOption);
}

Set the value of the noSelectionOption property.

 public  void setValue(Object value) {
        getStateHelper().put(PropertyKeys.value,  value);
}

Sets the value property of the UISelectItem.