org.omnifaces.component.input

Class Form

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

javax.faces.component.UIForm

javax.faces.component.html.HtmlForm

org.omnifaces.component.input.Form

All Implemented Interfaces:

EventListener, ClientBehaviorHolder, NamingContainer, PartialStateHolder, StateHolder, TransientStateHolder, UniqueIdVendor, ComponentSystemEventListener, FacesListener, SystemEventListenerHolder

public class Form
extends HtmlForm

The <o:form> is a component that extends the standard <h:form> 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. This component also supports adding query string parameters to the action URL via nested <f:param> and <o:param>.

You can use it the same way as <h:form>, you only need to change h: to o:.

Include View Params

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>.

 <o:form includeViewParams="true">
 

This setting is ignored when includeRequestParams="true" or useRequestURI="true" is used.

Include Request Params

As an alternative to includeViewParams, you can use includeRequestParams="true" to optionally include the current GET request query string.

 <o:form includeRequestParams="true">
 

This setting overrides the includeViewParams. This setting is ignored when useRequestURI="true" is used.

Use request URI

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.

 <o:form useRequestURI="true">
 

This setting overrides the includeViewParams and includeRequestParams.

Add query string parameters to action URL

The standard UIForm doesn't support adding query string parameters to the action URL. This component offers this possibility via nested <f:param> and <o:param>.

 <o:form>
     <f:param name="somename" value="somevalue" />
     ...
 </o:form>
 

This can be used in combination with useRequestURI, includeViewParams and includeRequestParams. The <f|o:param> will override any included view or request parameters on the same name. To conditionally add or override, use the disabled attribute of <f|o:param>.

The support was added in OmniFaces 2.2.

Ignore Validation Failed

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.

Since:

1.1

Author:

Arjan Tijms, Bauke Scholtz

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPONENT_TYPE

Fields inherited from class javax.faces.component.UIForm

COMPONENT_FAMILY

Fields inherited from class javax.faces.component.UIComponent

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

Fields inherited from interface javax.faces.component.NamingContainer

SEPARATOR_CHAR

Constructor Summary

Constructors

Constructor and Description
Form()

Method Summary

Modifier and Type	Method and Description
void	encodeBegin(FacesContext context)
boolean	isIgnoreValidationFailed() Returns whether or not the form should ignore validation fail (and thus proceed to update model/invoke action).
boolean	isIncludeRequestParams() Returns whether or not the request parameters should be encoded into the form's action URL.
boolean	isIncludeViewParams() Returns whether or not the view parameters should be encoded into the form's action URL.
boolean	isUseRequestURI() Returns whether or not the request URI should be used as form's action URL.
void	processUpdates(FacesContext context)
void	processValidators(FacesContext context)
void	setIgnoreValidationFailed(boolean ignoreValidationFailed) Set whether or not the form should ignore validation fail.
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.

Methods inherited from class javax.faces.component.html.HtmlForm

getAccept, getAcceptcharset, getDefaultEventName, getDir, getEnctype, getEventNames, getLang, getOnclick, getOndblclick, getOnkeydown, getOnkeypress, getOnkeyup, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getOnreset, getOnsubmit, getRole, getStyle, getStyleClass, getTarget, getTitle, setAccept, setAcceptcharset, setDir, setEnctype, setLang, setOnclick, setOndblclick, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setOnreset, setOnsubmit, setRole, setStyle, setStyleClass, setTarget, setTitle

Methods inherited from class javax.faces.component.UIForm

createUniqueId, getContainerClientId, getFamily, isPrependId, isSubmitted, processDecodes, setPrependId, setSubmitted, visitTree

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder

addClientBehavior, getClientBehaviors

Field Detail

COMPONENT_TYPE

public static final String COMPONENT_TYPE

See Also:

Constant Field Values

Constructor Detail

Form

public Form()

Method Detail

processValidators

public void processValidators(FacesContext context)

Overrides:

processValidators in class UIForm

processUpdates

public void processUpdates(FacesContext context)

Overrides:

processUpdates in class UIForm

encodeBegin

public void encodeBegin(FacesContext context)
                 throws IOException

Overrides:

encodeBegin in class UIComponentBase

Throws:

IOException

isIncludeViewParams

public boolean isIncludeViewParams()

Returns whether or not the view parameters should be encoded into the form's action URL.

Returns:

Whether or not the view parameters should be encoded into the form's action URL.

setIncludeViewParams

public void setIncludeViewParams(boolean includeViewParams)

Set whether or not the view parameters should be encoded into the form's action URL.

Parameters:

includeViewParams - The state of the switch for encoding view parameters

isIncludeRequestParams

public boolean isIncludeRequestParams()

Returns whether or not the request parameters should be encoded into the form's action URL.

Returns:

Whether or not the request parameters should be encoded into the form's action URL.

Since:

1.5

setIncludeRequestParams

public void setIncludeRequestParams(boolean includeRequestParams)

Set whether or not the request parameters should be encoded into the form's action URL.

Parameters:

includeRequestParams - The state of the switch for encoding request parameters.

Since:

1.5

isUseRequestURI

public boolean isUseRequestURI()

Returns whether or not the request URI should be used as form's action URL.

Returns:

Whether or not the request URI should be used as form's action URL.

Since:

1.6

setUseRequestURI

public void setUseRequestURI(boolean useRequestURI)

Set whether or not the request URI should be used as form's action URL.

Parameters:

useRequestURI - The state of the switch for using request URI.

Since:

1.6

isIgnoreValidationFailed

public boolean isIgnoreValidationFailed()

Returns whether or not the form should ignore validation fail (and thus proceed to update model/invoke action).

Returns:

Whether or not the form should ignore validation fail.

Since:

2.1

setIgnoreValidationFailed

public void setIgnoreValidationFailed(boolean ignoreValidationFailed)

Set whether or not the form should ignore validation fail.

Parameters:

ignoreValidationFailed - Whether or not the form should ignore validation fail.

Since:

2.1