Class UIFlexLayout

  • 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 UIFlexLayout
    extends AbstractUIFlexLayout
    implements jakarta.faces.component.behavior.ClientBehaviorHolder
    Renders a <a href=https://www.w3.org/TR/css-flexbox-1/>Flexible Box Layout</a>. UIComponent class, generated from template component.stg with class FlexLayoutTagDeclaration.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static String COMPONENT_FAMILY  
      static String COMPONENT_TYPE  
      • 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
      UIFlexLayout()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      AlignItems getAlignItems()
      This value defines CSS align-items value of the flex layout.
      MeasureList getColumns()
      This value defines the layout constraints for column layout.
      CustomClass getCustomClass()
      Sets a CSS class in its parent, if the parent supports it.
      String getFamily()  
      JustifyContent getJustifyContent()
      This value defines CSS justify-content value of the flex layout.
      Markup getMarkup()  
      MeasureList getRows()
      This value defines the layout constraints for row layout.
      void restoreState​(jakarta.faces.context.FacesContext context, Object state)  
      void setAlignItems​(AlignItems alignItems)  
      void setColumns​(MeasureList columns)  
      void setCustomClass​(CustomClass customClass)  
      void setJustifyContent​(JustifyContent justifyContent)  
      void setMarkup​(Markup markup)  
      void setRows​(MeasureList rows)  
      • 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, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, 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, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, subscribeToEvent, unsubscribeFromEvent
      • Methods inherited from interface jakarta.faces.component.behavior.ClientBehaviorHolder

        addClientBehavior, getClientBehaviors, getDefaultEventName, getEventNames
    • Constructor Detail

      • UIFlexLayout

        public UIFlexLayout()
    • Method Detail

      • getFamily

        public String getFamily()
        Specified by:
        getFamily in class jakarta.faces.component.UIComponent
      • getAlignItems

        public AlignItems getAlignItems()
        This value defines CSS align-items value of the flex layout.
        Allowed Values: flexStart,flexEnd,baseline,center,stretch
        Specified by:
        getAlignItems in class AbstractUIFlexLayout
      • setAlignItems

        public void setAlignItems​(AlignItems alignItems)
      • getColumns

        public MeasureList getColumns()
        This value defines the layout constraints for column layout. It is a space separated list of layout tokens '<n>fr', '<measure>' or the keyword 'auto'. Where <n> is a positive integer and <measure> is a valid CSS length. Example: '2fr 1fr 100px 3rem auto'.
        Specified by:
        getColumns in class AbstractUIFlexLayout
      • setColumns

        public void setColumns​(MeasureList columns)
      • 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
      • getRows

        public MeasureList getRows()
        This value defines the layout constraints for row layout. It is a space separated list of layout tokens '<n>fr', '<measure>' or the keyword 'auto'. Where <n> is a positive integer and <measure> is a valid CSS length. Example: '2fr 1fr 100px 3rem auto'.
        Specified by:
        getRows in class AbstractUIFlexLayout
      • getJustifyContent

        public JustifyContent getJustifyContent()
        This value defines CSS justify-content value of the flex layout.
        Allowed Values: flexStart,flexEnd,center,spaceBetween,spaceAround
        Specified by:
        getJustifyContent in class AbstractUIFlexLayout
      • setJustifyContent

        public void setJustifyContent​(JustifyContent justifyContent)
      • 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