org.apache.myfaces.tobago.component

Class UIFlexLayout

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

org.apache.myfaces.tobago.internal.component.AbstractUILayoutBase

org.apache.myfaces.tobago.internal.component.AbstractUIFlexLayout

org.apache.myfaces.tobago.component.UIFlexLayout

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

public class UIFlexLayout
extends AbstractUIFlexLayout
implements Visual

Renders a flex layout (CSS3 feature). UIComponent class, generated from template component.stg with class FlexLayoutTagDeclaration.

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPONENT_FAMILY
static String	COMPONENT_TYPE

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 and Description
UIFlexLayout()

Method Summary

Modifier and Type	Method and Description
AlignItems	getAlignItems() This value defines CSS align-items value of the flex layout.
String	getColumns() This value defines the layout constraints for column layout.
CustomClass	getCustomClass() Sets a CSS class in its parent, if the parent supports it.
String	getFamily()
JustifyContent	getJustifyContent() This value defines CSS justify-content value of the flex layout.
Markup	getMarkup()
String	getRows() This value defines the layout constraints for row layout.
Style	getStyle() For internal use.
void	setAlignItems(AlignItems alignItems)
void	setColumns(String columns)
void	setCustomClass(CustomClass customClass)
void	setJustifyContent(JustifyContent justifyContent)
void	setMarkup(Markup markup)
void	setRows(String rows)
void	setStyle(Style style)

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, restoreState, 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, processEvent, 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

Field Detail

COMPONENT_TYPE

public static final String COMPONENT_TYPE

See Also:

Constant Field Values

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY

See Also:

Constant Field Values

Constructor Detail

UIFlexLayout

public UIFlexLayout()

Method Detail

getFamily

public String getFamily()

Specified by:

getFamily in class javax.faces.component.UIComponent

getMarkup

public Markup getMarkup()

Specified by:

getMarkup in interface Visual

setMarkup

public void setMarkup(Markup markup)

Specified by:

setMarkup in interface Visual

getAlignItems

public AlignItems getAlignItems()

This value defines CSS align-items value of the flex layout.
Allowed Values: flexStart,flexEnd,baseline,center,stretch

setAlignItems

public void setAlignItems(AlignItems alignItems)

getColumns

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*

setColumns

public void setColumns(String 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.

Specified by:

getCustomClass in interface Visual

setCustomClass

public void setCustomClass(CustomClass customClass)

Specified by:

setCustomClass in interface Visual

getStyle

public Style getStyle()

For internal use. Used for rendering, if there is a child tag <tc:style>

Specified by:

getStyle in interface Visual

setStyle

public void setStyle(Style style)

Specified by:

setStyle in interface Visual

getRows

public String getRows()

This value defines the layout constraints for row 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*

setRows

public void setRows(String rows)

getJustifyContent

public JustifyContent getJustifyContent()

This value defines CSS justify-content value of the flex layout.
Allowed Values: flexStart,flexEnd,center,spaceBetween,spaceAround

setJustifyContent

public void setJustifyContent(JustifyContent justifyContent)