public class

Widget

extends AbstractConfigurationElement
implements ConfigurationElement

java.lang.Object
↳	com.microstrategy.utils.config.AbstractConfigurationElement
	↳	com.microstrategy.web.app.Widget

Class Overview

This class represents a widget node of the widgets.xml
A Widget is a way to display the report/document data. Its name must match a style name from the style catalog.

Summary

Constants
String	ATT_DEFAULT_DHTML_STYLE	xml attribute name indicates the default dhtml style a widget uses (if it uses any).
String	ATT_FLASH_STYLE_ID	xml attribute name for the flash style id
String	ATT_ID	xml attribute name for widget ID
String	ATT_IS_APP	xml attribute name indicates whether it is an application widget or component widget.
String	ATT_IS_IVE	xml attribute name indicates whether it is available for IVE.
String	ATT_JAVA_CLASS	xml attribute name for widget Java class name
String	ATT_MAX_SECONDARY_PROVIDERS	xml attribute name indicates the maximum number of secondary data providers a widget uses.
String	ATT_MIN_SECONDARY_PROVIDERS	xml attribute name indicates the minimum number of secondary data providers a widget uses.
String	ATT_PREVIEW_IMAGE	xml attribute name for widget preview image
String	ATT_RSL_PATH	xml attribute name for widget RSL path
String	ATT_SCOPE	xml attribute name for widget scope
String	ATT_TB_CLASS	xml attribute name for widget toolbar CSS class
String	ATT_TB_IMAGE	xml attribute name for widget toolbar image
String	ATT_TITLE	xml attribute name for widget title
String	ATT_TITLE_DESC_ID	xml attribute name for widget title description ID
String	ATT_TITLE_ID	xml attribute name for widget title ID
String	NODE_WIDGET	Tag name
int	SCOPE_RW_CONTROL
int	SCOPE_RW_GRID

[Expand]

Inherited Constants

From class com.microstrategy.utils.config.AbstractConfigurationElement

Public Constructors
	Widget()
	Widget(Node root) Creates a Widget with the information in the Xml Node.

Public Methods
int	getDefaultDHTMLStyel() Returns the widget default DHTML style.
String	getFlashStyleId() Get the widget flash style ID
String	getId() Get the widget ID
boolean	getIsIVE()
String	getJavaClass() Get the widget Java class
int	getMaxSecondaryProviders() Returns the widget maximum number of secondary providers allowed.
int	getMinSecondaryProviders() Returns the widget minimum number of secondary providers allowed.
String	getPreviewImage() Returns the widget preview image path
String	getRslPath() Returns the widget RSL path
int	getScope() Returns a unit type supported by the widget
String	getTitle() Get the widget title
String	getTitleDescId() Returns the widgets titleDESCId
String	getTitleId() Get the widget title ID
String	getToolbarClass() Returns the widget toolbar class
String	getToolbarImage() Get the widget toolbar image path
boolean	isApp()
void	setDefaultDHTMLStyle(int value) Sets the default DHTML style the widget uses
void	setFlashStyleId(String value) Set the widget flash style ID
void	setId(String value) Set the widget ID
void	setIsApp(boolean value)
void	setIsIVE(boolean value)
void	setJavaClass(String value) Set the widget Java class
void	setMaxSecondaryProviders(int value) Sets the widget minimum number of secondary providers allowed.
void	setMinSecondaryProviders(int value) Sets the widget minimum number of secondary providers allowed.
void	setPreviewImage(String value) Sets the widget preview image path
void	setRslPath(String value) Sets the widget RSL path
void	setScope(int value) Sets a unit type supported by the widget
void	setTitle(String value) Set the widget title
void	setTitleDescId(String value) Sets the Desktop title description id
void	setTitleId(String value) Set the widget title ID
void	setToolbarClass(String value) Sets the widget toolbar CSS class
void	setToolbarImage(String value) Sets the widget toolbar image path

Protected Methods
String	getKeyAttribute() This method must return the attribute that uniquely identifies this element among its siblings; if no single attribute can be used, return null and override the `getKey` and `setKey` methods.

[Expand]

Inherited Methods

From class com.microstrategy.utils.config.AbstractConfigurationElement

