Class UISplitLayout

  • All Implemented Interfaces:
    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 UISplitLayout
    extends AbstractUISplitLayout

    WARNING: This component is preliminary and may be changed without a major release.

    Renders a SplitLayout. A area with two child components rendered horizontally or vertically and allows to change the layout relation of this two components on the client. UIComponent class, generated from template component.stg with class SplitLayoutTagDeclaration.
    • 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
      UISplitLayout()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      MeasureList getColumns()
      This value defines the layout constraints for column layout.
      Measure getColumnSpacing()
      Spacing between the columns in the actual layout.
      CustomClass getCustomClass()
      Sets a CSS class in its parent, if the parent supports it.
      String getFamily()  
      Markup getMarkup()  
      MeasureList getRows()
      This value defines the layout constraints for row layout.
      Measure getRowSpacing()
      Spacing between the rows in the actual layout.
      void restoreState​(jakarta.faces.context.FacesContext context, Object state)  
      void setColumns​(MeasureList columns)  
      void setColumnSpacing​(Measure columnSpacing)  
      void setCustomClass​(CustomClass customClass)  
      void setMarkup​(Markup markup)  
      void setRows​(MeasureList rows)  
      void setRowSpacing​(Measure rowSpacing)  
      • 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
    • Constructor Detail

      • UISplitLayout

        public UISplitLayout()
    • Method Detail

      • getFamily

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

        public Measure getColumnSpacing()
        Spacing between the columns in the actual layout.
      • setColumnSpacing

        public void setColumnSpacing​(Measure columnSpacing)
      • getMarkup

        public Markup getMarkup()
      • setMarkup

        public void setMarkup​(Markup markup)
      • 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.
      • setCustomClass

        public void setCustomClass​(CustomClass customClass)
      • getRowSpacing

        public Measure getRowSpacing()
        Spacing between the rows in the actual layout.
      • setRowSpacing

        public void setRowSpacing​(Measure rowSpacing)
      • 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
      • 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