Package org.primefaces.extensions.component.dynaform

Class DynaForm

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

org.primefaces.extensions.component.base.AbstractDynamicData

org.primefaces.extensions.component.dynaform.DynaForm

All Implemented Interfaces:

EventListener, 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 DynaForm
extends AbstractDynamicData
implements org.primefaces.component.api.Widget

DynaForm component.

Since:

0.5

Version:

$Revision$

Author:

Oleg Varaksin / last modified by $Author$

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static enum	DynaForm.PropertyKeys	Properties that are tracked by state saving.

Field Summary

Fields

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

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 javax.faces.component.NamingContainer

SEPARATOR_CHAR

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	Description
DynaForm()

Method Summary

Modifier and Type	Method	Description
protected static void	checkModelInstance(Object value)
protected KeyData	findData(String key)	Finds instance of KeyData by corresponding key.
String	getButtonBarPosition()
String	getColumnClasses()
UIDynaFormControl	getControlCell(String type)
protected Map<String,UIDynaFormControl>	getControlCells()
String	getFamily()
String	getStyle()
String	getStyleClass()
String	getWidgetVar()
protected boolean	invokeOnChildren(javax.faces.context.FacesContext context, 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	isAutoSubmit()
boolean	isOpenExtended()
protected void	processChildren(javax.faces.context.FacesContext context, javax.faces.event.PhaseId phaseId)	Processes children components during processDecodes(), processValidators(), processUpdates().
Object	saveState(javax.faces.context.FacesContext context)
void	setAutoSubmit(boolean autoSubmit)
void	setButtonBarPosition(String buttonBarPosition)
void	setColumnClasses(String columnClasses)
void	setOpenExtended(boolean openExtended)
void	setStyle(String style)
void	setStyleClass(String styleClass)
void	setWidgetVar(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, queueEvent, 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, getEventNames, 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

Field Details

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 Details

DynaForm

public DynaForm()

Method Details

getFamily

public String getFamily()

Specified by:

getFamily in class javax.faces.component.UIComponent

getWidgetVar

public String getWidgetVar()

setWidgetVar

public void setWidgetVar(String widgetVar)

isAutoSubmit

public boolean isAutoSubmit()

setAutoSubmit

public void setAutoSubmit(boolean autoSubmit)

isOpenExtended

public boolean isOpenExtended()

setOpenExtended

public void setOpenExtended(boolean openExtended)

getButtonBarPosition

public String getButtonBarPosition()

setButtonBarPosition

public void setButtonBarPosition(String buttonBarPosition)

setStyle

public void setStyle(String style)

getStyle

public String getStyle()

setStyleClass

public void setStyleClass(String styleClass)

getStyleClass

public String getStyleClass()

setColumnClasses

public void setColumnClasses(String columnClasses)

getColumnClasses

public String getColumnClasses()

getControlCell

public UIDynaFormControl getControlCell(String type)

getControlCells

protected Map<String,UIDynaFormControl> getControlCells()

checkModelInstance

protected static void checkModelInstance(Object value)

findData

protected KeyData findData(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,
 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 Object saveState(javax.faces.context.FacesContext context)

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class AbstractDynamicData