void	addFileSource(String filePath, String appPath, long lastLoaded) Adds a reference to a file from a config-source.
void	applyCustomization(CustomizationInfo c) Applies the corresponding customizations.
void	applyCustomizations() Loops through all the `CustomizationInfo` in the `Customizations` class and apply the corresponding customizations.
void	cleanUpDeletedElements() This method when called will delete all the child elements that are marked as deleted.
Object	clone()
void	delete(Object key)
AbstractConfigurationElement	deltas(AbstractConfigurationElement other) Returns a partial instance of this object that contains the attributes and elements required to make this object equals to the `other` paramter.
final AbstractConfigurationElement	deltas() Returns the `deltas` between the `original()` and `this` objects.
boolean	equalAtts(AbstractConfigurationElement other) Returns `true` if the list of active attributes of the given AbstractConfigurationElement is equal to this list of active attributes of this AbstractConfigurationElement.
boolean	equalElements(AbstractConfigurationElement other) Returns `true` if the list of all child elements of the given AbstractConfigurationElement is equal to this list of all child-elements of this AbstractConfigurationElement.
boolean	equalNodeValues(AbstractConfigurationElement other) Returns `true` if the node value of both configuration elements is the same.
boolean	equals(Object object)
boolean	equalsIncludingDeletedElements(Object object)
void	exportAttributesToXML(Element element, ConfigurationSource source) Appends the list of attributes of this `ConfigurationElement` into the given node.
void	exportElementsToXML(Element element, ConfigurationSource source) Appends the list of child-elements of this `ConfigurationElement` into the given node.
void	exportNodeValueToXML(Element element, ConfigurationSource source) Appends the node value associated with the given source key into the given node.
final ConfigurationValue	getAttribute(String name) Returns the value associated with the given attribute.
HashList	getAttributes() Returns the list of all attributes available to this ConfigurationElement.
boolean	getBoolAttribute(String name) Helper method, returns the value of the given attribute as boolean (true/false).
Object	getChildKey(Node node) Returns the key that uniquely identifies the child element associated with the given `Node`.
String	getConfigSrc() Returns the value of the config-src attribute.
String	getDTDFileName() Returns the name of a DTD file that will be added as SystemID to the XML resulting from serializing the contents of this ConfigurationElement into a file; `null` by default.
ConfigurationElement	getElement(Object key, boolean includeDeleted)
ConfigurationElement	getElement(Object key) Returns the `ConfigurationElement` instance associated with the given nodeName.
final HashList	getElements() Returns the list of all child-elements available to this ConfigurationElement.
FileLoader	getFileLoader() Returns the file loader instance used by this ConfigurationElement to load files from the file system.
int	getIntAttribute(String name, int defaultValue) Helper method, returns the value of the given attribute as integer.
int	getIntAttribute(String name) Helper method, returns the value of the given attribute as integer.
Object	getKey() Default implementation for `getKey()`.
abstract String	getKeyAttribute() This method must return the attribute that uniquely identifies this element among its siblings; if no single attribute can be used, return null and override the `getKey` and `setKey` methods.
int	getLineNumber() Returns the line number (if known) of the element in the XML file.
AbstractConfigurationElement.FilteredList	getList(String nodeName) Returns an `ImplicitList` with all the elements associated with the given `nodeName`.
Object	getNextKey() Returns an object that can be used as key for a list of child-elements that doesn't have a key by itself.
String	getNodeName() Returns the node-name for this element.
String	getNodeValue() Returns the node value for this element.
String	getNodeValue(ConfigurationSource source) Returns the node value for this element in the given sourceKey.
AbstractConfigurationElement	getOrCreateElement(String nodeName, Object key) Returns the current child instance; if null but the child is registered, it creates a new instance for it.
AbstractConfigurationElement	getParent() Gets the parent for this configuration element.
int	getPosition() Returns the expected position of this element.
AbstractConfigurationElement	getPrototype() Returns the current prototype of this instance.
Class	getRegisteredClass(String nodeName) Returns the `Class` associated with the given `nodeName`.
String	getSelfInitPath() Returns the path to the file where this configuration element was originally loaded from.
ConfigurationSource	getSource(String key) Gets the `ElementSource` for the given key.
String	getStrAttribute(String name) Helper method, returns the value of the given attribute as a string.
boolean	getUseDefault() Returns the use-default value.
ParserParameters	getXMLParserParameters(String fileName) Returns an instance of `ParserParameters` used by the XML parser.
SerializerParameters	getXMLSerializerParameters() Returns an instance of `SerializerParameters` used by the XML serializer in the `toXML()` By default it returns `null`.
boolean	hasRegisteredClass(String nodeName) Returns `true` is there is a child registered for the given `nodeName`.
int	hashCode()
int	hashCodeAtts() Returns the hashcode for attributes.
int	hashCodeElements() Returns the hashcode for attributes.
int	hashCodeNodeValues() Returns the hashcode for attributes.
void	initAttributesFromXML(Node root, String sourceKey, CustomizationInfo c) Initializes the list of attributes from given `Node`
void	initDefaultAttributes() This method can be overridden to set default values for attributes.
void	initElementFromXML(Node child, String sourceKey, CustomizationInfo c) Initializes a single child-element from the given `Node`
void	initElementsFromXML(Node root, String sourceKey, CustomizationInfo c) Initializes the list of child-elements from given `Node`
void	initFromFile(String filePath, CustomizationInfo c) Initializes this configuration element by loading the contents of the given `filePath` using the corresponding `CustomizationInfo`.
void	initFromResource(String resourceName) Initializes this configuration element by loading the contents a resource that exists in the class path.
void	initFromXML(Node root, String sourceKey, CustomizationInfo c) Initialize the attributes and child elements from the values in the given `Node`
void	initFromXML(Node root) Initialize the attributes and child elements from the values in the given `Node`
void	initNodeValueFromXML(Node root, String sourceKey, CustomizationInfo c) Initializes the list of child-elements from given `Node`
void	initPrototype(String protoName) Inits the prototype object of this element.
boolean	isActive()
boolean	isCustomized()
boolean	isDeleted() Returns `true` is this element has been mark as deleted.
boolean	isDirty() Returns `true` is this element or one of its children has been modified programatically after being loaded.
boolean	isInSource(String sourceKey) Returns `true` if the element already contains an `ElementSource` for the given key.
boolean	isKeyAttribute(String name) Returns `true` is the name is that of the key attribute.
void	load(String fileName) Loads the file with the given name and initializes this `ConfigurationElement` with its content.
void	mergeChanges(String srcKey) Removes deltas and applies them to the given source.
AbstractConfigurationElement	newChildInstance(String nodeName, Class childClass) Creates a new instance of a child element for the given class.
ConfigurationSource	newSource(String srcKey, CustomizationInfo c) Create a new `ElementSource` and adds to the list of sources of this element.
final AbstractConfigurationElement	original() Returns a new instance of this object, populated only with the out of the box values of Microstrategy Web, that is, only default values or those that came from the load method.
ConfigurationElement	populate(ConfigurationElement other) This method takes another configuration element and populates this element with the other's attributes and child-elements.
void	printAttributes(StringBuffer outString) Appends the list of attributes of this `ConfigurationElement` into the given `StringBuffer`.
void	printElements(StringBuffer outString) Appends the list of child-elements of this `ConfigurationElement` into the given `StringBuffer`.
void	printNodeValue(StringBuffer outString) Appends the node value into the given `StringBuffer`.
void	refreshLists()
void	registerClass(String nodeName, Class c) Registers a child class for the child with the given `nodeName`.
void	registerElement(String nodeName, Class c) Register a child of this `ConfigurationElement`.
void	registerElement(String nodeName, Class c, boolean canBeNull) Register a child of this `ConfigurationElement`.
void	registerElementList(String nodeName, Class c) Register a list of this `ConfigurationElement`.
void	reload() Loops through all the `ElementSource` of this `ConfigurationElement` and reloads the content of those whose underlying configuration file has changed.
void	reloadPrototype() Loops through all the `ElementSource` of this `ConfigurationElement` and reloads the content of those whose underlying configuration file has changed.
void	removeAttribute(String name) Completely remove the value for the given attribute.
void	removeDefaults(CustomizationInfo c) This method is called when the use-default attribute is set false, so all previous values of attributes and children must be cleared.
void	replaceList(AbstractConfigurationElement.FilteredList list)
void	restore(Object key)
void	save(CustomizationInfo c) Saves deltas for this `ConfigurationElement` into the given CustomizationInfo.
void	save() Saves this `ConfigurationElement` back into the files where it was loaded from.
void	saveChangesAs(String fileName) Saves all in-memory changes to the given file.
final void	saveConfig(String filePath) This method is deprecated. To save in a different location, set a custom FileLoader and use the save() method.
void	saveFlatXML(String fileName) Saves the current element structure, in XML format, into the given file.
void	saveNode(Node node, String fileLocation) Saves an XML node into a file in the given location.
void	saveSource(ConfigurationSource source) Saves only the contents associated with the given source.
void	setAttribute(String name, Object value) Sets the value for the given attribute.
void	setBoolAttribute(String name, boolean value) Helper method, sets the value of the given attribute from a boolean.
void	setChildOriginals()
void	setConfigSrc(String path) Sets the config-src attribute.
void	setCustomized(boolean value) set if this element is a customized element or not.
void	setElement(Object key, ConfigurationElement child) Allows users to add or replace an element.
void	setFileLoader(FileLoader fl) Sets the `FileLoader` instance to be used to load files.
void	setIntAttribute(String name, int value) Helper method, sets the value of the given attribute from an integer.
void	setKey(Element element) Default implementation for `setKey()`.
void	setLineNumber(int lineNumber) Sets the line number of the element in the XML file.
void	setNodeName(String name) Sets the name of the node associated with this configuration element.
void	setNodeValue(String value) Returns the node value for this element.
void	setPosition(int position) Sets the expected position of this element.
void	setPrototype(AbstractConfigurationElement prototype) Sets the prototype object for this instance.
void	setSelfInitPath(String value)
void	setStrAttribute(String name, String value) Helper method, sets the value of the given attribute as a string.
void	setUseDefault(boolean useDefault) The definition of a ConfigurationElement can come come from different sources, for example, the definition can come from an external file (by specifying a `getConfigSrc()` value), or it can be modified through a Customization.
void	setUseValidation(boolean value) Defines whether the XML content should validated using a DTD.
String	toString() Generates the String representation of this `ConfigurationElement`.
Element	toXML(Document doc, String sourceKey) Generates the DOM representation of this `ConfigurationElement` for the list of attributes and elements defined in the given `ElementSource`.
synchronized Element	toXML(Document doc) Generates the DOM representation of this `ConfigurationElement`.
synchronized Element	toXML() Generates the DOM representation of this `ConfigurationElement`.
Element	toXML(String sourceKey) Generates the DOM representation of this `ConfigurationElement` for the list of attributes and elements defined in the given `ElementSource`.
boolean	useNodeValue() Controls whether this element will use the node value as a property.
boolean	useValidation() Returns whether the XML content should be validated using a DTD.

