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
From class java.lang.Object
From interface com.microstrategy.utils.config.ConfigurationElement
From interface com.microstrategy.utils.config.ConfigurationFile

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.