Package javax.faces.component
Class UIForm
- java.lang.Object
-
- javax.faces.component.UIComponent
-
- javax.faces.component.UIComponentBase
-
- javax.faces.component.UIForm
-
- All Implemented Interfaces:
EventListener,NamingContainer,PartialStateHolder,StateHolder,TransientStateHolder,UniqueIdVendor,ComponentSystemEventListener,FacesListener,SystemEventListenerHolder
- Direct Known Subclasses:
HtmlForm
@JSFComponent(type="javax.faces.Form", family="javax.faces.Form") public class UIForm extends UIComponentBase implements NamingContainer, UniqueIdVendorsee Javadoc of JSF Specification
-
-
Field Summary
Fields Modifier and Type Field Description static StringCOMPONENT_FAMILYstatic StringCOMPONENT_TYPE-
Fields inherited from class javax.faces.component.UIComponent
ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, 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
-
-
Constructor Summary
Constructors Constructor Description UIForm()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description StringcreateUniqueId(FacesContext context, String seed)StringgetContainerClientId(FacesContext ctx)StringgetFamily()booleaninvokeOnComponent(FacesContext context, String clientId, ContextCallback callback)invokeOnComponentmust be implemented inUIComponentBasetoo...booleanisPrependId()booleanisSubmitted()voidprocessDecodes(FacesContext context)voidprocessUpdates(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.voidprocessValidators(FacesContext context)voidsetPrependId(boolean prependId)voidsetSubmitted(boolean submitted)booleanvisitTree(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-
Methods inherited from class javax.faces.component.UIComponentBase
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, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, isRendered, isTransient, markInitialState, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient
-
Methods inherited from class javax.faces.component.UIComponent
getClientId, getCompositeComponentParent, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, subscribeToEvent, unsubscribeFromEvent
-
-
-
-
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
-
-
Method Detail
-
createUniqueId
public String createUniqueId(FacesContext context, String seed)
- Specified by:
createUniqueIdin interfaceUniqueIdVendor- Since:
- 2.0
-
isSubmitted
public boolean isSubmitted()
-
setSubmitted
public void setSubmitted(boolean submitted)
-
processDecodes
public void processDecodes(FacesContext context)
- Overrides:
processDecodesin classUIComponentBase
-
processValidators
public void processValidators(FacesContext context)
- Overrides:
processValidatorsin classUIComponentBase
-
processUpdates
public void processUpdates(FacesContext context)
Description copied from class:UIComponentBaseThis 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:
processUpdatesin classUIComponentBase
-
invokeOnComponent
public boolean invokeOnComponent(FacesContext context, String clientId, ContextCallback callback) throws FacesException
Description copied from class:UIComponentBaseinvokeOnComponentmust be implemented inUIComponentBasetoo...- Overrides:
invokeOnComponentin classUIComponentBase- Parameters:
context-FacesContextfor the current requestclientId- the id of the desiredUIComponentclazzcallback- Implementation of theContextCallbackto be called- Returns:
- has component been found ?
- Throws:
FacesException
-
visitTree
public boolean visitTree(VisitContext context, VisitCallback callback)
Description copied from class:UIComponentThe visit tree method, visit tree walks over a subtree and processes the callback object to perform some operation on the subtreethere 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
- Overrides:
visitTreein classUIComponentBase- Parameters:
context- the visit context which handles the processing detailscallback- the callback to be performed- Returns:
- false if the processing is not done true if we can shortcut the visiting because we are done with everything
-
getFamily
public String getFamily()
- Specified by:
getFamilyin classUIComponent
-
getContainerClientId
public String getContainerClientId(FacesContext ctx)
- Overrides:
getContainerClientIdin classUIComponent
-
isPrependId
@JSFProperty(defaultValue="true") public boolean isPrependId()
-
setPrependId
public void setPrependId(boolean prependId)
-
-