Package com.microstrategy.web.app

Class ShortcutListSet

    • Field Detail

      • NODE_SHORTCUT_LISTS

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

      • ATT_NAME

        public static final java.lang.String ATT_NAME
        xml attribute name for the nmae of the shortcut list set
        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 set
        See Also:
        Constant Field Values

      • ATT_JS_FILE

        public static final java.lang.String ATT_JS_FILE
        xml attribute name for the js file associated with the list set
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values

      • ATT_SCRIPT_CLASS

        public static final java.lang.String ATT_SCRIPT_CLASS
        xml attribute name for the script class associated with the list set
        Since:
        MicroStrategy Web 8.0.0
        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 set
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values

      • EVENT_UNDEFINED

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

    • Constructor Detail

      • ShortcutListSet

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

      • ShortcutListSet

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

      • ShortcutListSet

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

      • ShortcutListSet

        public ShortcutListSet​(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.

      • ShortcutListSet

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

    • 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

      • getShortcutList

        public ShortcutList getShortcutList​(java.lang.String name)
        Returns the ShortcutList associated with the given name.

      • setName

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

      • getName

        public java.lang.String getName()
        Returns the name of the ShortcutList instance, which is used as a unique identifier.

      • setBaseBean

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

      • getBaseBean

        public java.lang.String getBaseBean()
        Returns the name of the base-bean associated with this ShortcutListSet
        See Also:
        setBaseBean(java.lang.String)

      • setJavascriptFile

        public void setJavascriptFile​(java.lang.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.
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        setScriptClass(java.lang.String)

      • setScriptClass

        public void setScriptClass​(java.lang.String value)
        Associates this ShortcutListSet with a JavaScript bone, the script-class defines the name of the corresponding JavaScript class
        Since:
        MicroStrategy Web 8.0.0

      • getScriptClass

        public java.lang.String getScriptClass()
        Returns the script-class of the JavaScript bone associated with this ShortcutListSet
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        setScriptClass(java.lang.String)

      • getFeatureId

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

      • setFeatureId

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

      • getAttributeList

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

      • getDefaultListSet

        @Deprecated
public ShortcutListSet getDefaultListSet()
        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.

      • getEventMapping

        public HashList getEventMapping()