public interface

PageComponent

implements AppComponent
com.microstrategy.web.app.beans.PageComponent
Known Indirect Subclasses

Class Overview

A PageComponent class instance represents the information regarding a page that can be handled by the Web Application. All the details required for displaying one page on the application is available from here.
It has a PageInfo class associated. This PageInfo contains the structure as defined in the pageConfig.xml Things like BeanList and Bean Properties are retrieved from here.

Summary

Constants
int REMOVE_PAGE Used by saveReturnToPage(int mode) to indicate the page link in the return to browser setting should be removed
int STORE_PAGE Used by saveReturnToPage(int mode) to add a page's link to the browser setting
[Expand]
Inherited Constants
From interface com.microstrategy.web.app.beans.AppComponent
Public Methods
abstract void cleanUp()
Performs any necessary clean up tasks before leaving the page.
abstract boolean executeCollectDataRequiredAddons(WebComponent wc)
Checks if the different addons associated with the WebComponent require a collect data to be performed.
abstract void executePostCollectDataAddons()
Executes the post collect data addons on the page in the order in which they appear in the pageconfig file.
abstract void executePreCollectDataAddons()
Executes the addons on the page in the order in which they appear in the pageconfig file.
abstract String getContactInfo()
Returns the administrator contact info for this application.
abstract ContextMenuManager getContextMenuManager()
This method is deprecated. This method is not used by the application and will be removed in future versions.
abstract int getDebugFlags()
Get the decimal-format debug flags from the page
abstract MarkupOutput getDebugOut(int debugFlags)
Get the Debug Information into the output
abstract AppBeanError getErrorInfo()
Returns the last AppBeanError set to this page.
abstract int getExplicitScreenMode()
abstract String getFontName()
Returns a string with the name of the fonts, or the list of fonts that a browser should use when rendering the page.
abstract String getFontSize()
A string with the base font size to use, the string might contain the type of size (i.e, pt, px, etc.)
abstract int getLastMessageKey()
abstract String getLastMsgID()
abstract PageInfo getPageInfo()
abstract String getRedirectURL()
Returns the URL to be send down to the browser that corresponds to the page.
abstract PageResourceManager getResourceManager()
Returns the instance of the PageResourceManager associated with the page.
abstract int getResourceManagerMode()
Returns the mode of the page manager set up on the page component.
abstract int getScreenMode()
Return the current page screen mode.
abstract String getTemplateFileName()
Returns the name of a template file to redirect
abstract TemplateInfo getTemplateInfo()
Returns the TemplateInfo to use with this page
abstract String getTitle()
Returns the pages's title.
abstract WebIServerSession getWebIServerSession()
abstract String getXMLStatusPageName()
Returns the name of the page in the Page Framework that will be displayed for the current page and xml status combination.
abstract boolean hasBinaryContent()
abstract boolean hasXMLStatusPage()
Returns true if a page in the Page Framework will be displayed for the current page and xml status combination.
abstract boolean isRedirect()
Indicates if the page will be sent down as a redirect response (HTTP 302) instead of an ok response (HTTP 200)
abstract boolean isRestoredFromPageHistory()
abstract boolean isStagePage()
Returns true if this page is just a stage page which acts as a bridge between two pages.
abstract void processApplyChanges(String pageName)
The method will be responsible for executing the apply events to those beans that require to so, when the page is about to change
abstract void saveLastPage()
Saves the information of the last succesful page so it can be restored by the cancel event.
abstract void saveReturnToPage(int mode)
Saves the information of the last visited page so it can be restored by the returnTo event.
abstract void setErrorInfo(AppBeanError error)
Associates an AppBeanError with the page.
abstract void setExplicitScreenMode(int screenMode)
Use to set the explicit screen mode.
abstract void setIsRedirect(boolean redirect)
Sets the page as a redirect response (HTTP 302) instead of an ok response (HTTP 200)
abstract void setPageInfo(PageInfo page)
This method sets the current PageInfo (the object with the current Page structure).
abstract void setRestoredFromPageHistory(boolean value)
abstract void setScreenMode(int screenMode)
Set the screenMode of the page.
abstract void setStagePage(boolean isStagePage)
Sets the page as a stage page which acts as a bridge between two pages.
abstract void setTemplateFileName(String value)
Sets the name of a template file to redirect
abstract void setTitle(String title)
Define the alias that the page will display when called.
abstract void setWebIServerSession(WebIServerSession session)
abstract void switchPage(String pageName, ServletWebComponent servletWebComponent)
Replaces the current page in the Servlet with the indicated page
[Expand]
Inherited Methods
From interface com.microstrategy.web.app.beans.AppComponent
From interface com.microstrategy.web.beans.Transformable
From interface com.microstrategy.web.beans.WebComponent

Constants

public static final int REMOVE_PAGE

Used by saveReturnToPage(int mode) to indicate the page link in the return to browser setting should be removed

Constant Value: 0 (0x00000000)

public static final int STORE_PAGE

Used by saveReturnToPage(int mode) to add a page's link to the browser setting

Constant Value: 1 (0x00000001)

Public Methods

public abstract void cleanUp ()

Performs any necessary clean up tasks before leaving the page.
Called when event WebEventOpenHistoryPage is submited

public abstract boolean executeCollectDataRequiredAddons (WebComponent wc)

Checks if the different addons associated with the WebComponent require a collect data to be performed.

Parameters
wc WebComponent instance that will have its addon methods called
Returns
  • boolean value indicating if the collectData is required or not

public abstract void executePostCollectDataAddons ()

Executes the post collect data addons on the page in the order in which they appear in the pageconfig file.

public abstract void executePreCollectDataAddons ()

