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

Class ReportGraphDrill.GraphAreaContextMenuBuilder

java.lang.Object

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

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

All Implemented Interfaces:

ComposedContextMenuBuilder, OnDemandContextMenuBuilder, ReportCellDrill.DrillContextMenuBuilder

Enclosing class:

ReportGraphDrill

public static class ReportGraphDrill.GraphAreaContextMenuBuilder
extends ReportCellDrill.AbstractDrillContextMenuBuilder

Since:

MicroStrategy Web 9.0.0

Field Summary

Fields inherited from class com.microstrategy.web.app.transforms.contextmenus.ReportCellDrill.AbstractDrillContextMenuBuilder

SYS_DEFAULT_DISABLE_ONDEMAND_DRILLING

Constructor Summary

Constructors

Constructor	Description
GraphAreaContextMenuBuilder(TransformContext context)

Method Summary

Modifier and Type	Method	Description
boolean	canDrill()	Checks if the current GraphArea object supports Drilling
ContextMenu	generateSubMenu()	Method that generates a ContextMenu instance with all the possible sub menu options enabled for the report cell provided.
TransformContext	getContext()
protected java.lang.String	getDrillParameters(WebDrillPath drillPath, boolean isAdvanced)	Returns the parameters to the JavaScript function 'submitGraphDrill' in mstrReportGraphCMImpl.js which submits the Graph Drill Event
protected WebGraphArea	getGraphArea()
protected int	getIntValue(java.lang.String fpName, int defaultValue)	Utility method for obtaining the integer value of a given formal parameter
protected java.lang.String	getJavaScriptFunction()	Returns the name of the JavaScript function that needs to be called in order to submit the Graph Drill Event
protected java.lang.String	getMoreOptionsArgs()
protected java.lang.String	getStringValue(java.lang.String fpName, java.lang.String defaultValue)	Utility method for obtaining the string value of a given formal parameter
protected ContextMenu	getSubMenu()	Returns ContextMenu using TransformContext's ContextMenuManager.
protected java.lang.String	getSubMenuName()	Gets the submenu Name which helps in creation of dynamic menuitems.
WebDrillMap	getWebDrillMap()	Returns the DrillMap for with the GraphArea object associated with this class
protected WebTitle	getWebTitle()	Utility method for obtaining the current WebTitle instance related to the cell being processed
protected boolean	isAdvancedDrillMenuAvailable()
protected boolean	isFeatureAvailable(java.lang.String featureName)	Utility method for determining if a feature is available or not
boolean	isIframeEnabled()
protected boolean	isTrue(java.lang.String fpName)	Utility method for obtaining the boolean value of a given formal parameter
protected void	setGraphArea(WebGraphArea wga)
void	setIframeEnabled(boolean value)	Define if the options to generate will be iframe enabled or not
protected boolean	shouldIncludeDrillPath(WebDrillPath drillPath)	Checks for the Drill Mode preferences and the Web Drill Metric privilege

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

addDrillMenuItem, addDrillMenuItem, addDrillPathToMenu, addGenericMoreOptions, areThereOptions, getDescriptor, getDisplayMode, getDrillWithin, getGridDrillDynamicMenuName, hasDrillPaths, internalPopulate, isCellMetric, isDrillable, isMetricDrillingEnabled, isOndemandDrillingDisabled, isRW, isTestForElements, isValid, populateMoreOptions, populateOnDemand, processAdvancedDrillPathElements, processDrillPathElements, setAreThereOptions, setImageType, sortWebDrillMap

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.microstrategy.web.app.transforms.contextmenus.ComposedContextMenuBuilder

generateSubMenu, isIframeEnabled, setIframeEnabled

Constructor Detail

GraphAreaContextMenuBuilder

public GraphAreaContextMenuBuilder(TransformContext context)

Method Detail

getWebDrillMap

public WebDrillMap getWebDrillMap()

Returns the DrillMap for with the GraphArea object associated with this class

Specified by:

getWebDrillMap in class ReportCellDrill.AbstractDrillContextMenuBuilder

Returns:

WebDrillMap initialized instance with the drill information. Returns null if not supported

getSubMenuName

protected java.lang.String getSubMenuName()

Description copied from class: ReportCellDrill.AbstractDrillContextMenuBuilder

Gets the submenu Name which helps in creation of dynamic menuitems. This name is used to store the ContextMenu (submenu) with the ContextMenuManager.

Eventually this method could become part of the parent ComposedContextMenuBuilder interface if the ondemand dynamicMenus is also needed for other non-drill context menus.

Specified by:

getSubMenuName in class ReportCellDrill.AbstractDrillContextMenuBuilder

Returns:

a name of the ContextMenu (subMenu)

shouldIncludeDrillPath

protected boolean shouldIncludeDrillPath(WebDrillPath drillPath)

Checks for the Drill Mode preferences and the Web Drill Metric privilege

Overrides:

shouldIncludeDrillPath in class ReportCellDrill.AbstractDrillContextMenuBuilder

Parameters:

