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

Class ReportCellDrill.HeaderDrillContextMenuBuilder

java.lang.Object

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

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

All Implemented Interfaces:

ComposedContextMenuBuilder, OnDemandContextMenuBuilder, ReportCellDrill.DrillContextMenuBuilder

Enclosing class:

ReportCellDrill

public static class ReportCellDrill.HeaderDrillContextMenuBuilder
extends ReportCellDrill.AbstractDrillContextMenuBuilder

Relevant to WebHeader (could be MetricHeader, AttributeHeader or DimensionHeader

Since:

MicroStrategy Web 8.0.1

Field Summary

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

SYS_DEFAULT_DISABLE_ONDEMAND_DRILLING

Constructor Summary

Constructors

Constructor	Description
HeaderDrillContextMenuBuilder(TransformContext context)

Method Summary

Modifier and Type	Method	Description
ContextMenu	generateSubMenu()	Method that generates a ContextMenu instance with all the possible sub menu options enabled for the report cell provided.
TransformContext	getContext()
protected ReportGridCellHeader	getDisplayCell()
protected int	getIntValue(java.lang.String fpName, int defaultValue)	Utility method for obtaining the integer value of a given formal parameter
static java.lang.String	getItemKeyOf(ReportGridDisplayCell.Context context)
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 java.lang.String	getSubMenuName()	Gets the submenu Name which helps in creation of dynamic menuitems.
protected WebDrillMap	getWebDrillMap()	Utility method for obtaining the drill map information for the current cell indicated
protected WebHeader	getWebHeader()
protected WebTitle	getWebTitle()	Utility method for obtaining the current WebTitle instance related to the cell being processed
protected boolean	isCellMetric()	If the cell a metric value or template metric, it should return true otherwise false
protected boolean	isDrillable(WebDrillPath drillPath)	if getDisplayCell() is null, then this method is called from ondemand drilling and hence we return true, otherwise it reverts to the default implementation.
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
boolean	isValid()
void	setIframeEnabled(boolean value)	Define if the options to generate will be iframe enabled or not
protected void	setWebHeader(WebHeader header)
protected boolean	shouldIncludeDrillPath(WebDrillPath drillPath)	Utility method for determining if the drill path information should be included or not

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

addDrillMenuItem, addDrillMenuItem, addDrillPathToMenu, addGenericMoreOptions, areThereOptions, canDrill, getDescriptor, getDisplayMode, getDrillParameters, getDrillWithin, getGridDrillDynamicMenuName, getJavaScriptFunction, getMoreOptionsArgs, getSubMenu, hasDrillPaths, internalPopulate, isAdvancedDrillMenuAvailable, isMetricDrillingEnabled, isOndemandDrillingDisabled, isRW, isTestForElements, 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

HeaderDrillContextMenuBuilder

public HeaderDrillContextMenuBuilder(TransformContext context)

Since:

MicroStrategy Web 9.0.0

Method Detail

getDisplayCell

protected ReportGridCellHeader getDisplayCell()

getWebHeader

protected WebHeader getWebHeader()

setWebHeader

protected void setWebHeader(WebHeader header)

Since:

MicroStrategy Web 9.0.0

shouldIncludeDrillPath

protected boolean shouldIncludeDrillPath(WebDrillPath drillPath)

Description copied from class: ReportCellDrill.AbstractDrillContextMenuBuilder

Utility method for determining if the drill path information should be included or not

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.

isDrillable

protected boolean isDrillable(WebDrillPath drillPath)

if getDisplayCell() is null, then this method is called from ondemand drilling and hence we return true, otherwise it reverts to the default implementation.

Overrides:

isDrillable in class ReportCellDrill.AbstractDrillContextMenuBuilder

Parameters:

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

Returns:

boolean value indicating if the current cell is drillable or not

isValid

public boolean isValid()

Specified by:

isValid in interface ComposedContextMenuBuilder

Overrides:

isValid in class ReportCellDrill.AbstractDrillContextMenuBuilder

Returns:

boolean value that indicates if drilling on the current cell shall be enabled to the user

isCellMetric

protected boolean isCellMetric()

Description copied from class: ReportCellDrill.AbstractDrillContextMenuBuilder

If the cell a metric value or template metric, it should return true otherwise false

Overrides:

isCellMetric in class ReportCellDrill.AbstractDrillContextMenuBuilder

Since:

MicroStrategy Web 9.0.0

getItemKeyOf

public static java.lang.String getItemKeyOf(ReportGridDisplayCell.Context context)

Since:

MicroStrategy Web 9.0.0

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)

Since:

MicroStrategy Web 9.0.0

getWebDrillMap

protected WebDrillMap getWebDrillMap()

Description copied from class: ReportCellDrill.AbstractDrillContextMenuBuilder

Utility method for obtaining the drill map information for the current cell indicated

Specified by:

getWebDrillMap in class ReportCellDrill.AbstractDrillContextMenuBuilder

Returns:

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

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.

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.