From class java.lang.Object

From interface com.microstrategy.utils.config.ConfigurationElement

abstract ConfigurationValue	getAttribute(String name) Returns the value associated with the given attribute.
abstract HashList	getAttributes() Returns the list of all attributes available to this ConfigurationElement.
abstract ConfigurationElement	getElement(Object nodeName) Returns the `ConfigurationElement` instance associated with the given nodeName.
abstract HashList	getElements() Returns the list of all child-elements available to this ConfigurationElement.
abstract Object	getKey() This method is used to uniquely identify this ConfigurationElement within a list.
abstract String	getNodeName() Returns the node-name for this element.
abstract String	getStrAttribute(String name)
abstract void	initFromXML(Node root) Initializes the object with information from an XML Node.
abstract void	reload() Triggers the re-initialization of the element and its children if the configuration files have changed.
abstract Element	toXML(Document doc) Utility method to get the object's XML representation.

From interface com.microstrategy.utils.config.ConfigurationFile

abstract void	applyCustomization(CustomizationInfo c) Applies the corresponding customizations.
abstract void	applyCustomizations() Loops through all the `CustomizationInfo` in the `Customizations` class and apply the corresponding customizations.
abstract void	load(String fileName) Loads the file with the given name and initializes this `ConfigurationFile` with its content.
abstract void	reload() Reloads the content of this `ConfigurationFile` if the underlying configuration file has changed.
abstract void	save() Saves this `ConfigurationFile` back into the files where it was loaded from.
abstract void	save(CustomizationInfo c) Saves the differences between the shipped ("out of the box") definition of this `ConfigurationFile` and its currents values into the corresponding `CustomizationInfo`.
abstract void	setUseValidation(boolean value) Defines whether the XML content should validated using a DTD.
abstract boolean	useValidation() Returns whether the XML content should be validated using a DTD.