Executes the addons on the page in the order in which they appear in the pageconfig file.

public abstract String getContactInfo ()

Returns the administrator contact info for this application.

Returns
  • The admin contact info.

public abstract ContextMenuManager getContextMenuManager ()

This method is deprecated.
This method is not used by the application and will be removed in future versions.

Returns

public abstract int getDebugFlags ()

Get the decimal-format debug flags from the page

public abstract MarkupOutput getDebugOut (int debugFlags)

Get the Debug Information into the output

Returns

public abstract AppBeanError getErrorInfo ()

Returns the last AppBeanError set to this page. If no errors have been associated to this page it returns null.

Returns
  • the AppBeanError associated with the execution of the page.

public abstract int getExplicitScreenMode ()

Returns
  • integer value representing the explicit screen mode selected

public abstract String getFontName ()

Returns a string with the name of the fonts, or the list of fonts that a browser should use when rendering the page. This is usually retrieved from user Preferences

Returns
  • a String with a comma separated list of the fonts to use in this page.

public abstract String getFontSize ()

A string with the base font size to use, the string might contain the type of size (i.e, pt, px, etc.)

Returns
  • a string with size of the font to use

public abstract int getLastMessageKey ()

public abstract String getLastMsgID ()

public abstract PageInfo getPageInfo ()

Returns
  • the current PageInfo (that holds the Page structure)

public abstract String getRedirectURL ()

Returns the URL to be send down to the browser that corresponds to the page.

Returns
  • a URL String

public abstract PageResourceManager getResourceManager ()

Returns the instance of the PageResourceManager associated with the page. Returns null if the resource manager is disabled.

Returns

public abstract int getResourceManagerMode ()

Returns the mode of the page manager set up on the page component. The values are defined in the PageResourceManager class

Returns
  • the current mode of the page resource manager for this page.

public abstract int getScreenMode ()

Return the current page screen mode.

Returns
  • page screen mode.

public abstract String getTemplateFileName ()

Returns the name of a template file to redirect

Returns
  • a file name.

public abstract TemplateInfo getTemplateInfo ()

Returns the TemplateInfo to use with this page

Returns

public abstract String getTitle ()

Returns the pages's title.

Returns
  • The title of this page

public abstract WebIServerSession getWebIServerSession ()

Returns
  • The WebIServerSession used by this page. If this page is not using a session, it returns null;

public abstract String getXMLStatusPageName ()

Returns the name of the page in the Page Framework that will be displayed for the current page and xml status combination. This is defined at the template level in the pageConfig.xml file

Returns
  • String. Page Name from pageConfig.xml

public abstract boolean hasBinaryContent ()

Returns
  • true if the page would generate binary content in it's output

public abstract boolean hasXMLStatusPage ()

Returns true if a page in the Page Framework will be displayed for the current page and xml status combination. This is defined at the template level in the pageConfig.xml file

Returns
  • true is a page Name has been defined in pageConfig.xml

public abstract boolean isRedirect ()

Indicates if the page will be sent down as a redirect response (HTTP 302) instead of an ok response (HTTP 200)

Returns
  • boolean value indicating if the the page will be displayed as a redirect (HTTP 302) response

public abstract boolean isRestoredFromPageHistory ()

public abstract boolean isStagePage ()

Returns true if this page is just a stage page which acts as a bridge between two pages.

Returns
  • true is this page is a stage page.

public abstract void processApplyChanges (String pageName)

The method will be responsible for executing the apply events to those beans that require to so, when the page is about to change

Parameters
pageName The name of the new page
Throws
WebException
WebException

public abstract void saveLastPage ()

Saves the information of the last succesful page so it can be restored by the cancel event.

public abstract void saveReturnToPage (int mode)

Saves the information of the last visited page so it can be restored by the returnTo event.

Parameters
mode int value indicating the type of action that should be performed about the return to page information. Values includeSTORE_PAGE and REMOVE_PAGE.

public abstract void setErrorInfo (AppBeanError error)

Associates an AppBeanError with the page. If an error occurred during the page initialization/execution, this error should be set. It's responsibility of the display later (i.e., the JSP) to display this error to the end user.

Parameters
error The last error on this page. null if none happened

public abstract void setExplicitScreenMode (int screenMode)

Use to set the explicit screen mode.

public abstract void setIsRedirect (boolean redirect)

Sets the page as a redirect response (HTTP 302) instead of an ok response (HTTP 200)

Parameters
redirect boolean value indicating if the the page will be displayed as a redirect (HTTP 302) response

public abstract void setPageInfo (PageInfo page)

This method sets the current PageInfo (the object with the current Page structure). The PageInfo should be the one used to create this component.

Parameters
page Page object

public abstract void setRestoredFromPageHistory (boolean value)

public abstract void setScreenMode (int screenMode)

Set the screenMode of the page. Screen mode can be normal screen mode (screenMode = 1), full screen mode (screenMode = 2), or default to normal screen mode (screenMode = 0).

public abstract void setStagePage (boolean isStagePage)

Sets the page as a stage page which acts as a bridge between two pages.

Parameters
isStagePage boolean value indicating if the the page is a stagePage.

public abstract void setTemplateFileName (String value)

Sets the name of a template file to redirect

Parameters
value String value indicating the template file name to use.

public abstract void setTitle (String title)

Define the alias that the page will display when called.

Parameters
title String with the title of the page. User setTitle

public abstract void setWebIServerSession (WebIServerSession session)

Parameters
session The WebIServerSession to be used by this page.

public abstract void switchPage (String pageName, ServletWebComponent servletWebComponent)

Replaces the current page in the Servlet with the indicated page

Throws
WebException When it fails to redirects to the target page.
WebBeanException