Class UITree

java.lang.Object
javax.faces.component.UIComponent
javax.faces.component.UIComponentBase
All Implemented Interfaces:
EventListener, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.NamingContainer, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.component.UniqueIdVendor, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, Visual

@Generated("component.stg") public class UITree extends AbstractUITree implements javax.faces.component.behavior.ClientBehaviorHolder
A tree with classical look. Usually used with icons and junction lines to open folder, etc. UIComponent class, generated from template component.stg with class TreeTagDeclaration.
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static String
     
    static String
     

    Fields inherited from class org.apache.myfaces.tobago.internal.component.AbstractUITree

    SUFFIX_PARENT

    Fields inherited from class org.apache.myfaces.tobago.internal.component.AbstractUIData

    SUFFIX_EXPANDED, SUFFIX_MARKED, SUFFIX_SELECTED

    Fields inherited from class javax.faces.component.UIComponent

    ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY

    Fields inherited from interface javax.faces.component.NamingContainer

    SEPARATOR_CHAR
  • Constructor Summary

    Constructors
    Constructor
    Description
     
  • Method Summary

    Modifier and Type
    Method
    Description
    Sets a CSS class in its parent, if the parent supports it.
     
     
    Flag indicating whether or not this component should be render selectable items.
    boolean
    Only applicable in the case that the data model is a tree.
    boolean
    Only applicable in the case that the data model is a tree.
    void
    restoreState​(javax.faces.context.FacesContext context, Object state)
     
    void
    setCustomClass​(CustomClass customClass)
     
    void
    setMarkup​(Markup markup)
     
    void
    setSelectable​(Selectable selectable)
     
    void
    setShowRoot​(boolean showRoot)
     
    void
    setShowRootJunction​(boolean showRootJunction)
     

    Methods inherited from class javax.faces.component.UIData

    broadcast, createUniqueId, encodeEnd, getContainerClientId, getFirst, getFooter, getHeader, getRowCount, getRowData, getRowIndex, getRows, getValue, getVar, isRowAvailable, isRowStatePreserved, markInitialState, queueEvent, setDataModel, setFirst, setFooter, setHeader, setRowIndex, setRows, setRowStatePreserved, setValue, setValueBinding, setValueExpression, setVar

    Methods inherited from class javax.faces.component.UIComponentBase

    addClientBehavior, addFacesListener, clearInitialState, decode, encodeAll, encodeChildren, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getPassThroughAttributes, getRenderer, getRendererType, getValueBinding, isRendered, isTransient, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient

    Methods inherited from class javax.faces.component.UIComponent

    getClientId, getCompositeComponentParent, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, 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, getDefaultEventName, getEventNames

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

    getRendererType, isPlain
  • Field Details

  • Constructor Details

    • UITree

      public UITree()
  • Method Details

    • getFamily

      public String getFamily()
      Overrides:
      getFamily in class javax.faces.component.UIData
    • isShowRoot

      public boolean isShowRoot()
      Only applicable in the case that the data model is a tree. This flag indicates that the root node should be displayed. Often in tree structures the root node is special and should not be displayed.
      Default: false
      Specified by:
      isShowRoot in class AbstractUIData
    • setShowRoot

      public void setShowRoot(boolean showRoot)
    • getMarkup

      public Markup getMarkup()
      Specified by:
      getMarkup in interface Visual
    • setMarkup

      public void setMarkup(Markup markup)
      Specified by:
      setMarkup in interface Visual
    • isShowRootJunction

      public boolean isShowRootJunction()
      Only applicable in the case that the data model is a tree. This flag indicates that the root node should be displayed with an open-close-switch.
      Default: false
      Overrides:
      isShowRootJunction in class AbstractUIData
    • setShowRootJunction

      public void setShowRootJunction(boolean showRootJunction)
    • getSelectable

      public Selectable getSelectable()
      Flag indicating whether or not this component should be render selectable items. Possible values are:
      • none : not selectable
      • multi : a multi section tree is rendered
      • single : a single section tree is rendered
      • multiLeafOnly : a multi section tree is rendered, only leaf's are selectable
      • singleLeafOnly : a single section tree is rendered, only leaf's are selectable

      Default: multi
      Allowed Values: none,multi,single,multiLeafOnly,singleLeafOnly
      Specified by:
      getSelectable in class AbstractUIData
    • setSelectable

      public void setSelectable(Selectable selectable)
    • 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.
      Specified by:
      getCustomClass in interface Visual
    • setCustomClass

      public void setCustomClass(CustomClass customClass)
      Specified by:
      setCustomClass in interface Visual
    • restoreState

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