org.primefaces.extensions.component.layout

Class Layout

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

org.primefaces.extensions.component.layout.Layout

All Implemented Interfaces:

java.util.EventListener, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, org.primefaces.component.api.Widget

public class Layout
extends javax.faces.component.UIComponentBase
implements org.primefaces.component.api.Widget, javax.faces.component.behavior.ClientBehaviorHolder

Layout component.

Since:

0.2

Author:

Oleg Varaksin / last modified by Melloware

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Layout.PropertyKeys Properties that are tracked by state saving.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static java.lang.String	PANE_POSITION_CENTER
static java.lang.String	PANE_POSITION_EAST
static java.lang.String	PANE_POSITION_NORTH
static java.lang.String	PANE_POSITION_SOUTH
static java.lang.String	PANE_POSITION_WEST
static java.lang.String	POSITION_SEPARATOR
static java.lang.String	STYLE_CLASS
static java.lang.String	STYLE_CLASS_LAYOUT_CONTENT
static java.lang.String	STYLE_CLASS_PANE
static java.lang.String	STYLE_CLASS_PANE_CONTENT
static java.lang.String	STYLE_CLASS_PANE_HEADER
static java.lang.String	STYLE_CLASS_PANE_WITH_SUBPANES

Fields inherited from class javax.faces.component.UIComponent

ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY

Fields inherited from interface org.primefaces.component.api.Widget

ATTR_WIDGET_VAR_PATTERN, CALLBACK_POST_CONSTRUCT, CALLBACK_POST_REFRESH, CALLBACK_PRE_DESTROY

Constructor Summary

Constructors

Constructor and Description
Layout()

Method Summary

Modifier and Type	Method and Description
java.util.Collection<java.lang.String>	getEventNames()
java.lang.String	getFamily()
org.primefaces.util.FastStringWriter	getFastStringWriter()
static LayoutPane	getLayoutPane(javax.faces.component.UIComponent component, java.lang.String combinedPosition)
java.lang.Object	getOptions()
javax.faces.context.ResponseWriter	getOriginalWriter()
java.lang.String	getResizerTip()
java.lang.String	getSliderTip()
java.lang.String	getState()
java.lang.String	getStyle()
java.lang.String	getStyleClass()
java.lang.String	getTogglerTipClosed()
java.lang.String	getTogglerTipOpen()
java.lang.String	getWidgetVar()
boolean	isBuildOptions()
boolean	isElementLayout()
boolean	isFullPage()
boolean	isMaskPanesEarly()
boolean	isNested()
boolean	isStateCookie()
void	processDecodes(javax.faces.context.FacesContext fc)
void	processUpdates(javax.faces.context.FacesContext fc)
void	processValidators(javax.faces.context.FacesContext fc)
void	queueEvent(javax.faces.event.FacesEvent event)
void	removeOptions()
void	setBuildOptions(boolean buildOptions)
void	setFastStringWriter(org.primefaces.util.FastStringWriter fsw)
void	setFullPage(boolean fullPage)
void	setMaskPanesEarly(boolean maskPanesEarly)
void	setOptions(java.lang.Object options)
void	setOriginalWriter(javax.faces.context.ResponseWriter originalWriter)
void	setResizerTip(java.lang.String resizerTip)
void	setSliderTip(java.lang.String sliderTip)
void	setState(java.lang.String state)
void	setStateCookie(boolean stateCookie)
void	setStyle(java.lang.String style)
void	setStyleClass(java.lang.String styleClass)
void	setTogglerTipClosed(java.lang.String togglerTipClosed)
void	setTogglerTipOpen(java.lang.String togglerTipOpen)
void	setWidgetVar(java.lang.String widgetVar)

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, visitTree

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.primefaces.component.api.Widget

resolveWidgetVar, resolveWidgetVar

Methods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder

addClientBehavior, getClientBehaviors, getDefaultEventName

Field Detail

POSITION_SEPARATOR

public static final java.lang.String POSITION_SEPARATOR

See Also:

Constant Field Values

STYLE_CLASS

public static final java.lang.String STYLE_CLASS

See Also:

Constant Field Values

STYLE_CLASS_PANE

public static final java.lang.String STYLE_CLASS_PANE

See Also:

Constant Field Values

STYLE_CLASS_PANE_WITH_SUBPANES

public static final java.lang.String STYLE_CLASS_PANE_WITH_SUBPANES

See Also:

Constant Field Values