Constants

protected static final String ATT_DEFAULT_DHTML_STYLE

xml attribute name indicates the default dhtml style a widget uses (if it uses any).

Constant Value: "defaultDHTMLStyle"

protected static final String ATT_FLASH_STYLE_ID

xml attribute name for the flash style id

Constant Value: "flashStyleId"

protected static final String ATT_ID

xml attribute name for widget ID

Constant Value: "id"

protected static final String ATT_IS_APP

xml attribute name indicates whether it is an application widget or component widget.

Constant Value: "isApp"

protected static final String ATT_IS_IVE

xml attribute name indicates whether it is available for IVE.

Constant Value: "isIVE"

protected static final String ATT_JAVA_CLASS

xml attribute name for widget Java class name

Constant Value: "fqcn"

protected static final String ATT_MAX_SECONDARY_PROVIDERS

xml attribute name indicates the maximum number of secondary data providers a widget uses. Default value of this attribute is 0.

Constant Value: "maxSecondaryProviders"

protected static final String ATT_MIN_SECONDARY_PROVIDERS

xml attribute name indicates the minimum number of secondary data providers a widget uses. Default value of this attribute is 0.

Constant Value: "minSecondaryProviders"

protected static final String ATT_PREVIEW_IMAGE

xml attribute name for widget preview image

