Package com.microstrategy.web.app.transforms.contextmenus

Class AbstractFolderParentMenu

java.lang.Object

com.microstrategy.web.app.gui.ContextMenu.DefaultContextMenuItemBuilder

com.microstrategy.web.app.transforms.contextmenus.AbstractFolderContextMenuItemBuilder

com.microstrategy.web.app.transforms.contextmenus.AbstractFolderParentMenu

All Implemented Interfaces:

ContextMenuItemBuilder

Direct Known Subclasses:

FolderRunAs, FolderVIDebug

public abstract class AbstractFolderParentMenu
extends AbstractFolderContextMenuItemBuilder

Since:

MicroStrategy Web 9.0.0

Constructor Summary

Constructors

Constructor	Description
AbstractFolderParentMenu(Shortcut definition)	Class constructor

Method Summary

Modifier and Type	Method	Description
ContextMenuItem	createItem(TransformContext context)	Creates the item and sets its javascript to submit the corresponding event using the iFrame.
java.lang.String	getItemKey(TransformContext context)	Retrieve the key will be set on the context menu item corresponding to the context input.
protected java.lang.String	getJSCode(TransformContext context)	Returns the javascript code to use with this context-menu-item

Methods inherited from class com.microstrategy.web.app.transforms.contextmenus.AbstractFolderContextMenuItemBuilder

getContextMenuFlag, getEvent, getLinkForMenuItem, getObjectInfo, getTarget, getTransform, iframeParam, isActionEnabled, isItemAvailable

Methods inherited from class com.microstrategy.web.app.gui.ContextMenu.DefaultContextMenuItemBuilder

createItem, getDefinition, getScript

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractFolderParentMenu

public AbstractFolderParentMenu(Shortcut definition)

Class constructor

Parameters:

definition - Shortcut instance with the base definition of the option

Method Detail

getJSCode

protected java.lang.String getJSCode(TransformContext context)

Description copied from class: AbstractFolderContextMenuItemBuilder

Returns the javascript code to use with this context-menu-item

Overrides:

getJSCode in class AbstractFolderContextMenuItemBuilder

createItem

public ContextMenuItem createItem(TransformContext context)

Description copied from class: AbstractFolderContextMenuItemBuilder

Creates the item and sets its javascript to submit the corresponding event using the iFrame.

Specified by:

createItem in interface ContextMenuItemBuilder

Overrides:

createItem in class AbstractFolderContextMenuItemBuilder

Parameters:

context - TransformContext with context information.

Returns:

a new instance of a ContextMenuItem.

getItemKey

public java.lang.String getItemKey(TransformContext context)

Description copied from class: ContextMenu.DefaultContextMenuItemBuilder

Retrieve the key will be set on the context menu item corresponding to the context input. The context menu item generated based on the same context input will have the same key. This method can be called by context menu before calling ContextMenu.DefaultContextMenuItemBuilder.createItem(TransformContext) to check whether the item already exists in the menu to avoid unnecessary creation.

Specified by:

getItemKey in interface ContextMenuItemBuilder

Overrides:

getItemKey in class AbstractFolderContextMenuItemBuilder

Parameters:

context - The context for context menu item creation

Returns:

The key for the context menu item if created using the context. By default null will be return, which means build has no knowledge about the item key. Then context menu item may generate the key by itself. For builder who wants avoid unnecessary item creation should take advantage of this method by overriding with a meaningful implementation.