com.liferay.faces.bridge.application
Class BridgeNavigationHandler

java.lang.Object
  javax.faces.application.NavigationHandler
      javax.faces.application.ConfigurableNavigationHandler
          com.liferay.faces.bridge.application.BridgeNavigationHandler

Direct Known Subclasses:

BridgeNavigationHandlerImpl

public abstract class BridgeNavigationHandler
extends javax.faces.application.ConfigurableNavigationHandler

This abstract class defines the contract for a brige-specific NavigationHandler that fortifies the JSF runtime with the ability to handle to-view-id entries in navigaion-case blocks that respect the Bridge.PORTLET_MODE_PARAMETER parameter for switching to a different PortletMode and the Bridge.PORTLET_WINDOWSTATE_PARAMETER parameter for switching to a different WindowState. It also has the ability to react to changes in portlet modes that were done programattically by portlet developers that called StateAwareResponse.setWindowState(WindowState) during the INVOKE_APPLICATION phase of the JSF lifecycle.

Author:

Neil Griffin

Constructor Summary

BridgeNavigationHandler()

Method Summary

abstract void

handleNavigation(javax.faces.context.FacesContext facesContext, javax.portlet.PortletMode fromPortletMode, javax.portlet.PortletMode toPortletMode) This method must react to changes in portlet modes that were done programatically by portlet developers that called StateAwareResponse.setWindowState(WindowState) during the INVOKE_APPLICATION phase of the JSF lifecycle.

abstract void

handleNavigation(javax.faces.context.FacesContext facesContext, String fromAction, String outcome) This method is defined in the NavigationHandler superclass and must be overridden in the bridge implementation so that it can handle to-view-id entries in navigaion-case blocks that respect the Bridge.PORTLET_MODE_PARAMETER parameter for switching to a different PortletMode and the Bridge.PORTLET_WINDOWSTATE_PARAMETER parameter for switching to a different WindowState.

Methods inherited from class javax.faces.application.ConfigurableNavigationHandler

getNavigationCase, getNavigationCases, performNavigation

Methods inherited from class java.lang.Object

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

Constructor Detail

BridgeNavigationHandler

public BridgeNavigationHandler()

Method Detail

handleNavigation

public abstract void handleNavigation(javax.faces.context.FacesContext facesContext,
                                      String fromAction,
                                      String outcome)

This method is defined in the NavigationHandler superclass and must be overridden in the bridge implementation so that it can handle to-view-id entries in navigaion-case blocks that respect the Bridge.PORTLET_MODE_PARAMETER parameter for switching to a different PortletMode and the Bridge.PORTLET_WINDOWSTATE_PARAMETER parameter for switching to a different WindowState.

Specified by:

handleNavigation in class javax.faces.application.NavigationHandler

See Also:

NavigationHandler#handleNavigation(FacesContext, String, String)}

handleNavigation

public abstract void handleNavigation(javax.faces.context.FacesContext facesContext,
                                      javax.portlet.PortletMode fromPortletMode,
                                      javax.portlet.PortletMode toPortletMode)

This method must react to changes in portlet modes that were done programatically by portlet developers that called StateAwareResponse.setWindowState(WindowState) during the INVOKE_APPLICATION phase of the JSF lifecycle. The viewId to be rendered is the current viewId in the UIViewRoot.

Parameters:

facesContext - The current FacesContext.

fromPortletMode - The PortletMode that was rendered prior to the developer calling StateAwareResponse.setWindowState(WindowState).

toPortletMode - The PortletMode that is to be switched to.