Class UISection

java.lang.Object
javax.faces.component.UIComponent
All Implemented Interfaces:
EventListener, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, SupportsAutoSpacing, 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 final String
     
    static final String
     

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

    Constructors
    Constructor
    Description
     
  • Method Summary

    Modifier and Type
    Method
    Description
    Automatically add spacing (margins/paddings) to the component for better positioning.
    Enum indicating the mode of the collapsed state of this component.
    Sets a CSS class in its parent, if the parent supports it.
     
    Url to an image to display.
    A localized user presentable label for this component.
    Level of the title.
     
    Text value to display as tooltip.
    boolean
    Indicating the collapsed state of this component.
    void
    restoreState(javax.faces.context.FacesContext context, Object state)
     
    void
    setAutoSpacing(Boolean autoSpacing)
     
    void
    setCollapsed(boolean collapsed)
     
    void
     
    void
     
    void
     
    void
     
    void
     
    void
    setMarkup(Markup markup)
     
    void
     

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

    encodeBegin

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

    isNormalLifecycle, processDecodes, processState, processUpdates, processValidators, setSubmittedCollapsed

    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, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, 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, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, 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.SupportsAutoSpacing

    getAutoSpacing

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

    getRendererType, isPlain
  • Field Details

  • Constructor Details

    • UISection

      public UISection()
  • Method Details

    • getFamily

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

      public String getImage()
      Url to an image to display.
      Specified by:
      getImage in class AbstractUISection
    • setImage

      public void setImage(String image)
    • getAutoSpacing

      public Boolean getAutoSpacing()
      Automatically add spacing (margins/paddings) to the component for better positioning. Default is 'true' except the component is inside a: - header - footer - bar - sheet - tree - link group - button group - before facet - after facet - label facet - bar facet
      Specified by:
      getAutoSpacing in interface SupportsAutoSpacing
    • setAutoSpacing

      public void setAutoSpacing(Boolean autoSpacing)
    • getMarkup

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

      public void setMarkup(Markup markup)
      Specified by:
      setMarkup in interface Visual
    • 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
    • setLevel

      public void setLevel(Integer level)
      Specified by:
      setLevel in class AbstractUISection
    • isCollapsed

      public boolean isCollapsed()
      Indicating the collapsed state of this component.
      Default: false
      Specified by:
      isCollapsed in class AbstractUICollapsiblePanel
    • setCollapsed

      public void setCollapsed(boolean collapsed)
      Specified by:
      setCollapsed in class AbstractUICollapsiblePanel
    • 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
    • getTip

      public String getTip()
      Text value to display as tooltip.
      Specified by:
      getTip in class AbstractUIPanelBase
    • setTip

      public void setTip(String tip)
    • getLabel

      public String getLabel()
      A localized user presentable label for this component.
      Specified by:
      getLabel in class AbstractUISection
    • setLabel

      public void setLabel(String label)
    • getCollapsedMode

      public CollapseMode getCollapsedMode()
      Enum indicating the mode of the collapsed state of this component.
      Default: none
      Specified by:
      getCollapsedMode in class AbstractUICollapsiblePanel
    • 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