org.apache.myfaces.custom.dynaForm.component.dynaForm
Class DynaForm

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by org.apache.myfaces.custom.dynaForm.component.dynaForm.DynaForm
All Implemented Interfaces:
javax.faces.component.StateHolder

public class DynaForm
extends javax.faces.component.UIComponentBase

the dynaForm component
handles whats needed to dynamically create JSF component trees


Field Summary
static java.lang.String COMPONENT_FAMILY
           
static java.lang.String COMPONENT_TYPE
           
static java.lang.String DEFAULT_RENDERER_TYPE
           
static java.lang.String DYNA_FORM_CREATED
           
 
Constructor Summary
DynaForm()
           
 
Method Summary
protected  DynaForm findParentDynaForm(DynaForm start)
          try to find a parent dyna form+
 java.lang.String getBundle()
           
protected  UriResolver.Configuration getConfiguration()
          get the overall configuration based on the given uri
static DynaForm getDynaForm(javax.faces.component.UIComponent component)
          Find the dynaForm component
 Extractor getExtractor()
           
 java.lang.String getFamily()
           
 DynaConfigs getFormConfigs()
          get access to the special form configurations
 java.lang.String getUri()
           
 java.lang.String getValueBindingPrefix()
           
 java.lang.String getVar()
           
 boolean isDisplayOnly()
           
 boolean isExclusiveFields()
           
 void restoreState(javax.faces.context.FacesContext context, java.lang.Object stateArray)
           
 java.lang.Object saveState(javax.faces.context.FacesContext context)
           
 void setBundle(java.lang.String bundle)
          The bundle to use to convert the labels to readable strings
 void setDisplayOnly(boolean displayOnly)
          Display the whole form in read only mode
 void setExclusiveFields(boolean exclusiveFields)
          Process only fields listed by their facets
 void setUri(java.lang.String uri)
          how to reach the model
e.g.
 void setValueBindingPrefix(java.lang.String valueBindingPrefix)
          The value binding prefix which will be used to create the real value binding.
 void setVar(java.lang.String var)
          the var name used to allow access to the form controller
 
Methods inherited from class javax.faces.component.UIComponentBase
addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE
See Also:
Constant Field Values

DEFAULT_RENDERER_TYPE

public static final java.lang.String DEFAULT_RENDERER_TYPE
See Also:
Constant Field Values

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY
See Also:
Constant Field Values

DYNA_FORM_CREATED

public static final java.lang.String DYNA_FORM_CREATED
See Also:
Constant Field Values
Constructor Detail

DynaForm

public DynaForm()
Method Detail

getFamily

public java.lang.String getFamily()
Specified by:
getFamily in class javax.faces.component.UIComponent

getUri

public java.lang.String getUri()
See Also:
setUri(java.lang.String)

setUri

public void setUri(java.lang.String uri)
how to reach the model
e.g. ejb:fqn.to.model.Entity means use EJB3 to work with the given entity
beside the model itself the uri scheme also configures what to do with this entity

See Also:
UriResolver

getValueBindingPrefix

public java.lang.String getValueBindingPrefix()
See Also:
setValueBindingPrefix(java.lang.String)

setValueBindingPrefix

public void setValueBindingPrefix(java.lang.String valueBindingPrefix)
The value binding prefix which will be used to create the real value binding. If this is missing and the layout component has a "var" attribute its value will be used.


getBundle

public java.lang.String getBundle()
See Also:
setBundle(java.lang.String)

setBundle

public void setBundle(java.lang.String bundle)
The bundle to use to convert the labels to readable strings


getVar

public java.lang.String getVar()
See Also:
setVar(java.lang.String)

setDisplayOnly

public void setDisplayOnly(boolean displayOnly)
Display the whole form in read only mode


isDisplayOnly

public boolean isDisplayOnly()
See Also:
setVar(java.lang.String)

setExclusiveFields

public void setExclusiveFields(boolean exclusiveFields)
Process only fields listed by their facets


isExclusiveFields

public boolean isExclusiveFields()
See Also:
setExclusiveFields(boolean)

setVar

public void setVar(java.lang.String var)
the var name used to allow access to the form controller


restoreState

public void restoreState(javax.faces.context.FacesContext context,
                         java.lang.Object stateArray)
Specified by:
restoreState in interface javax.faces.component.StateHolder
Overrides:
restoreState in class javax.faces.component.UIComponentBase

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext context)
Specified by:
saveState in interface javax.faces.component.StateHolder
Overrides:
saveState in class javax.faces.component.UIComponentBase

getConfiguration

protected UriResolver.Configuration getConfiguration()
get the overall configuration based on the given uri

See Also:
UriResolver

getExtractor

public Extractor getExtractor()

findParentDynaForm

protected DynaForm findParentDynaForm(DynaForm start)
try to find a parent dyna form+


getDynaForm

public static DynaForm getDynaForm(javax.faces.component.UIComponent component)
Find the dynaForm component


getFormConfigs

public DynaConfigs getFormConfigs()
get access to the special form configurations



Copyright © 2011. All Rights Reserved.