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

Class AbstractReportCellParentMenu

java.lang.Object

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

com.microstrategy.web.app.transforms.contextmenus.AbstractReportCellContextMenuItemBuilder

com.microstrategy.web.app.transforms.contextmenus.AbstractReportCellParentMenu

All Implemented Interfaces:

ContextMenuItemBuilder

Direct Known Subclasses:

ReportCellInsertMetric, ReportCellInsertPercentToTotalMetric, ReportCellMetricFilter, ReportCellMove, ReportCellSort, ReportCellThresholds, ReportTitleInsertMetric

public abstract class AbstractReportCellParentMenu
extends AbstractReportCellContextMenuItemBuilder

The AbstractReportCellParentMenu represents a context menu item builder that will hold a sub-menu structure with a list of the options - defined on the XML Configuration file - that a user will be enabled to select. If no children options are defined on its submenu (lack of privileges, conditions required not met by the current context, etc) the option will automatically be ignored and the final context menu will not display it.

Since:

MicroStrategy Web 8.0.1

Constructor Summary

Constructors

Constructor	Description
AbstractReportCellParentMenu(Shortcut definition)	Class constructor

Method Summary

Modifier and Type	Method	Description
ContextMenuItem	createItem(TransformContext context)	Creates and populates a ContextMenuItem based on the information in the Shortcut used as its defintion, as well as the logic included on this builder instance.
protected java.lang.String	getJSCode(TransformContext context)	Generate the JavaScript code the context menu item generated by this builder instance will trigger when the user selects it.

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

canDefineDerivedElements, getCell, getFormalParameter, getIntValue, getPassThroughMode, getStringValue, getTransform, isActionEnabled, isFeatureAvailable, isIframeEnabled, isItemAvailable, isRW, isTrue

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

createItem, getDefinition, getItemKey, getScript

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractReportCellParentMenu

public AbstractReportCellParentMenu(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: AbstractReportCellContextMenuItemBuilder

Generate the JavaScript code the context menu item generated by this builder instance will trigger when the user selects it.

Specified by:

getJSCode in class AbstractReportCellContextMenuItemBuilder

Parameters:

context - TransformContext initialized instance with the information on where this option will be used

Returns:

String value with the JavaScript information to trigger when the option is selected.

createItem

public ContextMenuItem createItem(TransformContext context)

Description copied from class: AbstractReportCellContextMenuItemBuilder

Creates and populates a ContextMenuItem based on the information in the Shortcut used as its defintion, as well as the logic included on this builder instance.

Specified by:

createItem in interface ContextMenuItemBuilder

Overrides:

createItem in class AbstractReportCellContextMenuItemBuilder

Parameters:

context - TransformContext initialized instance with the information on where this option will be used

Returns:

a new instance of a ContextMenuItem initialized with the option information to present to the user.