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

void	clear() Clears the element of the collection
Object	clone()
ConfigurationElement	get(int index)
ConfigurationElement	get(Object key)
AbstractConfigurationElement.FilteredList	getFilteredList()
Object	getKey(int index)
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.
HashList	getList() Returns the collection of elements that are in the list.
Enumeration	getValues() This method is deprecated. It's not recommended to use this method. Instead you can just iterator through the elements of this object.
String	getVersion() Returns the version of the configuration file
void	init(Node root) This method is deprecated. use `initFromXML(Node)`
boolean	isEmpty() Returns `true` if this list contains no elements.
void	put(Object key, ConfigurationElement element) Add an element to the collection
void	put(ConfigurationElement element) Add an element to the collection without providing a key
void	registerElementInList(String nodeName, Class cls) Register element to the list.
ConfigurationElement	remove(Object key) Removes an element from the collection
void	setVersion(String version) Sets the version of the configuration file
int	size() Retuns the size of the collection
void	sort(Comparator comp) Sorts the existing list according to the order induced by the specified comparator.

From class com.microstrategy.utils.config.AbstractConfigurationElement

void	addFileSource(String filePath, String appPath, long lastLoaded) Adds a reference to a file from a config-source.
void	applyCustomization(CustomizationInfo c) Applies the corresponding customizations.
void	applyCustomizations() Loops through all the `CustomizationInfo` in the `Customizations` class and apply the corresponding customizations.
void	cleanUpDeletedElements() This method when called will delete all the child elements that are marked as deleted.
Object	clone()
void	delete(Object key)
AbstractConfigurationElement	deltas(AbstractConfigurationElement other) Returns a partial instance of this object that contains the attributes and elements required to make this object equals to the `other` paramter.
final AbstractConfigurationElement	deltas() Returns the `deltas` between the `original()` and `this` objects.
boolean	equalAtts(AbstractConfigurationElement other) Returns `true` if the list of active attributes of the given AbstractConfigurationElement is equal to this list of active attributes of this AbstractConfigurationElement.
boolean	equalElements(AbstractConfigurationElement other) Returns `true` if the list of all child elements of the given AbstractConfigurationElement is equal to this list of all child-elements of this AbstractConfigurationElement.
boolean	equalNodeValues(AbstractConfigurationElement other) Returns `true` if the node value of both configuration elements is the same.
boolean	equals(Object object)
boolean	equalsIncludingDeletedElements(Object object)
void	exportAttributesToXML(Element element, ConfigurationSource source) Appends the list of attributes of this `ConfigurationElement` into the given node.
void	exportElementsToXML(Element element, ConfigurationSource source) Appends the list of child-elements of this `ConfigurationElement` into the given node.
void	exportNodeValueToXML(Element element, ConfigurationSource source) Appends the node value associated with the given source key into the given node.
final ConfigurationValue	getAttribute(String name) Returns the value associated with the given attribute.
HashList	getAttributes() Returns the list of all attributes available to this ConfigurationElement.
boolean	getBoolAttribute(String name) Helper method, returns the value of the given attribute as boolean (true/false).
Object	getChildKey(Node node) Returns the key that uniquely identifies the child element associated with the given `Node`.
String	getConfigSrc() Returns the value of the config-src attribute.
String	getDTDFileName() Returns the name of a DTD file that will be added as SystemID to the XML resulting from serializing the contents of this ConfigurationElement into a file; `null` by default.
ConfigurationElement	getElement(Object key, boolean includeDeleted)
ConfigurationElement	getElement(Object key) Returns the `ConfigurationElement` instance associated with the given nodeName.
final HashList	getElements() Returns the list of all child-elements available to this ConfigurationElement.
FileLoader	getFileLoader() Returns the file loader instance used by this ConfigurationElement to load files from the file system.
int	getIntAttribute(String name, int defaultValue) Helper method, returns the value of the given attribute as integer.
int	getIntAttribute(String name) Helper method, returns the value of the given attribute as integer.
Object	getKey() Default implementation for `getKey()`.
abstract 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.
int	getLineNumber() Returns the line number (if known) of the element in the XML file.
AbstractConfigurationElement.FilteredList	getList(String nodeName) Returns an `ImplicitList` with all the elements associated with the given `nodeName`.
Object	getNextKey() Returns an object that can be used as key for a list of child-elements that doesn't have a key by itself.
String	getNodeName() Returns the node-name for this element.
String	getNodeValue() Returns the node value for this element.
String	getNodeValue(ConfigurationSource source) Returns the node value for this element in the given sourceKey.
AbstractConfigurationElement	getOrCreateElement(String nodeName, Object key) Returns the current child instance; if null but the child is registered, it creates a new instance for it.
AbstractConfigurationElement	getParent() Gets the parent for this configuration element.
int	getPosition() Returns the expected position of this element.
AbstractConfigurationElement	getPrototype() Returns the current prototype of this instance.
Class	getRegisteredClass(String nodeName) Returns the `Class` associated with the given `nodeName`.
String	getSelfInitPath() Returns the path to the file where this configuration element was originally loaded from.
ConfigurationSource	getSource(String key) Gets the `ElementSource` for the given key.
String	getStrAttribute(String name) Helper method, returns the value of the given attribute as a string.
boolean	getUseDefault() Returns the use-default value.
ParserParameters	getXMLParserParameters(String fileName) Returns an instance of `ParserParameters` used by the XML parser.
SerializerParameters	getXMLSerializerParameters() Returns an instance of `SerializerParameters` used by the XML serializer in the `toXML()` By default it returns `null`.
boolean	hasRegisteredClass(String nodeName) Returns `true` is there is a child registered for the given `nodeName`.
int	hashCode()
int	hashCodeAtts() Returns the hashcode for attributes.
int	hashCodeElements() Returns the hashcode for attributes.
int	hashCodeNodeValues() Returns the hashcode for attributes.
void	initAttributesFromXML(Node root, String sourceKey, CustomizationInfo c) Initializes the list of attributes from given `Node`
void	initDefaultAttributes() This method can be overridden to set default values for attributes.
void	initElementFromXML(Node child, String sourceKey, CustomizationInfo c) Initializes a single child-element from the given `Node`
void	initElementsFromXML(Node root, String sourceKey, CustomizationInfo c) Initializes the list of child-elements from given `Node`
void	initFromFile(String filePath, CustomizationInfo c) Initializes this configuration element by loading the contents of the given `filePath` using the corresponding `CustomizationInfo`.
void	initFromResource(String resourceName) Initializes this configuration element by loading the contents a resource that exists in the class path.
void	initFromXML(Node root, String sourceKey, CustomizationInfo c) Initialize the attributes and child elements from the values in the given `Node`
void	initFromXML(Node root) Initialize the attributes and child elements from the values in the given `Node`
void	initNodeValueFromXML(Node root, String sourceKey, CustomizationInfo c) Initializes the list of child-elements from given `Node`
void	initPrototype(String protoName) Inits the prototype object of this element.
boolean	isActive()
boolean	isCustomized()
boolean	isDeleted() Returns `true` is this element has been mark as deleted.
boolean	isDirty() Returns `true` is this element or one of its children has been modified programatically after being loaded.
boolean	isInSource(String sourceKey) Returns `true` if the element already contains an `ElementSource` for the given key.
boolean	isKeyAttribute(String name) Returns `true` is the name is that of the key attribute.
void	load(String fileName) Loads the file with the given name and initializes this `ConfigurationElement` with its content.
void	mergeChanges(String srcKey) Removes deltas and applies them to the given source.
AbstractConfigurationElement	newChildInstance(String nodeName, Class childClass) Creates a new instance of a child element for the given class.
ConfigurationSource	newSource(String srcKey, CustomizationInfo c) Create a new `ElementSource` and adds to the list of sources of this element.
final AbstractConfigurationElement	original() Returns a new instance of this object, populated only with the out of the box values of Microstrategy Web, that is, only default values or those that came from the load method.
ConfigurationElement	populate(ConfigurationElement other) This method takes another configuration element and populates this element with the other's attributes and child-elements.
void	printAttributes(StringBuffer outString) Appends the list of attributes of this `ConfigurationElement` into the given `StringBuffer`.
void	printElements(StringBuffer outString) Appends the list of child-elements of this `ConfigurationElement` into the given `StringBuffer`.
void	printNodeValue(StringBuffer outString) Appends the node value into the given `StringBuffer`.
void	refreshLists()
void	registerClass(String nodeName, Class c) Registers a child class for the child with the given `nodeName`.
void	registerElement(String nodeName, Class c) Register a child of this `ConfigurationElement`.
void	registerElement(String nodeName, Class c, boolean canBeNull) Register a child of this `ConfigurationElement`.
void	registerElementList(String nodeName, Class c) Register a list of this `ConfigurationElement`.
void	reload() Loops through all the `ElementSource` of this `ConfigurationElement` and reloads the content of those whose underlying configuration file has changed.
void	reloadPrototype() Loops through all the `ElementSource` of this `ConfigurationElement` and reloads the content of those whose underlying configuration file has changed.
void	removeAttribute(String name) Completely remove the value for the given attribute.
void	removeDefaults(CustomizationInfo c) This method is called when the use-default attribute is set false, so all previous values of attributes and children must be cleared.
void	replaceList(AbstractConfigurationElement.FilteredList list)
void	restore(Object key)
void	save(CustomizationInfo c) Saves deltas for this `ConfigurationElement` into the given CustomizationInfo.
void	save() Saves this `ConfigurationElement` back into the files where it was loaded from.
void	saveChangesAs(String fileName) Saves all in-memory changes to the given file.
final void	saveConfig(String filePath) This method is deprecated. To save in a different location, set a custom FileLoader and use the save() method.
void	saveFlatXML(String fileName) Saves the current element structure, in XML format, into the given file.
void	saveNode(Node node, String fileLocation) Saves an XML node into a file in the given location.
void	saveSource(ConfigurationSource source) Saves only the contents associated with the given source.
void	setAttribute(String name, Object value) Sets the value for the given attribute.
void	setBoolAttribute(String name, boolean value) Helper method, sets the value of the given attribute from a boolean.
void	setChildOriginals()
void	setConfigSrc(String path) Sets the config-src attribute.
void	setCustomized(boolean value) set if this element is a customized element or not.
void	setElement(Object key, ConfigurationElement child) Allows users to add or replace an element.
void	setFileLoader(FileLoader fl) Sets the `FileLoader` instance to be used to load files.
void	setIntAttribute(String name, int value) Helper method, sets the value of the given attribute from an integer.
void	setKey(Element element) Default implementation for `setKey()`.
void	setLineNumber(int lineNumber) Sets the line number of the element in the XML file.
void	setNodeName(String name) Sets the name of the node associated with this configuration element.
void	setNodeValue(String value) Returns the node value for this element.
void	setPosition(int position) Sets the expected position of this element.
void	setPrototype(AbstractConfigurationElement prototype) Sets the prototype object for this instance.
void	setSelfInitPath(String value)
void	setStrAttribute(String name, String value) Helper method, sets the value of the given attribute as a string.
void	setUseDefault(boolean useDefault) The definition of a ConfigurationElement can come come from different sources, for example, the definition can come from an external file (by specifying a `getConfigSrc()` value), or it can be modified through a Customization.
void	setUseValidation(boolean value) Defines whether the XML content should validated using a DTD.
String	toString() Generates the String representation of this `ConfigurationElement`.
Element	toXML(Document doc, String sourceKey) Generates the DOM representation of this `ConfigurationElement` for the list of attributes and elements defined in the given `ElementSource`.
synchronized Element	toXML(Document doc) Generates the DOM representation of this `ConfigurationElement`.
synchronized Element	toXML() Generates the DOM representation of this `ConfigurationElement`.
Element	toXML(String sourceKey) Generates the DOM representation of this `ConfigurationElement` for the list of attributes and elements defined in the given `ElementSource`.
boolean	useNodeValue() Controls whether this element will use the node value as a property.
boolean	useValidation() Returns whether the XML content should be validated using a DTD.

