public class

PageInfo

extends AbstractConfigurationElement
java.lang.Object
   ↳ com.microstrategy.utils.config.AbstractConfigurationElement
     ↳ com.microstrategy.web.app.PageInfo

Class Overview

A PageInfo 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 are available from here.

Summary

Constants
String ATT_ALLOW_CANCEL
String ATT_BINARY_DISPLAY
String ATT_BINARY_DISPLAY_BEAN
String ATT_CACHE_CONTROL
String ATT_DEFAULT
String ATT_DESCRIPTION
String ATT_DESC_ID
String ATT_EVENT_HANDLER
String ATT_FEATURE_ID
String ATT_HELP_TOPIC
String ATT_ISPROMPT
String ATT_LOGIN_REQUIRED
String ATT_NAME
String ATT_PAGE_CLASS
String ATT_PERSIST_MODE
String ATT_SHOW_RECOVER_LINK Flag indicating whether the page support automatic session recovery feature by displaying a recovery link to last messageID.
String ATT_TITLE_BEAN
String ATT_TRACK
String ATT_USE_RESOURCE_MGR
String NODE_PAGE
[Expand]
Inherited Constants
From class com.microstrategy.utils.config.AbstractConfigurationElement
Public Constructors
PageInfo()
Class constructor.
PageInfo(Node root)
Class constructor.
PageInfo(Node root, PageInfo defaultPage)
Class constructor.
Public Methods
AddonInfoList getAddOns()
Get the list of add-ons related to this page
boolean getAllowCancel()
Returns if this object be used as destination when a cancel event occurs.
String getBinaryDisplay()
This method is deprecated. Use getBinaryDisplayBean instead.
String getBinaryDisplayBean()
Get the binary display information related with this page
String getCacheControl()
return the value for the ATT_CACHE_CONTROL attribute
String getDescription()
Get the String description related with this page
String getDescriptorID()
Get the descriptor ID related with this page
String getEventHandlerClass()
Get the name of the class related with the event handler for this page
EventMapList getEventMapList()
Get the list of event mapping related to this page
String getFeatureId()
Get the feature Id associated with this page.
String getHelpTopic()
return the value for the ATT_HELP_TOPIC attribute
JavaScriptInfoList getJavaScripts()
Get the list of javascripts related to this page
String getMessage(Messages messages)
Get the page's localized description based on the descriptor information used for initializing this instance
String getName()
Get the page name related with this instance
String getPageComponentClass()
Get the name of the class related with the event handler for this page
WebComponent getPageInstance(AppContext appContext, ComponentInitializationContext initContext)
Generate the WebComponent instance related with the page information stored
WebComponent getPageInstance(AppContext appContext)
Generate the WebComponent instance related with the page information stored
String getPrototypeAttribute()
return the name of the inherited page stored as prototype attribute
boolean getShowRecoverLink()
Get flag indicating whether this page can support show last message recovery link.
TemplateInfoList getTemplateInfoList()
Get the TemplateInfo instance for this page.
String getTitleBean()
String getUseResourceManager()
return the value for the ATT_USE_RESOURCE_MGR attribute
WebBeanInfoList getWebBeanInfoList()
Get the list of beans defined for this page
boolean isDefault()
Get the isDefault flag for this Page instance.
boolean isLoginRequired()
Get if login is required for accessing this page
boolean isPersistable()
Verifies if this page instance is persistable or not.
boolean isPrompt()
return the value for the ATT_ISPROMPT attribute
boolean isRelatedToPage(PageInfo page)
Indicated whether the page shares common executable beans with another page.
boolean isTrack()
Returns if this object should be traced as visited link or not.
void setAddOns(AddonInfoList addonInfoList)
Set the AddonInfoList on the page to the given list
void setAllowCancel(boolean allowCancel)
Sets if this object be used as destination when a cancel event occurs.
void setBinaryDisplay(String binaryDisplayBean)
This method is deprecated. Use SetBinaryDisplayBean instead.
void setBinaryDisplayBean(String binaryDisplayBean)
Set the binary display information related with this page
void setCacheControl(String cacheControl)
set the value for the ATT_CACHE_CONTROL attribute
void setDescription(String description)
Set the text descriptor of this page to the given parameter
void setDescriptorID(String descriptorID)
Set the descriptor ID of this page to the given parameter
void setEventHandlerClass(String eventHandlerClass)
Set the name of the class for the event handler of this page.
void setEventMapList(EventMapList eventMapList)
Set the list of event mappings on the page
void setFeatureId(String featureId)
Sets the name of the class for the event handler of this page.
void setHelpTopic(String helpTopic)
set the value for the ATT_HELP_TOPIC attribute
void setIsDefault(boolean isDefault)
Set the isDefault flag for this Page instance
void setIsLoginRequired(boolean loginRequired)
Set if login is required for accessing this page
void setIsPrompt(Boolean isPrompt)
set the value for the ATT_ISPROMPT attribute
void setIsTrack(boolean isTrack)
Sets if this object should be traced as visited link or not.
void setJavaScripts(JavaScriptInfoList javaScriptInfoList)
Set the list of javascripts on the page
void setName(String pageName)
Set the page's name to the given parameter
void setPageComponentClass(String className)
Set the name of the class for the component instance of this page.
void setPersistMode(int persistMode)
Sets the persist mode property of this object.
void setPrototype(AbstractConfigurationElement prototype)
Sets the prototype object for this instance.
void setPrototypeAttribute(String prototype)
set the name of the inherited page as prototype attribute
void setShowRecoverLink(boolean showRecoverLink)
Set flag indicating whether this page can support show last message recovery link.
void setTemplateInfoList(TemplateInfoList templateInfoList)
Set the list of template infos on the page
void setTitleBean(String value)
void setUseResourceManager(String useResourceMgr)
set the value for the ATT_USE_RESOURCE_MGR attribute
void setWebBeanInfoList(WebBeanInfoList webBeanInfoList)
Set the WebBeanInfoList on the page to the given list
Protected Methods
String getKeyAttribute()
This method must return the attribute that uniquely identifies this element among its siblings; if no single attribute can be used, return null and override the getKey and setKey methods.
void initDefaultAttributes()
This method can be overridden to set default values for attributes.
void initPrototype(String protoName)
Inits the prototype object of this element.
[Expand]
Inherited Methods
From class com.microstrategy.utils.config.AbstractConfigurationElement
From class java.lang.Object
From interface com.microstrategy.utils.config.ConfigurationElement
From interface com.microstrategy.utils.config.ConfigurationFile

