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

Class ReportCellDrill.InvalidDrillContextMenuBuilder

java.lang.Object

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

All Implemented Interfaces:

ComposedContextMenuBuilder, ReportCellDrill.DrillContextMenuBuilder

Enclosing class:

ReportCellDrill

protected static class ReportCellDrill.InvalidDrillContextMenuBuilder
extends java.lang.Object
implements ReportCellDrill.DrillContextMenuBuilder

Implementation of the ReportCellDrill.DrillContextMenuBuilder interface for representing a builder instance corresponding to a non-supported context.

Since:

MicroStrategy Web 8.0.1

Constructor Summary

Constructors

Constructor	Description
InvalidDrillContextMenuBuilder(ReportGridDisplayCell.Context 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 java.lang.String	getDescriptor(int key)	Utility method for obtaining the string of a descriptor
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 ContextMenu	getSubMenu()
protected void	internalPopulate()	For this class, this method has no effect since the context menu option is not enabled given the context provided.
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

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, isValid, setIframeEnabled

Constructor Detail

InvalidDrillContextMenuBuilder

public InvalidDrillContextMenuBuilder(ReportGridDisplayCell.Context context)

Method Detail

getItemKeyOf

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

Since:

MicroStrategy Web 9.0.0

isValid

public boolean isValid()

Returns:

boolean false value indicating the drill option is not valid given the current context information

internalPopulate

protected void internalPopulate()

For this class, this method has no effect since the context menu option is not enabled given the context 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.

getSubMenu

protected ContextMenu getSubMenu()

Returns:

ContextMenu instance where the different options this builder will generate will be saved.

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

getDescriptor

protected java.lang.String getDescriptor(int key)

Utility method for obtaining the string of a descriptor

Parameters:

key - value with the identifier of the descriptor to obtain

Returns:

String value of the descriptor, according to the key provided

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.