Package com.microstrategy.web.app

Class ShortcutList

  • All Implemented Interfaces:
    ConfigurationElement, ConfigurationElementList, ConfigurationFile, java.lang.Cloneable
    public class ShortcutList
extends AbstractConfigurationElementList
    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.
    Since:
    MicroStrategy Web 7.3.1 or earlier

    • Field Detail

      • NODE_SHORTCUTS

        public static final java.lang.String NODE_SHORTCUTS
        constant for the shorcut list node name
        See Also:
        Constant Field Values

      • ATT_NAME

        public static final java.lang.String ATT_NAME
        xml attribute name for the name of the shortcut list
        See Also:
        Constant Field Values

      • ATT_DESC

        public static final java.lang.String ATT_DESC
        xml attribute name for the description of the shortcut list
        See Also:
        Constant Field Values

      • ATT_DESC_ID

        public static final java.lang.String ATT_DESC_ID
        xml attribute name for the descriptor ID of the shortcut list
        See Also:
        Constant Field Values

      • ATT_BASE_BEAN

        public static final java.lang.String ATT_BASE_BEAN
        xml attribute name for the base bean property of the shortcut list
        See Also:
        Constant Field Values

      • ATT_FEATURE_ID

        public static final java.lang.String ATT_FEATURE_ID
        xml attribute name for the feature associated with this shortcut list
        See Also:
        Constant Field Values

      • ATT_ENABLE_FEATURE_ID

        public static final java.lang.String ATT_ENABLE_FEATURE_ID
        xml attribute name for the enable feature associated with this shortcut list
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values

      • ATT_TYPE

        public static final java.lang.String ATT_TYPE
        xml attribute name for the type associated with this shortcut list
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values

      • TYPE_DEFAULT

        public static final int TYPE_DEFAULT
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values

      • TYPE_STYLES

        public static final int TYPE_STYLES
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values

    • Constructor Detail

      • ShortcutList

        public ShortcutList()
        Class constructor. Initializes a new -empty- instance of the EventMapList class.

      • ShortcutList

        public ShortcutList​(org.w3c.dom.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.

      • ShortcutList

        public ShortcutList​(org.w3c.dom.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.

    • 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.
        Overrides:
        getKeyAttribute in class AbstractConfigurationElementList
        Since:
        MicroStrategy Web 9.0.0

      • getType

        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.
        Since:
        MicroStrategy Web 8.0.0

      • setType

        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.
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        getType()

      • getShortcut

        public Shortcut getShortcut​(java.lang.String name)
        Parameters:
        name - string representing the name of the shortcut to return
        Returns:
        a Shortcut by its name.

      • getShortcutByFeatureId

        public Shortcut getShortcutByFeatureId​(java.lang.String featureId)
        Parameters:
        featureId - string representing the feature identifier of the shortcut to return
        Returns:
        a Shortcut by its feature Id.

      • setName

        public void setName​(java.lang.String name)
        Set the name of the ShortcutList instance, a unique identifier of the ShortcutList instance.

      • getName

        public java.lang.String getName()
        Returns the name for this shortcut list, a unique identifier of the ShortcutList instance.

      • getDescriptor

        public java.lang.String getDescriptor()
        Returns a descriptor that the application should use to display the shortcut list if the desc-id attribute is missing.

      • setDescriptor

        public void setDescriptor​(java.lang.String descriptor)
        Provides a descriptor that the application should use to display the shortcut list if the desc-id attribute is missing.

      • getDescriptorID

        public java.lang.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.

      • setDescriptorID

        public void setDescriptorID​(java.lang.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.

      • setBaseBean

        public void setBaseBean​(java.lang.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.)

      • getBaseBean

        public java.lang.String getBaseBean()
        Returns the bean from the pages bean hierarchy associated with the shortcut list.
        See Also:
        setBaseBean(java.lang.String)

      • setFeatureID

        public void setFeatureID​(java.lang.String value)
        Indicates a feature-id that is evaluated to determine whether the shortcut list object should be displayed.

      • getFeatureID

        public java.lang.String getFeatureID()
        Returns the id of a feature that is evaluated to determine whether the shortcut list object should be displayed.
        Returns:
        String

      • setEnableFeatureId

        public void setEnableFeatureId​(java.lang.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.
        Since:
        MicroStrategy Web 8.0.0

      • getEnableFeatureId

        public java.lang.String getEnableFeatureId()
        Represents a feature that is evaluated to determine whether the shortcut list object should appear enabled or disabled when it is rendered.
        Since:
        MicroStrategy Web 8.0.0

      • getAttributeList

        public WebAttributeList getAttributeList()
        Get the attribute list for the instance
        Returns:
        attribute list for this style
        Since:
        MicroStrategy Web 8.0.0

      • getAttributeList

        public WebAttributeList getAttributeList​(boolean createElement)

      • getString

        public java.lang.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.