Class UIOffcanvas

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

@Generated("component.stg") public class UIOffcanvas extends AbstractUIOffcanvas implements jakarta.faces.component.behavior.ClientBehaviorHolder
Offcanvas component for hidden content that slides into the page. UIComponent class, generated from template component.stg with class OffcanvasTagDeclaration.
  • Field Summary

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

    Fields inherited from class jakarta.faces.component.UIComponent

    ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, FACETS_KEY, VIEW_LOCATION_KEY
  • Constructor Summary

    Constructors
    Constructor
    Description
     
  • Method Summary

    Modifier and Type
    Method
    Description
    Enum indicating the mode of the collapsed state of this component.
    Sets a CSS class in its parent, if the parent supports it.
     
     
    Defines the placement of the offcanvas.
    Text value to display as tooltip.
    boolean
    Indicating the collapsed state of this component.
    void
    restoreState(jakarta.faces.context.FacesContext context, Object state)
     
    void
    setCollapsed(boolean collapsed)
     
    void
     
    void
     
    void
    setMarkup(Markup markup)
     
    void
     
    void
     

    Methods inherited from class jakarta.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, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, invokeOnComponent, isRendered, isTransient, markInitialState, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, visitTree

    Methods inherited from class jakarta.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 jakarta.faces.component.behavior.ClientBehaviorHolder

    addClientBehavior, getClientBehaviors, getDefaultEventName, getEventNames

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

    getRendererType, isPlain
  • Field Details

  • Constructor Details

    • UIOffcanvas

      public UIOffcanvas()
  • Method Details

    • getFamily

      public String getFamily()
      Overrides:
      getFamily in class jakarta.faces.component.UIPanel
    • getMarkup

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

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

      public boolean isCollapsed()
      Indicating the collapsed state of this component.
      Default: true
      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)
    • getPlacement

      public OffcanvasPlacement getPlacement()
      Defines the placement of the offcanvas. Default is "left".
      Default: left
      Allowed Values: top,left,right,bottom
      Specified by:
      getPlacement in class AbstractUIOffcanvas
    • setPlacement

      public void setPlacement(OffcanvasPlacement placement)
    • getCollapsedMode

      public CollapseMode getCollapsedMode()
      Enum indicating the mode of the collapsed state of this component.
      Default: absent
      Specified by:
      getCollapsedMode in class AbstractUICollapsiblePanel
    • setCollapsedMode

      public void setCollapsedMode(CollapseMode collapsedMode)
    • restoreState

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