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:
java.util.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 class
DynaForm.PropertyKeys
Properties that are tracked by state saving.
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
COMPONENT_FAMILY
static java.lang.String
COMPONENT_TYPE
-
Fields inherited from class org.primefaces.extensions.component.base.AbstractDynamicData
data
-
-
Constructor Summary
Constructors Constructor Description DynaForm()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description protected static void
checkModelInstance(java.lang.Object value)
protected KeyData
findData(java.lang.String key)
Finds instance ofKeyData
by corresponding key.java.lang.String
getButtonBarPosition()
java.lang.String
getColumnClasses()
UIDynaFormControl
getControlCell(java.lang.String type)
protected java.util.Map<java.lang.String,UIDynaFormControl>
getControlCells()
java.lang.String
getFamily()
java.lang.String
getStyle()
java.lang.String
getStyleClass()
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
isAutoSubmit()
boolean
isOpenExtended()
protected void
processChildren(javax.faces.context.FacesContext context, javax.faces.event.PhaseId phaseId)
Processes children components during processDecodes(), processValidators(), processUpdates().java.lang.Object
saveState(javax.faces.context.FacesContext context)
void
setAutoSubmit(boolean autoSubmit)
void
setButtonBarPosition(java.lang.String buttonBarPosition)
void
setColumnClasses(java.lang.String columnClasses)
void
setOpenExtended(boolean openExtended)
void
setStyle(java.lang.String style)
void
setStyleClass(java.lang.String styleClass)
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, 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
-
-
-
-
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
-
-
Method Detail
-
getFamily
public java.lang.String getFamily()
- Specified by:
getFamily
in classjavax.faces.component.UIComponent
-
getWidgetVar
public java.lang.String getWidgetVar()
-
setWidgetVar
public void setWidgetVar(java.lang.String widgetVar)
-
isAutoSubmit
public boolean isAutoSubmit()
-
setAutoSubmit
public void setAutoSubmit(boolean autoSubmit)
-
isOpenExtended
public boolean isOpenExtended()
-
setOpenExtended
public void setOpenExtended(boolean openExtended)
-
getButtonBarPosition
public java.lang.String getButtonBarPosition()
-
setButtonBarPosition
public void setButtonBarPosition(java.lang.String buttonBarPosition)
-
setStyle
public void setStyle(java.lang.String style)
-
getStyle
public java.lang.String getStyle()
-
setStyleClass
public void setStyleClass(java.lang.String styleClass)
-
getStyleClass
public java.lang.String getStyleClass()
-
setColumnClasses
public void setColumnClasses(java.lang.String columnClasses)
-
getColumnClasses
public java.lang.String getColumnClasses()
-
getControlCell
public UIDynaFormControl getControlCell(java.lang.String type)
-
getControlCells
protected java.util.Map<java.lang.String,UIDynaFormControl> getControlCells()
-
checkModelInstance
protected static void checkModelInstance(java.lang.Object value)
-
findData
protected KeyData findData(java.lang.String key)
Description copied from class:AbstractDynamicData
Finds instance ofKeyData
by corresponding key.- Specified by:
findData
in classAbstractDynamicData
- 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 classAbstractDynamicData
- Parameters:
context
- faces contextFacesContext
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 classAbstractDynamicData
- Parameters:
context
- visit contextVisitContext
callback
- visit callbackVisitCallback
- 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 classAbstractDynamicData
- Parameters:
context
- faces contextFacesContext
clientId
- client Idcallback
-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 interfacejavax.faces.component.StateHolder
- Overrides:
saveState
in classAbstractDynamicData
-
-