Package org.apache.myfaces.tobago.component

Class UISelectItems

  • All Implemented Interfaces:
    EventListener, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder
    @Generated("component.stg")
public class UISelectItems
extends AbstractUISelectItems
    Add a child UISelectItems component to the UIComponent associated with the closed parent UIComponent custom action. UIComponent class, generated from template component.stg with class SelectItemsTagDeclaration.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static String COMPONENT_FAMILY  
      static String COMPONENT_TYPE  

      • 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

      Constructors 
      Constructor Description
      UISelectItems()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      String getFamily()  
      String getItemImage()
      Image to be displayed to the user for this option.
      String getItemLabel()
      Label to be displayed to the user for this option.
      Object getItemValue()
      Value to be returned to the server if this option is selected by the user.
      String getTip()
      Text value to display as tooltip.
      String getVar()
      Name of a variable under which the iterated data will be exposed.
      boolean isItemDisabled()
      Flag indicating whether the option created by this component is disabled.
      void restoreState​(javax.faces.context.FacesContext context, Object state)  
      void setItemDisabled​(boolean itemDisabled)  
      void setItemImage​(String itemImage)  
      void setItemLabel​(String itemLabel)  
      void setItemValue​(Object itemValue)  
      void setTip​(String tip)  
      void setVar​(String var)  

      • Methods inherited from class javax.faces.component.UISelectItems

        getFacesContext, getValue, setRendered, setValue

      • Methods inherited from class javax.faces.component.UIComponentBase

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

      • Methods inherited from class javax.faces.component.UIComponent

        getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getValueExpression, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, setInView, setValueExpression, subscribeToEvent, unsubscribeFromEvent

    • Constructor Detail

      • UISelectItems

        public UISelectItems()

    • Method Detail

      • getFamily

        public String getFamily()
        Overrides:
        getFamily in class javax.faces.component.UISelectItems

      • isItemDisabled

        public boolean isItemDisabled()
        Flag indicating whether the option created by this component is disabled.
        Default: false

      • setItemDisabled

        public void setItemDisabled​(boolean itemDisabled)

      • getVar

        public String getVar()
        Name of a variable under which the iterated data will be exposed. It may be referred to in EL of other attributes.

      • setVar

        public void setVar​(String var)

      • getItemValue

        public Object getItemValue()
        Value to be returned to the server if this option is selected by the user.

      • setItemValue

        public void setItemValue​(Object itemValue)

      • getTip

        public String getTip()
        Text value to display as tooltip.

      • setTip

        public void setTip​(String tip)

      • getItemLabel

        public String getItemLabel()
        Label to be displayed to the user for this option.

      • setItemLabel

        public void setItemLabel​(String itemLabel)

      • getItemImage

        public String getItemImage()
        Image to be displayed to the user for this option.

      • setItemImage

        public void setItemImage​(String itemImage)

      • restoreState

        public void restoreState​(javax.faces.context.FacesContext context,
                         Object state)
        Specified by:
        restoreState in interface javax.faces.component.StateHolder
        Overrides:
        restoreState in class javax.faces.component.UIComponentBase