public class

SectionInfoList

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

Class Overview

The SectionInfoList class is a collection of SectionInfo instances that holds information about which file to use for that section in the Template.

Summary

Constants
String NODE_SECTIONS
[Expand]
Inherited Constants
From class com.microstrategy.utils.config.AbstractConfigurationElementList
From class com.microstrategy.utils.config.AbstractConfigurationElement
Public Constructors
SectionInfoList()
Class constructor.
SectionInfoList(Node root)
Class constructor.
SectionInfoList(Document doc)
Class constructor.
SectionInfoList(Node root, SectionInfoList defaultList)
Class constructor.
SectionInfoList(Document doc, SectionInfoList defaultList)
Class constructor.
Public Methods
SectionInfoList getDefaultSectionInfoList()
This method is deprecated. Not used anymore
SectionInfo getSectionInfo(String name)
Retrieve a SectionInfo by its name.
boolean useDefault()
This method is deprecated. Use-default has been expanded to not only support Default values, but also values from config-src and customizations. To retrieve the value use getUseDefault()
[Expand]
Inherited Methods
From class com.microstrategy.utils.config.AbstractConfigurationElementList
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.ConfigurationElementList
From interface com.microstrategy.utils.config.ConfigurationFile

Constants

public static final String NODE_SECTIONS

Constant Value: "page-sections"

Public Constructors

public SectionInfoList ()

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

public SectionInfoList (Node root)

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

Parameters
root Node instance representing the shortcut list information.

public SectionInfoList (Document doc)

Class constructor. Initializes a SectionInfoList instance based on the information included in the DOM Document

Parameters
doc Document instance representing the shortcut list information.

public SectionInfoList (Node root, SectionInfoList defaultList)

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

Parameters
root Node instance representing the shortcut list information.
defaultList a SectionInfoList used as default.

public SectionInfoList (Document doc, SectionInfoList defaultList)

Class constructor. Initializes a SectionInfoList instance based on the information included in the DOM Document

Parameters
doc Document instance representing the shortcut list information.
defaultList a SectionInfoList used as default.

Public Methods

public SectionInfoList getDefaultSectionInfoList ()

This method is deprecated.
Not used anymore

Returns the DefaultSectionList. This list is used when initializing the instance if the useDefault is true. All the elements in this list are automatically added, not depending if they're in the xml definition.

Returns
  • the default SectionInfoList

public SectionInfo getSectionInfo (String name)

Retrieve a SectionInfo by its name.

Parameters
name The name of the Section.
Returns

public boolean useDefault ()

This method is deprecated.
Use-default has been expanded to not only support Default values, but also values from config-src and customizations. To retrieve the value use getUseDefault()

Returns whether to use the DefaultSectionInfoList when when initializing this instance. If true and the defaultSectionList is not null, we'll add first all of the default SectionInfo and then add the elements on the xml.

Returns
  • true if the defaultList should be used