Constants

public static final String ATT_ALLOW_CANCEL

Constant Value: "allow-cancel"

public static final String ATT_BINARY_DISPLAY

Constant Value: "binary-display"

public static final String ATT_BINARY_DISPLAY_BEAN

Constant Value: "binary-display-bean"

public static final String ATT_CACHE_CONTROL

Constant Value: "cache-control"

public static final String ATT_DEFAULT

Constant Value: "default"

public static final String ATT_DESCRIPTION

Constant Value: "desc"

public static final String ATT_DESC_ID

Constant Value: "desc-id"

public static final String ATT_EVENT_HANDLER

Constant Value: "event-handler"

public static final String ATT_FEATURE_ID

Constant Value: "feature-id"

public static final String ATT_HELP_TOPIC

Constant Value: "help-topic"

public static final String ATT_ISPROMPT

Constant Value: "isPrompt"

public static final String ATT_LOGIN_REQUIRED

Constant Value: "login-required"

public static final String ATT_NAME

Constant Value: "name"

public static final String ATT_PAGE_CLASS

Constant Value: "class"

public static final String ATT_PERSIST_MODE

Constant Value: "persist-mode"

public static final String ATT_SHOW_RECOVER_LINK

Flag indicating whether the page support automatic session recovery feature by displaying a recovery link to last messageID.

Constant Value: "show-recover-link"

public static final String ATT_TITLE_BEAN

Constant Value: "title-bean"

public static final String ATT_TRACK

Constant Value: "track"

public static final String ATT_USE_RESOURCE_MGR

Constant Value: "useResourceMgr"

public static final String NODE_PAGE

Constant Value: "page"

Public Constructors

public PageInfo ()

Class constructor. Initializes a new -empty- instance of the Page class.

public PageInfo (Node root)

Class constructor. Initializes a Page instance based on the information included on the XML Node

Parameters
root Node instance representing the Page information.

public PageInfo (Node root, PageInfo defaultPage)

Class constructor. Initializes a Page with the information based on the XML Node and the default page instance.

Parameters
root Node instance representing the Page information.
defaultPage Template page for defining the default properties if required

Public Methods

public AddonInfoList getAddOns ()

Get the list of add-ons related to this page

Returns
  • an instance of AddonInfoList containing the list of add-ons defined for this page.

public boolean getAllowCancel ()

Returns if this object be used as destination when a cancel event occurs.

Returns
  • true if this page can receive the cancel event.

public String getBinaryDisplay ()

