public class Form extends UIForm
UIForm and provides a way to keep view
or request parameters in the request URL after a post-back and offers in combination with the
<o:ignoreValidationFailed> tag on an UICommand component the possibility to ignore
validation failures so that the invoke action phase will be executed anyway.
You can use it the same way as <h:form>, you only need to change h: to
o:.
The standard UIForm doesn't put the original view parameters in the action URL that's used for the post-back.
Instead, it relies on those view parameters to be stored in the state associated with the standard
UIViewParameter. Via this state those parameters are invisibly re-applied after every post-back.
The disadvantage of this invisible retention of view parameters is that the user doesn't see them anymore in the address bar of the browser that is used to interact with the faces application. Copy-pasting the URL from the address bar or refreshing the page by hitting enter inside the address bar will therefore not always yield the expected results.
To solve this, this component offers an attribute includeViewParams="true" that will optionally include
all view parameters, in exactly the same way that this can be done for <h:link> and
<h:button>.
This setting is ignored when includeRequestParams="true" or useRequestURI="true" is used.
As an alternative to includeViewParams, you can use includeRequestParams="true" to
optionally include the current GET request query string.
This setting overrides the includeViewParams.
This setting is ignored when useRequestURI="true" is used.
As an alternative to includeViewParams and includeRequestParams, you can use
useRequestURI="true" to use the current request URI, including with the GET request query string, if
any. This is particularly useful if you're using FacesViews or forwarding everything to 1 page. Otherwise, by default
the current view ID will be used.
This setting overrides the includeViewParams and includeRequestParams.
In order to properly use the <o:ignoreValidationFailed> tag on an UICommand component, its
parent <h:form> component has to be replaced by this <o:form> component.
See also IgnoreValidationFailed.
| Modifier and Type | Field and Description |
|---|---|
static String |
COMPONENT_TYPE |
COMPONENT_FAMILYBEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, VIEW_LOCATION_KEYSEPARATOR_CHAR| Constructor and Description |
|---|
Form() |
| Modifier and Type | Method and Description |
|---|---|
void |
encodeBegin(FacesContext context) |
Boolean |
isIncludeRequestParams()
Return whether or not the request parameters should be encoded into the form's action URL.
|
Boolean |
isIncludeViewParams()
Return whether or not the view parameters should be encoded into the form's action URL.
|
Boolean |
isUseRequestURI()
Return whether or not the request URI should be used as form's action URL.
|
void |
processUpdates(FacesContext context) |
void |
processValidators(FacesContext context) |
void |
setIncludeRequestParams(boolean includeRequestParams)
Set whether or not the request parameters should be encoded into the form's action URL.
|
void |
setIncludeViewParams(boolean includeViewParams)
Set whether or not the view parameters should be encoded into the form's action URL.
|
void |
setUseRequestURI(boolean useRequestURI)
Set whether or not the request URI should be used as form's action URL.
|
createUniqueId, getContainerClientId, getFamily, isPrependId, isSubmitted, processDecodes, setPrependId, setSubmitted, visitTreeaddClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBindingencodeAll, getClientId, getCompositeComponentParent, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, setInView, setValueExpression, subscribeToEvent, unsubscribeFromEventpublic static final String COMPONENT_TYPE
public void processValidators(FacesContext context)
processValidators in class UIFormpublic void processUpdates(FacesContext context)
processUpdates in class UIFormpublic void encodeBegin(FacesContext context) throws IOException
encodeBegin in class UIComponentBaseIOExceptionpublic Boolean isIncludeViewParams()
public void setIncludeViewParams(boolean includeViewParams)
includeViewParams - The state of the switch for encoding view parameterspublic Boolean isIncludeRequestParams()
public void setIncludeRequestParams(boolean includeRequestParams)
includeRequestParams - The state of the switch for encoding request parameters.public Boolean isUseRequestURI()
public void setUseRequestURI(boolean useRequestURI)
useRequestURI - The state of the switch for using request URI.