Constant Value: "previewImage"

protected static final String ATT_RSL_PATH

xml attribute name for widget RSL path

Constant Value: "rslPath"

protected static final String ATT_SCOPE

xml attribute name for widget scope

Constant Value: "scope"

protected static final String ATT_TB_CLASS

xml attribute name for widget toolbar CSS class

Constant Value: "tbClass"

protected static final String ATT_TB_IMAGE

xml attribute name for widget toolbar image

Constant Value: "tbImage"

protected static final String ATT_TITLE

xml attribute name for widget title

Constant Value: "title"

protected static final String ATT_TITLE_DESC_ID

xml attribute name for widget title description ID

Constant Value: "titleDESCId"

protected static final String ATT_TITLE_ID

xml attribute name for widget title ID

Constant Value: "titleId"

public static final String NODE_WIDGET

Tag name

Constant Value: "widget"

public static final int SCOPE_RW_CONTROL

Constant Value: 2 (0x00000002)

public static final int SCOPE_RW_GRID

Constant Value: 1 (0x00000001)

Public Constructors

public Widget ()

public Widget (Node root)

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

Parameters

root	the xml node.

Public Methods

public int getDefaultDHTMLStyel ()

Returns the widget default DHTML style.

Returns

the widget default DHTML style.

public String getFlashStyleId ()

Get the widget flash style ID

Returns

the widget flash style ID.

public String getId ()

Get the widget ID

Returns

the widget ID.

public boolean getIsIVE ()

public String getJavaClass ()

Get the widget Java class

Returns

the widget Java class.

public int getMaxSecondaryProviders ()

Returns the widget maximum number of secondary providers allowed.

Returns

the widget maximum number of secondary providers allowed.

public int getMinSecondaryProviders ()

Returns the widget minimum number of secondary providers allowed.

Returns

the widget minimum number of secondary providers allowed.

public String getPreviewImage ()

Returns the widget preview image path

Returns

the widget preview image path.

public String getRslPath ()

Returns the widget RSL path

Returns

the widget RSL path.

public int getScope ()

Returns a unit type supported by the widget

Returns

a unit type supported by the widget.

public String getTitle ()

Get the widget title

Returns

the widget title.

public String getTitleDescId ()

Returns the widgets titleDESCId

Returns

The widgets titleDESCId

public String getTitleId ()

Get the widget title ID

Returns

the widget title ID.