This method is deprecated.
Use getBinaryDisplayBean instead.

Get the binary display information related with this page

Returns
  • the bean name (or bean hierarchy) that will be displayed as binary output

public String getBinaryDisplayBean ()

Get the binary display information related with this page

Returns
  • the bean name (or bean hierarchy) that will be displayed as binary output

public String getCacheControl ()

return the value for the ATT_CACHE_CONTROL attribute

public String getDescription ()

Get the String description related with this page

Returns
  • the text description of this page

public String getDescriptorID ()

Get the descriptor ID related with this page

Returns
  • the descriptor ID for this page

public String getEventHandlerClass ()

Get the name of the class related with the event handler for this page

Returns
  • the name of the class for the event handler of this page.

public EventMapList getEventMapList ()

Get the list of event mapping related to this page

Returns
  • an instance of EventMapList containing the list of events that need to be mapped.

public String getFeatureId ()

Get the feature Id associated with this page. The feature Id controls whether the page is visible or not depending on user privileges and application settings.

Returns
  • the feature Id associated with this page.

public String getHelpTopic ()

return the value for the ATT_HELP_TOPIC attribute

public JavaScriptInfoList getJavaScripts ()

Get the list of javascripts related to this page

Returns
  • an instance of JavaScriptInfoList containing the list of JavaScripts defined for this page.

public String getMessage (Messages messages)

Get the page's localized description based on the descriptor information used for initializing this instance

Parameters
messages the Messages localization instance.
Returns
  • the page's localized descriptor, or the description if the descriptionId is empty.

public String getName ()

Get the page name related with this instance

Returns
  • the page name

public String getPageComponentClass ()

Get the name of the class related with the event handler for this page

Returns
  • the name of the class for the event handler of this page.

public WebComponent getPageInstance (AppContext appContext, ComponentInitializationContext initContext)

Generate the WebComponent instance related with the page information stored

Parameters
appContext the AppContext object with information about the application.
initContext the ComponentInitializationContext onject with initialization information the beans will require to initialize
Returns
  • an instance of a PageComponent initialized based on the information on this pageWebComponent instance related to the current page
Throws
WebAppException if an error occurs while initialization.

public WebComponent getPageInstance (AppContext appContext)

Generate the WebComponent instance related with the page information stored

Parameters
appContext the AppContext object with information about the application.
Returns
  • an instance of a PageComponent initialized based on the information on this page
Throws
WebAppException if an error occurs while initialization.

public String getPrototypeAttribute ()

return the name of the inherited page stored as prototype attribute

Returns
  • name of the inherited page

public boolean getShowRecoverLink ()

Get flag indicating whether this page can support show last message recovery link.

Returns
  • true if this page can support automatic session recovery

public TemplateInfoList getTemplateInfoList ()

Get the TemplateInfo instance for this page.

Returns
  • the TemplateInfo instance containing information used by the output page to render. Usage: getTemplateInfo() was replaced with getTemplateInfoList().getTemplateInfo(EnumRequestStatus.WebBeanRequestSuccessful)

public String getTitleBean ()

public String getUseResourceManager ()

return the value for the ATT_USE_RESOURCE_MGR attribute

public WebBeanInfoList getWebBeanInfoList ()

Get the list of beans defined for this page

Returns

public boolean isDefault ()

Get the isDefault flag for this Page instance. The default page is used by the PageManager to serve as template when creating other pages.

Returns
  • the true/false value of the isDefault flag of this Page

public boolean isLoginRequired ()

Get if login is required for accessing this page

Returns
  • the true/false value of the loginRequired flag of this Page

public boolean isPersistable ()

Verifies if this page instance is persistable or not.

Returns
  • true if the page's persist mode property has assigned any valid value different than EnumBeanPersistMode.BeanPersistModeDefault, otherwise, returns false.

public boolean isPrompt ()

return the value for the ATT_ISPROMPT attribute

public boolean isRelatedToPage (PageInfo page)

Indicated whether the page shares common executable beans with another page.
AN executable bean could be a Report Bean, a RW Bean or a Document Bean.

Parameters
page a PageInfo instance.

public boolean isTrack ()

Returns if this object should be traced as visited link or not. Only tracks are maintained by the application for last visted pages.

Returns
  • true if this page is a track of the application.

public void setAddOns (AddonInfoList addonInfoList)

Set the AddonInfoList on the page to the given list

Parameters
addonInfoList The new AddonInfoList to be set on the page

public void setAllowCancel (boolean allowCancel)

Sets if this object be used as destination when a cancel event occurs.

