Package com.microstrategy.web.app
Class PageManager
- java.lang.Object
-
- com.microstrategy.utils.config.AbstractConfigurationElement
-
- com.microstrategy.web.app.PageManager
-
- All Implemented Interfaces:
ConfigurationElement
,ConfigurationFile
,java.lang.Cloneable
public class PageManager extends AbstractConfigurationElement
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.- Since:
- MicroStrategy Web 7.3.1 or earlier
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.microstrategy.utils.config.AbstractConfigurationElement
AbstractConfigurationElement.FilteredList
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
ATT_DESC
static java.lang.String
ATT_NAME
static java.lang.String
ATT_VERSION
static java.lang.String
NODE_FRAMEWORK
-
Fields inherited from class com.microstrategy.utils.config.AbstractConfigurationElement
ATT_CONFIG_SRC, ATT_DELETED, ATT_POSITION, ATT_PROTOTYPE, ATT_USE_DEFAULT
-
-
Constructor Summary
Constructors Constructor Description PageManager()
Class constructor.PageManager(java.lang.String xml)
Class constructor.PageManager(org.w3c.dom.Document doc)
Class constructor.PageManager(org.w3c.dom.Node root)
Class constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
addPage(java.lang.String pageName, PageInfo page)
Add a new Page instance to the Page Managervoid
deleteAllPages()
Delete all pages from this manager instancevoid
deletePage(java.lang.String pageName)
Removes the requestedPageInfo
instance from the Manager, based on its ID.java.lang.Object
get(java.lang.Object key)
Deprecated.WebBeanStyleList
getBeanStyleList()
Get the collection of bean styles available to all thePageInfo
instances defined on this instanceBrowserSettingDefinitionList
getBrowserSettingDefinitionList()
Returns the Application's Browser Settings List informationDBPropertiesInfo
getDBProperties()
PageInfo
getDefaultPage()
Return the Page that is assigned as default pagejava.lang.String
getDescription()
Get the Page Manager's descriptionDynamicMenus
getDynamicMenus()
Returns the Application's dynamic menus informationErrorInfoList
getErrorInfoList()
Returns the Application's Error Info List informationESRIConfigurationInfo
getESRIConfiguration()
ExportFormatList
getExportFormatList()
Returns the Application's Export Format List informationExportPlaintextDelimiterList
getExportPlaintextDelimiterList()
Returns the Application's Export Plaintext Delimiter List informationObjBrowserFolderLinks
getFolderLinkList()
Returns the Application's folder Links List information used in the Object BrowserFolderMappingList
getFolderMapList()
Returns the Application's Folder Map List informationprotected java.lang.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 thegetKey
andsetKey
methods.MapNameConversions
getMapNameConversion()
MultiMapConfigurationInfo
getMultiMapConfiguration()
java.lang.String
getName()
Return the Page Manager's name.PageInfo
getPage(java.lang.String pageName)
Get the Page instance associated with the given pageName.PageInfoList
getPageList()
Get the pages in this page managerPaperSizesList
getPaperSizesList()
Returns the Application's Paper Sizes List informationRibbonListSet
getRibbonListSet()
MSTRShapeConfigurationInfo
getShapeConfiguration()
ShapeFileMaps
getShapeFileMaps()
Returns the VI ImageLayout ShapeFileMap information.protected ConfigurationSource
getSource(java.lang.String srcKey)
Gets theElementSource
for the given key.StaticSessionList
getStaticSessionList()
Deprecated.Static Sessions is not a feature supported by the application.SystemPickerList
getSystemPickerList()
Returns the Application's picker informationCustomThresholdsInfo
getThresholds()
ToolbarInfoList
getToolbarInfoList()
Returns the Application's toolbars informationTransitions
getTransitions()
java.lang.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 thePageInfo
instances defined on this instancevoid
setBrowserSettingDefinitionList(BrowserSettingDefinitionList browserSettingDefinitionList)
void
setDescription(java.lang.String newDesc)
Set the Page Manager's Descriptionvoid
setDynamicMenus(DynamicMenus dynamicMenus)
void
setErrorInfoList(ErrorInfoList errorInfoList)
void
setExportFormatList(ExportFormatList exportFormatList)
void
setExportFormatList(ExportPlaintextDelimiterList exportPlaintextDelimiters)
void
setFolderLinkList(ObjBrowserFolderLinks objBrowserFolderLinks)
void
setFolderMapList(FolderMappingList folderMappingList)
void
setName(java.lang.String newName)
Set the Page Manager's Namevoid
setPaperSizesList(PaperSizesList paperSizesList)
void
setStaticSessionList(StaticSessionList sessionList)
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(java.lang.String version)
Sets the Application's build version.void
setVisualizationGallery(VisualizationGallery visualizationGallery)
void
setVisualizations(Visualizations visualizations)
void
setWidgets(Widgets widgets)
int
size()
Deprecated.java.lang.String
toString()
Generates the String representation of thisConfigurationElement
.-
Methods inherited from class com.microstrategy.utils.config.AbstractConfigurationElement
addFileSource, applyCustomization, applyCustomizations, cleanUpDeletedElements, clone, delete, deltas, deltas, equalAtts, equalElements, equalNodeValues, equals, equalsIncludingDeletedElements, exportAttributesToXML, exportElementsToXML, exportNodeValueToXML, getAttribute, getAttributes, getBoolAttribute, getChildKey, getConfigSrc, getDTDFileName, getElement, getElement, getElements, getFileLoader, getIntAttribute, getIntAttribute, getKey, getLineNumber, getList, getNextKey, getNodeName, getNodeValue, getNodeValue, getOrCreateElement, getParent, getPosition, getPrototype, getRegisteredClass, getSelfInitPath, getStrAttribute, getUseDefault, getXMLParserParameters, getXMLSerializerParameters, hashCode, hashCodeAtts, hashCodeElements, hashCodeNodeValues, hasRegisteredClass, initAttributesFromXML, initDefaultAttributes, initElementFromXML, initElementsFromXML, initFromFile, initFromResource, initFromXML, initFromXML, initNodeValueFromXML, initPrototype, isActive, isCustomized, isDeleted, isDirty, isInSource, isKeyAttribute, load, mergeChanges, newChildInstance, newSource, original, populate, printAttributes, printElements, printNodeValue, refreshLists, registerClass, registerElement, registerElement, registerElementList, reload, reloadPrototype, removeAttribute, removeDefaults, replaceList, restore, save, save, saveChangesAs, saveConfig, saveFlatXML, saveNode, saveSource, setAttribute, setBoolAttribute, setChildOriginals, setConfigSrc, setCustomized, setElement, setFileLoader, setIntAttribute, setKey, setLineNumber, setNodeName, setNodeValue, setPosition, setPrototype, setSelfInitPath, setStrAttribute, setUseDefault, setUseValidation, throwConfigParseException, toXML, toXML, toXML, toXML, useNodeValue, useValidation
-
-
-
-
Field Detail
-
NODE_FRAMEWORK
public static final java.lang.String NODE_FRAMEWORK
- Since:
- MicroStrategy Web 9.0.0
- See Also:
- Constant Field Values
-
ATT_NAME
public static final java.lang.String ATT_NAME
- Since:
- MicroStrategy Web 9.0.0
- See Also:
- Constant Field Values
-
ATT_VERSION
public static final java.lang.String ATT_VERSION
- Since:
- MicroStrategy Web 9.0.0
- See Also:
- Constant Field Values
-
ATT_DESC
public static final java.lang.String ATT_DESC
- Since:
- MicroStrategy Web 9.0.0
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
PageManager
public PageManager()
Class constructor. Creates a new -empty- instance of the Page Manager.
-
PageManager
public PageManager(java.lang.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.
-
PageManager
public PageManager(org.w3c.dom.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.
-
PageManager
public PageManager(org.w3c.dom.Document doc)
Class constructor. Creates a new instance of the Page Manager, initializing it with the information provided on the XMLDocument
.- Parameters:
doc
- DOM Document with information to initialize this class
-
-
Method Detail
-
getPage
public PageInfo getPage(java.lang.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.
-
addPage
public void addPage(java.lang.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.
-
deletePage
public void deletePage(java.lang.String pageName)
Removes the requestedPageInfo
instance from the Manager, based on its ID.- Parameters:
pageName
- the page's unique identifier to look for.
-
setBeanStyleList
public void setBeanStyleList(WebBeanStyleList styleList)
Set the collection of bean styles available to all thePageInfo
instances defined on this instance- Parameters:
styleList
-WebBeanStyleList
instance representing the styles
-
getBeanStyleList
public WebBeanStyleList getBeanStyleList()
Get the collection of bean styles available to all thePageInfo
instances defined on this instance- Returns:
- the
WebBeanStyleList
associated with this instance
-
setStaticSessionList
public void setStaticSessionList(StaticSessionList sessionList)
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.- Since:
- MicroStrategy Web 9.0.0
-
getStaticSessionList
public StaticSessionList getStaticSessionList()
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 thesetStaticSessionList(com.microstrategy.web.app.StaticSessionList)
-
setFolderMapList
public void setFolderMapList(FolderMappingList folderMappingList)
- Since:
- MicroStrategy Web 9.0.0
-
getFolderMapList
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.
-
setPaperSizesList
public void setPaperSizesList(PaperSizesList paperSizesList)
- Since:
- MicroStrategy Web 9.0.0
-
getPaperSizesList
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.
-
getExportFormatList
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.
-
setExportFormatList
public void setExportFormatList(ExportFormatList exportFormatList)
- Since:
- MicroStrategy Web 9.0.0
-
getExportPlaintextDelimiterList
public ExportPlaintextDelimiterList getExportPlaintextDelimiterList()
Returns the Application's Export Plaintext Delimiter List information- Returns:
- a
ExportPlaintextDelimiterList
instance containing the information about the export plaintext available for the application. - Since:
- MicroStrategy Web 9.0.0
-
setExportFormatList
public void setExportFormatList(ExportPlaintextDelimiterList exportPlaintextDelimiters)
- Since:
- MicroStrategy Web 9.0.0
-
getErrorInfoList
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.
-
setErrorInfoList
public void setErrorInfoList(ErrorInfoList errorInfoList)
- Since:
- MicroStrategy Web 9.0.0
-
getFolderLinkList
public ObjBrowserFolderLinks getFolderLinkList()
Returns the Application's folder Links List information used in the Object Browser- Returns:
- a
ObjBrowserFolderLinks
instance containing the information about the folder Links for the application. - Since:
- MicroStrategy Web 8.0.1
-
setFolderLinkList
public void setFolderLinkList(ObjBrowserFolderLinks objBrowserFolderLinks)
- Since:
- MicroStrategy Web 9.0.0
-
getDynamicMenus
public DynamicMenus getDynamicMenus()
Returns the Application's dynamic menus information- Returns:
- a
DynamicMenus
instance containing the information about the dynamic menus for the application.
-
setDynamicMenus
public void setDynamicMenus(DynamicMenus dynamicMenus)
- Since:
- MicroStrategy Web 9.0.0
-
getToolbarInfoList
public ToolbarInfoList getToolbarInfoList()
Returns the Application's toolbars information- Returns:
- a
ToolbarInfoList
instance containing the information about the toolbars for the application. - Since:
- MicroStrategy Web 8.0.0
-
setToolbarInfoList
public void setToolbarInfoList(ToolbarInfoList toolbarInfoList)
- Since:
- MicroStrategy Web 9.0.0
-
getSystemPickerList
public SystemPickerList getSystemPickerList()
Returns the Application's picker information- Returns:
- a
SystemPickerList
instance containing the information about the toolbars for the application. - Since:
- MicroStrategy Web 8.0.0
-
setSystemPickerList
public void setSystemPickerList(SystemPickerList systemPickerList)
- Since:
- MicroStrategy Web 9.0.0
-
getBrowserSettingDefinitionList
public BrowserSettingDefinitionList getBrowserSettingDefinitionList()
Returns the Application's Browser Settings List information- Returns:
- a
BrowserSettingDefinitionList
instance containing the information about the browser settings available for the application.
-
setBrowserSettingDefinitionList
public void setBrowserSettingDefinitionList(BrowserSettingDefinitionList browserSettingDefinitionList)
- Since:
- MicroStrategy Web 9.0.0
-
getVisualizations
public Visualizations getVisualizations()
Returns the Application's Visualizations information.
This object contains a collection ofVisualizationList
which in turn contains a list ofVisualization
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. - Since:
- MicroStrategy Web 8.0.2
-
setVisualizations
public void setVisualizations(Visualizations visualizations)
- Since:
- MicroStrategy Web 9.0.0
-
getWidgets
public Widgets getWidgets()
- Since:
- MicroStrategy Web 8.1.0
-
setWidgets
public void setWidgets(Widgets widgets)
- Since:
- MicroStrategy Web 9.0.0
-
getVisualizationGallery
public VisualizationGallery getVisualizationGallery()
-
setVisualizationGallery
public void setVisualizationGallery(VisualizationGallery visualizationGallery)
-
getTransitions
public Transitions getTransitions()
- Since:
- MicroStrategy Web 8.1.0
-
setTransitions
public void setTransitions(Transitions transitions)
- Since:
- MicroStrategy Web 9.0.0
-
getVersion
public java.lang.String getVersion()
Get the Application's build version.- Returns:
- a
String
with the build version's information i.e. 7.5.0.112.
-
setVersion
public void setVersion(java.lang.String version)
Sets the Application's build version. I.e. 7.5.0.112.- Parameters:
version
- Application's build version.
-
getDefaultPage
public PageInfo getDefaultPage()
Return the Page that is assigned as default page- Returns:
- a
PageInfo
instance assigned as default page
-
setName
public void setName(java.lang.String newName)
Set the Page Manager's Name- Parameters:
newName
- the page manager's new name.
-
getName
public java.lang.String getName()
Return the Page Manager's name. Simply used to identify this PageManager.- Returns:
- the page manager's new name.
-
setDescription
public void setDescription(java.lang.String newDesc)
Set the Page Manager's Description- Parameters:
newDesc
- the page manager's new description.
-
getDescription
public java.lang.String getDescription()
Get the Page Manager's description- Returns:
- the page manager's new description.
-
deleteAllPages
public void deleteAllPages()
Delete all pages from this manager instance
-
size
public int size()
Deprecated.- Returns:
- The size of page list
- Since:
- MicroStrategy Web 9.0.0
-
get
public java.lang.Object get(java.lang.Object key)
Deprecated.- Returns:
- PageInfo object by given key from the PageInfoList
- Since:
- MicroStrategy Web 9.0.0
-
getPageList
public PageInfoList getPageList()
Get the pages in this page manager- Returns:
- PageInfoList
- Since:
- MicroStrategy Web 9.0.0
-
getSource
protected ConfigurationSource getSource(java.lang.String srcKey)
Description copied from class:AbstractConfigurationElement
Gets theElementSource
for the given key. If there is noConfigurationSource
for the given key, a new source is automatically added.- Overrides:
getSource
in classAbstractConfigurationElement
- Since:
- MicroStrategy Web 9.0.0
-
getKeyAttribute
protected java.lang.String getKeyAttribute()
Description copied from class:AbstractConfigurationElement
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 thegetKey
andsetKey
methods.- Specified by:
getKeyAttribute
in classAbstractConfigurationElement
- Since:
- MicroStrategy Web 9.0.0
-
toString
public java.lang.String toString()
Description copied from class:AbstractConfigurationElement
Generates the String representation of thisConfigurationElement
.- Overrides:
toString
in classAbstractConfigurationElement
-
getRibbonListSet
public RibbonListSet getRibbonListSet()
- Since:
- MicroStrategy Web 9.0.1
-
getDBProperties
public DBPropertiesInfo getDBProperties()
-
getThresholds
public CustomThresholdsInfo getThresholds()
-
getShapeFileMaps
public ShapeFileMaps getShapeFileMaps()
Returns the VI ImageLayout ShapeFileMap information.
This object contains a collection ofShapeFileMaps
which in turn contains a list ofShapeFileMap
nodes.
ShapeFileMap is an XML file defining the maps using in VI ImageLayout.- Returns:
- a
ShapeFileMaps
instance containing ShapeFileMap information available in VI ImageLayout. - Since:
- MicroStrategy Web 9.4.0
-
getESRIConfiguration
public ESRIConfigurationInfo getESRIConfiguration()
-
getMultiMapConfiguration
public MultiMapConfigurationInfo getMultiMapConfiguration()
-
getShapeConfiguration
public MSTRShapeConfigurationInfo getShapeConfiguration()
-
getMapNameConversion
public MapNameConversions getMapNameConversion()
-
-