Class UIGridLayout
- 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
-
- 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
WARNING: This component is preliminary and may be changed without a major release.
Renders a GridLayout.columns/rows ::= LAYOUT LAYOUT ::= TOKEN [";" TOKEN]+ TOKEN ::= AUTO | PIXEL | PROPORTIONAL AUTO ::= "auto" | "fixed" PIXEL ::= NUMBER "px" PROPORTIONAL ::= [NUMBER] "*"
GridLayout Parent Child Okay? Remarks AUTO any combination of AUTO or PIXEL but no PROPORTIONAL okay - AUTO any combination with at least one PROPORTIONAL wrong Layout manager 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 - component.stg
with classGridLayoutTagDeclaration
.
-
-
Field Summary
Fields Modifier and Type Field Description static String
COMPONENT_FAMILY
static String
COMPONENT_TYPE
-
Fields inherited from class org.apache.myfaces.tobago.internal.component.AbstractUIGridLayout
SPAN
-
-
Constructor Summary
Constructors Constructor Description UIGridLayout()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
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()
String
getRows()
This value defines the layout constraints for row layout.Measure
getRowSpacing()
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
setCustomClass(CustomClass customClass)
void
setMarkup(Markup markup)
void
setRows(String rows)
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 Detail
-
COMPONENT_TYPE
public static final String COMPONENT_TYPE
-
COMPONENT_FAMILY
public static final String COMPONENT_FAMILY
- See Also:
- Constant Field Values
-
-
Method Detail
-
getFamily
public String getFamily()
- Specified by:
getFamily
in classjavax.faces.component.UIComponent
-
getColumnSpacing
public Measure getColumnSpacing()
Spacing between the columns in the actual layout.
-
setColumnSpacing
public void setColumnSpacing(Measure columnSpacing)
-
getColumns
public String getColumns()
This value defines the layout constraints for column layout. It is a space 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'.
Default:1*
- Specified by:
getColumns
in classAbstractUIGridLayout
-
setColumns
public void setColumns(String columns)
- Specified by:
setColumns
in classAbstractUIGridLayout
-
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 interfaceVisual
-
setCustomClass
public void setCustomClass(CustomClass customClass)
- Specified by:
setCustomClass
in interfaceVisual
-
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>*', '<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'.
Default:1*
- Specified by:
getRows
in classAbstractUIGridLayout
-
setRows
public void setRows(String rows)
- Specified by:
setRows
in classAbstractUIGridLayout
-
restoreState
public void restoreState(javax.faces.context.FacesContext context, Object state)
- Specified by:
restoreState
in interfacejavax.faces.component.StateHolder
- Overrides:
restoreState
in classjavax.faces.component.UIComponentBase
-
-