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

Class FolderCreateDocumentFromReport

java.lang.Object

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

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

com.microstrategy.web.app.transforms.contextmenus.FolderCreateDocumentFromReport

All Implemented Interfaces:

ContextMenuItemBuilder

public class FolderCreateDocumentFromReport
extends AbstractFolderContextMenuItemBuilder

Since:

MicroStrategy Web 9.0.0

Constructor Summary

Constructors

Constructor	Description
FolderCreateDocumentFromReport(Shortcut definition)

Method Summary

Modifier and Type	Method	Description
protected int	getContextMenuFlag()	Indicates the abstract class which is the context-menu flag associated with this item.
protected WebEvent	getEvent(TransformContext context)	Provides the abstract class with the corresponding event to execution with this item.
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
protected java.lang.String	iframeParam(FolderViewTransform transform)
protected boolean	isActionEnabled(TransformContext context)	Indicates the abstract class if the corresponding action of this item is available.
boolean	isItemAvailable(TransformContext context)	Returns true if the corresponding flag is on and the the corresponding action is available.

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

createItem, getLinkForMenuItem, getObjectInfo, getTarget, getTransform

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

FolderCreateDocumentFromReport

public FolderCreateDocumentFromReport(Shortcut definition)

Method Detail

getContextMenuFlag

protected int getContextMenuFlag()

Description copied from class: AbstractFolderContextMenuItemBuilder

Indicates the abstract class which is the context-menu flag associated with this item.

Specified by:

getContextMenuFlag in class AbstractFolderContextMenuItemBuilder

isItemAvailable

public boolean isItemAvailable(TransformContext context)

Returns true if the corresponding flag is on and the the corresponding action is available.

Specified by:

isItemAvailable in interface ContextMenuItemBuilder

Overrides:

isItemAvailable in class AbstractFolderContextMenuItemBuilder

Parameters:

context - TransformContext with context information.

Returns:

true if the context-menu-item is available and should be included.

isActionEnabled

protected boolean isActionEnabled(TransformContext context)

Description copied from class: AbstractFolderContextMenuItemBuilder

Indicates the abstract class if the corresponding action of this item is available.

Specified by:

isActionEnabled in class AbstractFolderContextMenuItemBuilder

getEvent

protected WebEvent getEvent(TransformContext context)

Description copied from class: AbstractFolderContextMenuItemBuilder

Provides the abstract class with the corresponding event to execution with this item.

Overrides:

getEvent in class AbstractFolderContextMenuItemBuilder

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

iframeParam

protected java.lang.String iframeParam(FolderViewTransform transform)

Overrides:

iframeParam in class AbstractFolderContextMenuItemBuilder

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.