Class UISplitLayout

All Implemented Interfaces:
EventListener, 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 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 final String
     
    static final String
     

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

    Modifier and Type
    Method
    Description
    This value defines the layout constraints for column layout.
    Spacing between the columns in the actual layout.
    Sets a CSS class in its parent, if the parent supports it.
     
     
    This value defines the layout constraints for row layout.
    Spacing between the rows in the actual layout.
    void
    restoreState(javax.faces.context.FacesContext context, Object state)
     
    void
     
    void
    setColumnSpacing(Measure columnSpacing)
     
    void
     
    void
    setMarkup(Markup markup)
     
    void
     
    void
    setRowSpacing(Measure rowSpacing)
     

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

    getAlignItems

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

    isHorizontal, processEvent

    Methods inherited from class javax.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, getRenderer, getRendererType, getRendersChildren, getValueBinding, initialStateMarked, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, 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, pushComponentToEL, 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 org.apache.myfaces.tobago.component.Visual

    getRendererType, isPlain
  • Field Details

  • Constructor Details

    • UISplitLayout

      public UISplitLayout()
  • Method Details

    • getFamily

      public String getFamily()
      Specified by:
      getFamily in class javax.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 semicolon separated list of layout tokens '<n>*', '<measure>' or the keyword 'auto'. Where <n> is a positive integer or empty and <measure> is a valid CSS length. Example: '2*;*;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 semicolon separated list of layout tokens '<n>*', '<measure>' or the keyword 'auto'. Where <n> is a positive integer or empty and <measure> is a valid CSS length. Example: '2*;*;100px;3rem;auto'.
      Specified by:
      getRows in class AbstractUIFlexLayout
    • setRows

      public void setRows(MeasureList rows)
    • 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