public class

ShortcutListSet

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

Class Overview

The ShortcutListSet class groups a list of objects, which each define a group of shortcut objects. These shortcut objects can be used to define menu items, system picker items, links and context menu items.

Summary

Nested Classes
class ShortcutListSet.EventActionMapping  
Constants
String ATT_BASE_BEAN xml attribute name for the base bean property of the shortcut list set
String ATT_FEATURE_ID xml attribute name for the feature associated with this shortcut list set
String ATT_JS_FILE xml attribute name for the js file associated with the list set
String ATT_NAME xml attribute name for the nmae of the shortcut list set
String ATT_SCRIPT_CLASS xml attribute name for the script class associated with the list set
int EVENT_UNDEFINED
String NODE_SHORTCUT_LISTS constant for the shorcut list set node name
[Expand]
Inherited Constants
From class com.microstrategy.utils.config.AbstractConfigurationElementList
From class com.microstrategy.utils.config.AbstractConfigurationElement
Public Constructors
ShortcutListSet()
Class constructor.
ShortcutListSet(Node root)
Class constructor.
ShortcutListSet(Node root, ShortcutListSet defaultListSet)
Class constructor.
ShortcutListSet(Document doc)
Class constructor.
ShortcutListSet(Document doc, ShortcutListSet defaultListSet)
Class constructor.
Public Methods
WebAttributeList getAttributeList()
Returns the WebAttributeList associated with this ShortcutListSet.
String getBaseBean()
Returns the name of the base-bean associated with this ShortcutListSet
ShortcutListSet getDefaultListSet()
This method is deprecated. Not used anymore. A more generic framework is now in place to support default values and values from multiple sources. See AbstractConfigurationElement.
HashList getEventMapping()
String getFeatureId()
Get the feature Id associated with this shortcut list set.
String getJavascriptFile()
Returns the javascript file name associated with this ShortcutListSet
String getName()
Returns the name of the ShortcutList instance, which is used as a unique identifier.
String getScriptClass()
Returns the script-class of the JavaScript bone associated with this ShortcutListSet
ShortcutList getShortcutList(String name)
Returns the ShortcutList associated with the given name.
void setBaseBean(String value)
Indicates the bean from the pages bean hierarchy associated with the shortcut lists in the set.
void setFeatureId(String featureId)
Sets the feature Id associated with this shortcut list set.
void setJavascriptFile(String value)
If the shortcut list set is associated with a JavaScript bone, this property defines the JavaScript file that contains the JavaScript class corresponding to the JavaScript bone.
void setName(String name)
Sets the name, a unique identifier for the ShortcutList instance
void setScriptClass(String value)
Associates this ShortcutListSet with a JavaScript bone, the script-class defines the name of the corresponding JavaScript class
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.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 ATT_BASE_BEAN

xml attribute name for the base bean property of the shortcut list set

Constant Value: "base-bean"

public static final String ATT_FEATURE_ID

xml attribute name for the feature associated with this shortcut list set

Constant Value: "feature-id"

public static final String ATT_JS_FILE

xml attribute name for the js file associated with the list set

Constant Value: "javascript-file"

public static final String ATT_NAME

xml attribute name for the nmae of the shortcut list set

Constant Value: "name"

public static final String ATT_SCRIPT_CLASS

xml attribute name for the script class associated with the list set

Constant Value: "script-class"

public static final int EVENT_UNDEFINED

Constant Value: -1 (0xffffffff)

public static final String NODE_SHORTCUT_LISTS

constant for the shorcut list set node name

Constant Value: "shortcut-list-set"

Public Constructors

public ShortcutListSet ()

Class constructor. Initializes a new -empty- instance of the ShortcutListSet class.

public ShortcutListSet (Node root)

Class constructor. Initializes a ShortcutListSet instance and populates it based on the information included in the XML Node

Parameters
root Node instance representing the shortcut list information.

public ShortcutListSet (Node root, ShortcutListSet defaultListSet)

Class constructor. Initializes a ShortcutList instance based on the information included in the XML Node and the default shorctcut list set provided.

Parameters
root Node instance representing the shortcut list information.
defaultListSet the default ShortcutListSet to use Default Lists will be taken from this parameter

public ShortcutListSet (Document doc)

Class constructor. Initializes a ShortcutList instance based on the information included in the DOM Document

Parameters
doc Document instance representing the shortcut list information.

public ShortcutListSet (Document doc, ShortcutListSet defaultListSet)

Class constructor. Initializes a ShortcutList instance based on the information included in the DOM Document

Parameters
doc Document instance representing the shortcut list information.
defaultListSet the default ShortcutListSet to use Default Lists will be taken from this parameter

Public Methods

public WebAttributeList getAttributeList ()

Returns the WebAttributeList associated with this ShortcutListSet. These attribute elements define name-value pairs of html attributes that are added to the objects container (that is, added within the

tag) when rendered. The attributes element is used with system pickers and toolbars, but not menus.

Returns
  • attribute list for this style

public String getBaseBean ()

Returns the name of the base-bean associated with this ShortcutListSet

public ShortcutListSet getDefaultListSet ()

This method is deprecated.
Not used anymore. A more generic framework is now in place to support default values and values from multiple sources. See AbstractConfigurationElement.

Returns the default ShortcutListSet object that was used to populate default values for this ShortcutListSet in the constructor. If none, it returns null.

public HashList getEventMapping ()

public String getFeatureId ()

Get the feature Id associated with this shortcut list set. The feature Id controls whether the shortcut list set is visible or not depending on user privileges and application settings.

Returns
  • the feature Id associated with this shortcut list set.

public String getJavascriptFile ()

Returns the javascript file name associated with this ShortcutListSet

public String getName ()

Returns the name of the ShortcutList instance, which is used as a unique identifier.

public String getScriptClass ()

Returns the script-class of the JavaScript bone associated with this ShortcutListSet

public ShortcutList getShortcutList (String name)

Returns the ShortcutList associated with the given name.

public void setBaseBean (String value)

Indicates the bean from the pages bean hierarchy associated with the shortcut lists in the set. If a shortcut list object inside the set does not define a base bean attribute, the value of this base-bean attribute is used in tasks such as resolving features for the shortcut list.

public void setFeatureId (String featureId)

Sets the feature Id associated with this shortcut list set. The feature Id controls whether the shortcut list set is visible or not depending on user privileges and application settings.

Parameters
featureId the feature Id associated with this shortcut list set.

public void setJavascriptFile (String value)

If the shortcut list set is associated with a JavaScript bone, this property defines the JavaScript file that contains the JavaScript class corresponding to the JavaScript bone.

public void setName (String name)

Sets the name, a unique identifier for the ShortcutList instance

public void setScriptClass (String value)

Associates this ShortcutListSet with a JavaScript bone, the script-class defines the name of the corresponding JavaScript class

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.