Class UITreeSelect

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

    @Generated("component.stg")
    public class UITreeSelect
    extends AbstractUITreeSelect
    Makes a tree node selectable. UIComponent class, generated from template component.stg with class TreeSelectTagDeclaration.
    • Field Summary

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

        ALWAYS_PERFORM_VALIDATION_WHEN_REQUIRED_IS_TRUE, CONVERSION_MESSAGE_ID, EMPTY_STRING_AS_NULL_PARAM_NAME, REQUIRED_MESSAGE_ID, UPDATE_MESSAGE_ID, VALIDATE_EMPTY_FIELDS_PARAM_NAME
      • 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
      UITreeSelect()  
    • 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 getDefaultEventName()  
      Collection<String> getEventNames()  
      String getFamily()  
      String getLabel()
      A localized user presentable label for this component.
      Markup getMarkup()  
      String getTip()
      Text value to display as tooltip.
      boolean isDisabled()
      Flag indicating that this element is disabled.
      boolean isShowCheckbox()
      Show a checkbox to visualize the selection state.
      void restoreState​(jakarta.faces.context.FacesContext context, Object state)  
      void setCustomClass​(CustomClass customClass)  
      void setDisabled​(boolean disabled)  
      void setLabel​(String label)  
      void setMarkup​(Markup markup)  
      void setShowCheckbox​(boolean showCheckbox)  
      void setTip​(String tip)  
      • Methods inherited from class jakarta.faces.component.UISelectBoolean

        getValue, getValueExpression, isSelected, setSelected, setValueExpression
      • Methods inherited from class jakarta.faces.component.UIInput

        addValidator, addValueChangeListener, broadcast, clearInitialState, compareValues, decode, getConvertedValue, getConverterMessage, getRequiredMessage, getSubmittedValue, getValidatorMessage, getValidators, getValueChangeListeners, isEmpty, isImmediate, isLocalValueSet, isRequired, isValid, markInitialState, processDecodes, processUpdates, processValidators, removeValidator, removeValueChangeListener, resetValue, saveState, setConverterMessage, setImmediate, setLocalValueSet, setRequired, setRequiredMessage, setSubmittedValue, setValid, setValidatorMessage, setValue, validate, validateValue
      • Methods inherited from class jakarta.faces.component.UIOutput

        getConverter, getLocalValue, setConverter
      • Methods inherited from class jakarta.faces.component.UIComponentBase

        addClientBehavior, addFacesListener, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, invokeOnComponent, isRendered, isTransient, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, 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, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, subscribeToEvent, unsubscribeFromEvent
      • Methods inherited from interface jakarta.faces.component.behavior.ClientBehaviorHolder

        addClientBehavior, getClientBehaviors
      • Methods inherited from interface jakarta.faces.component.ValueHolder

        getConverter, getLocalValue, setConverter
    • Constructor Detail

      • UITreeSelect

        public UITreeSelect()
    • Method Detail

      • getEventNames

        public Collection<String> getEventNames()
        Specified by:
        getEventNames in interface jakarta.faces.component.behavior.ClientBehaviorHolder
        Overrides:
        getEventNames in class jakarta.faces.component.UIComponentBase
      • getDefaultEventName

        public String getDefaultEventName()
        Specified by:
        getDefaultEventName in interface jakarta.faces.component.behavior.ClientBehaviorHolder
        Overrides:
        getDefaultEventName in class jakarta.faces.component.UIComponentBase
      • getFamily

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

        public Markup getMarkup()
      • setMarkup

        public void setMarkup​(Markup markup)
      • setLabel

        public void setLabel​(String label)
      • isShowCheckbox

        public boolean isShowCheckbox()
        Show a checkbox to visualize the selection state. This is useful to hide the checkbox, e. g. dependent of the type of the node.
        Default: true
        Specified by:
        isShowCheckbox in class AbstractUITreeSelect
      • setShowCheckbox

        public void setShowCheckbox​(boolean showCheckbox)
      • 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)
      • isDisabled

        public boolean isDisabled()
        Flag indicating that this element is disabled.
        Default: false
        Specified by:
        isDisabled in class AbstractUITreeSelect
      • setDisabled

        public void setDisabled​(boolean disabled)
      • 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.UIInput