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

Class PageByHyperLinkNavigation.AbstractHyperLinkNavigationContextMenuBuilder

java.lang.Object

com.microstrategy.web.app.transforms.contextmenus.PageByHyperLinkNavigation.AbstractHyperLinkNavigationContextMenuBuilder

All Implemented Interfaces:

ComposedContextMenuBuilder, PageByHyperLinkNavigation.HyperLinkNavigationContextMenuBuilder

Enclosing class:

PageByHyperLinkNavigation

protected abstract static class PageByHyperLinkNavigation.AbstractHyperLinkNavigationContextMenuBuilder
extends java.lang.Object
implements PageByHyperLinkNavigation.HyperLinkNavigationContextMenuBuilder

Abstract base implementation of the ReportCellDrill.DrillContextMenuBuilder class.

Since:

MicroStrategy Web 8.1.2

Field Summary

Fields

Modifier and Type	Field	Description
protected PageByUnit	unit

Constructor Summary

Constructors

Constructor	Description
AbstractHyperLinkNavigationContextMenuBuilder(TransformContext context, PageByUnit _unit)

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 abstract WebHyperLinks	getHyperLinks()
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	getJSCode(WebHyperLink link, int linkIndex)
protected abstract int	getPosition()
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 WebTitle	getWebTitle()	Utility method for obtaining the current WebTitle instance related to the cell being processed
protected void	internalPopulate()
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()
protected void	processHyperLinkElement(WebHyperLink link, int linkIndex)
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, setIframeEnabled

Field Detail

unit

protected PageByUnit unit

Constructor Detail

AbstractHyperLinkNavigationContextMenuBuilder

public AbstractHyperLinkNavigationContextMenuBuilder(TransformContext context,
                                                     PageByUnit _unit)

Method Detail

getWebTitle

protected WebTitle getWebTitle()

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

Returns:

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

getHyperLinks

protected abstract WebHyperLinks getHyperLinks()

getPosition

protected abstract int getPosition()

getSubMenu

protected ContextMenu getSubMenu()

Returns:

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

internalPopulate

protected void internalPopulate()

processHyperLinkElement

protected void processHyperLinkElement(WebHyperLink link,
                                       int linkIndex)

getJSCode

protected java.lang.String getJSCode(WebHyperLink link,
                                     int linkIndex)

isValid

public boolean isValid()

Specified by:

isValid in interface ComposedContextMenuBuilder

Returns:

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

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

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.