public class

PageManager

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

Class Overview

This class represents the root element of the page-config. It holds all global settings, that is, settings that can be accessed from any page.

Summary

Constants
String ATT_DESC
String ATT_NAME
String ATT_VERSION
String NODE_FRAMEWORK
[Expand]
Inherited Constants
From class com.microstrategy.utils.config.AbstractConfigurationElement
Public Constructors
PageManager()
Class constructor.
PageManager(String xml)
Class constructor.
PageManager(Node root)
Class constructor.
PageManager(Document doc)
Class constructor.
Public Methods
void addPage(String pageName, PageInfo page)
Add a new Page instance to the Page Manager
void deleteAllPages()
Delete all pages from this manager instance
void deletePage(String pageName)
Removes the requested PageInfo instance from the Manager, based on its ID.
Object get(Object key)
This method is deprecated. use getPage(String)
WebBeanStyleList getBeanStyleList()
Get the collection of bean styles available to all the PageInfo instances defined on this instance
BrowserSettingDefinitionList getBrowserSettingDefinitionList()
Returns the Application's Browser Settings List information
DBPropertiesInfo getDBProperties()
PageInfo getDefaultPage()
Return the Page that is assigned as default page
String getDescription()
Get the Page Manager's description
DynamicMenus getDynamicMenus()
Returns the Application's dynamic menus information
ESRIConfigurationInfo getESRIConfiguration()
ErrorInfoList getErrorInfoList()
Returns the Application's Error Info List information
ExportFormatList getExportFormatList()
Returns the Application's Export Format List information
ExportPlaintextDelimiterList getExportPlaintextDelimiterList()
Returns the Application's Export Plaintext Delimiter List information
ObjBrowserFolderLinks getFolderLinkList()
Returns the Application's folder Links List information used in the Object Browser
FolderMappingList getFolderMapList()
Returns the Application's Folder Map List information
MapNameConversions getMapNameConversion()
MultiMapConfigurationInfo getMultiMapConfiguration()
String getName()
Return the Page Manager's name.
PageInfo getPage(String pageName)
Get the Page instance associated with the given pageName.
PageInfoList getPageList()
Get the pages in this page manager
PaperSizesList getPaperSizesList()
Returns the Application's Paper Sizes List information
RibbonListSet getRibbonListSet()
MSTRShapeConfigurationInfo getShapeConfiguration()
ShapeFileMaps getShapeFileMaps()
Returns the VI ImageLayout ShapeFileMap information.
StaticSessionList getStaticSessionList()
This method is deprecated. Static Sessions is not a feature supported by the application.
SystemPickerList getSystemPickerList()
Returns the Application's picker information
CustomThresholdsInfo getThresholds()
ToolbarInfoList getToolbarInfoList()
Returns the Application's toolbars information
Transitions getTransitions()
String getVersion()
Get the Application's build version.
VisualizationGallery getVisualizationGallery()
Visualizations getVisualizations()
Returns the Application's Visualizations information.
Widgets getWidgets()
void setBeanStyleList(WebBeanStyleList styleList)
Set the collection of bean styles available to all the PageInfo instances defined on this instance
void setBrowserSettingDefinitionList(BrowserSettingDefinitionList browserSettingDefinitionList)
void setDescription(String newDesc)
Set the Page Manager's Description
void setDynamicMenus(DynamicMenus dynamicMenus)
void setErrorInfoList(ErrorInfoList errorInfoList)
void setExportFormatList(ExportPlaintextDelimiterList exportPlaintextDelimiters)
void setExportFormatList(ExportFormatList exportFormatList)
void setFolderLinkList(ObjBrowserFolderLinks objBrowserFolderLinks)
void setFolderMapList(FolderMappingList folderMappingList)
void setName(String newName)
Set the Page Manager's Name
void setPaperSizesList(PaperSizesList paperSizesList)
void setStaticSessionList(StaticSessionList sessionList)
This method is deprecated. Static Sessions is not a feature supported by the application.
void setSystemPickerList(SystemPickerList systemPickerList)
void setToolbarInfoList(ToolbarInfoList toolbarInfoList)
void setTransitions(Transitions transitions)
void setVersion(String version)
Sets the Application's build version.
void setVisualizationGallery(VisualizationGallery visualizationGallery)
void setVisualizations(Visualizations visualizations)
void setWidgets(Widgets widgets)
int size()
This method is deprecated. use size()
String toString()
Generates the String representation of this ConfigurationElement.
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.
ConfigurationSource getSource(String srcKey)
Gets the ElementSource for the given key.
[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_DESC

Constant Value: "desc"

public static final String ATT_NAME

Constant Value: "name"

public static final String ATT_VERSION

Constant Value: "version"

public static final String NODE_FRAMEWORK

Constant Value: "framework"

Public Constructors

public PageManager ()

Class constructor. Creates a new -empty- instance of the Page Manager.

public PageManager (String xml)

Class constructor. Creates a new instance of the Page Manager, initializing it with the information provided on an xml string.

Parameters
xml Xml String to use for initializing the object.

public PageManager (Node root)

Class constructor. Creates a new instance of the Page Manager, initializing it with the information provided on the XML Node.

Parameters
root Node instance representing the different pages information.

public PageManager (Document doc)

Class constructor. Creates a new instance of the Page Manager, initializing it with the information provided on the XML Document.

Parameters
doc DOM Document with information to initialize this class

Public Methods

public void addPage (String pageName, PageInfo page)

Add a new Page instance to the Page Manager

Parameters
pageName the page's unique identifier.
page PageInfo instance to insert, associated with the given page ID.

public void deleteAllPages ()

Delete all pages from this manager instance

public void deletePage (String pageName)

Removes the requested PageInfo instance from the Manager, based on its ID.

Parameters
pageName the page's unique identifier to look for.

public Object get (Object key)

This method is deprecated.
use getPage(String)

Returns
  • PageInfo object by given key from the PageInfoList

public WebBeanStyleList getBeanStyleList ()

Get the collection of bean styles available to all the PageInfo instances defined on this instance

Returns

public BrowserSettingDefinitionList getBrowserSettingDefinitionList ()

Returns the Application's Browser Settings List information

Returns

public DBPropertiesInfo getDBProperties ()

public PageInfo getDefaultPage ()

Return the Page that is assigned as default page

Returns
  • a PageInfo instance assigned as default page

public String getDescription ()

Get the Page Manager's description

Returns
  • the page manager's new description.

public DynamicMenus getDynamicMenus ()

Returns the Application's dynamic menus information

Returns
  • a DynamicMenus instance containing the information about the dynamic menus for the application.

public ESRIConfigurationInfo getESRIConfiguration ()

public ErrorInfoList getErrorInfoList ()

Returns the Application's Error Info List information

Returns
  • a ErrorInfoList instance containing the information about the error customized for the application.

public ExportFormatList getExportFormatList ()

Returns the Application's Export Format List information

Returns
  • a ExportFormatList instance containing the information about the export formats available for the application.

public ExportPlaintextDelimiterList getExportPlaintextDelimiterList ()

Returns the Application's Export Plaintext Delimiter List information

Returns

public ObjBrowserFolderLinks getFolderLinkList ()

Returns the Application's folder Links List information used in the Object Browser

Returns

public FolderMappingList getFolderMapList ()

Returns the Application's Folder Map List information

Returns
  • a FolderMappingList instance containing the information about the folder mapping available for the application.

public MapNameConversions getMapNameConversion ()

public MultiMapConfigurationInfo getMultiMapConfiguration ()

public String getName ()

Return the Page Manager's name. Simply used to identify this PageManager.

Returns
  • the page manager's new name.

public PageInfo getPage (String pageName)

Get the Page instance associated with the given pageName.

Parameters
pageName the page's unique identifier.
Returns
  • the PageInfo associated that corresponds to the given pageName.

public PageInfoList getPageList ()

Get the pages in this page manager

Returns
  • PageInfoList

public PaperSizesList getPaperSizesList ()

Returns the Application's Paper Sizes List information

Returns
  • a PaperSizesList instance containing the information about the paper sizes available for the application.

public RibbonListSet getRibbonListSet ()

public MSTRShapeConfigurationInfo getShapeConfiguration ()

public ShapeFileMaps getShapeFileMaps ()

Returns the VI ImageLayout ShapeFileMap information.
This object contains a collection of ShapeFileMaps which in turn contains a list of ShapeFileMap nodes.
ShapeFileMap is an XML file defining the maps using in VI ImageLayout.

Returns
  • a ShapeFileMaps instance containing ShapeFileMap information available in VI ImageLayout.

public StaticSessionList getStaticSessionList ()

This method is deprecated.
Static Sessions is not a feature supported by the application.

Static Sessions is a feature that has been removed from the application as it was never fully supported. Calling this method will return null unless a StaticSessionList has been explicitly associated with this instance through the setStaticSessionList(StaticSessionList)

public SystemPickerList getSystemPickerList ()

Returns the Application's picker information

Returns
  • a SystemPickerList instance containing the information about the toolbars for the application.

public CustomThresholdsInfo getThresholds ()

public ToolbarInfoList getToolbarInfoList ()

Returns the Application's toolbars information

Returns
  • a ToolbarInfoList instance containing the information about the toolbars for the application.

public Transitions getTransitions ()

public String getVersion ()

Get the Application's build version.

Returns
  • a String with the build version's information i.e. 7.5.0.112.

public VisualizationGallery getVisualizationGallery ()

public Visualizations getVisualizations ()

Returns the Application's Visualizations information.
This object contains a collection of VisualizationList which in turn contains a list of Visualization nodes.
A Visualization is a way to display the report/document data. Its name must match a style name from the style catalog.

Returns
  • a Visualizations instance containing the information about the visualizations available for the application.

public Widgets getWidgets ()

public void setBeanStyleList (WebBeanStyleList styleList)

Set the collection of bean styles available to all the PageInfo instances defined on this instance

Parameters
styleList WebBeanStyleList instance representing the styles

public void setBrowserSettingDefinitionList (BrowserSettingDefinitionList browserSettingDefinitionList)

public void setDescription (String newDesc)

Set the Page Manager's Description

Parameters
newDesc the page manager's new description.

public void setDynamicMenus (DynamicMenus dynamicMenus)

public void setErrorInfoList (ErrorInfoList errorInfoList)

public void setExportFormatList (ExportPlaintextDelimiterList exportPlaintextDelimiters)

public void setExportFormatList (ExportFormatList exportFormatList)

public void setFolderLinkList (ObjBrowserFolderLinks objBrowserFolderLinks)

public void setFolderMapList (FolderMappingList folderMappingList)

public void setName (String newName)

Set the Page Manager's Name

Parameters
newName the page manager's new name.

public void setPaperSizesList (PaperSizesList paperSizesList)

public void setStaticSessionList (StaticSessionList sessionList)

This method is deprecated.
Static Sessions is not a feature supported by the application.

Static Sessions is a feature that has been removed from the application as it was never fully supported. To use the StaticSesssionList you need to explicitly call this method first to associate a StaticSessionList with this page.

public void setSystemPickerList (SystemPickerList systemPickerList)

public void setToolbarInfoList (ToolbarInfoList toolbarInfoList)

public void setTransitions (Transitions transitions)

public void setVersion (String version)

Sets the Application's build version. I.e. 7.5.0.112.

Parameters
version Application's build version.

public void setVisualizationGallery (VisualizationGallery visualizationGallery)

public void setVisualizations (Visualizations visualizations)

public void setWidgets (Widgets widgets)

public int size ()

This method is deprecated.
use size()

Returns
  • The size of page list

public String toString ()

Generates the String representation of this ConfigurationElement.

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 ConfigurationSource getSource (String srcKey)

Gets the ElementSource for the given key. If there is no ConfigurationSource for the given key, a new source is automatically added.