javax.faces.component
Class UIForm

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UIForm

All Implemented Interfaces:

NamingContainer, StateHolder

Direct Known Subclasses:

HtmlForm

@JSFComponent(type="javax.faces.Form",
              family="javax.faces.Form")
public class UIForm
extends UIComponentBase
implements NamingContainer

see Javadoc of JSF Specification

Version:

$Revision: 949326 $ $Date: 2010-05-28 19:39:48 -0500 (Fri, 28 May 2010) $

Author:

Manfred Geiler (latest modification by $Author: lu4242 $)

Field Summary

static String	COMPONENT_FAMILY
static String	COMPONENT_TYPE

Fields inherited from class javax.faces.component.UIComponent

bindings

Fields inherited from interface javax.faces.component.NamingContainer

SEPARATOR_CHAR

Constructor Summary

UIForm()

Method Summary

String	getContainerClientId(FacesContext ctx)
String	getFamily()
boolean	isPrependId()
boolean	isSubmitted()
void	processDecodes(FacesContext context)
void	processUpdates(FacesContext context) This isn't an input component, so just pass on the processUpdates call to child components and facets that might be input components.
void	processValidators(FacesContext context)
void	restoreState(FacesContext context, Object state) Invoked in the "restore view" phase, this initialises this object's members from the values saved previously into the provided state object.
Object	saveState(FacesContext context) Invoked after the render phase has completed, this method returns an object which can be passed to the restoreState of some other instance of UIComponentBase to reset that object's state to the same values as this object currently has.
void	setPrependId(boolean prependId)
void	setSubmitted(boolean submitted)

Methods inherited from class javax.faces.component.UIComponentBase

addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getValueExpression, setValueExpression

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 String COMPONENT_TYPE

See Also:

Constant Field Values

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY

See Also:

Constant Field Values

Constructor Detail

UIForm

public UIForm()

Method Detail

isSubmitted

public boolean isSubmitted()

setSubmitted

public void setSubmitted(boolean submitted)

processDecodes

public void processDecodes(FacesContext context)

Overrides:

processDecodes in class UIComponentBase

processValidators

public void processValidators(FacesContext context)

Overrides:

processValidators in class UIComponentBase

processUpdates

public void processUpdates(FacesContext context)

Description copied from class: UIComponentBase

This isn't an input component, so just pass on the processUpdates call to child components and facets that might be input components.

Components that were never rendered can't possibly be receiving update data (no corresponding fields were ever put into the response) so if this component is not rendered then this method does not invoke processUpdates on its children.

Overrides:

processUpdates in class UIComponentBase

saveState

public Object saveState(FacesContext context)

Description copied from class: UIComponentBase

Invoked after the render phase has completed, this method returns an object which can be passed to the restoreState of some other instance of UIComponentBase to reset that object's state to the same values as this object currently has.

Specified by:

saveState in interface StateHolder

Overrides:

saveState in class UIComponentBase

restoreState

public void restoreState(FacesContext context,
                         Object state)

Description copied from class: UIComponentBase

Invoked in the "restore view" phase, this initialises this object's members from the values saved previously into the provided state object.

Specified by:

restoreState in interface StateHolder

Overrides:

restoreState in class UIComponentBase

state - is an object previously returned by the saveState method of this class.

getFamily

public String getFamily()

Specified by:

getFamily in class UIComponent

getContainerClientId

public String getContainerClientId(FacesContext ctx)

Overrides:

getContainerClientId in class UIComponent

isPrependId

@JSFProperty(defaultValue="true")
public boolean isPrependId()

setPrependId

public void setPrependId(boolean prependId)