Package com.microstrategy.web.app

Class WebGuiComponentList

java.lang.Object

com.microstrategy.utils.config.AbstractConfigurationElement

com.microstrategy.utils.config.AbstractConfigurationElementList

com.microstrategy.web.app.WebGuiComponentList

All Implemented Interfaces:

ConfigurationElement, ConfigurationElementList, ConfigurationFile, java.lang.Cloneable

public class WebGuiComponentList
extends AbstractConfigurationElementList

The WebGuiComponentList class represents a collection of WebComponent objects, corresponding to the components defined for a given 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	NODE_WEB_COMPONENTS

Fields inherited from class com.microstrategy.utils.config.AbstractConfigurationElementList

ATT_VERSION

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
WebGuiComponentList()	Class constructor.
WebGuiComponentList(org.w3c.dom.Document doc)	Class constructor.
WebGuiComponentList(org.w3c.dom.Document doc, WebGuiComponentList defaultList)	Class constructor.
WebGuiComponentList(org.w3c.dom.Node root)	Class constructor.
WebGuiComponentList(org.w3c.dom.Node root, WebGuiComponentList defaultList)	Class constructor.

Method Summary

Modifier and Type	Method	Description
WebGuiComponent	getWebGuiComponent(java.lang.String name)

Methods inherited from class com.microstrategy.utils.config.AbstractConfigurationElementList

clear, clone, get, get, getFilteredList, getKey, getKeyAttribute, getList, getValues, getVersion, init, isEmpty, put, put, registerElementInList, remove, setVersion, size, sort

Methods inherited from class com.microstrategy.utils.config.AbstractConfigurationElement

addFileSource, applyCustomization, applyCustomizations, cleanUpDeletedElements, 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, getSource, 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, toString, toXML, toXML, toXML, toXML, useNodeValue, useValidation

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.microstrategy.utils.config.ConfigurationElement

getAttribute, getAttributes, getElement, getElements, getKey, getNodeName, getStrAttribute, initFromXML, reload, toXML

Field Detail

NODE_WEB_COMPONENTS

public static final java.lang.String NODE_WEB_COMPONENTS

See Also:

Constant Field Values

Constructor Detail

WebGuiComponentList

public WebGuiComponentList()

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

WebGuiComponentList

public WebGuiComponentList(org.w3c.dom.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.

WebGuiComponentList

public WebGuiComponentList(org.w3c.dom.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.

WebGuiComponentList

public WebGuiComponentList(org.w3c.dom.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.

WebGuiComponentList

public WebGuiComponentList(org.w3c.dom.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.

Method Detail

getWebGuiComponent

public WebGuiComponent getWebGuiComponent(java.lang.String name)

Parameters:

name - the name of the WebComponent

Returns:

the WebComponent in the collection with the given name