Package com.microstrategy.web.app
Class ShortcutListSet
- java.lang.Object
-
- com.microstrategy.utils.config.AbstractConfigurationElement
-
- com.microstrategy.utils.config.AbstractConfigurationElementList
-
- com.microstrategy.web.app.ShortcutListSet
-
- All Implemented Interfaces:
ConfigurationElement
,ConfigurationElementList
,ConfigurationFile
,java.lang.Cloneable
public class ShortcutListSet extends AbstractConfigurationElementList
The ShortcutListSet class groups a list ofobjects, 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. - Since:
- MicroStrategy Web 7.3.1 or earlier
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ShortcutListSet.EventActionMapping
-
Nested classes/interfaces inherited from class com.microstrategy.utils.config.AbstractConfigurationElement
AbstractConfigurationElement.FilteredList
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
ATT_BASE_BEAN
xml attribute name for the base bean property of the shortcut list setstatic java.lang.String
ATT_FEATURE_ID
xml attribute name for the feature associated with this shortcut list setstatic java.lang.String
ATT_JS_FILE
xml attribute name for the js file associated with the list setstatic java.lang.String
ATT_NAME
xml attribute name for the nmae of the shortcut list setstatic java.lang.String
ATT_SCRIPT_CLASS
xml attribute name for the script class associated with the list setstatic int
EVENT_UNDEFINED
static java.lang.String
NODE_SHORTCUT_LISTS
constant for the shorcut list set node name-
Fields inherited from class com.microstrategy.utils.config.AbstractConfigurationElementList
ATT_VERSION
-
Fields inherited from class com.microstrategy.utils.config.AbstractConfigurationElement
ATT_CONFIG_SRC, ATT_DELETED, ATT_POSITION, ATT_PROTOTYPE, ATT_USE_DEFAULT
-
-
Constructor Summary
Constructors Constructor Description ShortcutListSet()
Class constructor.ShortcutListSet(org.w3c.dom.Document doc)
Class constructor.ShortcutListSet(org.w3c.dom.Document doc, ShortcutListSet defaultListSet)
Class constructor.ShortcutListSet(org.w3c.dom.Node root)
Class constructor.ShortcutListSet(org.w3c.dom.Node root, ShortcutListSet defaultListSet)
Class constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description WebAttributeList
getAttributeList()
Returns theWebAttributeList
associated with this ShortcutListSet.java.lang.String
getBaseBean()
Returns the name of the base-bean associated with this ShortcutListSetShortcutListSet
getDefaultListSet()
Deprecated.Not used anymore.HashList
getEventMapping()
java.lang.String
getFeatureId()
Get the feature Id associated with this shortcut list set.java.lang.String
getJavascriptFile()
Returns the javascript file name associated with this ShortcutListSetprotected java.lang.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 thegetKey
andsetKey
methods.java.lang.String
getName()
Returns the name of the ShortcutList instance, which is used as a unique identifier.java.lang.String
getScriptClass()
Returns the script-class of the JavaScript bone associated with this ShortcutListSetShortcutList
getShortcutList(java.lang.String name)
Returns theShortcutList
associated with the given name.void
setBaseBean(java.lang.String value)
Indicates the bean from the pages bean hierarchy associated with the shortcut lists in the set.void
setFeatureId(java.lang.String featureId)
Sets the feature Id associated with this shortcut list set.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.void
setName(java.lang.String name)
Sets the name, a unique identifier for the ShortcutList instancevoid
setScriptClass(java.lang.String value)
Associates this ShortcutListSet with a JavaScript bone, the script-class defines the name of the corresponding JavaScript class-
Methods inherited from class com.microstrategy.utils.config.AbstractConfigurationElementList
clear, clone, get, get, getFilteredList, getKey, getList, getValues, getVersion, init, isEmpty, put, put, registerElementInList, remove, setVersion, size, sort
-
Methods inherited from class com.microstrategy.utils.config.AbstractConfigurationElement
addFileSource, applyCustomization, applyCustomizations, cleanUpDeletedElements, delete, deltas, deltas, equalAtts, equalElements, equalNodeValues, equals, equalsIncludingDeletedElements, exportAttributesToXML, exportElementsToXML, exportNodeValueToXML, getAttribute, getAttributes, getBoolAttribute, getChildKey, getConfigSrc, getDTDFileName, getElement, getElement, getElements, getFileLoader, getIntAttribute, getIntAttribute, getKey, getLineNumber, getList, getNextKey, getNodeName, getNodeValue, getNodeValue, getOrCreateElement, getParent, getPosition, getPrototype, getRegisteredClass, getSelfInitPath, getSource, getStrAttribute, getUseDefault, getXMLParserParameters, getXMLSerializerParameters, hashCode, hashCodeAtts, hashCodeElements, hashCodeNodeValues, hasRegisteredClass, initAttributesFromXML, initDefaultAttributes, initElementFromXML, initElementsFromXML, initFromFile, initFromResource, initFromXML, initFromXML, initNodeValueFromXML, initPrototype, isActive, isCustomized, isDeleted, isDirty, isInSource, isKeyAttribute, load, mergeChanges, newChildInstance, newSource, original, populate, printAttributes, printElements, printNodeValue, refreshLists, registerClass, registerElement, registerElement, registerElementList, reload, reloadPrototype, removeAttribute, removeDefaults, replaceList, restore, save, save, saveChangesAs, saveConfig, saveFlatXML, saveNode, saveSource, setAttribute, setBoolAttribute, setChildOriginals, setConfigSrc, setCustomized, setElement, setFileLoader, setIntAttribute, setKey, setLineNumber, setNodeName, setNodeValue, setPosition, setPrototype, setSelfInitPath, setStrAttribute, setUseDefault, setUseValidation, throwConfigParseException, toString, toXML, toXML, toXML, toXML, useNodeValue, useValidation
-
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface com.microstrategy.utils.config.ConfigurationElement
getAttribute, getAttributes, getElement, getElements, getKey, getNodeName, getStrAttribute, initFromXML, reload, toXML
-
-
-
-
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 thegetKey
andsetKey
methods.- Overrides:
getKeyAttribute
in classAbstractConfigurationElementList
- Since:
- MicroStrategy Web 9.0.0
-
getShortcutList
public ShortcutList getShortcutList(java.lang.String name)
Returns theShortcutList
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)
-
getJavascriptFile
public java.lang.String getJavascriptFile()
Returns the javascript file name associated with this ShortcutListSet- Since:
- MicroStrategy Web 8.0.0
- See Also:
setScriptClass(java.lang.String)
,setJavascriptFile(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 theWebAttributeList
associated with this ShortcutListSet. Theseattribute
elements define name-value pairs of html attributes that are added to the objects container (that is, added within thetag) when rendered. Theattributes
element is used with system pickers and toolbars, but not menus.- Returns:
- attribute list for this style
- Since:
- MicroStrategy Web 8.0.0
-
getDefaultListSet
public ShortcutListSet getDefaultListSet()
Deprecated.Not used anymore. A more generic framework is now in place to support default values and values from multiple sources. SeeAbstractConfigurationElement
.Returns the defaultShortcutListSet
object that was used to populate default values for thisShortcutListSet
in the constructor. If none, it returnsnull
.
-
getEventMapping
public HashList getEventMapping()
-
-