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) Generate the WebComponent instance related with the page information stored
WebComponent	getPageInstance(AppContext appContext, ComponentInitializationContext initContext) 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

void	addFileSource(String filePath, String appPath, long lastLoaded) Adds a reference to a file from a config-source.
void	applyCustomization(CustomizationInfo c) Applies the corresponding customizations.
void	applyCustomizations() Loops through all the `CustomizationInfo` in the `Customizations` class and apply the corresponding customizations.
void	cleanUpDeletedElements() This method when called will delete all the child elements that are marked as deleted.
Object	clone()
void	delete(Object key)
AbstractConfigurationElement	deltas(AbstractConfigurationElement other) Returns a partial instance of this object that contains the attributes and elements required to make this object equals to the `other` paramter.
final AbstractConfigurationElement	deltas() Returns the `deltas` between the `original()` and `this` objects.
boolean	equalAtts(AbstractConfigurationElement other) Returns `true` if the list of active attributes of the given AbstractConfigurationElement is equal to this list of active attributes of this AbstractConfigurationElement.
boolean	equalElements(AbstractConfigurationElement other) Returns `true` if the list of all child elements of the given AbstractConfigurationElement is equal to this list of all child-elements of this AbstractConfigurationElement.
boolean	equalNodeValues(AbstractConfigurationElement other) Returns `true` if the node value of both configuration elements is the same.
boolean	equals(Object object)
boolean	equalsIncludingDeletedElements(Object object)
void	exportAttributesToXML(Element element, ConfigurationSource source) Appends the list of attributes of this `ConfigurationElement` into the given node.
void	exportElementsToXML(Element element, ConfigurationSource source) Appends the list of child-elements of this `ConfigurationElement` into the given node.
void	exportNodeValueToXML(Element element, ConfigurationSource source) Appends the node value associated with the given source key into the given node.
final ConfigurationValue	getAttribute(String name) Returns the value associated with the given attribute.
HashList	getAttributes() Returns the list of all attributes available to this ConfigurationElement.
boolean	getBoolAttribute(String name) Helper method, returns the value of the given attribute as boolean (true/false).
Object	getChildKey(Node node) Returns the key that uniquely identifies the child element associated with the given `Node`.
String	getConfigSrc() Returns the value of the config-src attribute.
String	getDTDFileName() Returns the name of a DTD file that will be added as SystemID to the XML resulting from serializing the contents of this ConfigurationElement into a file; `null` by default.
ConfigurationElement	getElement(Object key, boolean includeDeleted)
ConfigurationElement	getElement(Object key) Returns the `ConfigurationElement` instance associated with the given nodeName.
final HashList	getElements() Returns the list of all child-elements available to this ConfigurationElement.
FileLoader	getFileLoader() Returns the file loader instance used by this ConfigurationElement to load files from the file system.
int	getIntAttribute(String name, int defaultValue) Helper method, returns the value of the given attribute as integer.
int	getIntAttribute(String name) Helper method, returns the value of the given attribute as integer.
Object	getKey() Default implementation for `getKey()`.
abstract 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.
int	getLineNumber() Returns the line number (if known) of the element in the XML file.
AbstractConfigurationElement.FilteredList	getList(String nodeName) Returns an `ImplicitList` with all the elements associated with the given `nodeName`.
Object	getNextKey() Returns an object that can be used as key for a list of child-elements that doesn't have a key by itself.
String	getNodeName() Returns the node-name for this element.
String	getNodeValue() Returns the node value for this element.
String	getNodeValue(ConfigurationSource source) Returns the node value for this element in the given sourceKey.
AbstractConfigurationElement	getOrCreateElement(String nodeName, Object key) Returns the current child instance; if null but the child is registered, it creates a new instance for it.
AbstractConfigurationElement	getParent() Gets the parent for this configuration element.
int	getPosition() Returns the expected position of this element.
AbstractConfigurationElement	getPrototype() Returns the current prototype of this instance.
Class	getRegisteredClass(String nodeName) Returns the `Class` associated with the given `nodeName`.
String	getSelfInitPath() Returns the path to the file where this configuration element was originally loaded from.
ConfigurationSource	getSource(String key) Gets the `ElementSource` for the given key.
String	getStrAttribute(String name) Helper method, returns the value of the given attribute as a string.
boolean	getUseDefault() Returns the use-default value.
ParserParameters	getXMLParserParameters(String fileName) Returns an instance of `ParserParameters` used by the XML parser.
SerializerParameters	getXMLSerializerParameters() Returns an instance of `SerializerParameters` used by the XML serializer in the `toXML()` By default it returns `null`.
boolean	hasRegisteredClass(String nodeName) Returns `true` is there is a child registered for the given `nodeName`.
int	hashCode()
int	hashCodeAtts() Returns the hashcode for attributes.
int	hashCodeElements() Returns the hashcode for attributes.
int	hashCodeNodeValues() Returns the hashcode for attributes.
void	initAttributesFromXML(Node root, String sourceKey, CustomizationInfo c) Initializes the list of attributes from given `Node`
void	initDefaultAttributes() This method can be overridden to set default values for attributes.
void	initElementFromXML(Node child, String sourceKey, CustomizationInfo c) Initializes a single child-element from the given `Node`
void	initElementsFromXML(Node root, String sourceKey, CustomizationInfo c) Initializes the list of child-elements from given `Node`
void	initFromFile(String filePath, CustomizationInfo c) Initializes this configuration element by loading the contents of the given `filePath` using the corresponding `CustomizationInfo`.
void	initFromResource(String resourceName) Initializes this configuration element by loading the contents a resource that exists in the class path.
void	initFromXML(Node root, String sourceKey, CustomizationInfo c) Initialize the attributes and child elements from the values in the given `Node`
void	initFromXML(Node root) Initialize the attributes and child elements from the values in the given `Node`
void	initNodeValueFromXML(Node root, String sourceKey, CustomizationInfo c) Initializes the list of child-elements from given `Node`
void	initPrototype(String protoName) Inits the prototype object of this element.
boolean	isActive()
boolean	isCustomized()
boolean	isDeleted() Returns `true` is this element has been mark as deleted.
boolean	isDirty() Returns `true` is this element or one of its children has been modified programatically after being loaded.
boolean	isInSource(String sourceKey) Returns `true` if the element already contains an `ElementSource` for the given key.
boolean	isKeyAttribute(String name) Returns `true` is the name is that of the key attribute.
void	load(String fileName) Loads the file with the given name and initializes this `ConfigurationElement` with its content.
void	mergeChanges(String srcKey) Removes deltas and applies them to the given source.
AbstractConfigurationElement	newChildInstance(String nodeName, Class childClass) Creates a new instance of a child element for the given class.
ConfigurationSource	newSource(String srcKey, CustomizationInfo c) Create a new `ElementSource` and adds to the list of sources of this element.
final AbstractConfigurationElement	original() Returns a new instance of this object, populated only with the out of the box values of Microstrategy Web, that is, only default values or those that came from the load method.
ConfigurationElement	populate(ConfigurationElement other) This method takes another configuration element and populates this element with the other's attributes and child-elements.
void	printAttributes(StringBuffer outString) Appends the list of attributes of this `ConfigurationElement` into the given `StringBuffer`.
void	printElements(StringBuffer outString) Appends the list of child-elements of this `ConfigurationElement` into the given `StringBuffer`.
void	printNodeValue(StringBuffer outString) Appends the node value into the given `StringBuffer`.
void	refreshLists()
void	registerClass(String nodeName, Class c) Registers a child class for the child with the given `nodeName`.
void	registerElement(String nodeName, Class c) Register a child of this `ConfigurationElement`.
void	registerElement(String nodeName, Class c, boolean canBeNull) Register a child of this `ConfigurationElement`.
void	registerElementList(String nodeName, Class c) Register a list of this `ConfigurationElement`.
void	reload() Loops through all the `ElementSource` of this `ConfigurationElement` and reloads the content of those whose underlying configuration file has changed.
void	reloadPrototype() Loops through all the `ElementSource` of this `ConfigurationElement` and reloads the content of those whose underlying configuration file has changed.
void	removeAttribute(String name) Completely remove the value for the given attribute.
void	removeDefaults(CustomizationInfo c) This method is called when the use-default attribute is set false, so all previous values of attributes and children must be cleared.
void	replaceList(AbstractConfigurationElement.FilteredList list)
void	restore(Object key)
void	save(CustomizationInfo c) Saves deltas for this `ConfigurationElement` into the given CustomizationInfo.
void	save() Saves this `ConfigurationElement` back into the files where it was loaded from.
void	saveChangesAs(String fileName) Saves all in-memory changes to the given file.
final void	saveConfig(String filePath) This method is deprecated. To save in a different location, set a custom FileLoader and use the save() method.
void	saveFlatXML(String fileName) Saves the current element structure, in XML format, into the given file.
void	saveNode(Node node, String fileLocation) Saves an XML node into a file in the given location.
void	saveSource(ConfigurationSource source) Saves only the contents associated with the given source.
void	setAttribute(String name, Object value) Sets the value for the given attribute.
void	setBoolAttribute(String name, boolean value) Helper method, sets the value of the given attribute from a boolean.
void	setChildOriginals()
void	setConfigSrc(String path) Sets the config-src attribute.
void	setCustomized(boolean value) set if this element is a customized element or not.
void	setElement(Object key, ConfigurationElement child) Allows users to add or replace an element.
void	setFileLoader(FileLoader fl) Sets the `FileLoader` instance to be used to load files.
void	setIntAttribute(String name, int value) Helper method, sets the value of the given attribute from an integer.
void	setKey(Element element) Default implementation for `setKey()`.
void	setLineNumber(int lineNumber) Sets the line number of the element in the XML file.
void	setNodeName(String name) Sets the name of the node associated with this configuration element.
void	setNodeValue(String value) Returns the node value for this element.
void	setPosition(int position) Sets the expected position of this element.
void	setPrototype(AbstractConfigurationElement prototype) Sets the prototype object for this instance.
void	setSelfInitPath(String value)
void	setStrAttribute(String name, String value) Helper method, sets the value of the given attribute as a string.
void	setUseDefault(boolean useDefault) The definition of a ConfigurationElement can come come from different sources, for example, the definition can come from an external file (by specifying a `getConfigSrc()` value), or it can be modified through a Customization.
void	setUseValidation(boolean value) Defines whether the XML content should validated using a DTD.
String	toString() Generates the String representation of this `ConfigurationElement`.
Element	toXML(Document doc, String sourceKey) Generates the DOM representation of this `ConfigurationElement` for the list of attributes and elements defined in the given `ElementSource`.
synchronized Element	toXML(Document doc) Generates the DOM representation of this `ConfigurationElement`.
synchronized Element	toXML() Generates the DOM representation of this `ConfigurationElement`.
Element	toXML(String sourceKey) Generates the DOM representation of this `ConfigurationElement` for the list of attributes and elements defined in the given `ElementSource`.
boolean	useNodeValue() Controls whether this element will use the node value as a property.
boolean	useValidation() Returns whether the XML content should be validated using a DTD.

