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 Summary
FieldsFields inherited from class jakarta.faces.component.UIComponent
ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, FACETS_KEY, VIEW_LOCATION_KEY
Fields inherited from interface jakarta.faces.component.NamingContainer
SEPARATOR_CHAR
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncreateUniqueId
(FacesContext context, String seed) boolean
invokeOnComponent
(FacesContext context, String clientId, ContextCallback callback) invokeOnComponent
must be implemented inUIComponentBase
too...boolean
boolean
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
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 subtreeMethods inherited from class jakarta.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 jakarta.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 Details
-
COMPONENT_TYPE
- See Also:
-
COMPONENT_FAMILY
- See Also:
-
-
Constructor Details
-
UIForm
public UIForm()
-
-
Method Details
-
createUniqueId
- Specified by:
createUniqueId
in interfaceUniqueIdVendor
- Since:
- 2.0
-
isSubmitted
public boolean isSubmitted() -
setSubmitted
public void setSubmitted(boolean submitted) -
processDecodes
- Overrides:
processDecodes
in classUIComponentBase
-
processValidators
- Overrides:
processValidators
in classUIComponentBase
-
processUpdates
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 classUIComponentBase
-
invokeOnComponent
public boolean invokeOnComponent(FacesContext context, String clientId, ContextCallback callback) throws FacesException Description copied from class:UIComponentBase
invokeOnComponent
must be implemented inUIComponentBase
too...- Overrides:
invokeOnComponent
in classUIComponentBase
- Parameters:
context
-FacesContext
for the current requestclientId
- the id of the desiredUIComponent
clazzcallback
- Implementation of theContextCallback
to be called- Returns:
- has component been found ?
- Throws:
FacesException
-
visitTree
Description copied from class:UIComponent
The 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:
visitTree
in 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
- Specified by:
getFamily
in classUIComponent
-
getContainerClientId
- Overrides:
getContainerClientId
in classUIComponent
-
isPrependId
@JSFProperty(defaultValue="true") public boolean isPrependId() -
setPrependId
public void setPrependId(boolean prependId)
-