Class UISelectItem

  • All Implemented Interfaces:
    jakarta.faces.component.PartialStateHolder, jakarta.faces.component.StateHolder, jakarta.faces.component.TransientStateHolder, jakarta.faces.event.ComponentSystemEventListener, jakarta.faces.event.FacesListener, jakarta.faces.event.SystemEventListenerHolder, EventListener, Visual

    @Generated("component.stg")
    public class UISelectItem
    extends AbstractUISelectItem
    Add a child UISelectItem component to the UIComponent associated with the closed parent UIComponent custom action. UIComponent class, generated from template component.stg with class SelectItemTagDeclaration.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static String COMPONENT_FAMILY  
      static String COMPONENT_TYPE  
      • Fields inherited from class jakarta.faces.component.UIComponent

        ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, FACETS_KEY, VIEW_LOCATION_KEY
    • Constructor Summary

      Constructors 
      Constructor Description
      UISelectItem()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      CustomClass getCustomClass()
      Sets a CSS class in its parent, if the parent supports it.
      String getFamily()  
      String getItemImage()
      Image to be displayed to the user for this option.
      Markup getMarkup()  
      String getTip()
      Text value to display as tooltip.
      void restoreState​(jakarta.faces.context.FacesContext context, Object state)  
      void setCustomClass​(CustomClass customClass)  
      void setItemImage​(String itemImage)  
      void setMarkup​(Markup markup)  
      void setTip​(String tip)  
      • Methods inherited from class jakarta.faces.component.UISelectItem

        getFacesContext, getItemDescription, getItemLabel, getValue, isItemDisabled, isItemEscaped, isNoSelectionOption, setItemDescription, setItemDisabled, setItemEscaped, setItemLabel, setNoSelectionOption, setValue
      • Methods inherited from class jakarta.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, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, visitTree
      • Methods inherited from class jakarta.faces.component.UIComponent

        getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, subscribeToEvent, unsubscribeFromEvent
    • Constructor Detail

      • UISelectItem

        public UISelectItem()
    • Method Detail

      • getFamily

        public String getFamily()
        Overrides:
        getFamily in class jakarta.faces.component.UISelectItem
      • getMarkup

        public Markup getMarkup()
      • setMarkup

        public void setMarkup​(Markup markup)
      • getCustomClass

        public CustomClass getCustomClass()
        Sets a CSS class in its parent, if the parent supports it. Which this feature it is possible to put a CSS class name into a component with the <tc:style> tag. Example:
           <tc:in>
             <tc:style customClass="my-emphasized"/>
           </tc:in>
           
        One capability is, to used external CSS libs.
        This feature should not be used imprudent. Because it might be unstable against changes in the renderered HTML code.
      • setCustomClass

        public void setCustomClass​(CustomClass customClass)
      • getTip

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

        public void setTip​(String tip)
      • getItemImage

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

        public void setItemImage​(String itemImage)
      • restoreState

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