org.apache.myfaces.custom.selectitems
Class AbstractUISelectItems

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by javax.faces.component.UISelectItems
              extended by org.apache.myfaces.custom.selectitems.AbstractUISelectItems
All Implemented Interfaces:
java.util.EventListener, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder
Direct Known Subclasses:
UISelectItems

public abstract class AbstractUISelectItems
extends javax.faces.component.UISelectItems

An extended version of the standard UISelectItems. Populates the SelectItem collection from the given value automatically using the itemLabel and itemValue attributes. By using the component there is no need to manually create a SelectItem collection because component automatically populates SelectItem objects from types like Collection, Map and etc..

Since:
1.1.7
Version:
$Revision: 891039 $ $Date: 2009-12-15 17:29:01 -0500 (Tue, 15 Dec 2009) $
Author:
cagatay (latest modification by $Author: lu4242 $)

Field Summary
static java.lang.String COMPONENT_TYPE
           
 
Fields inherited from class javax.faces.component.UISelectItems
COMPONENT_FAMILY
 
Fields inherited from class javax.faces.component.UIComponent
BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, VIEW_LOCATION_KEY
 
Constructor Summary
AbstractUISelectItems()
           
 
Method Summary
abstract  java.lang.Object getItemDescription()
          name of the selectitem
abstract  java.lang.Object getItemDisabled()
          disabled state of the selectitem
abstract  java.lang.Object getItemLabel()
          name of the selectitem
abstract  java.lang.Object getItemLabelEscaped()
          indicate if the label should be escaped of the selectitem
abstract  java.lang.Object getItemValue()
          value of the selectitem
 java.lang.Object getValue()
           
abstract  java.lang.String getVar()
          name of the iterator
abstract  boolean isUseEntryAsItem()
          Only applies when value points to a map.
 
Methods inherited from class javax.faces.component.UISelectItems
getFamily, setRendered, setValue
 
Methods inherited from class javax.faces.component.UIComponentBase
addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, initialStateMarked, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendererType, setTransient, setValueBinding, visitTree
 
Methods inherited from class javax.faces.component.UIComponent
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getValueExpression, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, setInView, setValueExpression, subscribeToEvent, unsubscribeFromEvent
 
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
Constructor Detail

AbstractUISelectItems

public AbstractUISelectItems()
Method Detail

getVar

public abstract java.lang.String getVar()
name of the iterator


getItemLabel

public abstract java.lang.Object getItemLabel()
name of the selectitem


getItemValue

public abstract java.lang.Object getItemValue()
value of the selectitem


getItemLabelEscaped

public abstract java.lang.Object getItemLabelEscaped()
indicate if the label should be escaped of the selectitem

Since:
1.1.9

getItemDescription

public abstract java.lang.Object getItemDescription()
name of the selectitem

Since:
1.1.9

getItemDisabled

public abstract java.lang.Object getItemDisabled()
disabled state of the selectitem

Since:
1.1.9

isUseEntryAsItem

public abstract boolean isUseEntryAsItem()
Only applies when value points to a map. Use the Entry instance instead the value for resolve EL Expressions

Since:
1.1.10

getValue

public java.lang.Object getValue()
Overrides:
getValue in class javax.faces.component.UISelectItems


Copyright © 2011 The Apache Software Foundation. All Rights Reserved.