com.liferay.faces.bridge.context
Class FacesViewImpl

java.lang.Object
  com.liferay.faces.bridge.context.FacesViewImpl

All Implemented Interfaces:

FacesView

public class FacesViewImpl
extends Object
implements FacesView

Author:

Neil Griffin

Constructor Summary

FacesViewImpl(String viewId, List<String> configuredExtensions)

FacesViewImpl(String viewId, String navigationQueryString, List<String> configuredExtensions)

Method Summary

String	getExtension() Determines the extension (such as *.faces) used by the extension-mapped servlet-mapping.
String	getQueryString() Returns the query-string which may contain navigation parameters such as Bridge.PORTLET_MODE_PARAMETER, Bridge.NONFACES_TARGET_PATH_PARAMETER, Bridge.PORTLET_SECURE_PARAMETER, Bridge.PORTLET_WINDOWSTATE_PARAMETER, Bridge.FACES_VIEW_ID_PARAMETER, or Bridge.FACES_VIEW_PATH_PARAMETER.
String	getServletPath() Determines the servlet-path (such as /faces/views) used by the path-mapped servlet-mapping.
String	getViewId() Returns the viewId associated with this view.
boolean	isExtensionMapped() Flag indicating whether or not the view is mapped to the FacesServlet via extension-mapping (such as *.faces) or some other extension.
boolean	isPathMapped() Flag indicating whether or not the view is mapped to the FacesServlet via path-mapping (such as /faces/views/*) or some other extension.
boolean	isServletMapped()

Methods inherited from class java.lang.Object

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

Constructor Detail

FacesViewImpl

public FacesViewImpl(String viewId,
                     List<String> configuredExtensions)

FacesViewImpl

public FacesViewImpl(String viewId,
                     String navigationQueryString,
                     List<String> configuredExtensions)

Method Detail

isExtensionMapped

public boolean isExtensionMapped()

Description copied from interface: FacesView

Flag indicating whether or not the view is mapped to the FacesServlet via extension-mapping (such as *.faces) or some other extension.

Specified by:

isExtensionMapped in interface FacesView

Returns:

true if extension-mapped, otherwise false.

isPathMapped

public boolean isPathMapped()

Description copied from interface: FacesView

Flag indicating whether or not the view is mapped to the FacesServlet via path-mapping (such as /faces/views/*) or some other extension.

Specified by:

isPathMapped in interface FacesView

Returns:

true if extension-mapped, otherwise false.

isServletMapped

public boolean isServletMapped()

getExtension

public String getExtension()

Description copied from interface: FacesView

Determines the extension (such as *.faces) used by the extension-mapped servlet-mapping.

Specified by:

getExtension in interface FacesView

Returns:

If the view is extension-mapped, returns the extension. Otherwise, returns null.

getQueryString

public String getQueryString()

Description copied from interface: FacesView

Returns the query-string which may contain navigation parameters such as Bridge.PORTLET_MODE_PARAMETER, Bridge.NONFACES_TARGET_PATH_PARAMETER, Bridge.PORTLET_SECURE_PARAMETER, Bridge.PORTLET_WINDOWSTATE_PARAMETER, Bridge.FACES_VIEW_ID_PARAMETER, or Bridge.FACES_VIEW_PATH_PARAMETER. Note that "navigation" does not refer to JSF navigation-rules, but rather changes in PortletMode, WindowState, etc. It could also contain user-define name=value parameters specified in a Bridge.VIEW_ID request attribute.

Specified by:

getQueryString in interface FacesView

getServletPath

public String getServletPath()

Description copied from interface: FacesView

Determines the servlet-path (such as /faces/views) used by the path-mapped servlet-mapping.

Specified by:

getServletPath in interface FacesView

Returns:

If the view is path-mapped, returns the path. Otherwise, returns null.

getViewId

public String getViewId()

Description copied from interface: FacesView

Returns the viewId associated with this view.

Specified by:

getViewId in interface FacesView