From class java.lang.Object

From interface com.microstrategy.utils.config.ConfigurationElement

abstract ConfigurationValue	getAttribute(String name) Returns the value associated with the given attribute.
abstract HashList	getAttributes() Returns the list of all attributes available to this ConfigurationElement.
abstract ConfigurationElement	getElement(Object nodeName) Returns the `ConfigurationElement` instance associated with the given nodeName.
abstract HashList	getElements() Returns the list of all child-elements available to this ConfigurationElement.
abstract Object	getKey() This method is used to uniquely identify this ConfigurationElement within a list.
abstract String	getNodeName() Returns the node-name for this element.
abstract String	getStrAttribute(String name)
abstract void	initFromXML(Node root) Initializes the object with information from an XML Node.
abstract void	reload() Triggers the re-initialization of the element and its children if the configuration files have changed.
abstract Element	toXML(Document doc) Utility method to get the object's XML representation.

From interface com.microstrategy.utils.config.ConfigurationElementList

From interface com.microstrategy.utils.config.ConfigurationFile

abstract void	applyCustomization(CustomizationInfo c) Applies the corresponding customizations.
abstract void	applyCustomizations() Loops through all the `CustomizationInfo` in the `Customizations` class and apply the corresponding customizations.
abstract void	load(String fileName) Loads the file with the given name and initializes this `ConfigurationFile` with its content.
abstract void	reload() Reloads the content of this `ConfigurationFile` if the underlying configuration file has changed.
abstract void	save() Saves this `ConfigurationFile` back into the files where it was loaded from.
abstract void	save(CustomizationInfo c) Saves the differences between the shipped ("out of the box") definition of this `ConfigurationFile` and its currents values into the corresponding `CustomizationInfo`.
abstract void	setUseValidation(boolean value) Defines whether the XML content should validated using a DTD.
abstract boolean	useValidation() Returns whether the XML content should be validated using a DTD.

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

