Package com.microstrategy.web.app

Class Widgets

java.lang.Object

com.microstrategy.utils.config.AbstractConfigurationElement

com.microstrategy.utils.config.AbstractConfigurationElementList

com.microstrategy.web.app.Widgets

All Implemented Interfaces:

ConfigurationElement, ConfigurationElementList, ConfigurationFile, java.lang.Cloneable

public class Widgets
extends AbstractConfigurationElementList

This class represents a visualization list node of the visualizations.xml.
Contains a collection of Visualization

Since:

MicroStrategy Web 8.1.0

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_WIDGETS

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
Widgets()
Widgets(org.w3c.dom.Node root)	Creates a Visualization with the information in the Xml Node.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getNodeName()	Returns the node-name for this element.
Widget	getWidget(int i)	Returns a widget at given index.
Widget	getWidget(java.lang.String id)	Returns a widget with the specified id.
java.lang.String	getWidgetsJson(Messages messages)	Returns a String that defines a JSON object used to pass the list of all widgets to the client side
java.lang.String	getWidgetsJson(Messages messages, VisualizationList visList)	Deprecated. use getWidgetsJson(Messages)
protected void	initFromFile(java.lang.String filePath, CustomizationInfo c)	Initializes this configuration element by loading the contents of the given filePath using the corresponding CustomizationInfo.
Widget	newWidget(java.lang.String id)	Create a new widget with given id.

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, getNodeValue, getNodeValue, getOrCreateElement, getParent, getPosition, getPrototype, getRegisteredClass, getSelfInitPath, getSource, getStrAttribute, getUseDefault, getXMLParserParameters, getXMLSerializerParameters, hashCode, hashCodeAtts, hashCodeElements, hashCodeNodeValues, hasRegisteredClass, initAttributesFromXML, initDefaultAttributes, initElementFromXML, initElementsFromXML, 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, getStrAttribute, initFromXML, reload, toXML

Field Detail

NODE_WIDGETS

public static final java.lang.String NODE_WIDGETS

See Also:

Constant Field Values

Constructor Detail

Widgets

public Widgets()

Widgets

public Widgets(org.w3c.dom.Node root)

Creates a Visualization with the information in the Xml Node. Internally it calls AbstractConfigurationElement.initFromXML(org.w3c.dom.Node).

Parameters:

root - the xml node.

Method Detail

initFromFile

protected void initFromFile(java.lang.String filePath,
                            CustomizationInfo c)
                     throws ConfigException

Initializes this configuration element by loading the contents of the given filePath using the corresponding CustomizationInfo.

Overrides:

initFromFile in class AbstractConfigurationElement

Throws:

ConfigException

Since:

MicroStrategy Web 9.0.1

getNodeName

public java.lang.String getNodeName()

Description copied from interface: ConfigurationElement

Returns the node-name for this element.

Specified by:

getNodeName in interface ConfigurationElement

Overrides:

getNodeName in class AbstractConfigurationElement

newWidget

public Widget newWidget(java.lang.String id)

Create a new widget with given id.

Parameters:

id - A String represents the id of the widget.

Returns:

a Widget.

Since:

MicroStrategy Web 8.1.1

getWidget

public Widget getWidget(int i)

Returns a widget at given index.

Parameters:

i - The index of the widget.

Returns:

a widget if found. Otherwise, returns null.

getWidget

public Widget getWidget(java.lang.String id)

Returns a widget with the specified id.

Parameters:

id - the wodget id.

Returns:

a widget with the specified id

getWidgetsJson

public java.lang.String getWidgetsJson(Messages messages,
                                       VisualizationList visList)

Deprecated.

use getWidgetsJson(Messages)

Returns a String that defines a JSON object used to pass the list of all widgets to the client side

Parameters:

messages - The Messages object

Returns:

a String that defines a JSON object used to pass the list of all widgets to the client side

Since:

MicroStrategy Web 9.0.1

getWidgetsJson

public java.lang.String getWidgetsJson(Messages messages)

Returns a String that defines a JSON object used to pass the list of all widgets to the client side

Parameters:

messages - The Messages object

Returns:

a String that defines a JSON object used to pass the list of all widgets to the client side

Since:

MicroStrategy Web 9.0.1