public class

Widgets

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

Class Overview

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

Summary

Constants
String NODE_WIDGETS
[Expand]
Inherited Constants
From class com.microstrategy.utils.config.AbstractConfigurationElementList
From class com.microstrategy.utils.config.AbstractConfigurationElement
Public Constructors
Widgets()
Widgets(Node root)
Creates a Visualization with the information in the Xml Node.
Public Methods
String getNodeName()
Returns the node-name for this element.
Widget getWidget(String id)
Returns a widget with the specified id.
Widget getWidget(int i)
Returns a widget at given index.
String getWidgetsJson(Messages messages)
Returns a String that defines a JSON object used to pass the list of all widgets to the client side
String getWidgetsJson(Messages messages, VisualizationList visList)
This method is deprecated. use getWidgetsJson(Messages)
Widget newWidget(String id)
Create a new widget with given id.
Protected Methods
void initFromFile(String filePath, CustomizationInfo c)
Initializes this configuration element by loading the contents of the given filePath using the corresponding CustomizationInfo.
[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_WIDGETS

Constant Value: "widgets"

Public Constructors

public Widgets ()

public Widgets (Node root)

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

Parameters
root the xml node.

Public Methods

public String getNodeName ()

Returns the node-name for this element.

public Widget getWidget (String id)

Returns a widget with the specified id.

Parameters
id the wodget id.
Returns
  • a widget with the specified id

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.

public 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

public String getWidgetsJson (Messages messages, VisualizationList visList)

This method is 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

public Widget newWidget (String id)

Create a new widget with given id.

Parameters
id A String represents the id of the widget.
Returns
  • a Widget.

Protected Methods

protected void initFromFile (String filePath, CustomizationInfo c)

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