java.lang.Object
- com.microstrategy.utils.config.AbstractConfigurationElement
- - com.microstrategy.web.app.Shortcut

All Implemented Interfaces:

ConfigurationElement, ConfigurationFile, java.lang.Cloneable
```
public class Shortcut
extends AbstractConfigurationElement
```
The Shortcut is a multi-purpose class used to configure elements that generate all sort of links or shortcuts, like menu items, drop-down lists and context menu items.

Since:

MicroStrategy Web 7.3.1 or earlier

Nested Class Summary
- 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_ACTIVE_FEATURE_ID`
`static java.lang.String`	`ATT_APPEND_STATE`
`static java.lang.String`	`ATT_BASE_BEAN`
`static java.lang.String`	`ATT_BASE_BONE`
`static java.lang.String`	`ATT_BUILDER_CLASS_NAME`
`static java.lang.String`	`ATT_CHECK_FEATURE_ID`
`static java.lang.String`	`ATT_DESC`
`static java.lang.String`	`ATT_DESC_ID`
`static java.lang.String`	`ATT_DHTML_CHECKED`
`static java.lang.String`	`ATT_DHTML_ENABLED`
`static java.lang.String`	`ATT_DHTML_SHOW`
`static java.lang.String`	`ATT_DYN_ALL_SUBMENU`
`static java.lang.String`	`ATT_DYN_SUBMENU`
`static java.lang.String`	`ATT_ENABLE_FEATURE_ID`
`static java.lang.String`	`ATT_EXTRA_URL`
`static java.lang.String`	`ATT_FEATURE_ID`
`static java.lang.String`	`ATT_FEATURE_TARGET`
`static java.lang.String`	`ATT_HREF`
`static java.lang.String`	`ATT_IFRAME`
`static java.lang.String`	`ATT_IMG_HEIGHT`
`static java.lang.String`	`ATT_IMG_SRC`
`static java.lang.String`	`ATT_IMG_WIDTH`
`static java.lang.String`	`ATT_KEY_SHORTCUT_DESC`
`static java.lang.String`	`ATT_KEY_SHORTCUT_DESC_ID`
`static java.lang.String`	`ATT_LOCATION`
`static java.lang.String`	`ATT_NAME`
`static java.lang.String`	`ATT_ONCLICK`
`static java.lang.String`	`ATT_SCOPE`
`static java.lang.String`	`ATT_SELECTED`
`static java.lang.String`	`ATT_SHORTCUT_CLASS_NAME`
`static java.lang.String`	`ATT_TARGET`
`static java.lang.String`	`ATT_TEXTCOMBO_TOOLTIP_DESC_ID`
`static java.lang.String`	`ATT_TYPE`
`static java.lang.String`	`ATT_USE_WINDOW_OPEN`
`static int`	`LOCATION_DEFAULT`
`static int`	`LOCATION_PREFIX`
`static int`	`LOCATION_SUFFIX`
`static java.lang.String`	`NODE_SHORCUT`	constant for the shortcut node name
`static java.lang.String`	`SHORTCUT_TARGET_TYPE_EXPORT_WINDOW`
`static int`	`TYPE_BEAN`
`static int`	`TYPE_BUTTON`
`static int`	`TYPE_BUTTON_LABEL`	button with label
`static int`	`TYPE_CAPTION`
`static int`	`TYPE_CHECKBOX`
`static int`	`TYPE_COLOR_PICKER_PANE`
`static int`	`TYPE_COMBO`
`static int`	`TYPE_DEFAULT`
`static int`	`TYPE_LABEL`	label button
`static int`	`TYPE_PICKER`	Generic Picker as submenu
`static int`	`TYPE_PICKER_OPTION`	picker option
`static int`	`TYPE_PULLDOWN`
`static int`	`TYPE_RADIO`
`static int`	`TYPE_TEXT_COMBO`	combo + text label
`static int`	`TYPE_TEXTBOX`

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
`Shortcut()`	Class constructor.
`Shortcut(java.lang.String name, java.lang.String href, java.lang.String desc)`	Class constructor.
`Shortcut(java.lang.String name, java.lang.String href, java.lang.String desc, java.lang.String descID, boolean isSelected)`	Class constructor.
`Shortcut(org.w3c.dom.Node root)`	Class constructor.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`void`	`addShortcutEvent(ShortcutEvent evt)`
`void`	`addSubItem(Shortcut shortcut)`	Add a shortcut item as a child of the shortcut list node in the current shortcut.
`boolean`	`appendState()`	Returns whether the shortcut needs to append the page state.
`boolean`	`fromDefault()`	Deprecated. This proprety is not used and it will be removed in future versions.
`java.lang.String`	`getActiveFeatureId()`	Get the active featureId property value of the Shortcut instance.
`WebAttributeList`	`getAttributeList()`	Get the attribute list for the instance
`java.lang.String`	`getBaseBean()`	Returns the name of the bean associated with the shortcut object.
`java.lang.String`	`getBaseBone()`	Returns the name of a JavaScript bone with which the shortcut is associated.
`java.lang.Object`	`getBuilder()`	Returns an instance of the class specified by the "builder-class-name" attribute.
`java.lang.String`	`getBuilderClassName()`	When used as part of context-menus, returns the fully qualified name of the class used to populate context-menus that uses this Shortcut as definition
`java.lang.String`	`getCheckFeatureId()`	Get the check featureId property value of the Shortcut instance.
`java.lang.String`	`getDescriptor()`	Returns a descriptor that the application should use to display the shortcut if the desc-id attribute is missing.
`java.lang.String`	`getDescriptorID()`	Returns the Resource Bundle item id that the application should use to display the shortcut in the language of the user's locale.
`java.lang.String`	`getDhtmlChecked()`	Returns a javascript code that is evaluated to determine whether the shortcut should appear checked or unchecked when it is displayed.
`java.lang.String`	`getDhtmlEnabled()`	Represents a javascript code that is evaluated to determine whether the shortcut should appear enabled or disabled when it is displayed.
`java.lang.String`	`getDhtmlShow()`	Represents a javascript code that is evaluated to determine whether the shortcut should be displayed.
`boolean`	`getDynamicAllSubMenu()`
`java.lang.String`	`getDynamicSubMenu()`
`java.lang.String`	`getEnableFeatureId()`	Get the enable featureId property value of the Shortcut instance.
`HashList`	`getEvents()`	Deprecated. Use `getShortcutEvents()`
`HashList`	`getEvents(boolean isChecked)`	Returns the HashList of ShortcutEvents associated with the shortcut
`WebBeanPropertyList`	`getExtendedPropertiesList()`	Get the attribute list for the instance
`java.lang.String`	`getExtraUrl()`	Returns a URL segment that is appended to the links URL.
`java.lang.String`	`getFeatureId()`	Represents a feature that is evaluated at the server to determine whether the object should be displayed.
`java.lang.String`	`getFeatureTarget()`	Returns the name of a feature that is evaluated to determine whether the target of this shortcut should be used.
`java.lang.String`	`getHREF()`	Indicates the HTTP location to which the browser is directed when the shortcut link is clicked.
`java.lang.String`	`getImgHeight()`	If the shortcut is represented as an image, this property indicates the height of the image.
`java.lang.String`	`getImgSrc()`	If the shortcut is represented as an image, the ImgSrc indicates the source path of the image.
`java.lang.String`	`getImgWidth()`	If the shortcut is represented as an image, this property indicates the width of the image.
`protected 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 the `getKey` and `setKey` methods.
`java.lang.String`	`getKeyShortcutDesc()`	Returns a descriptor that the application should use to display the accelerator key (keyboard shortcut) if the key-shortcut-desc-id attribute is missing.
`java.lang.String`	`getKeyShortcutDescID()`	Returns the Resource Bundle item id that the application should use to display the accelerator key (keyboard shortcut) in the language of the user's locale.
`java.lang.String`	`getKeyShortcutString(Messages messages)`	Returns the object's localized Shortcut descriptor.
`int`	`getLocation()`	When rendering multi-column system pickers, the location property indicates whether this shortcut is rendered before or after the rest of the shortcuts, outside the columns block.
`java.lang.String`	`getName()`	Returns the name, a unique identifier for this shortcut.
`java.lang.String`	`getOnclick()`	Represents the javascript code that is evaluated when the shortcut link is clicked.
`java.lang.String`	`getScope()`
`java.lang.String`	`getShortCutClassName()`	When used inside a toolbar definition, returns the fully qualified name of the class to use when building toolbar items using the shortcut definition.
`AbstractConfigurationElement.FilteredList`	`getShortcutEvents()`	Get the list of events
`java.lang.String`	`getString(Messages messages)`	Returns the object's localized descriptor.
`ShortcutList`	`getSubitemList()`	Get a single list of sub-items for this Shortcut.
`ShortcutList`	`getSubtemList()`	Deprecated. Use `getSubitemList()`
`java.lang.String`	`getTarget()`	Returns the value of the target property as saved in the configuration file.
`java.lang.String`	`getTarget(WebComponent root)`	Deprecated. use `resolveTarget(WebComponent root)` instead
`java.lang.String`	`getTargetUrl(WebComponent root, boolean useCheckedEvent, boolean includeState, WebFeatures featureManager)`	Returns the url associated with the shortcut
`java.lang.String`	`getTargetUrl(WebComponent root, boolean useCheckedEvent, WebFeatures featureManager)`	Returns the url associated with the shortcut
`java.lang.String`	`getTargetUrlParameters(WebComponent root, boolean useCheckedEvent, boolean includeState, WebFeatures featureManager)`	Returns the url associated with the shortcut without including the servlet information.
`java.lang.String`	`getTooltipDescriptorID()`	Returns the Resource Bundle item id that the application should use to display textCobmo tooltip on the shortcut
`int`	`getType()`	When used inside a toolbar definition, specifies the type of tool the shortcut represents: TYPE_BUTTON : an image-only button.
`boolean`	`hasSubItems()`	Returns true if the shortcut has shorcuts associated with it
`boolean`	`isIframe()`	When `true`, the shortcut link uses the application's asynchronous page update infrastructure through iframe to submit the users request to the Web server.
`boolean`	`isSelected()`	Indicates that the shortcut is rendered as the selected item among the other links in the shortcut list.
`boolean`	`isShortcutActive(WebFeatures featureManager, WebComponent root)`	Returns true if the shortcut is active
`boolean`	`isShortcutAvailable(WebFeatures featureManager, WebComponent root)`	Returns true if the shortcut is available to the user
`boolean`	`isShortcutChecked(WebFeatures featureManager, WebComponent root)`	Returns true if the shortcut will appear to the user as selected
`boolean`	`isShortcutEnabled(WebFeatures featureManager, WebComponent root)`	Returns true if the shortcut is enabled
`boolean`	`isShortcutTargetAvailable(WebFeatures featureManager, WebComponent root)`	Returns true if the shortcut's target is available to the user
`protected ParameterBuilder`	`newURIBuilder(WebComponent webComponent)`	Convenience method to retrieve a new instance of a URI Builder from the connected Container Services object.
`void`	`removeShortcutList(java.lang.Object key)`
`void`	`removeSubItem(java.lang.Object key)`	Remove the shortcut with the given key if it exists as a child for this shortcut.
`java.lang.String`	`resolveTarget(WebComponent root)`	Returns the runtime value of the target property.
`void`	`setActiveFeatureId(java.lang.String active_featureId)`	Set the active featureId property value of the Shortcut instance.This feature is used to decide if we need to do any action on clicking on the short cut item in the menu.
`void`	`setAppendState(boolean newValue)`	Sets whether the shortcut needs to append the page state.
`void`	`setBaseBean(java.lang.String value)`	Indicates the bean from the pages bean hierarchy associated with the shortcut object.
`void`	`setBaseBone(java.lang.String value)`	Defines the name of a JavaScript bone with which the shortcut is associated.
`void`	`setBuilderClassName(java.lang.String value)`	When used as part of context-menus, sets the fully qualified name of the class used to populate context-menus that uses this Shortcut as definition
`void`	`setCheckFeatureId(java.lang.String check_featureId)`	Set the check featureId property value of the Shortcut instance.This feature is used to decide if we need to show a check mark next to the short cut in the menu.
`void`	`setDescriptor(java.lang.String descriptor)`	Provides a descriptor that the application should use to display the shortcut if the desc-id attribute is missing.
`void`	`setDescriptorID(java.lang.String descriptorID)`	Provides the Resource Bundle item id that the application should use to display the shortcut in the language of the user's locale.
`void`	`setDhtmlChecked(java.lang.String value)`	Sets a javascript code that is evaluated to determine whether the shortcut should appear checked or unchecked when it is displayed.
`void`	`setDhtmlEnabled(java.lang.String value)`	Sets the javascript code that is evaluated to determine whether the shortcut should appear enabled or disabled when it is displayed.
`void`	`setDhtmlShow(java.lang.String value)`	/** Sets the javascript code that is evaluated to determine whether the shortcut should be displayed.
`void`	`setDynamicAllSubMenu(boolean value)`
`void`	`setDynamicSubMenu(java.lang.String value)`
`void`	`setEnableFeatureId(java.lang.String enable_featureId)`	Set the enable featureId property value of the Shortcut instance.This feature is used to decide if we need to enable or disable the short cut in the menu.
`void`	`setExtraUrl(java.lang.String newValue)`	Defines a URL segment that is appended to the links URL.
`void`	`setFeatureId(java.lang.String featureId)`	Sets the name of a feature that is evaluated at the server to determine whether the object should be displayed.
`void`	`setFeatureTarget(java.lang.String featureTarget)`	Sets the name of a feature that is evaluated to determine whether the target of this shortcut should be used.
`void`	`setFromDefault(boolean newValue)`	Deprecated. This proprety is not used and it will be removed in future versions.
`void`	`setHREF(java.lang.String href)`	Indicates the HTTP location to which the browser is directed when the shortcut link is clicked.
`void`	`setImgHeight(java.lang.String imgHeight)`	If the shortcut is represented as an image, this property indicates the height of the image.
`void`	`setImgSrc(java.lang.String imgSrc)`	If the shortcut is represented as an image, this property indicates the source path of the image.
`void`	`setImgWidth(java.lang.String imgWidth)`	If the shortcut is represented as an image, this property indicates the width of the image.
`void`	`setIsIframe(boolean iframe)`	When set to `true`, the shortcut link uses the application's asynchronous page update infrastructure through iframe to submit the users request to the Web server.
`void`	`setIsSelected(boolean newValue)`	Indicates whetther the shortcut is rendered as the selected item among the other links in the shortcut list.
`void`	`setKeyShortcutDesc(java.lang.String value)`	Provides a descriptor that the application should use to display the accelerator key (keyboard shortcut) if the key-shortcut-desc-id attribute is missing.
`void`	`setKeyShortcutDescID(java.lang.String value)`	Provides the Resource Bundle item id that the application should use to display the accelerator key (keyboard shortcut) in the language of the user's locale.
`void`	`setLocation(int location)`	Set the location property value of the Shortcut instance.
`void`	`setName(java.lang.String name)`	Sets the name, a unique identifier for this shortcut.
`void`	`setOnclick(java.lang.String value)`	Sets some javascript code that is evaluated when the shortcut link is clicked.
`void`	`setScope(java.lang.String value)`
`void`	`setShortCutClassName(java.lang.String value)`	When used inside a toolbar definition, specifies the fully qualified name of the class to use to render the tool.
`void`	`setShortcutList(ShortcutList shortcutList)`
`void`	`setTarget(java.lang.String target)`	Set the target property value of the Shortcut instance.
`void`	`setTooltipDescriptorID(java.lang.String ttDescriptorID)`	Provides the Resource Bundle item id that the application should use to display textCobmo tooltip on the shortcut
`void`	`setType(int type)`	Set the type property value of the Shortcut instance.
`void`	`setUseWindowOpen(boolean value)`	If set to `true` and the target attribute is set to a value, the application uses window.open to open the target window specified by the target attribute.
`boolean`	`useWindowOpen()`	If `true` and the target attribute is set to a value, the application uses window.open to open the target window specified by the target attribute.

Methods inherited from class com.microstrategy.utils.config.AbstractConfigurationElement
addFileSource, applyCustomization, applyCustomizations, cleanUpDeletedElements, clone, 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

- Field Detail
  - NODE_SHORCUT
```
public static final java.lang.String NODE_SHORCUT
```
    constant for the shortcut node name
    
    See Also:
    
    Constant Field Values
  - ATT_BASE_BONE
```
public static final java.lang.String ATT_BASE_BONE
```
    Since:
    
    MicroStrategy Web 9.0.0
    
    See Also:
    
    Constant Field Values
  - ATT_DHTML_ENABLED
```
public static final java.lang.String ATT_DHTML_ENABLED
```
    Since:
    
    MicroStrategy Web 9.0.0
    
    See Also:
    
    Constant Field Values
  - ATT_DHTML_CHECKED
```
public static final java.lang.String ATT_DHTML_CHECKED
```
    Since:
    
    MicroStrategy Web 9.0.0
    
    See Also:
    
    Constant Field Values
  - ATT_DHTML_SHOW
```
public static final java.lang.String ATT_DHTML_SHOW
```
    Since:
    
    MicroStrategy Web 9.0.0
    
    See Also:
    
    Constant Field Values
  - ATT_KEY_SHORTCUT_DESC_ID
```
public static final java.lang.String ATT_KEY_SHORTCUT_DESC_ID
```
    Since:
    
    MicroStrategy Web 9.0.0
    
    See Also:
    
    Constant Field Values
  - ATT_KEY_SHORTCUT_DESC
```
public static final java.lang.String ATT_KEY_SHORTCUT_DESC
```
    Since:
    
    MicroStrategy Web 9.0.0
    
    See Also:
    
    Constant Field Values
  - ATT_USE_WINDOW_OPEN
```
public static final java.lang.String ATT_USE_WINDOW_OPEN
```
    Since:
    
    MicroStrategy Web 9.0.0
    
    See Also:
    
    Constant Field Values
  - ATT_IFRAME
```
public static final java.lang.String ATT_IFRAME
```
    Since:
    
    MicroStrategy Web 9.0.0
    
    See Also:
    
    Constant Field Values
  - ATT_TARGET
```
public static final java.lang.String ATT_TARGET
```
    Since:
    
    MicroStrategy Web 9.0.0
    
    See Also:
    
    Constant Field Values
  - ATT_EXTRA_URL
```
public static final java.lang.String ATT_EXTRA_URL
```
    Since:
    
    MicroStrategy Web 9.0.0
    
    See Also:
    
    Constant Field Values
  - ATT_APPEND_STATE
```
public static final java.lang.String ATT_APPEND_STATE
```
    Since:
    
    MicroStrategy Web 9.0.0
    
    See Also:
    
    Constant Field Values
  - ATT_ONCLICK
```
public static final java.lang.String ATT_ONCLICK
```
    Since:
    
    MicroStrategy Web 9.0.0
    
    See Also:
    
    Constant Field Values
  - ATT_HREF
```
public static final java.lang.String ATT_HREF
```
    Since:
    
    MicroStrategy Web 9.0.0
    
    See Also:
    
    Constant Field Values
  - ATT_SELECTED
```
public static final java.lang.String ATT_SELECTED
```
    Since:
    
    MicroStrategy Web 9.0.0
    
    See Also:
    
    Constant Field Values
  - ATT_FEATURE_TARGET
```
public static final java.lang.String ATT_FEATURE_TARGET
```
    Since:
    
    MicroStrategy Web 9.0.0
    
    See Also:
    
    Constant Field Values
  - ATT_ENABLE_FEATURE_ID
```
public static final java.lang.String ATT_ENABLE_FEATURE_ID
```
    Since:
    
    MicroStrategy Web 9.0.0
    
    See Also:
    
    Constant Field Values
  - ATT_CHECK_FEATURE_ID
```
public static final java.lang.String ATT_CHECK_FEATURE_ID
```
    Since:
    
    MicroStrategy Web 9.0.0
    
    See Also:
    
    Constant Field Values
  - ATT_ACTIVE_FEATURE_ID
```
public static final java.lang.String ATT_ACTIVE_FEATURE_ID
```
    Since:
    
    MicroStrategy Web 9.0.0
    
    See Also:
    
    Constant Field Values
  - ATT_FEATURE_ID
```
public static final java.lang.String ATT_FEATURE_ID
```
    Since:
    
    MicroStrategy Web 9.0.0
    
    See Also:
    
    Constant Field Values
  - ATT_LOCATION
```
public static final java.lang.String ATT_LOCATION
```
    Since:
    
    MicroStrategy Web 9.0.0
    
    See Also:
    
    Constant Field Values
  - ATT_BASE_BEAN
```
public static final java.lang.String ATT_BASE_BEAN
```
    Since:
    
    MicroStrategy Web 9.0.0
    
    See Also:
    
    Constant Field Values
  - ATT_IMG_WIDTH
```
public static final java.lang.String ATT_IMG_WIDTH
```
    Since:
    
    MicroStrategy Web 9.0.0
    
    See Also:
    
    Constant Field Values
  - ATT_IMG_HEIGHT
```
public static final java.lang.String ATT_IMG_HEIGHT
```
    Since:
    
    MicroStrategy Web 9.0.0
    
    See Also:
    
    Constant Field Values
  - ATT_IMG_SRC
```
public static final java.lang.String ATT_IMG_SRC
```
    Since:
    
    MicroStrategy Web 9.0.0
    
    See Also:
    
    Constant Field Values
  - ATT_DESC_ID
```
public static final java.lang.String ATT_DESC_ID
```
    Since:
    
    MicroStrategy Web 9.0.0
    
    See Also:
    
    Constant Field Values
  - ATT_DESC
```
public static final java.lang.String ATT_DESC
```
    Since:
    
    MicroStrategy Web 9.0.0
    
    See Also:
    
    Constant Field Values
  - ATT_BUILDER_CLASS_NAME
```
public static final java.lang.String ATT_BUILDER_CLASS_NAME
```
    Since:
    
    MicroStrategy Web 9.0.0
    
    See Also:
    
    Constant Field Values
  - ATT_SHORTCUT_CLASS_NAME
```
public static final java.lang.String ATT_SHORTCUT_CLASS_NAME
```
    Since:
    
    MicroStrategy Web 9.0.0
    
    See Also:
    
    Constant Field Values
  - ATT_TYPE
```
public static final java.lang.String ATT_TYPE
```
    Since:
    
    MicroStrategy Web 9.0.0
    
    See Also:
    
    Constant Field Values
  - ATT_NAME
```
public static final java.lang.String ATT_NAME
```
    Since:
    
    MicroStrategy Web 9.0.0
    
    See Also:
    
    Constant Field Values
  - ATT_DYN_SUBMENU
```
public static final java.lang.String ATT_DYN_SUBMENU
```
    Since:
    
    MicroStrategy Web 9.0.0
    
    See Also:
    
    Constant Field Values
  - ATT_DYN_ALL_SUBMENU
```
public static final java.lang.String ATT_DYN_ALL_SUBMENU
```
    Since:
    
    MicroStrategy Web 9.0.0
    
    See Also:
    
    Constant Field Values
  - ATT_SCOPE
```
public static final java.lang.String ATT_SCOPE
```
    Since:
    
    MicroStrategy Web 9.0.0
    
    See Also:
    
    Constant Field Values
  - ATT_TEXTCOMBO_TOOLTIP_DESC_ID
```
public static final java.lang.String ATT_TEXTCOMBO_TOOLTIP_DESC_ID
```
    Since:
    
    MicroStrategy Web 9.0.0
    
    See Also:
    
    Constant Field Values
  - SHORTCUT_TARGET_TYPE_EXPORT_WINDOW
```
public static final java.lang.String SHORTCUT_TARGET_TYPE_EXPORT_WINDOW
```
    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_BUTTON
```
public static final int TYPE_BUTTON
```
    Since:
    
    MicroStrategy Web 8.0.0
    
    See Also:
    
    Constant Field Values
  - TYPE_COMBO
```
public static final int TYPE_COMBO
```
    Since:
    
    MicroStrategy Web 8.0.0
    
    See Also:
    
    Constant Field Values
  - TYPE_PULLDOWN
```
public static final int TYPE_PULLDOWN
```
    Since:
    
    MicroStrategy Web 8.0.0
    
    See Also:
    
    Constant Field Values
  - TYPE_TEXTBOX
```
public static final int TYPE_TEXTBOX
```
    Since:
    
    MicroStrategy Web 8.0.0
    
    See Also:
    
    Constant Field Values
  - TYPE_CHECKBOX
```
public static final int TYPE_CHECKBOX
```
    Since:
    
    MicroStrategy Web 8.0.0
    
    See Also:
    
    Constant Field Values
  - TYPE_RADIO
```
public static final int TYPE_RADIO
```
    Since:
    
    MicroStrategy Web 8.0.0
    
    See Also:
    
    Constant Field Values
  - TYPE_BEAN
```
public static final int TYPE_BEAN
```
    Since:
    
    MicroStrategy Web 8.0.0
    
    See Also:
    
    Constant Field Values
  - TYPE_CAPTION
```
public static final int TYPE_CAPTION
```
    Since:
    
    MicroStrategy Web 8.0.0
    
    See Also:
    
    Constant Field Values
  - TYPE_COLOR_PICKER_PANE
```
public static final int TYPE_COLOR_PICKER_PANE
```
    Since:
    
    MicroStrategy Web 8.0.0
    
    See Also:
    
    Constant Field Values
  - TYPE_PICKER
```
public static final int TYPE_PICKER
```
    Generic Picker as submenu
    
    Since:
    
    MicroStrategy Web 9.0.0
    
    See Also:
    
    Constant Field Values
  - TYPE_TEXT_COMBO
```
public static final int TYPE_TEXT_COMBO
```
    combo + text label
    
    Since:
    
    MicroStrategy Web 9.0.0
    
    See Also:
    
    Constant Field Values
  - TYPE_PICKER_OPTION
```
public static final int TYPE_PICKER_OPTION
```
    picker option
    
    Since:
    
    MicroStrategy Web 9.0.0
    
    See Also:
    
    Constant Field Values
  - TYPE_BUTTON_LABEL
```
public static final int TYPE_BUTTON_LABEL
```
    button with label
    
    Since:
    
    MicroStrategy Web 9.0.0
    
    See Also:
    
    Constant Field Values
  - TYPE_LABEL
```
public static final int TYPE_LABEL
```
    label button
    
    Since:
    
    MicroStrategy Web 9.0.0
    
    See Also:
    
    Constant Field Values
  - LOCATION_DEFAULT
```
public static final int LOCATION_DEFAULT
```
    Since:
    
    MicroStrategy Web 8.0.0
    
    See Also:
    
    Constant Field Values
  - LOCATION_PREFIX
```
public static final int LOCATION_PREFIX
```
    Since:
    
    MicroStrategy Web 8.0.0
    
    See Also:
    
    Constant Field Values
  - LOCATION_SUFFIX
```
public static final int LOCATION_SUFFIX
```
    Since:
    
    MicroStrategy Web 8.0.0
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Shortcut
```
public Shortcut()
```
    Class constructor. Initializes a new -empty- instance of the Shortcut class.
  - Shortcut
```
public Shortcut(java.lang.String name,
                java.lang.String href,
                java.lang.String desc)
```
    Class constructor. Initializes a new instance of the Shortcut class with the information given as parameters
    
    Parameters:
    
    name - unique name -identifier- for the shortcut.
    
    href - href property. Target address of the shortcut to display.
    
    desc - descriptor property.
  - Shortcut
```
public Shortcut(java.lang.String name,
                java.lang.String href,
                java.lang.String desc,
                java.lang.String descID,
                boolean isSelected)
```
    Class constructor. Initializes a new instance of the Shortcut class with the information given as parameters
    
    Parameters:
    
    name - unique name -identifier- for the shortcut.
    
    href - href property. Target address of the shortcut to display.
    
    desc - descriptor property.
    
    descID - identifier of the descriptor to be used for the shortcut
    
    isSelected - boolean indicating whether the shortcut is to be initialized as selected
  - Shortcut
```
public Shortcut(org.w3c.dom.Node root)
```
    Class constructor. Initializes a Shortcut instance based on the information included on the XML Node
    
    Parameters:
    
    root - Node instance representing the Shortcut 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.
    
    Specified by:
    
    getKeyAttribute in class AbstractConfigurationElement
    
    Since:
    
    MicroStrategy Web 9.0.0
  - 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.
  - getKeyShortcutString
```
public java.lang.String getKeyShortcutString(Messages messages)
```
    Returns the object's localized Shortcut descriptor.
    
    Parameters:
    
    messages - the messages l10n object.
    
    Returns:
    
    the String representing the object's localized descriptor.
    
    Since:
    
    MicroStrategy Web 8.0.0
  - getTarget
```
public java.lang.String getTarget()
```
    Returns the value of the target property as saved in the configuration file. The target represents the name of the window to which the request is directed when the shortcut link is clicked. The value itself might be a keyword like "mstrExportWindow" which is resolved at runtime based on preferences.
    
    See Also:
    
    resolveTarget(com.microstrategy.web.beans.WebComponent)
  - getTarget
```
public java.lang.String getTarget(WebComponent root)
```
    Deprecated.
    use resolveTarget(WebComponent root) instead
    
    Returns the runtime value for the target of this Shortcut. For naming consistency this method has been deprecated, instead you should call resolveTarget(com.microstrategy.web.beans.WebComponent)
    
    Since:
    
    MicroStrategy Web 8.0.0
  - resolveTarget
```
public java.lang.String resolveTarget(WebComponent root)
```
    Returns the runtime value of the target property. Tests for special (keyword) values of target and determine end value of this property. If not a keyword, it will return the value as specified for the shortcut.
    
    Parameters:
    
    root - WebComponent instance where to test features if required
    
    Since:
    
    MicroStrategy Web 9.0.0
  - setTarget
```
public void setTarget(java.lang.String target)
```
    Set the target property value of the Shortcut instance. The target represents the name of the browser's window to which the request is directed when the shortcut link is clicked. The value itself might be a keyword like "mstrExportWindow" which is resolved at runtime based on preferences.
  - getType
```
public int getType()
```
    When used inside a toolbar definition, specifies the type of tool the shortcut represents:
    
    TYPE_BUTTON : an image-only button.
    TYPE_LABEL : an no-image label button.
    TYPE_BUTTON_LABEL : an image button with label.
    TYPE_COMBO: an image with a dropdown list
    TYPE_TEXTCOMBO: a dropdown list with a text description.
    TYPE_CAPTION: a non-clickable text.
    TYPE_PULLDOWN: a pulldown list with a text area available for indicating the current element selected.
    TYPE_CHECKBOX: a checkbox input
    TYPE_TEXTBOX: a textbox input
    TYPE_RADIO: a radio button input
    TYPE_COLORPICKER: a color-picker
    TYPE_BEAN: a tool whose content is generated by transforming a bean. The style from the StyleCatalog to use is defined by specifying an with name 'style-name'.
    Since:
    
    MicroStrategy Web 8.0.0
  - setType
```
public void setType(int type)
```
    Set the type property value of the Shortcut instance. When used inside a toolbar definition, specifies the type of tool the shortcut represents
    
    Since:
    
    MicroStrategy Web 8.0.0
    
    See Also:
    
    getType()
  - getShortCutClassName
```
public java.lang.String getShortCutClassName()
```
    When used inside a toolbar definition, returns the fully qualified name of the class to use when building toolbar items using the shortcut definition. This class will be used instead of those mapped to the getType() attribute.
    
    Since:
    
    MicroStrategy Web 8.0.0
  - setShortCutClassName
```
public void setShortCutClassName(java.lang.String value)
```
    When used inside a toolbar definition, specifies the fully qualified name of the class to use to render the tool.
    
    Parameters:
    
    value - A fully-qualified class name (e.g. com.microstrategy.web.app.gui.ShortcutElement)
    
    Since:
    
    MicroStrategy Web 8.0.0
  - getBuilderClassName
```
public java.lang.String getBuilderClassName()
```
    When used as part of context-menus, returns the fully qualified name of the class used to populate context-menus that uses this Shortcut as definition
    
    Since:
    
    MicroStrategy Web 8.0.1
  - setBuilderClassName
```
public void setBuilderClassName(java.lang.String value)
```
    When used as part of context-menus, sets the fully qualified name of the class used to populate context-menus that uses this Shortcut as definition
    
    Parameters:
    
    value - fully qualified class name
    
    Since:
    
    MicroStrategy Web 8.0.1
  - getLocation
```
public int getLocation()
```
    When rendering multi-column system pickers, the location property indicates whether this shortcut is rendered before or after the rest of the shortcuts, outside the columns block. For example, when possible colors are displayed in a grid with rows and columns of color choices, you can use the location attribute to specify that the shortcut should be displayed either above (LOCATION_PREFIX) or below (LOCATION_SUFFIX) this grid.
    
    Returns:
    
    the String value of the location property.
    
    Since:
    
    MicroStrategy Web 8.0.0
  - setLocation
```
public void setLocation(int location)
```
    Set the location property value of the Shortcut instance. When rendering multi-column system pickers, the location property indicates whether this shortcut is rendered before or after the rest of the shortcuts, outside the columns block.
    
    Since:
    
    MicroStrategy Web 8.0.0
    
    See Also:
    
    getLocation()
  - getFeatureTarget
```
public java.lang.String getFeatureTarget()
```
    Returns the name of a feature that is evaluated to determine whether the target of this shortcut should be used. If the target is specified but the corresponding feature returns false, then the target is not used and the shortcut will open in the same browser window.
  - setFeatureTarget
```
public void setFeatureTarget(java.lang.String featureTarget)
```
    Sets the name of a feature that is evaluated to determine whether the target of this shortcut should be used. If the target is specified but the corresponding feature returns false, then the target is not used and the shortcut will open in the same browser window.
  - getOnclick
```
public java.lang.String getOnclick()
```
    Represents the javascript code that is evaluated when the shortcut link is clicked.
    
    Since:
    
    MicroStrategy Web 8.0.0
  - setOnclick
```
public void setOnclick(java.lang.String value)
```
    Sets some javascript code that is evaluated when the shortcut link is clicked.
    
    Parameters:
    
    value - Some javascript code to execute, for example: "alert('here');return false;"
    
    Since:
    
    MicroStrategy Web 8.0.0
  - getKeyShortcutDesc
```
public java.lang.String getKeyShortcutDesc()
```
    Returns a descriptor that the application should use to display the accelerator key (keyboard shortcut) if the key-shortcut-desc-id attribute is missing.
    
    Since:
    
    MicroStrategy Web 8.0.0
  - setKeyShortcutDesc
```
public void setKeyShortcutDesc(java.lang.String value)
```
    Provides a descriptor that the application should use to display the accelerator key (keyboard shortcut) if the key-shortcut-desc-id attribute is missing.
    
    Since:
    
    MicroStrategy Web 8.0.0
  - getKeyShortcutDescID
```
public java.lang.String getKeyShortcutDescID()
```
    Returns the Resource Bundle item id that the application should use to display the accelerator key (keyboard shortcut) in the language of the user's locale.
    
    Since:
    
    MicroStrategy Web 8.0.0
  - setKeyShortcutDescID
```
public void setKeyShortcutDescID(java.lang.String value)
```
    Provides the Resource Bundle item id that the application should use to display the accelerator key (keyboard shortcut) in the language of the user's locale.
    
    Since:
    
    MicroStrategy Web 8.0.0
  - getDhtmlShow
```
public java.lang.String getDhtmlShow()
```
    Represents a javascript code that is evaluated to determine whether the shortcut should be displayed. (This evaluation takes place at the browser and overrides the results of the evaluation that takes place at the server when the HTML is created - specified by the feature-id attribute. However, if the feature-id evaluation returns false, this evaluation never takes place.)
    
    Since:
    
    MicroStrategy Web 8.0.1
  - setDynamicSubMenu
```
public void setDynamicSubMenu(java.lang.String value)
```
    Parameters:
    
    value - String with the value of the dyn-menu property
    
    Since:
    
    MicroStrategy Web 8.1.0
  - getDynamicSubMenu
```
public java.lang.String getDynamicSubMenu()
```
    Returns:
    
    the value of the dhtml-show property
    
    Since:
    
    MicroStrategy Web 8.1.0
  - setDynamicAllSubMenu
```
public void setDynamicAllSubMenu(boolean value)
```
    Since:
    
    MicroStrategy Web 8.1.1
  - getDynamicAllSubMenu
```
public boolean getDynamicAllSubMenu()
```
    Since:
    
    MicroStrategy Web 8.1.1
  - setScope
```
public void setScope(java.lang.String value)
```
    Since:
    
    MicroStrategy Web 8.1.1
  - getScope
```
public java.lang.String getScope()
```
    Since:
    
    MicroStrategy Web 8.1.1
  - setDhtmlShow
```
public void setDhtmlShow(java.lang.String value)
```
    /** Sets the javascript code that is evaluated to determine whether the shortcut should be displayed.
    
    Since:
    
    MicroStrategy Web 8.0.1
    
    See Also:
    
    getDhtmlShow()
  - getDhtmlChecked
```
public java.lang.String getDhtmlChecked()
```
    Returns a javascript code that is evaluated to determine whether the shortcut should appear checked or unchecked when it is displayed. (This evaluation takes place at the browser and overrides the results of the evaluation that takes place at the server when the HTML is created - specified by the check-feature-id property.)
    
    Since:
    
    MicroStrategy Web 8.0.0
  - setDhtmlChecked
```
public void setDhtmlChecked(java.lang.String value)
```
    Sets a javascript code that is evaluated to determine whether the shortcut should appear checked or unchecked when it is displayed.
    
    Since:
    
    MicroStrategy Web 8.0.0
    
    See Also:
    
    getDhtmlChecked()
  - getDhtmlEnabled
```
public java.lang.String getDhtmlEnabled()
```
    Represents a javascript code that is evaluated to determine whether the shortcut should appear enabled or disabled when it is displayed. (This evaluation takes place at the browser and overrides the results of the evaluation that takes place at the server when the HTML is created - specified by the enable-feature-id property.)
    
    Since:
    
    MicroStrategy Web 8.0.0
  - setDhtmlEnabled
```
public void setDhtmlEnabled(java.lang.String value)
```
    Sets the javascript code that is evaluated to determine whether the shortcut should appear enabled or disabled when it is displayed.
    
    Since:
    
    MicroStrategy Web 8.0.0
    
    See Also:
    
    getDhtmlEnabled()
  - getBaseBone
```
public java.lang.String getBaseBone()
```
    Returns the name of a JavaScript bone with which the shortcut is associated. If defined, this bone is used to find the DHTML methods defined in other attributes of the shortcut element.
    
    Since:
    
    MicroStrategy Web 8.0.0
  - setBaseBone
```
public void setBaseBone(java.lang.String value)
```
    Defines the name of a JavaScript bone with which the shortcut is associated. If present, this bone is used to find the DHTML methods defined in other attributes of the shortcut element.
    
    Since:
    
    MicroStrategy Web 8.0.0
  - getHREF
```
public java.lang.String getHREF()
```
    Indicates the HTTP location to which the browser is directed when the shortcut link is clicked.
  - setHREF
```
public void setHREF(java.lang.String href)
```
    Indicates the HTTP location to which the browser is directed when the shortcut link is clicked.
    
    Parameters:
    
    href - A URL to use, for example: http://www.microstrategy.com
  - getName
```
public java.lang.String getName()
```
    Returns the name, a unique identifier for this shortcut.
  - setName
```
public void setName(java.lang.String name)
```
    Sets the name, a unique identifier for this shortcut.
  - isIframe
```
public boolean isIframe()
```
    When true, the shortcut link uses the application's asynchronous page update infrastructure through iframe to submit the users request to the Web server.
  - setIsIframe
```
public void setIsIframe(boolean iframe)
```
    When set to true, the shortcut link uses the application's asynchronous page update infrastructure through iframe to submit the users request to the Web server.
    
    Parameters:
    
    iframe - the boolean value of the iframe property
  - appendState
```
public boolean appendState()
```
    Returns whether the shortcut needs to append the page state. The page state includes the state of all beans in the page so they can be restored in the server.
  - useWindowOpen
```
public boolean useWindowOpen()
```
    If true and the target attribute is set to a value, the application uses window.open to open the target window specified by the target attribute. (This is useful for providing to the new window with a reference to the parent window)
  - setUseWindowOpen
```
public void setUseWindowOpen(boolean value)
```
    If set to true and the target attribute is set to a value, the application uses window.open to open the target window specified by the target attribute. (This is useful for providing to the new window with a reference to the parent window)
  - setAppendState
```
public void setAppendState(boolean newValue)
```
    Sets whether the shortcut needs to append the page state. The page state includes the state of all beans in the page so they can be restored in the server.
  - isSelected
```
public boolean isSelected()
```
    Indicates that the shortcut is rendered as the selected item among the other links in the shortcut list.
  - setIsSelected
```
public void setIsSelected(boolean newValue)
```
    Indicates whetther the shortcut is rendered as the selected item among the other links in the shortcut list.
  - getFeatureId
```
public java.lang.String getFeatureId()
```
    Represents a feature that is evaluated at the server to determine whether the object should be displayed.
    
    See Also:
    
    getDhtmlShow()
  - setFeatureId
```
public void setFeatureId(java.lang.String featureId)
```
    Sets the name of a feature that is evaluated at the server to determine whether the object should be displayed.
    
    See Also:
    
    getDhtmlShow()
  - getCheckFeatureId
```
public java.lang.String getCheckFeatureId()
```
    Get the check featureId property value of the Shortcut instance. This feature is used to decide if we need to show a check mark next to the short cut in the menu.
    
    See Also:
    
    getDhtmlChecked()
  - setCheckFeatureId
```
public void setCheckFeatureId(java.lang.String check_featureId)
```
    Set the check featureId property value of the Shortcut instance.This feature is used to decide if we need to show a check mark next to the short cut in the menu.
    
    See Also:
    
    getDhtmlChecked()
  - getEnableFeatureId
```
public java.lang.String getEnableFeatureId()
```
    Get the enable featureId property value of the Shortcut instance. This feature is used to decide if we need to enable or disable the short cut in the menu.
    
    See Also:
    
    getDhtmlEnabled()
  - setEnableFeatureId
```
public void setEnableFeatureId(java.lang.String enable_featureId)
```
    Set the enable featureId property value of the Shortcut instance.This feature is used to decide if we need to enable or disable the short cut in the menu.
    
    See Also:
    
    getDhtmlEnabled()
  - getActiveFeatureId
```
public java.lang.String getActiveFeatureId()
```
    Get the active featureId property value of the Shortcut instance. This feature is used to decide if we need to do any action on clicking on the short cut item in the menu.
    
    Returns:
    
    the String value of the active featureId property.
  - setActiveFeatureId
```
public void setActiveFeatureId(java.lang.String active_featureId)
```
    Set the active featureId property value of the Shortcut instance.This feature is used to decide if we need to do any action on clicking on the short cut item in the menu.
    
    Parameters:
    
    active_featureId - the String value of the active featureId property.
  - getDescriptor
```
public java.lang.String getDescriptor()
```
    Returns a descriptor that the application should use to display the shortcut 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 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 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 in the language of the user's locale.
  - getTooltipDescriptorID
```
public java.lang.String getTooltipDescriptorID()
```
    Returns the Resource Bundle item id that the application should use to display textCobmo tooltip on the shortcut
    
    Since:
    
    MicroStrategy Web 9.0.0
  - setTooltipDescriptorID
```
public void setTooltipDescriptorID(java.lang.String ttDescriptorID)
```
    Provides the Resource Bundle item id that the application should use to display textCobmo tooltip on the shortcut
    
    Since:
    
    MicroStrategy Web 9.0.0
  - getImgSrc
```
public java.lang.String getImgSrc()
```
    If the shortcut is represented as an image, the ImgSrc indicates the source path of the image.
  - setImgSrc
```
public void setImgSrc(java.lang.String imgSrc)
```
    If the shortcut is represented as an image, this property indicates the source path of the image.
  - setImgWidth
```
public void setImgWidth(java.lang.String imgWidth)
```
    If the shortcut is represented as an image, this property indicates the width of the image.
  - setImgHeight
```
public void setImgHeight(java.lang.String imgHeight)
```
    If the shortcut is represented as an image, this property indicates the height of the image.
  - getImgWidth
```
public java.lang.String getImgWidth()
```
    If the shortcut is represented as an image, this property indicates the width of the image.
  - getImgHeight
```
public java.lang.String getImgHeight()
```
    If the shortcut is represented as an image, this property indicates the height of the image.
  - setBaseBean
```
public void setBaseBean(java.lang.String value)
```
    Indicates the bean from the pages bean hierarchy associated with the shortcut object. This bean is used in tasks such as resolving features.
    
    See Also:
    
    getBaseBean()
  - getBaseBean
```
public java.lang.String getBaseBean()
```
    Returns the name of the bean associated with the shortcut object. This bean is used in tasks such as resolving features. Notice that if this attribute is not set, the application tries to use the base-bean attribute for the element.
  - getEvents
```
public HashList getEvents(boolean isChecked)
```
    Returns the HashList of ShortcutEvents associated with the shortcut
    
    Parameters:
    
    isChecked - specifies if the event requested is the event associated witht the checled or unchecked shortcut
    
    Returns:
    
    the HashList of ShortCutEvents associated with the shortcut
  - getTargetUrl
```
public java.lang.String getTargetUrl(WebComponent root,
                                     boolean useCheckedEvent,
                                     WebFeatures featureManager)
```
    Returns the url associated with the shortcut
    
    Parameters:
    
    root - Webcomponent where to start looking for the bean associated with the event
    
    useCheckedEvent - boolean tells if we need to use the events corresponding to the checked state of the short cut or the unchecked state of the shortcut
    
    featureManager - a instance of WebFeatures to process user feature availability
    
    Returns:
    
    the url associated with the shortcut
  - getTargetUrlParameters
```
public java.lang.String getTargetUrlParameters(WebComponent root,
                                               boolean useCheckedEvent,
                                               boolean includeState,
                                               WebFeatures featureManager)
```
    Returns the url associated with the shortcut without including the servlet information.
    
    Parameters:
    
    root - Webcomponent where to start looking for the bean associated with the event
    
    useCheckedEvent - boolean tells if we need to use the events corresponding to the checked state of the short cut or the unchecked state of the shortcut
    
    includeState - idicates if the url returned will contain the state of the WebComponents in the hierarchy or not.
    
    featureManager - a instance of WebFeatures to process user feature availability
    
    Returns:
    
    the url associated with the shortcut
    
    Since:
    
    MicroStrategy Web 8.0.0
  - getTargetUrl
```
public java.lang.String getTargetUrl(WebComponent root,
                                     boolean useCheckedEvent,
                                     boolean includeState,
                                     WebFeatures featureManager)
```
    Returns the url associated with the shortcut
    
    Parameters:
    
    root - Webcomponent where to start looking for the bean associated with the event
    
    useCheckedEvent - boolean tells if we need to use the events corresponding to the checked state of the short cut or the unchecked state of the shortcut
    
    includeState - idicates if the url returned will contain the state of the WebComponents in the hierarchy or not.
    
    featureManager - a instance of WebFeatures to process user feature availability
    
    Returns:
    
    the url associated with the shortcut
  - isShortcutAvailable
```
public boolean isShortcutAvailable(WebFeatures featureManager,
                                   WebComponent root)
```
    Returns true if the shortcut is available to the user
    
    Parameters:
    
    featureManager - the feature authority responsible for verifying if the user has access to the feature associated with the shortcut
    
    root - WebComponent to use as the dependency object by the feature authority
    
    Returns:
    
    whether the shortcut is available to the user
  - isShortcutChecked
```
public boolean isShortcutChecked(WebFeatures featureManager,
                                 WebComponent root)
```
    Returns true if the shortcut will appear to the user as selected
    
    Parameters:
    
    featureManager - the feature authority responsible for verifying if the user has access to the feature associated with the shortcut
    
    root - WebComponent to use as the dependency object by the feature authority
    
    Returns:
    
    whether the shortcut will appear to the user as selected
  - isShortcutTargetAvailable
```
public boolean isShortcutTargetAvailable(WebFeatures featureManager,
                                         WebComponent root)
```
    Returns true if the shortcut's target is available to the user
    
    Parameters:
    
    featureManager - the feature authority responsible for verifying if the user has access to the feature associated with the shortcut
    
    root - WebComponent to use as the dependency object by the feature authority
    
    Returns:
    
    whether the shortcut's target is available to the user
  - isShortcutEnabled
```
public boolean isShortcutEnabled(WebFeatures featureManager,
                                 WebComponent root)
```
    Returns true if the shortcut is enabled
    
    Parameters:
    
    featureManager - the feature authority responsible for verifying if the user has access to the feature associated with the shortcut
    
    root - WebComponent to use as the dependency object by the feature authority
    
    Returns:
    
    whether the shortcut is enabled
  - isShortcutActive
```
public boolean isShortcutActive(WebFeatures featureManager,
                                WebComponent root)
```
    Returns true if the shortcut is active
    
    Parameters:
    
    featureManager - the feature authority responsible for verifying if the user has access to the feature associated with the shortcut
    
    root - WebComponent to use as the dependency object by the feature authority
    
    Returns:
    
    whether the shortcut is active
  - hasSubItems
```
public boolean hasSubItems()
```
    Returns true if the shortcut has shorcuts associated with it
    
    Returns:
    
    whether the shortcut has shorcuts associated with it
  - getSubitemList
```
public ShortcutList getSubitemList()
```
    Get a single list of sub-items for this Shortcut. A sub-item can be specified as an implicit list of <shortcut&gr; nodes, or it can be specified as a list inside a <shortcuts&gr; node. This method will return a merge list of both of them.
    
    Returns:
    
    submenu list associated with this menu item
    
    Since:
    
    MicroStrategy Web 9.0.0
  - getSubtemList
```
public ShortcutList getSubtemList()
```
    Deprecated.
    Use getSubitemList()
    
    Get the list of submenu items inside this instance
    
    Returns:
    
    submenu list associated with this menu item
  - addSubItem
```
public void addSubItem(Shortcut shortcut)
```
    Add a shortcut item as a child of the shortcut list node in the current shortcut.
    
    Parameters:
    
    shortcut - The shortcut node to be added as a subitem
    
    Since:
    
    MicroStrategy Web 9.0.0
  - setShortcutList
```
public void setShortcutList(ShortcutList shortcutList)
```
    Since:
    
    MicroStrategy Web 9.0.0
  - removeShortcutList
```
public void removeShortcutList(java.lang.Object key)
```
    Since:
    
    MicroStrategy Web 9.0.0
  - removeSubItem
```
public void removeSubItem(java.lang.Object key)
```
    Remove the shortcut with the given key if it exists as a child for this shortcut. If a shortcut with the given key exists in the list (explicit list), it is deleted. Otherwise, the implicit list is searched for the shortcut.
    
    Parameters:
    
    key - The key for the shortcut node to be deleted
    
    Since:
    
    MicroStrategy Web 9.0.0
  - getShortcutEvents
```
public AbstractConfigurationElement.FilteredList getShortcutEvents()
```
    Get the list of events
    
    Since:
    
    MicroStrategy Web 9.0.0
  - addShortcutEvent
```
public void addShortcutEvent(ShortcutEvent evt)
```
    Since:
    
    MicroStrategy Web 9.0.0
  - getEvents
```
public HashList getEvents()
```
    Deprecated.
    Use getShortcutEvents()
    
    Get the list of events
    
    Returns:
    
    events list associated with this shortcut
  - setFromDefault
```
public void setFromDefault(boolean newValue)
```
    Deprecated.
    This proprety is not used and it will be removed in future versions.
    
    Indicates the shortcut it comes from a default on the default page
    
    Parameters:
    
    newValue - boolean value
  - fromDefault
```
public boolean fromDefault()
```
    Deprecated.
    This proprety is not used and it will be removed in future versions.
    
    Returns whether the shortcut it comes from a default on the default page
    
    Returns:
    
    true if the shortcut it comes from a default on the default page
  - getExtraUrl
```
public java.lang.String getExtraUrl()
```
    Returns a URL segment that is appended to the links URL.
  - setExtraUrl
```
public void setExtraUrl(java.lang.String newValue)
```
    Defines a URL segment that is appended to the links URL.
  - getAttributeList
```
public WebAttributeList getAttributeList()
```
    Get the attribute list for the instance
    
    Returns:
    
    attribute list for this style
    
    Since:
    
    MicroStrategy Web 8.0.0
  - getExtendedPropertiesList
```
public WebBeanPropertyList getExtendedPropertiesList()
```
    Get the attribute list for the instance
    
    Returns:
    
    attribute list for this style
    
    Since:
    
    MicroStrategy Web 8.0.1
  - newURIBuilder
```
protected ParameterBuilder newURIBuilder(WebComponent webComponent)
```
    Convenience method to retrieve a new instance of a URI Builder from the connected Container Services object. If anything fails along the way, returns null.
    
    Parameters:
    
    webComponent - WebComponent to use to retrieve the beanContext.
    
    Returns:
    
    The ParameterBuilder instance to use for building URIs.
    
    Since:
    
    MicroStrategy Web 8.0.0
  - getBuilder
```
public java.lang.Object getBuilder()
```
    Returns an instance of the class specified by the "builder-class-name" attribute. This object can be used to populate those classes that uses this Shortcut as their definition.
    
    Since:
    
    MicroStrategy Web 8.0.1

Class Shortcut

Nested Class Summary

Nested classes/interfaces inherited from class com.microstrategy.utils.config.AbstractConfigurationElement

Field Summary

Fields inherited from class com.microstrategy.utils.config.AbstractConfigurationElement

Constructor Summary

Method Summary

Methods inherited from class com.microstrategy.utils.config.AbstractConfigurationElement

Methods inherited from class java.lang.Object

Field Detail

NODE_SHORCUT

ATT_BASE_BONE

ATT_DHTML_ENABLED

ATT_DHTML_CHECKED

ATT_DHTML_SHOW

ATT_KEY_SHORTCUT_DESC_ID

ATT_KEY_SHORTCUT_DESC

ATT_USE_WINDOW_OPEN

ATT_IFRAME

ATT_TARGET

ATT_EXTRA_URL

ATT_APPEND_STATE

ATT_ONCLICK

ATT_HREF

ATT_SELECTED

ATT_FEATURE_TARGET

ATT_ENABLE_FEATURE_ID

ATT_CHECK_FEATURE_ID

ATT_ACTIVE_FEATURE_ID

ATT_FEATURE_ID

ATT_LOCATION

ATT_BASE_BEAN

ATT_IMG_WIDTH

ATT_IMG_HEIGHT

ATT_IMG_SRC

ATT_DESC_ID

ATT_DESC

ATT_BUILDER_CLASS_NAME

ATT_SHORTCUT_CLASS_NAME

ATT_TYPE

ATT_NAME

ATT_DYN_SUBMENU

ATT_DYN_ALL_SUBMENU

ATT_SCOPE

ATT_TEXTCOMBO_TOOLTIP_DESC_ID

SHORTCUT_TARGET_TYPE_EXPORT_WINDOW

TYPE_DEFAULT

TYPE_BUTTON

TYPE_COMBO

TYPE_PULLDOWN

TYPE_TEXTBOX

TYPE_CHECKBOX

TYPE_RADIO

TYPE_BEAN

TYPE_CAPTION

TYPE_COLOR_PICKER_PANE

TYPE_PICKER

TYPE_TEXT_COMBO

TYPE_PICKER_OPTION

TYPE_BUTTON_LABEL

TYPE_LABEL

LOCATION_DEFAULT

LOCATION_PREFIX

LOCATION_SUFFIX

Constructor Detail

Shortcut

Shortcut

Shortcut

Shortcut

Method Detail

getKeyAttribute

getString

getKeyShortcutString

getTarget

getTarget

resolveTarget

setTarget

getType

setType

getShortCutClassName