From class java.lang.Object

From interface com.microstrategy.utils.config.ConfigurationElement

abstract ConfigurationValue	getAttribute(String name) Returns the value associated with the given attribute.
abstract HashList	getAttributes() Returns the list of all attributes available to this ConfigurationElement.
abstract ConfigurationElement	getElement(Object nodeName) Returns the `ConfigurationElement` instance associated with the given nodeName.
abstract HashList	getElements() Returns the list of all child-elements available to this ConfigurationElement.
abstract Object	getKey() This method is used to uniquely identify this ConfigurationElement within a list.
abstract String	getNodeName() Returns the node-name for this element.
abstract String	getStrAttribute(String name)
abstract void	initFromXML(Node root) Initializes the object with information from an XML Node.
abstract void	reload() Triggers the re-initialization of the element and its children if the configuration files have changed.
abstract Element	toXML(Document doc) Utility method to get the object's XML representation.

From interface com.microstrategy.utils.config.ConfigurationFile

abstract void	applyCustomization(CustomizationInfo c) Applies the corresponding customizations.
abstract void	applyCustomizations() Loops through all the `CustomizationInfo` in the `Customizations` class and apply the corresponding customizations.
abstract void	load(String fileName) Loads the file with the given name and initializes this `ConfigurationFile` with its content.
abstract void	reload() Reloads the content of this `ConfigurationFile` if the underlying configuration file has changed.
abstract void	save() Saves this `ConfigurationFile` back into the files where it was loaded from.
abstract void	save(CustomizationInfo c) Saves the differences between the shipped ("out of the box") definition of this `ConfigurationFile` and its currents values into the corresponding `CustomizationInfo`.
abstract void	setUseValidation(boolean value) Defines whether the XML content should validated using a DTD.
abstract boolean	useValidation() Returns whether the XML content should be validated using a DTD.

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)

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 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 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

