org.primefaces.extensions.component.fluidgrid

Class FluidGrid

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

org.primefaces.extensions.component.base.AbstractDynamicData

org.primefaces.extensions.component.fluidgrid.FluidGrid

All Implemented Interfaces:

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

public class FluidGrid
extends AbstractDynamicData
implements org.primefaces.component.api.Widget, javax.faces.component.behavior.ClientBehaviorHolder

FluidGrid component.

Since:

1.1.0

Author:

Oleg Varaksin / last modified by Melloware

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	FluidGrid.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	DEFAULT_RENDERER

Fields inherited from class org.primefaces.extensions.component.base.AbstractDynamicData

data

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

Fields inherited from interface javax.faces.component.NamingContainer

SEPARATOR_CHAR

Constructor Summary

Constructors

Constructor and Description
FluidGrid()

Method Summary

Modifier and Type	Method and Description
protected static void	checkModelInstance(java.lang.Object value)
protected KeyData	findData(java.lang.String key) Finds instance of KeyData by corresponding key.
java.util.Collection<java.lang.String>	getEventNames()
java.lang.String	getFamily()
int	gethGutter()
UIFluidGridItem	getItem(java.lang.String type)
protected java.util.Map<java.lang.String,UIFluidGridItem>	getItems()
java.lang.String	getStamp()
java.lang.String	getStyle()
java.lang.String	getStyleClass()
java.lang.String	getTransitionDuration()
int	getvGutter()
java.lang.String	getWidgetVar()
protected boolean	invokeOnChildren(javax.faces.context.FacesContext context, java.lang.String clientId, javax.faces.component.ContextCallback callback) Searches a child component with the given clientId during invokeOnComponent() and invokes the callback on it if found.
boolean	isFitWidth()
boolean	isHasImages()
boolean	isOriginLeft()
boolean	isOriginTop()
boolean	isResizeBound()
protected void	processChildren(javax.faces.context.FacesContext context, javax.faces.event.PhaseId phaseId) Processes children components during processDecodes(), processValidators(), processUpdates().
void	queueEvent(javax.faces.event.FacesEvent event)
java.lang.Object	saveState(javax.faces.context.FacesContext context)
void	setFitWidth(boolean fitWidth)
void	setHasImages(boolean hasImages)
void	sethGutter(int hGutter)
void	setOriginLeft(boolean originLeft)
void	setOriginTop(boolean originTop)
void	setResizeBound(boolean resizeBound)
void	setStamp(java.lang.String stamp)
void	setStyle(java.lang.String style)
void	setStyleClass(java.lang.String styleClass)
void	setTransitionDuration(java.lang.String transitionDuration)
void	setvGutter(int vGutter)
void	setWidgetVar(java.lang.String widgetVar)
protected boolean	visitChildren(javax.faces.component.visit.VisitContext context, javax.faces.component.visit.VisitCallback callback) Visits children components during visitTree().

Methods inherited from class org.primefaces.extensions.component.base.AbstractDynamicData

broadcast, createUniqueId, exposeVar, getClientId, getContainerClientId, getData, getValue, getVar, getVarContainerId, invokeOnComponent, isNestedWithinIterator, preDecode, processDecodes, processFacets, processUpdates, processValidators, resetData, restoreDescendantState, restoreDescendantState, saveDescendantState, saveDescendantState, setData, setData, setId, setValue, setVar, setVarContainerId, visitTree

Methods inherited from class javax.faces.component.UIComponentBase

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

Methods inherited from class javax.faces.component.UIComponent

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

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

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

DEFAULT_RENDERER

public static final java.lang.String DEFAULT_RENDERER

See Also:

Constant Field Values

Constructor Detail

FluidGrid

public FluidGrid()

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)

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)

gethGutter

public int gethGutter()

sethGutter

public void sethGutter(int hGutter)

getvGutter

public int getvGutter()

setvGutter

public void setvGutter(int vGutter)

isFitWidth

public boolean isFitWidth()

setFitWidth

public void setFitWidth(boolean fitWidth)

isOriginLeft

public boolean isOriginLeft()

setOriginLeft

public void setOriginLeft(boolean originLeft)

isOriginTop

public boolean isOriginTop()

setOriginTop

public void setOriginTop(boolean originTop)

isResizeBound

public boolean isResizeBound()

setResizeBound

public void setResizeBound(boolean resizeBound)

getStamp

public java.lang.String getStamp()

setStamp

public void setStamp(java.lang.String stamp)

getTransitionDuration

public java.lang.String getTransitionDuration()

setTransitionDuration

public void setTransitionDuration(java.lang.String transitionDuration)

isHasImages

public boolean isHasImages()

setHasImages

public void setHasImages(boolean hasImages)

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

queueEvent

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

Overrides:

queueEvent in class AbstractDynamicData

getItem

public UIFluidGridItem getItem(java.lang.String type)

getItems

protected java.util.Map<java.lang.String,UIFluidGridItem> getItems()

checkModelInstance

protected static void checkModelInstance(java.lang.Object value)

findData

protected KeyData findData(java.lang.String key)

Description copied from class: AbstractDynamicData

Finds instance of KeyData by corresponding key.

Specified by:

findData in class AbstractDynamicData

Parameters:

key - unique key

Returns:

KeyData found data

processChildren

protected void processChildren(javax.faces.context.FacesContext context,
                               javax.faces.event.PhaseId phaseId)

Description copied from class: AbstractDynamicData

Processes children components during processDecodes(), processValidators(), processUpdates().

Specified by:

processChildren in class AbstractDynamicData

Parameters:

context - faces context FacesContext

phaseId - current JSF phase id

visitChildren

protected boolean visitChildren(javax.faces.component.visit.VisitContext context,
                                javax.faces.component.visit.VisitCallback callback)

Description copied from class: AbstractDynamicData

Visits children components during visitTree().

Specified by:

visitChildren in class AbstractDynamicData

Parameters:

context - visit context VisitContext

callback - visit callback VisitCallback

Returns:

boolean true - indicates that the children's visit is complete (e.g. all components that need to be visited have been visited), false - otherwise.

invokeOnChildren

protected boolean invokeOnChildren(javax.faces.context.FacesContext context,
                                   java.lang.String clientId,
                                   javax.faces.component.ContextCallback callback)

Description copied from class: AbstractDynamicData

Searches a child component with the given clientId during invokeOnComponent() and invokes the callback on it if found.

Specified by:

invokeOnChildren in class AbstractDynamicData

Parameters:

context - faces context FacesContext

clientId - client Id

callback - ContextCallback

Returns:

boolean true - child component was found, else - otherwise

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext context)

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class AbstractDynamicData