org.omnifaces.component.input

Class ViewAction

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

javax.faces.component.UIViewAction

org.omnifaces.component.input.ViewAction

All Implemented Interfaces:

EventListener, ActionSource, ActionSource2, PartialStateHolder, StateHolder, TransientStateHolder, ComponentSystemEventListener, FacesListener, SystemEventListenerHolder

public class ViewAction
extends UIViewAction

The <o:viewAction> is a component that extends the standard <f:viewAction> and changes the if attribute to be evaluated during INVOKE_APPLICATION phase instead of the APPLY_REQUEST_VALUES phase. This allows developers to let the if attribute check the converted and validated model values before performing the view action, which results in much more intuitive behavior.

In below example, the FooConverter may convert a non-null parameter to null without causing a validation or conversion error, and the intent is to redirect the current page to otherpage.xhtml when the converted result is null.

 <f:viewParam name="foo" value="#{bean.foo}" converter="fooConverter" />
 <f:viewAction action="otherpage" if="#{bean.foo eq null}" />
 

This is however not possible with standard <f:viewAction> as it evaluates the if attribute already before the conversion has taken place. This component solves that by postponing the evaluation of the if attribute to the INVOKE_APPLICATION phase.

 <f:viewParam name="foo" value="#{bean.foo}" converter="fooConverter" />
 <o:viewAction action="otherpage" if="#{bean.foo eq null}" />
 

Only when you set immediate="true", then it will behave the same as the standard <f:viewAction>.

Usage

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

 <o:viewAction action="otherpage" if="#{bean.property eq null}" />
 

Messaging

You can use the message attribute to add a global flash warning message.

 <o:viewAction ... message="Please use a valid link from within the site" />
 

Note that the message will only be shown when the redirect has actually taken place. The support was added in OmniFaces 3.2.

Since:

2.2

Author:

Bauke Scholtz

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPONENT_TYPE

Fields inherited from class javax.faces.component.UIViewAction

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

Constructor Summary

Constructors

Constructor and Description
ViewAction()

Method Summary

Modifier and Type	Method and Description
void	broadcast(FacesEvent event) Only broadcast the action event when UIViewAction.isRendered() returns true.
String	getMessage() Returns the global flash warning message to be shown in the redirected page.
boolean	isRendered() Returns true if the immediate="true" attribute is not set, otherwise delegate to super, hereby maintaining the original behavior of immediate="true".
void	setMessage(String message) Sets the global flash warning message to be shown in the redirected page.

Methods inherited from class javax.faces.component.UIViewAction

addActionListener, decode, getAction, getActionExpression, getActionListener, getActionListeners, getFamily, getPhase, isImmediate, isOnPostback, isProcessingBroadcast, removeActionListener, setAction, setActionExpression, setActionListener, setImmediate, setOnPostback, setPhase, setRendered

Methods inherited from class javax.faces.component.UIComponentBase

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

Methods inherited from class javax.faces.component.UIComponent

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

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

ViewAction

public ViewAction()

Method Detail

broadcast

public void broadcast(FacesEvent event)

Only broadcast the action event when UIViewAction.isRendered() returns true. The default implementation will always broadcast. The UIViewAction.isRendered() is by default only considered during UIViewAction.decode(javax.faces.context.FacesContext).

If the action event performs any redirect, then add any getMessage() as a global flash warning message.

Overrides:

broadcast in class UIViewAction

isRendered

public boolean isRendered()

Returns true if the immediate="true" attribute is not set, otherwise delegate to super, hereby maintaining the original behavior of immediate="true".

Overrides:

isRendered in class UIViewAction

getMessage

public String getMessage()

Returns the global flash warning message to be shown in the redirected page.

Returns:

The global flash warning message to be shown in the redirected page.

Since:

3.2

setMessage

public void setMessage(String message)

Sets the global flash warning message to be shown in the redirected page.

Parameters:

message - The global flash warning message to be shown in the redirected page.

Since:

3.2