public class

ShortcutList

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

Class Overview

The ShortcutList class is a multipurpose class that represents a list of Shortcut objects. This objects can be used to display links, menus, toolbars and pickers.

ShortcutList objects are the in memory representation of the <shortcut-list> elements from the pageConfig.xml file and menus, toolbars and pickers definition files. The properties of this object map directly the attributes of the configuration tag

The following list explains the different types of ShortcutList objects/tag elements used throughout the applicattion:

  • <template><shortcut-list-set><shortcut-list>... represents a list of links that can be displayed in the application using the <web:shortcutOptions> tag library.
  • <menus><shortcut-list-set><shortcut-list>... represents a menu block that can be display using the Menu GUI Element.
  • <toolbars><shortcut-list-set><shortcut-list>... represents a toolbar that can be display using the Toolbar GUI Element.
  • <system-pickers><shortcut-list-set><shortcut-list>... represents the list of options that appear inside a system picker, like those used in toolbars.

Summary

Constants
String ATT_BASE_BEAN xml attribute name for the base bean property of the shortcut list
String ATT_DESC xml attribute name for the description of the shortcut list
String ATT_DESC_ID xml attribute name for the descriptor ID of the shortcut list
String ATT_ENABLE_FEATURE_ID xml attribute name for the enable feature associated with this shortcut list
String ATT_FEATURE_ID xml attribute name for the feature associated with this shortcut list
String ATT_NAME xml attribute name for the name of the shortcut list
String ATT_TYPE xml attribute name for the type associated with this shortcut list
String NODE_SHORTCUTS constant for the shorcut list node name
int TYPE_DEFAULT
int TYPE_STYLES
[Expand]
Inherited Constants
From class com.microstrategy.utils.config.AbstractConfigurationElementList
From class com.microstrategy.utils.config.AbstractConfigurationElement
Public Constructors
ShortcutList()
Class constructor.
ShortcutList(Node root)
Class constructor.
ShortcutList(Document doc)
Class constructor.
Public Methods
WebAttributeList getAttributeList()
Get the attribute list for the instance
WebAttributeList getAttributeList(boolean createElement)
String getBaseBean()
Returns the bean from the pages bean hierarchy associated with the shortcut list.
String getDescriptor()
Returns a descriptor that the application should use to display the shortcut list if the desc-id attribute is missing.
String getDescriptorID()
Returns the Resource Bundle item id that the application should use to display the shortcut list in the language of the user's locale.
String getEnableFeatureId()
Represents a feature that is evaluated to determine whether the shortcut list object should appear enabled or disabled when it is rendered.
String getFeatureID()
Returns the id of a feature that is evaluated to determine whether the shortcut list object should be displayed.
String getName()
Returns the name for this shortcut list, a unique identifier of the ShortcutList instance.
Shortcut getShortcut(String name)
Shortcut getShortcutByFeatureId(String featureId)
String getString(Messages messages)
Returns the object's localized descriptor.
int getType()
Returns the ShortcutList's type.
void setBaseBean(String value)
Indicates the bean from the pages bean hierarchy associated with the shortcut list.
void setDescriptor(String descriptor)
Provides a descriptor that the application should use to display the shortcut list if the desc-id attribute is missing.
void setDescriptorID(String descriptorID)
Provides the Resource Bundle item id that the application should use to display the shortcut list in the language of the user's locale.
void setEnableFeatureId(String value)
Returns the ID of the enable feature associated with the ShortcutList.
void setFeatureID(String value)
Indicates a feature-id that is evaluated to determine whether the shortcut list object should be displayed.
void setName(String name)
Set the name of the ShortcutList instance, a unique identifier of the ShortcutList instance.
void setType(int type)
Sets the type property value of the instance.
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

Constant Value: "base-bean"

public static final String ATT_DESC

xml attribute name for the description of the shortcut list

Constant Value: "desc"

public static final String ATT_DESC_ID

xml attribute name for the descriptor ID of the shortcut list

Constant Value: "desc-id"

public static final String ATT_ENABLE_FEATURE_ID

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

Constant Value: "enable-feature-id"

public static final String ATT_FEATURE_ID

xml attribute name for the feature associated with this shortcut list

Constant Value: "feature-id"

public static final String ATT_NAME

xml attribute name for the name of the shortcut list

Constant Value: "name"

public static final String ATT_TYPE

xml attribute name for the type associated with this shortcut list

Constant Value: "type"

public static final String NODE_SHORTCUTS

constant for the shorcut list node name

Constant Value: "shortcut-list"

public static final int TYPE_DEFAULT

Constant Value: 0 (0x00000000)

public static final int TYPE_STYLES

Constant Value: 1 (0x00000001)

Public Constructors

public ShortcutList ()

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

public ShortcutList (Node root)

Class constructor. Initializes a ShortcutList instance based on the information included in the XML Node

Parameters
root Node instance representing the shortcut list information.

public ShortcutList (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 Methods

public WebAttributeList getAttributeList ()

Get the attribute list for the instance

Returns
  • attribute list for this style

public WebAttributeList getAttributeList (boolean createElement)

public String getBaseBean ()

Returns the bean from the pages bean hierarchy associated with the shortcut list.

public String getDescriptor ()

Returns a descriptor that the application should use to display the shortcut list if the desc-id attribute is missing.

public String getDescriptorID ()

Returns the Resource Bundle item id that the application should use to display the shortcut list in the language of the user's locale.

public String getEnableFeatureId ()

Represents a feature that is evaluated to determine whether the shortcut list object should appear enabled or disabled when it is rendered.

public String getFeatureID ()

Returns the id of a feature that is evaluated to determine whether the shortcut list object should be displayed.

Returns
  • String

public String getName ()

Returns the name for this shortcut list, a unique identifier of the ShortcutList instance.

public Shortcut getShortcut (String name)

Parameters
name string representing the name of the shortcut to return
Returns

public Shortcut getShortcutByFeatureId (String featureId)

Parameters
featureId string representing the feature identifier of the shortcut to return
Returns

public String getString (Messages messages)

Returns the object's localized descriptor.

Parameters
messages the messages l10n object.
Returns
  • the String representing the object's localized descriptor.

public int getType ()

Returns the ShortcutList's type. When the ShortcutList is used to define a drop-down list, this property controls which class is used to render the ShortcutList:

Returns
  • the int value of the type property.

public void setBaseBean (String value)

Indicates the bean from the pages bean hierarchy associated with the shortcut list. If a shortcut object inside the shortcut list 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. (If this attribute is not set, the application tries to use the base-bean attribute from the element.)

public void setDescriptor (String descriptor)

Provides a descriptor that the application should use to display the shortcut list if the desc-id attribute is missing.

public void setDescriptorID (String descriptorID)

Provides the Resource Bundle item id that the application should use to display the shortcut list in the language of the user's locale.

public void setEnableFeatureId (String value)

Returns the ID of the enable feature associated with the ShortcutList. If this feature is disabled, then the ShortcutList should be presented but disabled.

public void setFeatureID (String value)

Indicates a feature-id that is evaluated to determine whether the shortcut list object should be displayed.

public void setName (String name)

Set the name of the ShortcutList instance, a unique identifier of the ShortcutList instance.

public void setType (int type)

Sets the type property value of the instance. Defines which class is used to render ShortcutList when used as a drop-down definition.

See Also

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.