Parameters
allowCancel true if if this page can receive the cancel event.

public void setBinaryDisplay (String binaryDisplayBean)

This method is deprecated.
Use SetBinaryDisplayBean instead.

Set the binary display information related with this page

Parameters
binaryDisplayBean the bean name (or bean hierarchy) that will be displayed as binary output

public void setBinaryDisplayBean (String binaryDisplayBean)

Set the binary display information related with this page

Parameters
binaryDisplayBean the bean name (or bean hierarchy) that will be displayed as binary output

public void setCacheControl (String cacheControl)

set the value for the ATT_CACHE_CONTROL attribute

Parameters
cacheControl The values can be "on", "off", "auto" (read from preference)

public void setDescription (String description)

Set the text descriptor of this page to the given parameter

Parameters
description the description of this page.

public void setDescriptorID (String descriptorID)

Set the descriptor ID of this page to the given parameter

Parameters
descriptorID a descriptorID from the

public void setEventHandlerClass (String eventHandlerClass)

Set the name of the class for the event handler of this page.

Parameters
eventHandlerClass a fully qualified class name to use as EventHandler for this page.

public void setEventMapList (EventMapList eventMapList)

Set the list of event mappings on the page

Parameters
eventMapList The list of event maps to be set on the page

public void setFeatureId (String featureId)

Sets the name of the class for the event handler of this page.

Parameters
featureId the feature Id associated with this page.

public void setHelpTopic (String helpTopic)

set the value for the ATT_HELP_TOPIC attribute

public void setIsDefault (boolean isDefault)

Set the isDefault flag for this Page instance

Parameters
isDefault true/false value

public void setIsLoginRequired (boolean loginRequired)

Set if login is required for accessing this page

Parameters
loginRequired true/false value

public void setIsPrompt (Boolean isPrompt)

set the value for the ATT_ISPROMPT attribute

Parameters
isPrompt The values can be "true", "false"

public void setIsTrack (boolean isTrack)

Sets if this object should be traced as visited link or not. Only tracks are maintained by the application for last visted pages.

Parameters
isTrack true if this page is a track of the application.

public void setJavaScripts (JavaScriptInfoList javaScriptInfoList)

Set the list of javascripts on the page

Parameters
javaScriptInfoList The javascripts list to be set on the page

public void setName (String pageName)

Set the page's name to the given parameter

Parameters
pageName the new name of the page

public void setPageComponentClass (String className)

Set the name of the class for the component instance of this page.

Parameters
className a fully qualified class name to use as component instance for this page.

public void setPersistMode (int persistMode)

Sets the persist mode property of this object. The default assigned to it is to save it.

Parameters
persistMode value of the setting to assign.

public void setPrototype (AbstractConfigurationElement prototype)

Sets the prototype object for this instance. The attributes and elements of the prototype are copied into this instance.

public void setPrototypeAttribute (String prototype)

set the name of the inherited page as prototype attribute

Parameters
prototype name of the inherited page

public void setShowRecoverLink (boolean showRecoverLink)

Set flag indicating whether this page can support show last message recovery link.

public void setTemplateInfoList (TemplateInfoList templateInfoList)

Set the list of template infos on the page

Parameters
templateInfoList The TemplateInfoList to be set on the page

public void setTitleBean (String value)

public void setUseResourceManager (String useResourceMgr)

set the value for the ATT_USE_RESOURCE_MGR attribute

Parameters
useResourceMgr The values can be "on", "off", "renderInline"

public void setWebBeanInfoList (WebBeanInfoList webBeanInfoList)

Set the WebBeanInfoList on the page to the given list

Parameters
webBeanInfoList The new WebBeanInfoList to be set on the page

Protected Methods

protected String getKeyAttribute ()

This method must return the attribute that uniquely identifies this element among its siblings; if no single attribute can be used, return null and override the getKey and setKey methods.

protected void initDefaultAttributes ()

This method can be overridden to set default values for attributes. Simply extend this method and call setAttribute(String, Object)

protected void initPrototype (String protoName)

Inits the prototype object of this element. This element will inherit all the attribute and child elements from the prototype, but then any values defined through the config-src file or inline take precedence over the prototype. The name attribute represents the name of the prototype as specified in the XML. Typically this is the name of a sibling node in the xml. If name is empty, a different sibling might be used as prototype (like in the case of the PageInfo, which the page marked as isDefault is used as the default prototype). If this object already has a prototype, or if the prototype is not found in the siblings collections this methods throws an Exception.

Parameters
protoName Prototype name, typically the name of a sibling node in the xml.