a WebBeanInfoList instance containing the beans defined for the page

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.

Interfaces

Classes

Exceptions

PageInfo

Class Overview

Summary

Constants

public static final String ATT_ALLOW_CANCEL

public static final String ATT_BINARY_DISPLAY

public static final String ATT_BINARY_DISPLAY_BEAN

public static final String ATT_CACHE_CONTROL

public static final String ATT_DEFAULT

public static final String ATT_DESCRIPTION

public static final String ATT_DESC_ID

public static final String ATT_EVENT_HANDLER

public static final String ATT_FEATURE_ID

public static final String ATT_HELP_TOPIC

public static final String ATT_ISPROMPT

public static final String ATT_LOGIN_REQUIRED

public static final String ATT_NAME

public static final String ATT_PAGE_CLASS

public static final String ATT_PERSIST_MODE

public static final String ATT_SHOW_RECOVER_LINK

public static final String ATT_TITLE_BEAN

public static final String ATT_TRACK

public static final String ATT_USE_RESOURCE_MGR

public static final String NODE_PAGE

Public Constructors

public PageInfo ()

public PageInfo (Node root)

Parameters

public PageInfo (Node root, PageInfo defaultPage)

Parameters

Public Methods

public AddonInfoList getAddOns ()

Returns

public boolean getAllowCancel ()

Returns

public String getBinaryDisplay ()

Returns

public String getBinaryDisplayBean ()

Returns

public String getCacheControl ()

public String getDescription ()

Returns

public String getDescriptorID ()

Returns

public String getEventHandlerClass ()

Returns

public EventMapList getEventMapList ()

Returns

public String getFeatureId ()

Returns

public String getHelpTopic ()

public JavaScriptInfoList getJavaScripts ()

Returns

public String getMessage (Messages messages)

Parameters

Returns

public String getName ()

Returns

public String getPageComponentClass ()

Returns

public WebComponent getPageInstance (AppContext appContext)

Parameters

Returns

Throws

public WebComponent getPageInstance (AppContext appContext, ComponentInitializationContext initContext)

Parameters

Returns

Throws

public String getPrototypeAttribute ()

Returns

public boolean getShowRecoverLink ()

Returns

public TemplateInfoList getTemplateInfoList ()

Returns

public String getTitleBean ()

public String getUseResourceManager ()

public WebBeanInfoList getWebBeanInfoList ()