drillPath - WebDrillMap initialized instance with the drill information for the current cell.

Returns:

boolean value indicating if the drill path information shall be included or not.

isAdvancedDrillMenuAvailable

protected boolean isAdvancedDrillMenuAvailable()

Overrides:

isAdvancedDrillMenuAvailable in class ReportCellDrill.AbstractDrillContextMenuBuilder

getWebTitle

protected WebTitle getWebTitle()

Description copied from class: ReportCellDrill.AbstractDrillContextMenuBuilder

Utility method for obtaining the current WebTitle instance related to the cell being processed

Specified by:

getWebTitle in class ReportCellDrill.AbstractDrillContextMenuBuilder

Returns:

WebTitle instance related with the cell being processed. Returns null if none provided.

canDrill

public boolean canDrill()

Checks if the current GraphArea object supports Drilling

Overrides:

canDrill in class ReportCellDrill.AbstractDrillContextMenuBuilder

getDrillParameters

protected java.lang.String getDrillParameters(WebDrillPath drillPath,
                                              boolean isAdvanced)

Returns the parameters to the JavaScript function 'submitGraphDrill' in mstrReportGraphCMImpl.js which submits the Graph Drill Event

Overrides:

getDrillParameters in class ReportCellDrill.AbstractDrillContextMenuBuilder

Parameters:

drillPath - WebDrillPath from where the JavaScript arguments will be generated

Returns:

String value with the JavaScript information that should be included on the code generated for this drill path option.

getJavaScriptFunction

protected java.lang.String getJavaScriptFunction()

Returns the name of the JavaScript function that needs to be called in order to submit the Graph Drill Event

Overrides:

getJavaScriptFunction in class ReportCellDrill.AbstractDrillContextMenuBuilder

getMoreOptionsArgs

protected java.lang.String getMoreOptionsArgs()

Overrides:

getMoreOptionsArgs in class ReportCellDrill.AbstractDrillContextMenuBuilder

Since:

MicroStrategy Web 9.0.1

setGraphArea

protected void setGraphArea(WebGraphArea wga)

getGraphArea

protected WebGraphArea getGraphArea()

getSubMenu

protected ContextMenu getSubMenu()

Description copied from class: ReportCellDrill.AbstractDrillContextMenuBuilder

Returns ContextMenu using TransformContext's ContextMenuManager. For null ReportCellDrill.AbstractDrillContextMenuBuilder.getWebTitle() creates a new ContextMenu registered with the ContextMenuManager. For non-null ReportCellDrill.AbstractDrillContextMenuBuilder.getWebTitle() the ContextMenu associated with a #getSubMenuName method is returned

Overrides:

getSubMenu in class ReportCellDrill.AbstractDrillContextMenuBuilder

Returns:

the ContextMenu

setIframeEnabled

public void setIframeEnabled(boolean value)

Define if the options to generate will be iframe enabled or not

Specified by:

setIframeEnabled in interface ComposedContextMenuBuilder

Parameters:

value - boolean value indicating if the options to generate will be iframe enabled or not

isIframeEnabled

public boolean isIframeEnabled()

Specified by:

isIframeEnabled in interface ComposedContextMenuBuilder

Returns:

boolean value indicating if the options generated by this builder are iframe enabled or not

getContext

public TransformContext getContext()

Returns:

ReportGridDisplayCell.Context instance with the information about the context (cell, transform, etc) where this menu item will be displayed.

generateSubMenu

public ContextMenu generateSubMenu()

Description copied from interface: ComposedContextMenuBuilder

Method that generates a ContextMenu instance with all the possible sub menu options enabled for the report cell provided.

Specified by:

generateSubMenu in interface ComposedContextMenuBuilder

Returns:

ContextMenu instance with the drilling options that can be displayed to the user

isFeatureAvailable

protected boolean isFeatureAvailable(java.lang.String featureName)

Utility method for determining if a feature is available or not

Parameters:

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

Returns:

boolean value indicating if the feature is available or not.

isTrue

protected boolean isTrue(java.lang.String fpName)

Utility method for obtaining the boolean value of a given formal parameter

Parameters:

fpName - String value with the name of the formal parameter to test

Returns:

boolean value of the formal parameter requested. If not found or the formal parameter is not of type boolean, it will return false.

getIntValue

protected int getIntValue(java.lang.String fpName,
                          int defaultValue)

Utility method for obtaining the integer value of a given formal parameter

Parameters:

fpName - String value with the name of the formal parameter to test

defaultValue - value to return if the process of querying the formal parameter fails.

Returns:

value of the formal parameter requested. If not found or the formal parameter is not of type integer, it will return the default value provided.

getStringValue

protected java.lang.String getStringValue(java.lang.String fpName,
                                          java.lang.String defaultValue)

Utility method for obtaining the string value of a given formal parameter

Parameters:

fpName - String value with the name of the formal parameter to test

defaultValue - value to return if the process of querying the formal parameter fails.

Returns:

value of the formal parameter requested. If not found or the formal parameter is not of type string, it will return the default value provided.