Class UITreeIcon

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

@Generated("component.stg") public class UITreeIcon extends AbstractUITreeIcon implements javax.faces.component.behavior.ClientBehaviorHolder
Renders an image beside a tree node. UIComponent class, generated from template component.stg with class TreeIconTagDeclaration.
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
     
    static final String
     

    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
    Alternate textual description of the image rendered by this component.
    Name of the folder icon, if not set "value" will be used.
    Sets a CSS class in its parent, if the parent supports it.
     
     
    Name of the open folder icon, if not set "closed" will be used.
    Text value to display as tooltip.
    boolean
    Flag indicating that this element is disabled.
    void
    restoreState(javax.faces.context.FacesContext context, Object state)
     
    void
     
    void
    setClosed(String closed)
     
    void
     
    void
    setDisabled(boolean disabled)
     
    void
    setMarkup(Markup markup)
     
    void
     
    void
     

    Methods inherited from class javax.faces.component.UIGraphic

    getUrl, getValue, getValueExpression, setUrl, setValue, setValueExpression

    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, getFacesContext, 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, setRendered, setRendererType, setTransient, setValueBinding, 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, getDefaultEventName, getEventNames

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

    getRendererType, isPlain
  • Field Details

  • Constructor Details

    • UITreeIcon

      public UITreeIcon()
  • Method Details

    • getFamily

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

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

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

      public String getAlt()
      Alternate textual description of the image rendered by this component.
      Specified by:
      getAlt in class AbstractUIImage
    • setAlt

      public void setAlt(String alt)
    • 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
    • getClosed

      public String getClosed()
      Name of the folder icon, if not set "value" will be used.
      Specified by:
      getClosed in class AbstractUITreeIcon
    • setClosed

      public void setClosed(String closed)
    • 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 AbstractUIImage
    • setDisabled

      public void setDisabled(boolean disabled)
    • getOpen

      public String getOpen()
      Name of the open folder icon, if not set "closed" will be used.
      Specified by:
      getOpen in class AbstractUITreeIcon
    • setOpen

      public void setOpen(String open)
    • 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