Class UITreeSelect

java.lang.Object
javax.faces.component.UIComponent
javax.faces.component.UIComponentBase
javax.faces.component.UIOutput
javax.faces.component.UIInput
javax.faces.component.UISelectBoolean
org.apache.myfaces.tobago.internal.component.AbstractUITreeSelect
org.apache.myfaces.tobago.component.UITreeSelect
All Implemented Interfaces:
EventListener, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.EditableValueHolder, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.ValueHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, 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 final String
     
    static final String
     

    Fields inherited from class javax.faces.component.UIInput

    CONVERSION_MESSAGE_ID, REQUIRED_MESSAGE_ID, UPDATE_MESSAGE_ID, VALIDATE_EMPTY_FIELDS_PARAM_NAME

    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
     
  • Method Summary

    Modifier and Type
    Method
    Description
    Sets a CSS class in its parent, if the parent supports it.
     
     
     
    A localized user presentable label for this component.
     
    Text value to display as tooltip.
    boolean
    Flag indicating that this element is disabled.
    boolean
    Show a checkbox to visualize the selection state.
    void
    restoreState(javax.faces.context.FacesContext context, Object state)
     
    void
     
    void
    setDisabled(boolean disabled)
     
    void
     
    void
    setMarkup(Markup markup)
     
    void
    setShowCheckbox(boolean showCheckbox)
     
    void
     

    Methods inherited from class org.apache.myfaces.tobago.internal.component.AbstractUITreeSelect

    isValueStoredInState, updateModel

    Methods inherited from class javax.faces.component.UISelectBoolean

    getValue, getValueBinding, getValueExpression, isSelected, setSelected, setValueBinding, setValueExpression

    Methods inherited from class javax.faces.component.UIInput

    addValidator, addValueChangeListener, broadcast, clearInitialState, compareValues, decode, getConvertedValue, getConverterMessage, getRequiredMessage, getSubmittedValue, getValidator, getValidatorMessage, getValidators, getValueChangeListener, getValueChangeListeners, isEmpty, isImmediate, isLocalValueSet, isRequired, isValid, markInitialState, processDecodes, processUpdates, processValidators, removeValidator, removeValueChangeListener, resetValue, saveState, setConverterMessage, setImmediate, setLocalValueSet, setRequired, setRequiredMessage, setSubmittedValue, setValid, setValidator, setValidatorMessage, setValue, setValueChangeListener, validate, validateValue

    Methods inherited from class javax.faces.component.UIOutput

    getConverter, getLocalValue, setConverter

    Methods inherited from class javax.faces.component.UIComponentBase

    addClientBehavior, addFacesListener, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, initialStateMarked, invokeOnComponent, isRendered, isTransient, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, visitTree

    Methods inherited from class javax.faces.component.UIComponent

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

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder

    addClientBehavior, getClientBehaviors

    Methods inherited from interface javax.faces.component.ValueHolder

    getConverter, getLocalValue, setConverter

    Methods inherited from interface org.apache.myfaces.tobago.component.Visual

    getRendererType, isPlain
  • Field Details

  • Constructor Details

    • UITreeSelect

      public UITreeSelect()
  • Method Details

    • getEventNames

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

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

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

      public Markup getMarkup()
    • setMarkup

      public void setMarkup(Markup markup)
    • getLabel

      public String getLabel()
      A localized user presentable label for this component.
      Specified by:
      getLabel in class AbstractUITreeSelect
    • 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
    • setDisabled

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