org.omnifaces.component.input

Class Form

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

javax.faces.component.UIForm

org.omnifaces.component.input.Form

All Implemented Interfaces:

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

public class Form
extends UIForm

Form is a component that extends the standard UIForm and provides a way to keep view parameters in the request URL after a post-back.

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 that will optionally include all view parameters, in exactly the same way that this can be done for <h:link> and <h:button>.

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

Since:

1.1

Author:

Arjan Tijms

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

BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, VIEW_LOCATION_KEY

Fields inherited from interface javax.faces.component.NamingContainer

SEPARATOR_CHAR

Constructor Summary

Constructors

Constructor and Description
Form()

Method Summary

Methods

Modifier and Type	Method and Description
void	encodeBegin(FacesContext context)
boolean	isIncludeViewParams() Return whether or not the view 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.

Methods inherited from class javax.faces.component.UIForm

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

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, 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, setValueBinding

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, setInView, setValueExpression, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class java.lang.Object

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

Field Detail

COMPONENT_TYPE

public static final String COMPONENT_TYPE

See Also:

Constant Field Values

Constructor Detail

Form

public Form()

Method Detail

encodeBegin

public void encodeBegin(FacesContext context)
                 throws IOException

Overrides:

encodeBegin in class UIComponentBase

Throws:

IOException

isIncludeViewParams

public boolean isIncludeViewParams()

Return 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