public class

UIGridLayout

extends AbstractUIGridLayout
implements SupportsMarkup
java.lang.Object
   ↳ javax.faces.component.UIComponent
     ↳ javax.faces.component.UIComponentBase
       ↳ org.apache.myfaces.tobago.internal.component.AbstractUILayoutBase
         ↳ org.apache.myfaces.tobago.internal.component.AbstractUIGridLayout
           ↳ org.apache.myfaces.tobago.component.UIGridLayout

Class Overview

Renders a GridLayout.

  columns/rows ::= LAYOUT
  LAYOUT       ::= TOKEN [";" TOKEN]+
  TOKEN        ::= AUTO | PIXEL | PROPORTIONAL
  AUTO         ::= "auto" | "fixed"
  PIXEL        ::= NUMBER "px"
  PROPORTIONAL ::= [NUMBER] "*"
  

Parent Child Okay? Remarks
AUTO any combination of AUTO or PIXEL but no PROPORTIONAL okay -
AUTO any combination with at least one PROPORTIONAL wrong LayoutManager cannot compute the auto value.
PIXEL any combination of AUTO or PIXEL but no PROPORTIONAL potentially wrong The values depend on each other, the programmer has to keep consistency manually.
PIXEL any combination with at least one PROPORTIONAL okay -
PROPORTIONAL any combination of AUTO or PIXEL but no PROPORTIONAL potentially wrong No automatic matching:
  • too little space: scroll bar
  • too much space: elements will be spread.
PROPORTIONAL any combination with at least one PROPORTIONAL okay -
UIComponent class, generated from template component1.2.stg with class org.apache.myfaces.tobago.internal.taglib.component.GridLayoutTagDeclaration.

Summary

Constants
String COMPONENT_FAMILY
String COMPONENT_TYPE
[Expand]
Inherited Fields
From class javax.faces.component.UIComponent
Public Constructors
UIGridLayout()
Public Methods
String getBorder()
Border size of this component.
Measure getCellspacing()
Spacing between component and layout cell's.
Measure getColumnSpacing()
Spacing between the columns in the actual layout.
String getColumns()
This value defines the layout constraints for column layout.
Markup getCurrentMarkup()
String getFamily()
Measure getMargin()
Margin between container component and the children.
Measure getMarginBottom()
Bottom margin between container component and the children.
Measure getMarginLeft()
Left margin between container component and the children.
Measure getMarginRight()
Right margin between container component and the children.
Measure getMarginTop()
Top margin between container component and the children.
Markup getMarkup()
Measure getRowSpacing()
Spacing between the rows in the actual layout.
String getRows()
This value defines the layout constraints for column layout.
boolean isColumnOverflow()
This attribute is a hint for the layout manager.
boolean isRowOverflow()
This attribute is a hint for the layout manager.
void restoreState(FacesContext context, Object componentState)
Object saveState(FacesContext context)
void setBorder(String border)
void setCellspacing(Measure cellspacing)
void setColumnOverflow(boolean columnOverflow)
void setColumnSpacing(Measure columnSpacing)
void setColumns(String columns)
void setCurrentMarkup(Markup currentMarkup)
void setMargin(Measure margin)
void setMarginBottom(Measure marginBottom)
void setMarginLeft(Measure marginLeft)
void setMarginRight(Measure marginRight)
void setMarginTop(Measure marginTop)
void setMarkup(Markup markup)
void setRowOverflow(boolean rowOverflow)
void setRowSpacing(Measure rowSpacing)
void setRows(String rows)
[Expand]
Inherited Methods
From class org.apache.myfaces.tobago.internal.component.AbstractUIGridLayout
From class org.apache.myfaces.tobago.internal.component.AbstractUILayoutBase
From class javax.faces.component.UIComponentBase
From class javax.faces.component.UIComponent
From class java.lang.Object
From interface javax.faces.component.StateHolder
From interface org.apache.myfaces.tobago.component.SupportsMarkup
From interface org.apache.myfaces.tobago.config.Configurable
From interface org.apache.myfaces.tobago.layout.LayoutManager

Constants

public static final String COMPONENT_FAMILY

Constant Value: "org.apache.myfaces.tobago.GridLayout"

public static final String COMPONENT_TYPE

Constant Value: "org.apache.myfaces.tobago.GridLayout"

Public Constructors

public UIGridLayout ()

Public Methods

public String getBorder ()

Border size of this component.

public Measure getCellspacing ()

Spacing between component and layout cell's. Can be overwritten by columnSpacing and rowSpacing.@deprecated

public Measure getColumnSpacing ()

Spacing between the columns in the actual layout.

public String getColumns ()

This value defines the layout constraints for column layout. It is a semicolon separated list of layout tokens '[<n>]*', '<n>px' or 'auto'. Where <n> is a non negative integer and the square brackets means optional. Example: '2*;*;100px;auto'.
Default: 1*

public Markup getCurrentMarkup ()

public String getFamily ()

public Measure getMargin ()

Margin between container component and the children.

public Measure getMarginBottom ()

Bottom margin between container component and the children.

public Measure getMarginLeft ()

Left margin between container component and the children.

public Measure getMarginRight ()

Right margin between container component and the children.

public Measure getMarginTop ()

Top margin between container component and the children.

public Markup getMarkup ()

public Measure getRowSpacing ()

Spacing between the rows in the actual layout.

public String getRows ()

This value defines the layout constraints for column layout. It is a semicolon separated list of layout tokens '[<n>]*', '<n>px' or 'auto'. Where <n> is a non negative integer and the square brackets means optional. Example: '2*;*;100px;auto'.
Default: 1*

public boolean isColumnOverflow ()

This attribute is a hint for the layout manager. Should not be used in most cases.

public boolean isRowOverflow ()

This attribute is a hint for the layout manager. Should not be used in most cases.

public void restoreState (FacesContext context, Object componentState)

public Object saveState (FacesContext context)

public void setBorder (String border)

public void setCellspacing (Measure cellspacing)

public void setColumnOverflow (boolean columnOverflow)

public void setColumnSpacing (Measure columnSpacing)

public void setColumns (String columns)

public void setCurrentMarkup (Markup currentMarkup)

public void setMargin (Measure margin)

public void setMarginBottom (Measure marginBottom)

public void setMarginLeft (Measure marginLeft)

public void setMarginRight (Measure marginRight)

public void setMarginTop (Measure marginTop)

public void setMarkup (Markup markup)

public void setRowOverflow (boolean rowOverflow)

public void setRowSpacing (Measure rowSpacing)

public void setRows (String rows)