Class UIGridLayout

java.lang.Object
javax.faces.component.UIComponent
javax.faces.component.UIComponentBase
All Implemented Interfaces:
EventListener, javax.faces.component.behavior.ClientBehaviorHolder, 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 UIGridLayout extends AbstractUIGridLayout implements javax.faces.component.behavior.ClientBehaviorHolder
Renders a grid-layout. The grid is defined by the columns and rows attributes. You can adjust the widths of the columns and rows by value of the tokens. The number of tokens describe the number of columns and rows.
  columns/rows ::= LAYOUT
  LAYOUT       ::= TOKEN [" " TOKEN]+
  TOKEN        ::= "auto" | MEASURE | FRACTION
  MEASURE      ::= [NUMBER] ("px" | "em" | "ex" | "rem" | ...)
  FRACTION     ::= [POSITIVE_INTEGER] "fr"
  
UIComponent class, generated from template component.stg with class GridLayoutTagDeclaration.
  • Field Summary

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

    Fields inherited from class org.apache.myfaces.tobago.internal.component.AbstractUIGridLayout

    SPAN

    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
    setColumns(String columns)
     
    void
    setColumnSpacing(Measure columnSpacing)
     
    void
     
    void
    setMarkup(Markup markup)
     
    void
     
    void
    setRowSpacing(Measure rowSpacing)
     

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

    expand, expand, layout, 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 javax.faces.component.behavior.ClientBehaviorHolder

    addClientBehavior, getClientBehaviors, getDefaultEventName, getEventNames

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

    getRendererType, isPlain
  • Field Details

  • Constructor Details

    • UIGridLayout

      public UIGridLayout()
  • 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()
      Specified by:
      getMarkup in interface Visual
    • setMarkup

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

      public String 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'.

      Deprecated: The old syntax for "2fr" is "2*". The old name for "auto" is "fixed".


      Default: 1fr
      Specified by:
      getColumns in class AbstractUIGridLayout
    • setColumns

      public void setColumns(String columns)
      Specified by:
      setColumns in class AbstractUIGridLayout
    • 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
    • getRowSpacing

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

      public void setRowSpacing(Measure rowSpacing)
    • getRows

      public String 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'.

      Deprecated: The old syntax for "2fr" is "2*". The old name for "auto" is "fixed".


      Default: 1fr
      Specified by:
      getRows in class AbstractUIGridLayout
    • setRows

      public void setRows(String rows)
      Specified by:
      setRows in class AbstractUIGridLayout
    • 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