Package jakarta.faces.component
Class UIForm
java.lang.Object
jakarta.faces.component.UIComponent
jakarta.faces.component.UIComponentBase
jakarta.faces.component.UIForm
- All Implemented Interfaces:
- NamingContainer,- PartialStateHolder,- StateHolder,- TransientStateHolder,- UniqueIdVendor,- ComponentSystemEventListener,- FacesListener,- SystemEventListenerHolder,- EventListener
- Direct Known Subclasses:
- HtmlForm
@JSFComponent(type="jakarta.faces.Form",
              family="jakarta.faces.Form")
public class UIForm
extends UIComponentBase
implements NamingContainer, UniqueIdVendor
see Javadoc of Faces Specification
- 
Field SummaryFieldsFields inherited from class jakarta.faces.component.UIComponentATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, FACETS_KEY, VIEW_LOCATION_KEYFields inherited from interface jakarta.faces.component.NamingContainerSEPARATOR_CHAR
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptioncreateUniqueId(FacesContext context, String seed) booleaninvokeOnComponent(FacesContext context, String clientId, ContextCallback callback) invokeOnComponentmust be implemented inUIComponentBasetoo...booleanbooleanvoidprocessDecodes(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 subtreeMethods inherited from class jakarta.faces.component.UIComponentBaseaddClientBehavior, 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, setTransientMethods inherited from class jakarta.faces.component.UIComponentgetClientId, 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 Details- 
COMPONENT_TYPE- See Also:
 
- 
COMPONENT_FAMILY- See Also:
 
 
- 
- 
Constructor Details- 
UIFormpublic UIForm()
 
- 
- 
Method Details- 
createUniqueId- Specified by:
- createUniqueIdin interface- UniqueIdVendor
- Since:
- 2.0
 
- 
isSubmittedpublic boolean isSubmitted()
- 
setSubmittedpublic void setSubmitted(boolean submitted) 
- 
processDecodes- Overrides:
- processDecodesin class- UIComponentBase
 
- 
processValidators- Overrides:
- processValidatorsin class- UIComponentBase
 
- 
processUpdatesDescription 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 class- UIComponentBase
 
- 
invokeOnComponentpublic boolean invokeOnComponent(FacesContext context, String clientId, ContextCallback callback) throws FacesException Description copied from class:UIComponentBaseinvokeOnComponentmust be implemented inUIComponentBasetoo...- Overrides:
- invokeOnComponentin class- UIComponentBase
- Parameters:
- context-- FacesContextfor the current request
- clientId- the id of the desired- UIComponentclazz
- callback- Implementation of the- ContextCallbackto be called
- Returns:
- has component been found ?
- Throws:
- FacesException
 
- 
visitTreeDescription 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 class- UIComponentBase
- Parameters:
- context- the visit context which handles the processing details
- callback- 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- Specified by:
- getFamilyin class- UIComponent
 
- 
getContainerClientId- Overrides:
- getContainerClientIdin class- UIComponent
 
- 
isPrependId@JSFProperty(defaultValue="true") public boolean isPrependId()
- 
setPrependIdpublic void setPrependId(boolean prependId) 
 
-