Package org.apache.myfaces.tobago.component

Class UISection

  • 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 UISection
extends AbstractUISection
implements javax.faces.component.behavior.ClientBehaviorHolder
    Renders a section or subsection. UIComponent class, generated from template component.stg with class SectionTagDeclaration.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static String COMPONENT_FAMILY  
      static String COMPONENT_TYPE  

      • 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
      UISection()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      CollapseMode getCollapsedMode()
      Enum indicating the mode of the collapsed state of this component.
      CustomClass getCustomClass()
      Sets a CSS class in its parent, if the parent supports it.
      String getFamily()  
      String getImage()
      Url to an image to display.
      String getLabel()
      A localized user presentable label for this component.
      Integer getLevel()
      Level of the title.
      Markup getMarkup()  
      String getTip()
      Text value to display as tooltip.
      boolean isCollapsed()
      Indicating the collapsed state of this component.
      void restoreState​(javax.faces.context.FacesContext context, Object state)  
      void setCollapsed​(boolean collapsed)  
      void setCollapsedMode​(CollapseMode collapsedMode)  
      void setCustomClass​(CustomClass customClass)  
      void setImage​(String image)  
      void setLabel​(String label)  
      void setLevel​(Integer level)  
      void setMarkup​(Markup markup)  
      void setTip​(String tip)  

      • Methods inherited from class javax.faces.component.UIComponentBase

        addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeAll, 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, processRestoreState, processSaveState, 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, getValueExpression, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, setInView, setValueExpression, subscribeToEvent, unsubscribeFromEvent

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

        addClientBehavior, getClientBehaviors, getDefaultEventName, getEventNames

    • Constructor Detail

      • UISection

        public UISection()

    • Method Detail

      • getFamily

        public String getFamily()
        Overrides:
        getFamily in class javax.faces.component.UIPanel

      • setImage

        public void setImage​(String image)

      • getLevel

        public Integer getLevel()
        Level of the title. Lower value means bigger title, greater value means smaller title. Value goes from 1 to 6.
        Specified by:
        getLevel in class AbstractUISection

      • 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

      • setTip

        public void setTip​(String tip)

      • setLabel

        public void setLabel​(String label)

      • setCollapsedMode

        public void setCollapsedMode​(CollapseMode collapsedMode)

      • 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