a Shortcut by its name.

public Shortcut getShortcutByFeatureId (String featureId)

Parameters

featureId	string representing the feature identifier of the shortcut to return

Returns

a Shortcut by its feature Id.

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:

if type == TYPE_DEFAULT, then the ShortcutList is rendered using a ShortcutListPicker
if type == TYPE_STYLES then the ShortcutList is rendered using a ShortcutListStyles

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.

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.

Interfaces

Classes

Exceptions

ShortcutList

Class Overview

Summary

Constants

public static final String ATT_BASE_BEAN

public static final String ATT_DESC

public static final String ATT_DESC_ID

public static final String ATT_ENABLE_FEATURE_ID

public static final String ATT_FEATURE_ID

public static final String ATT_NAME

public static final String ATT_TYPE

public static final String NODE_SHORTCUTS

public static final int TYPE_DEFAULT

public static final int TYPE_STYLES

Public Constructors

public ShortcutList ()

public ShortcutList (Node root)

Parameters

public ShortcutList (Document doc)

Parameters

Public Methods

public WebAttributeList getAttributeList ()

Returns

public WebAttributeList getAttributeList (boolean createElement)

public String getBaseBean ()

See Also

public String getDescriptor ()

public String getDescriptorID ()

public String getEnableFeatureId ()

public String getFeatureID ()

Returns

public String getName ()

public Shortcut getShortcut (String name)

Parameters

Returns

public Shortcut getShortcutByFeatureId (String featureId)

Parameters

Returns

public String getString (Messages messages)

Parameters

Returns

public int getType ()

Returns

public void setBaseBean (String value)

public void setDescriptor (String descriptor)

public void setDescriptorID (String descriptorID)

public void setEnableFeatureId (String value)

public void setFeatureID (String value)

public void setName (String name)

public void setType (int type)

See Also

Protected Methods

protected String getKeyAttribute ()