STYLE_CLASS_PANE_HEADER

public static final java.lang.String STYLE_CLASS_PANE_HEADER

See Also:

Constant Field Values

STYLE_CLASS_PANE_CONTENT

public static final java.lang.String STYLE_CLASS_PANE_CONTENT

See Also:

Constant Field Values

STYLE_CLASS_LAYOUT_CONTENT

public static final java.lang.String STYLE_CLASS_LAYOUT_CONTENT

See Also:

Constant Field Values

PANE_POSITION_CENTER

public static final java.lang.String PANE_POSITION_CENTER

See Also:

Constant Field Values

PANE_POSITION_NORTH

public static final java.lang.String PANE_POSITION_NORTH

See Also:

Constant Field Values

PANE_POSITION_SOUTH

public static final java.lang.String PANE_POSITION_SOUTH

See Also:

Constant Field Values

PANE_POSITION_WEST

public static final java.lang.String PANE_POSITION_WEST

See Also:

Constant Field Values

PANE_POSITION_EAST

public static final java.lang.String PANE_POSITION_EAST

See Also:

Constant Field Values

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY

See Also:

Constant Field Values

Constructor Detail

Layout

public Layout()

Method Detail

getFamily

public java.lang.String getFamily()

Specified by:

getFamily in class javax.faces.component.UIComponent

getWidgetVar

public java.lang.String getWidgetVar()

setWidgetVar

public void setWidgetVar(java.lang.String widgetVar)

isFullPage

public boolean isFullPage()

setFullPage

public void setFullPage(boolean fullPage)

getOptions

public java.lang.Object getOptions()

setOptions

public void setOptions(java.lang.Object options)

getStyle

public java.lang.String getStyle()

setStyle

public void setStyle(java.lang.String style)

getStyleClass

public java.lang.String getStyleClass()

setStyleClass

public void setStyleClass(java.lang.String styleClass)

getState

public java.lang.String getState()

setState

public void setState(java.lang.String state)

isStateCookie

public boolean isStateCookie()

setStateCookie

public void setStateCookie(boolean stateCookie)

getTogglerTipOpen

public java.lang.String getTogglerTipOpen()

setTogglerTipOpen

public void setTogglerTipOpen(java.lang.String togglerTipOpen)

getTogglerTipClosed

public java.lang.String getTogglerTipClosed()

setTogglerTipClosed

public void setTogglerTipClosed(java.lang.String togglerTipClosed)

getResizerTip

public java.lang.String getResizerTip()

setResizerTip

public void setResizerTip(java.lang.String resizerTip)

getSliderTip

public java.lang.String getSliderTip()

setSliderTip

public void setSliderTip(java.lang.String sliderTip)

isMaskPanesEarly

public boolean isMaskPanesEarly()

setMaskPanesEarly

public void setMaskPanesEarly(boolean maskPanesEarly)

getEventNames

public java.util.Collection<java.lang.String> getEventNames()

Specified by:

getEventNames in interface javax.faces.component.behavior.ClientBehaviorHolder

Overrides:

getEventNames in class javax.faces.component.UIComponentBase

processDecodes

public void processDecodes(javax.faces.context.FacesContext fc)

Overrides:

processDecodes in class javax.faces.component.UIComponentBase

processValidators

public void processValidators(javax.faces.context.FacesContext fc)

Overrides:

processValidators in class javax.faces.component.UIComponentBase

processUpdates

public void processUpdates(javax.faces.context.FacesContext fc)

Overrides:

processUpdates in class javax.faces.component.UIComponentBase

queueEvent

public void queueEvent(javax.faces.event.FacesEvent event)

Overrides:

queueEvent in class javax.faces.component.UIComponentBase

getLayoutPane

public static LayoutPane getLayoutPane(javax.faces.component.UIComponent component,
                                       java.lang.String combinedPosition)

getOriginalWriter

public javax.faces.context.ResponseWriter getOriginalWriter()

setOriginalWriter

public void setOriginalWriter(javax.faces.context.ResponseWriter originalWriter)

getFastStringWriter

public org.primefaces.util.FastStringWriter getFastStringWriter()

setFastStringWriter

public void setFastStringWriter(org.primefaces.util.FastStringWriter fsw)

isBuildOptions

public boolean isBuildOptions()

setBuildOptions

public void setBuildOptions(boolean buildOptions)

removeOptions

public void removeOptions()

isNested

public boolean isNested()

isElementLayout

public boolean isElementLayout()