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

Class PageByHyperLinkNavigation

java.lang.Object

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

com.microstrategy.web.app.transforms.contextmenus.AbstractPagebyContextMenuItemBuilder

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

All Implemented Interfaces:

ContextMenuItemBuilder

public class PageByHyperLinkNavigation
extends AbstractPagebyContextMenuItemBuilder

Since:

MicroStrategy Web 8.1.2

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	PageByHyperLinkNavigation.AbstractHyperLinkNavigationContextMenuBuilder	Abstract base implementation of the ReportCellDrill.DrillContextMenuBuilder class.
protected static interface	PageByHyperLinkNavigation.HyperLinkNavigationContextMenuBuilder	Helper builder interface that allows generating the different drill path options for the current cell that shall be displayed to the user.
protected static class	PageByHyperLinkNavigation.InvalidHyperLinkNavigationContextMenuBuilder

Constructor Summary

Constructors

Constructor	Description
PageByHyperLinkNavigation(Shortcut definition)	Class constructor

Method Summary

Modifier and Type	Method	Description
ContextMenuItem	createItem(TransformContext context)	Creates and populates a ContextMenuItem based on the information in the Shortcut used as its defintion, as well as the logic included on this builder instance.
ContextMenu	generateSubMenu(TransformContext context)	Get the submenu that will display the different sub-menu options to the user.
protected ComposedContextMenuBuilder	getComposedContextMenuBuilder(TransformContext context)
protected java.lang.String	getJSCode(TransformContext context)	Generate the JavaScript code the context menu item generated by this builder instance will trigger when the user selects it.
protected boolean	isActionEnabled(TransformContext context)	Indicates the abstract class if the specific action of this item is available.
protected boolean	itemHasSubMenus(ContextMenuItem item, TransformContext context)

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

getBoneID, getContextMenusScript, getContextMenusScript, getPageByUnit, getTransform, isItemAvailable

Methods inherited from class com.microstrategy.web.app.gui.ContextMenu.DefaultContextMenuItemBuilder

createItem, getDefinition, getItemKey, getScript

Methods inherited from class java.lang.Object

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

Constructor Detail

PageByHyperLinkNavigation

public PageByHyperLinkNavigation(Shortcut definition)

Class constructor

Parameters:

definition - Shortcut instance with the base definition of the option

Method Detail

createItem

public ContextMenuItem createItem(TransformContext context)

Creates and populates a ContextMenuItem based on the information in the Shortcut used as its defintion, as well as the logic included on this builder instance.

Specified by:

createItem in interface ContextMenuItemBuilder

Overrides:

createItem in class ContextMenu.DefaultContextMenuItemBuilder

Parameters:

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

Returns:

a new instance of a ContextMenuItem initialized with the option information to present to the user.

itemHasSubMenus

protected boolean itemHasSubMenus(ContextMenuItem item,
                                  TransformContext context)

Since:

MicroStrategy Web 9.0.0

getJSCode

protected java.lang.String getJSCode(TransformContext context)

Generate the JavaScript code the context menu item generated by this builder instance will trigger when the user selects it.

Parameters:

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

Returns:

By default it will return a null string since this option will have a context menu attached to it, and JavaScript code already takes care of these cases.

generateSubMenu

public ContextMenu generateSubMenu(TransformContext context)

Get the submenu that will display the different sub-menu options to the user.

Parameters:

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

Returns:

ContextMenu instance initialized with all the options that can be presented to the user.

getComposedContextMenuBuilder

protected ComposedContextMenuBuilder getComposedContextMenuBuilder(TransformContext context)

isActionEnabled

protected boolean isActionEnabled(TransformContext context)

Description copied from class: AbstractPagebyContextMenuItemBuilder

Indicates the abstract class if the specific action of this item is available.

Specified by:

isActionEnabled in class AbstractPagebyContextMenuItemBuilder