public String getToolbarClass ()

Returns the widget toolbar class

Returns

the widget toolbar class.

public String getToolbarImage ()

Get the widget toolbar image path

Returns

the widget toolbar image path.

public boolean isApp ()

public void setDefaultDHTMLStyle (int value)

Sets the default DHTML style the widget uses

Parameters

value	the default DHTML style

public void setFlashStyleId (String value)

Set the widget flash style ID

Parameters

value	the widget flash style ID value.

public void setId (String value)

Set the widget ID

Parameters

value	widget id value.

public void setIsApp (boolean value)

public void setIsIVE (boolean value)

public void setJavaClass (String value)

Set the widget Java class

Parameters

value	widget Java class value.

public void setMaxSecondaryProviders (int value)

Sets the widget minimum number of secondary providers allowed.

Parameters

value	the widget minimum number of secondary providers allowed.

public void setMinSecondaryProviders (int value)

Sets the widget minimum number of secondary providers allowed.

Parameters

value	the widget minimum number of secondary providers allowed.

public void setPreviewImage (String value)

Sets the widget preview image path

Parameters

value	the widget preview image path.

public void setRslPath (String value)

Sets the widget RSL path

Parameters

value	the widget RSL path.

public void setScope (int value)

Sets a unit type supported by the widget

Parameters

value	unit type value

public void setTitle (String value)

Set the widget title

Parameters

value	the widget title value.

public void setTitleDescId (String value)

Sets the Desktop title description id

Parameters

value	value of the titleDESCId

public void setTitleId (String value)

Set the widget title ID

Parameters

value	the widget title ID value.

public void setToolbarClass (String value)

Sets the widget toolbar CSS class

Parameters

value	the widget toolbar CSS class.

public void setToolbarImage (String value)

Sets the widget toolbar image path

Parameters

value	the widget toolbar image path

Protected Methods

protected String getKeyAttribute ()

This method must return the attribute that uniquely identifies this element among its siblings; if no single attribute can be used, return null and override the getKey and setKey methods.

Interfaces

Classes

Exceptions

Widget

Class Overview

Summary

Constants

protected static final String ATT_DEFAULT_DHTML_STYLE

protected static final String ATT_FLASH_STYLE_ID

protected static final String ATT_ID

protected static final String ATT_IS_APP

protected static final String ATT_IS_IVE

protected static final String ATT_JAVA_CLASS

protected static final String ATT_MAX_SECONDARY_PROVIDERS

protected static final String ATT_MIN_SECONDARY_PROVIDERS

protected static final String ATT_PREVIEW_IMAGE

protected static final String ATT_RSL_PATH

protected static final String ATT_SCOPE

protected static final String ATT_TB_CLASS

protected static final String ATT_TB_IMAGE

protected static final String ATT_TITLE

protected static final String ATT_TITLE_DESC_ID

protected static final String ATT_TITLE_ID

public static final String NODE_WIDGET

public static final int SCOPE_RW_CONTROL

public static final int SCOPE_RW_GRID

Public Constructors

public Widget ()

public Widget (Node root)

Parameters

Public Methods

public int getDefaultDHTMLStyel ()

Returns

public String getFlashStyleId ()

Returns

public String getId ()

Returns

public boolean getIsIVE ()

public String getJavaClass ()

Returns

public int getMaxSecondaryProviders ()

Returns

public int getMinSecondaryProviders ()

Returns

public String getPreviewImage ()

Returns

public String getRslPath ()

Returns

public int getScope ()

Returns

public String getTitle ()

Returns

public String getTitleDescId ()

Returns

public String getTitleId ()

Returns

public String getToolbarClass ()

Returns

public String getToolbarImage ()

Returns

public boolean isApp ()

public void setDefaultDHTMLStyle (int value)

Parameters

public void setFlashStyleId (String value)

Parameters

public void setId (String value)

Parameters

public void setIsApp (boolean value)

public void setIsIVE (boolean value)

public void setJavaClass (String value)

Parameters

public void setMaxSecondaryProviders (int value)

Parameters

public void setMinSecondaryProviders (int value)

Parameters

public void setPreviewImage (String value)

Parameters

public void setRslPath (String value)

Parameters

public void setScope (int value)