@JSFComponent(type="javax.faces.Form", family="javax.faces.Form") public class UIForm extends UIComponentBase implements NamingContainer, UniqueIdVendor
Modifier and Type | Field and Description |
---|---|
static String |
COMPONENT_FAMILY |
static String |
COMPONENT_TYPE |
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
SEPARATOR_CHAR
Constructor and Description |
---|
UIForm() |
Modifier and Type | Method and Description |
---|---|
String |
createUniqueId(FacesContext context,
String seed) |
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) |
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) |
boolean |
visitTree(VisitContext context,
VisitCallback callback)
The visit tree method, visit tree walks over a subtree and processes
the callback object to perform some operation on the subtree
|
addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, initialStateMarked, invokeOnComponent, isRendered, isTransient, markInitialState, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding
getClientId, getCompositeComponentParent, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, subscribeToEvent, unsubscribeFromEvent
public static final String COMPONENT_TYPE
public static final String COMPONENT_FAMILY
public String createUniqueId(FacesContext context, String seed)
createUniqueId
in interface UniqueIdVendor
public boolean isSubmitted()
public void setSubmitted(boolean submitted)
public void processDecodes(FacesContext context)
processDecodes
in class UIComponentBase
public void processValidators(FacesContext context)
processValidators
in class UIComponentBase
public void processUpdates(FacesContext context)
UIComponentBase
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.
processUpdates
in class UIComponentBase
public Object saveState(FacesContext context)
UIComponentBase
saveState
in interface StateHolder
saveState
in class UIComponentBase
public boolean visitTree(VisitContext context, VisitCallback callback)
UIComponent
there are some details in the implementation which according to the spec have to be in place: a) before calling the callback and traversing into the subtree pushComponentToEL has to be called b) after the processing popComponentFromEL has to be performed to remove the component from the el
The tree traversal optimizations are located in the visit context and can be replaced via the VisitContextFactory in the faces-config factory section
visitTree
in class UIComponentBase
context
- the visit context which handles the processing detailscallback
- the callback to be performedpublic String getFamily()
getFamily
in class UIComponent
public String getContainerClientId(FacesContext ctx)
getContainerClientId
in class UIComponent
@JSFProperty(defaultValue="true") public boolean isPrependId()
public void setPrependId(boolean prependId)
Copyright © 2016 The Apache Software Foundation. All Rights Reserved.