public class

WebGuiComponentList

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

Class Overview

The WebGuiComponentList class represents a collection of WebComponent objects, corresponding to the components defined for a given Page.

Summary

Constants
String NODE_WEB_COMPONENTS
[Expand]
Inherited Constants
From class com.microstrategy.utils.config.AbstractConfigurationElementList
From class com.microstrategy.utils.config.AbstractConfigurationElement
Public Constructors
WebGuiComponentList()
Class constructor.
WebGuiComponentList(Node root)
Class constructor.
WebGuiComponentList(Node root, WebGuiComponentList defaultList)
Class constructor.
WebGuiComponentList(Document doc)
Class constructor.
WebGuiComponentList(Document doc, WebGuiComponentList defaultList)
Class constructor.
Public Methods
WebGuiComponent getWebGuiComponent(String name)
[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_WEB_COMPONENTS

Constant Value: "web-components"

Public Constructors

public WebGuiComponentList ()

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

public WebGuiComponentList (Node root)

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

Parameters
root Node instance representing the web Component list information.

public WebGuiComponentList (Node root, WebGuiComponentList defaultList)

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

Parameters
root Node instance representing the WebGuiComponentList information.
defaultList a WebGuiComponentList used as default.

public WebGuiComponentList (Document doc)

Class constructor. Initializes a WebGuiComponentList instance based on the information included in the Document doc

Parameters
doc Document instance representing the shortcut list information.

public WebGuiComponentList (Document doc, WebGuiComponentList defaultList)

Class constructor. Initializes a WebGuiComponentList instance based on the information included in the Document doc

Parameters
doc Document instance representing the WebGuiComponentList information.
defaultList a WebGuiComponentList used as default.

Public Methods

public WebGuiComponent getWebGuiComponent (String name)

Parameters
name the name of the WebComponent
Returns
  • the WebComponent in the collection with the given name