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

All Implemented Interfaces:

ConfigurationElement, ConfigurationFile, java.lang.Cloneable
```
public class Widget
extends AbstractConfigurationElement
implements ConfigurationElement
```
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.

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

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

Widget()

Widget(org.w3c.dom.Node root)
Creates a Widget with the information in the Xml Node.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int`	`getDefaultDHTMLStyel()`	Returns the widget default DHTML style.
`java.lang.String`	`getFlashStyleId()`	Get the widget flash style ID
`java.lang.String`	`getId()`	Get the widget ID
`boolean`	`getIsIVE()`
`java.lang.String`	`getJavaClass()`	Get the widget Java class
`protected java.lang.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`	`getMaxSecondaryProviders()`	Returns the widget maximum number of secondary providers allowed.
`int`	`getMinSecondaryProviders()`	Returns the widget minimum number of secondary providers allowed.
`java.lang.String`	`getPreviewImage()`	Returns the widget preview image path
`java.lang.String`	`getRslPath()`	Returns the widget RSL path
`int`	`getScope()`	Returns a unit type supported by the widget
`java.lang.String`	`getTitle()`	Get the widget title
`java.lang.String`	`getTitleDescId()`	Returns the widgets titleDESCId
`java.lang.String`	`getTitleId()`	Get the widget title ID
`java.lang.String`	`getToolbarClass()`	Returns the widget toolbar class
`java.lang.String`	`getToolbarImage()`	Get the widget toolbar image path
`boolean`	`isApp()`
`void`	`setDefaultDHTMLStyle(int value)`	Sets the default DHTML style the widget uses
`void`	`setFlashStyleId(java.lang.String value)`	Set the widget flash style ID
`void`	`setId(java.lang.String value)`	Set the widget ID
`void`	`setIsApp(boolean value)`
`void`	`setIsIVE(boolean value)`
`void`	`setJavaClass(java.lang.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(java.lang.String value)`	Sets the widget preview image path
`void`	`setRslPath(java.lang.String value)`	Sets the widget RSL path
`void`	`setScope(int value)`	Sets a unit type supported by the widget
`void`	`setTitle(java.lang.String value)`	Set the widget title
`void`	`setTitleDescId(java.lang.String value)`	Sets the Desktop title description id
`void`	`setTitleId(java.lang.String value)`	Set the widget title ID
`void`	`setToolbarClass(java.lang.String value)`	Sets the widget toolbar CSS class
`void`	`setToolbarImage(java.lang.String value)`	Sets the widget toolbar image path

Methods inherited from class com.microstrategy.utils.config.AbstractConfigurationElement
addFileSource, applyCustomization, applyCustomizations, cleanUpDeletedElements, clone, 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
  - SCOPE_RW_GRID
```
public static final int SCOPE_RW_GRID
```
    See Also:
    
    Constant Field Values
  - SCOPE_RW_CONTROL
```
public static final int SCOPE_RW_CONTROL
```
    See Also:
    
    Constant Field Values
  - NODE_WIDGET
```
public static final java.lang.String NODE_WIDGET
```
    Tag name
    
    See Also:
    
    Constant Field Values
  - ATT_ID
```
protected static final java.lang.String ATT_ID
```
    xml attribute name for widget ID
    
    See Also:
    
    Constant Field Values
  - ATT_JAVA_CLASS
```
protected static final java.lang.String ATT_JAVA_CLASS
```
    xml attribute name for widget Java class name
    
    See Also:
    
    Constant Field Values
  - ATT_TITLE
```
protected static final java.lang.String ATT_TITLE
```
    xml attribute name for widget title
    
    See Also:
    
    Constant Field Values
  - ATT_TITLE_ID
```
protected static final java.lang.String ATT_TITLE_ID
```
    xml attribute name for widget title ID
    
    See Also:
    
    Constant Field Values
  - ATT_FLASH_STYLE_ID
```
protected static final java.lang.String ATT_FLASH_STYLE_ID
```
    xml attribute name for the flash style id
    
    Since:
    
    MicroStrategy Web 8.1.1
    
    See Also:
    
    Constant Field Values
  - ATT_TITLE_DESC_ID
```
protected static final java.lang.String ATT_TITLE_DESC_ID
```
    xml attribute name for widget title description ID
    
    Since:
    
    MicroStrategy Web 8.1.1
    
    See Also:
    
    Constant Field Values
  - ATT_SCOPE
```
protected static final java.lang.String ATT_SCOPE
```
    xml attribute name for widget scope
    
    See Also:
    
    Constant Field Values
  - ATT_TB_IMAGE
```
protected static final java.lang.String ATT_TB_IMAGE
```
    xml attribute name for widget toolbar image
    
    See Also:
    
    Constant Field Values
  - ATT_TB_CLASS
```
protected static final java.lang.String ATT_TB_CLASS
```
    xml attribute name for widget toolbar CSS class
    
    See Also:
    
    Constant Field Values
  - ATT_PREVIEW_IMAGE
```
protected static final java.lang.String ATT_PREVIEW_IMAGE
```
    xml attribute name for widget preview image
    
    See Also:
    
    Constant Field Values
  - ATT_RSL_PATH
```
protected static final java.lang.String ATT_RSL_PATH
```
    xml attribute name for widget RSL path
    
    See Also:
    
    Constant Field Values
  - ATT_IS_APP
```
protected static final java.lang.String ATT_IS_APP
```
    xml attribute name indicates whether it is an application widget or component widget.
    
    Since:
    
    MicroStrategy Web 8.1.1
    
    See Also:
    
    Constant Field Values
  - ATT_DEFAULT_DHTML_STYLE
```
protected static final java.lang.String ATT_DEFAULT_DHTML_STYLE
```
    xml attribute name indicates the default dhtml style a widget uses (if it uses any).
    
    Since:
    
    MicroStrategy Web 8.1.1
    
    See Also:
    
    Constant Field Values
  - ATT_MIN_SECONDARY_PROVIDERS
```
protected static final java.lang.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.
    
    Since:
    
    MicroStrategy Web 8.1.1
    
    See Also:
    
    Constant Field Values
  - ATT_MAX_SECONDARY_PROVIDERS
```
protected static final java.lang.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.
    
    Since:
    
    MicroStrategy Web 8.1.1
    
    See Also:
    
    Constant Field Values
  - ATT_IS_IVE
```
protected static final java.lang.String ATT_IS_IVE
```
    xml attribute name indicates whether it is available for IVE.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Widget
```
public Widget()
```
    Since:
    
    MicroStrategy Web 9.0.0
  - Widget
```
public Widget(org.w3c.dom.Node root)
```
    Creates a Widget with the information in the Xml Node. Internally it calls AbstractConfigurationElement.initFromXML(org.w3c.dom.Node).
    
    Parameters:
    
    root - the xml node.
- Method Detail
  - getKeyAttribute
```
protected java.lang.String getKeyAttribute()
```
    Description copied from class: AbstractConfigurationElement
    
    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.
    
    Specified by:
    
    getKeyAttribute in class AbstractConfigurationElement
    
    Since:
    
    MicroStrategy Web 9.0.0
  - getId
```
public java.lang.String getId()
```
    Get the widget ID
    
    Returns:
    
    the widget ID.
  - setId
```
public void setId(java.lang.String value)
```
    Set the widget ID
    
    Parameters:
    
    value - widget id value.
  - getJavaClass
```
public java.lang.String getJavaClass()
```
    Get the widget Java class
    
    Returns:
    
    the widget Java class.
  - setJavaClass
```
public void setJavaClass(java.lang.String value)
```
    Set the widget Java class
    
    Parameters:
    
    value - widget Java class value.
  - getTitle
```
public java.lang.String getTitle()
```
    Get the widget title
    
    Returns:
    
    the widget title.
  - setTitle
```
public void setTitle(java.lang.String value)
```
    Set the widget title
    
    Parameters:
    
    value - the widget title value.
  - getTitleId
```
public java.lang.String getTitleId()
```
    Get the widget title ID
    
    Returns:
    
    the widget title ID.
  - setTitleId
```
public void setTitleId(java.lang.String value)
```
    Set the widget title ID
    
    Parameters:
    
    value - the widget title ID value.
  - getFlashStyleId
```
public java.lang.String getFlashStyleId()
```
    Get the widget flash style ID
    
    Returns:
    
    the widget flash style ID.
    
    Since:
    
    MicroStrategy Web 8.1.1
  - setFlashStyleId
```
public void setFlashStyleId(java.lang.String value)
```
    Set the widget flash style ID
    
    Parameters:
    
    value - the widget flash style ID value.
    
    Since:
    
    MicroStrategy Web 8.1.1
  - getScope
```
public int getScope()
```
    Returns a unit type supported by the widget
    
    Returns:
    
    a unit type supported by the widget.
  - setScope
```
public void setScope(int value)
```
    Sets a unit type supported by the widget
    
    Parameters:
    
    value - unit type value
  - getToolbarImage
```
public java.lang.String getToolbarImage()
```
    Get the widget toolbar image path
    
    Returns:
    
    the widget toolbar image path.
  - setToolbarImage
```
public void setToolbarImage(java.lang.String value)
```
    Sets the widget toolbar image path
    
    Parameters:
    
    value - the widget toolbar image path
  - getToolbarClass
```
public java.lang.String getToolbarClass()
```
    Returns the widget toolbar class
    
    Returns:
    
    the widget toolbar class.
  - setToolbarClass
```
public void setToolbarClass(java.lang.String value)
```
    Sets the widget toolbar CSS class
    
    Parameters:
    
    value - the widget toolbar CSS class.
  - getPreviewImage
```
public java.lang.String getPreviewImage()
```
    Returns the widget preview image path
    
    Returns:
    
    the widget preview image path.
  - setPreviewImage
```
public void setPreviewImage(java.lang.String value)
```
    Sets the widget preview image path
    
    Parameters:
    
    value - the widget preview image path.
  - getRslPath
```
public java.lang.String getRslPath()
```
    Returns the widget RSL path
    
    Returns:
    
    the widget RSL path.
  - setRslPath
```
public void setRslPath(java.lang.String value)
```
    Sets the widget RSL path
    
    Parameters:
    
    value - the widget RSL path.
  - getDefaultDHTMLStyel
```
public int getDefaultDHTMLStyel()
```
    Returns the widget default DHTML style.
    
    Returns:
    
    the widget default DHTML style.
    
    Since:
    
    MicroStrategy Web 8.1.1
  - setDefaultDHTMLStyle
```
public void setDefaultDHTMLStyle(int value)
```
    Sets the default DHTML style the widget uses
    
    Parameters:
    
    value - the default DHTML style
    
    Since:
    
    MicroStrategy Web 8.1.1
  - getMinSecondaryProviders
```
public int getMinSecondaryProviders()
```
    Returns the widget minimum number of secondary providers allowed.
    
    Returns:
    
    the widget minimum number of secondary providers allowed.
    
    Since:
    
    MicroStrategy Web 8.1.1
  - setMinSecondaryProviders
```
public void setMinSecondaryProviders(int value)
```
    Sets the widget minimum number of secondary providers allowed.
    
    Parameters:
    
    value - the widget minimum number of secondary providers allowed.
    
    Since:
    
    MicroStrategy Web 8.1.1
  - getMaxSecondaryProviders
```
public int getMaxSecondaryProviders()
```
    Returns the widget maximum number of secondary providers allowed.
    
    Returns:
    
    the widget maximum number of secondary providers allowed.
    
    Since:
    
    MicroStrategy Web 8.1.1
  - setMaxSecondaryProviders
```
public void setMaxSecondaryProviders(int value)
```
    Sets the widget minimum number of secondary providers allowed.
    
    Parameters:
    
    value - the widget minimum number of secondary providers allowed.
    
    Since:
    
    MicroStrategy Web 8.1.1
  - getTitleDescId
```
public java.lang.String getTitleDescId()
```
    Returns the widgets titleDESCId
    
    Returns:
    
    The widgets titleDESCId
    
    Since:
    
    MicroStrategy Web 8.1.1
  - setTitleDescId
```
public void setTitleDescId(java.lang.String value)
```
    Sets the Desktop title description id
    
    Parameters:
    
    value - value of the titleDESCId
    
    Since:
    
    MicroStrategy Web 8.1.1
  - setIsApp
```
public void setIsApp(boolean value)
```
    Since:
    
    MicroStrategy Web 8.1.1
  - isApp
```
public boolean isApp()
```
    Since:
    
    MicroStrategy Web 8.1.1
  - setIsIVE
```
public void setIsIVE(boolean value)
```
  - getIsIVE
```
public boolean getIsIVE()
```

Constructor	Description
`Widget()`
`Widget(org.w3c.dom.Node root)`	Creates a Widget with the information in the Xml Node.

Class Widget

Nested Class Summary

Nested classes/interfaces inherited from class com.microstrategy.utils.config.AbstractConfigurationElement

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

SCOPE_RW_GRID

SCOPE_RW_CONTROL

NODE_WIDGET

ATT_ID

ATT_JAVA_CLASS

ATT_TITLE

ATT_TITLE_ID

ATT_FLASH_STYLE_ID

ATT_TITLE_DESC_ID

ATT_SCOPE

ATT_TB_IMAGE

ATT_TB_CLASS

ATT_PREVIEW_IMAGE

ATT_RSL_PATH

ATT_IS_APP

ATT_DEFAULT_DHTML_STYLE

ATT_MIN_SECONDARY_PROVIDERS

ATT_MAX_SECONDARY_PROVIDERS

ATT_IS_IVE

Constructor Detail

Widget

Widget

Method Detail

getKeyAttribute

getId

setId

getJavaClass

setJavaClass

getTitle

setTitle

getTitleId

setTitleId

getFlashStyleId

setFlashStyleId

getScope

setScope

getToolbarImage

setToolbarImage

getToolbarClass

setToolbarClass

getPreviewImage

setPreviewImage

getRslPath

setRslPath

getDefaultDHTMLStyel

setDefaultDHTMLStyle

getMinSecondaryProviders

setMinSecondaryProviders

getMaxSecondaryProviders

setMaxSecondaryProviders

getTitleDescId

setTitleDescId

setIsApp

isApp

setIsIVE

getIsIVE