lumis.portal.page.context
Class PageContext

java.lang.Object
  lumis.portal.page.context.PageContext

All Implemented Interfaces:

IPageContext

public class PageContext
extends Object
implements IPageContext

Object that contains information on the page context.

This object contains a PageConfig object as well as any runtime information that may be required for rendering. Internally it calls the configured PageRuntimeDataProvider implementation for the current page to retrieve the runtime information.

Since:

4.2.0

Constructor Summary

PageContext()

Method Summary

PageConfig	getPageConfig() Returns the page configuration previously set.
PageRuntimeData	getPageRuntimeData() Returns the runtime information of the page.
HttpServletRequest	getRequest() Returns the page parameters previously set.
boolean	isPreviewModeEnabled() Returns if the user is in preview mode or not.
void	setPageConfig(PageConfig pageConfig) Sets the page configuration.
void	setPreviewModeEnabled(boolean previewModeEnabled)
void	setRequest(HttpServletRequest request) Sets the page parameters.

Methods inherited from class java.lang.Object

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

Constructor Detail

PageContext

public PageContext()

Method Detail

getPageConfig

public PageConfig getPageConfig()

Returns the page configuration previously set.

Specified by:

getPageConfig in interface IPageContext

Returns:

the page configuration.

setPageConfig

public void setPageConfig(PageConfig pageConfig)

Sets the page configuration.

Parameters:

pageConfig -

Since:

4.2.0

getRequest

public HttpServletRequest getRequest()

Returns the page parameters previously set.

Specified by:

getRequest in interface IPageContext

Returns:

the current HTTPServletRequest object.

setRequest

public void setRequest(HttpServletRequest request)

Sets the page parameters.

Parameters:

parameters -

Since:

4.2.0

getPageRuntimeData

public PageRuntimeData getPageRuntimeData()
                                   throws PortalException

Returns the runtime information of the page.

Returns:

the runtime data

Throws:

PortalException

Since:

4.2.0

isPreviewModeEnabled

public boolean isPreviewModeEnabled()

Description copied from interface: IPageContext

Returns if the user is in preview mode or not.

Specified by:

isPreviewModeEnabled in interface IPageContext

Returns:

the preview mode of the user.

setPreviewModeEnabled

public void setPreviewModeEnabled(boolean previewModeEnabled)