com.esri.gpt.framework.jsf
Class PageContext

java.lang.Object
  com.esri.gpt.framework.jsf.PageContext

public class PageContext
extends Object

Represents the context for an active JSF based page.

The PageContext is a JSF managed bean in request scope.

Constructor Summary

PageContext()
Default constructor.

Method Summary

static PageContext	extract() Extract the PageContext from the Faces context instance.
static MessageBroker	extractMessageBroker() Extract the MessageBroker from the Faces context instance.
ApplicationConfiguration	getApplicationConfiguration() Gets application configuration.
String	getCaption() Gets the page caption.
String	getCaptionResourceKey() Gets the resource key associated with the page caption.
String	getContextPath() Gets the context path.
IdentitySupport	getIdentitySupport() Gets the supported identity functions.
String	getLanguage() Gets language code (lowercase).
MenuStyleMap	getMenuStyleMap() Gets the menu link style map.
String	getPageId() Gets the page id.
String	getPrepareView() Gets expression used to prepare view.
String	getResourceMessage(String resourceKey) Gets resource message associated with a key.
RoleMap	getRoleMap() Gets the role map associated with the active user.
String	getSiteTitle() Gets the site title.
String	getTabId() Gets tab id.
TabStyleMap	getTabStyleMap() Gets the menu link style map.
TocsByKey	getTocsByKey() Gets the toc collection map.
User	getUser() Gets the user associated with the active request.
String	getVersion() Gets the application version.
String	getWelcomeMessage() Gets the welcome message.
void	setCaption(String caption) Sets the page caption.
void	setCaptionResourceKey(String resourceKey) Sets the resource key associated with the page caption.
void	setPageId(String id) Sets the page id.
void	setPrepareView(String prepareView) Sets expression used to prepare view.
void	setTabId(String tabId) Sets tab id.

Methods inherited from class java.lang.Object

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

Constructor Detail

PageContext

public PageContext()

Default constructor.

Method Detail

getCaption

public String getCaption()

Gets the page caption.

Returns:

the caption

setCaption

public void setCaption(String caption)

Sets the page caption.

Parameters:

caption - the caption

getCaptionResourceKey

public String getCaptionResourceKey()

Gets the resource key associated with the page caption.

Returns:

the resource key

setCaptionResourceKey

public void setCaptionResourceKey(String resourceKey)

Sets the resource key associated with the page caption.

Parameters:

resourceKey - the resource key

getTabId

public String getTabId()

Gets tab id.

Returns:

tab id

setTabId

public void setTabId(String tabId)

Sets tab id.

Parameters:

tabId - tab id

getContextPath

public String getContextPath()

Gets the context path.

Returns:

the context path

getApplicationConfiguration

public ApplicationConfiguration getApplicationConfiguration()

Gets application configuration.

Returns:

application configuration

getIdentitySupport

public IdentitySupport getIdentitySupport()

Gets the supported identity functions.

Returns:

the supported identity functions

getLanguage

public String getLanguage()

Gets language code (lowercase).

Returns:

language 2-letter code

getMenuStyleMap

public MenuStyleMap getMenuStyleMap()

Gets the menu link style map.

Returns:

the menu link style map

getPageId

public String getPageId()

Gets the page id.

Returns:

the page id

setPageId

public void setPageId(String id)

Sets the page id.

Parameters:

id - the page id

getResourceMessage

public String getResourceMessage(String resourceKey)

Gets resource message associated with a key.

Returns:

the resource message

getRoleMap

public RoleMap getRoleMap()

Gets the role map associated with the active user.

Returns:

the role map

getSiteTitle

public String getSiteTitle()

Gets the site title.

Returns:

the site title

getTabStyleMap

public TabStyleMap getTabStyleMap()

Gets the menu link style map.

Returns:

the menu link style map

getTocsByKey

public TocsByKey getTocsByKey()

Gets the toc collection map.

Returns:

the toc collection map

getUser

public User getUser()

Gets the user associated with the active request.

Returns:

the user

getVersion

public String getVersion()

Gets the application version.

Returns:

the application version

getWelcomeMessage

public String getWelcomeMessage()

Gets the welcome message.

Returns:

the site title

getPrepareView

public String getPrepareView()

Gets expression used to prepare view.

Returns:

expression used to prepare view

setPrepareView

public void setPrepareView(String prepareView)

Sets expression used to prepare view.

Parameters:

prepareView - expression used to prepare view

extract

public static PageContext extract()

Extract the PageContext from the Faces context instance.

Returns:

the PageContext

extractMessageBroker

public static MessageBroker extractMessageBroker()

Extract the MessageBroker from the Faces context instance.

Returns:

the PageContext