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

Class ReportGraphDrill

java.lang.Object

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

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

com.microstrategy.web.app.transforms.contextmenus.AbstractReportCellComposedContextMenuItemBuilder

com.microstrategy.web.app.transforms.contextmenus.ReportCellDrill

com.microstrategy.web.app.transforms.contextmenus.ReportGraphDrill

All Implemented Interfaces:

ContextMenuItemBuilder

public class ReportGraphDrill
extends ReportCellDrill

Since:

MicroStrategy Web 9.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ReportGraphDrill.GraphAreaContextMenuBuilder

Nested classes/interfaces inherited from class com.microstrategy.web.app.transforms.contextmenus.ReportCellDrill

ReportCellDrill.AbstractDrillContextMenuBuilder, ReportCellDrill.DrillContextMenuBuilder, ReportCellDrill.HeaderDrillContextMenuBuilder, ReportCellDrill.InvalidDrillContextMenuBuilder, ReportCellDrill.RowValueDrillContextMenuBuilder, ReportCellDrill.TitleDrillContextMenuBuilder

Constructor Summary

Constructors

Constructor	Description
ReportGraphDrill(Shortcut definition)

Method Summary

Modifier and Type	Method	Description
protected ComposedContextMenuBuilder	getComposedContextMenuBuilder(TransformContext context)	Get an instance of ReportGraphDrill.GraphAreaContextMenuBuilder that will help obtaining the different drill options that shall be presented to the user.
protected FormalParameter	getFormalParameter(TransformContext context, java.lang.String fpName)	Returns an instance of FormalParameter for the given formal parameter name 'fpName' from the ReportGraphTransformImpl instance
java.lang.String	getItemKey(TransformContext context)	Retrieve the key will be set on the context menu item corresponding to the context input.
protected Transform	getTransform(TransformContext context)	Returns an instance of ReportGraphTransformImpl instance which is the transform associated with Graphs
protected boolean	isActionEnabled(TransformContext context)	Checks if a Drill action is allowed on the current GraphArea object
protected boolean	isFeatureAvailable(TransformContext context, java.lang.String featureName)	Checks if the given feature 'featureName' is supported by the transform ReportGraphTransformImpl
boolean	isItemAvailable(TransformContext context)	Check to detect whether the "Drill" menu item can be shown in the context menu for for the GraphArea object in question
protected void	setOndemandMenuItemProperties(ContextMenuItem item, TransformContext context)	Sets the properties on "Drill" ContextMenuItems which is essential for populating of ondemand drilling items for grids.
protected boolean	shuoldAddExtraSubMenuOptions(TransformContext context)

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

addExtraSubMenuOptions, createItem, generateSubMenu, getDrillContextMenuBuilder, itemHasSubMenus, setOndemandProperties

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

getJSCode

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

canDefineDerivedElements, getCell, getIntValue, getPassThroughMode, getStringValue, isIframeEnabled, isRW, isTrue

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

ReportGraphDrill

public ReportGraphDrill(Shortcut definition)

Method Detail

getComposedContextMenuBuilder

protected ComposedContextMenuBuilder getComposedContextMenuBuilder(TransformContext context)

Get an instance of ReportGraphDrill.GraphAreaContextMenuBuilder that will help obtaining the different drill options that shall be presented to the user.

Overrides:

getComposedContextMenuBuilder in class ReportCellDrill

Parameters:

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

Returns:

ReportGraphDrill.GraphAreaContextMenuBuilder initialized instance. Calling its generateDrillSubMenu method provides the ContextMenu with the different drill paths available.

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 ReportCellDrill

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.

isActionEnabled

protected boolean isActionEnabled(TransformContext context)

Checks if a Drill action is allowed on the current GraphArea object

Overrides:

isActionEnabled in class ReportCellDrill

Parameters:

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

Returns:

boolean value indicating if the option should be enabled to the user or not, given the properties available on the context object.

isItemAvailable

public boolean isItemAvailable(TransformContext context)

Check to detect whether the "Drill" menu item can be shown in the context menu for for the GraphArea object in question

Specified by:

isItemAvailable in interface ContextMenuItemBuilder

Overrides:

isItemAvailable in class AbstractReportCellContextMenuItemBuilder

Parameters:

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

Returns:

boolean value indicating if the option should be enabled to the user or not, given the properties available on the context object.

setOndemandMenuItemProperties

protected void setOndemandMenuItemProperties(ContextMenuItem item,
                                             TransformContext context)

Description copied from class: ReportCellDrill

Sets the properties on "Drill" ContextMenuItems which is essential for populating of ondemand drilling items for grids.

Overrides:

setOndemandMenuItemProperties in class ReportCellDrill

Parameters:

item - a ContextMenuItem

context - a TransformContext

getTransform

protected Transform getTransform(TransformContext context)

Returns an instance of ReportGraphTransformImpl instance which is the transform associated with Graphs

Overrides:

getTransform in class AbstractReportCellContextMenuItemBuilder

Parameters:

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

Returns:

Transform instance related with this menu builder instance.

getFormalParameter

protected FormalParameter getFormalParameter(TransformContext context,
                                             java.lang.String fpName)

Returns an instance of FormalParameter for the given formal parameter name 'fpName' from the ReportGraphTransformImpl instance

Overrides:

getFormalParameter in class AbstractReportCellContextMenuItemBuilder

Parameters:

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

fpName - String value with the name of the formal parameter to look for

Returns:

FormalParameter instance if found on the transform defined on the context. If the transform is not compatible with this menu builder or the formal parameter does not exist, returns null

isFeatureAvailable

protected boolean isFeatureAvailable(TransformContext context,
                                     java.lang.String featureName)

Checks if the given feature 'featureName' is supported by the transform ReportGraphTransformImpl

Overrides:

isFeatureAvailable in class AbstractReportCellContextMenuItemBuilder

Parameters:

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

featureName - String value with the name of the feature to test for

Returns:

boolean value indicating if the feature is granted or not.

shuoldAddExtraSubMenuOptions

protected boolean shuoldAddExtraSubMenuOptions(TransformContext context)

Overrides:

shuoldAddExtraSubMenuOptions in class ReportCellDrill