public class

PageByHyperLinkNavigation

extends AbstractPagebyContextMenuItemBuilder
java.lang.Object
   ↳ com.microstrategy.web.app.gui.ContextMenu.DefaultContextMenuItemBuilder
     ↳ com.microstrategy.web.app.transforms.contextmenus.AbstractPagebyContextMenuItemBuilder
       ↳ com.microstrategy.web.app.transforms.contextmenus.PageByHyperLinkNavigation

Summary

Nested Classes
class PageByHyperLinkNavigation.AbstractHyperLinkNavigationContextMenuBuilder Abstract base implementation of the ReportCellDrill.DrillContextMenuBuilder class. 
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. 
class PageByHyperLinkNavigation.InvalidHyperLinkNavigationContextMenuBuilder  
Public Constructors
PageByHyperLinkNavigation(Shortcut definition)
Class constructor
Public Methods
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 Methods
ComposedContextMenuBuilder getComposedContextMenuBuilder(TransformContext context)
String getJSCode(TransformContext context)
Generate the JavaScript code the context menu item generated by this builder instance will trigger when the user selects it.
boolean isActionEnabled(TransformContext context)
Indicates the abstract class if the specific action of this item is available.
boolean itemHasSubMenus(ContextMenuItem item, TransformContext context)
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.contextmenus.AbstractPagebyContextMenuItemBuilder
From class com.microstrategy.web.app.gui.ContextMenu.DefaultContextMenuItemBuilder
From class java.lang.Object
From interface com.microstrategy.web.app.gui.ContextMenuItemBuilder

Public Constructors

public PageByHyperLinkNavigation (Shortcut definition)

Class constructor

Parameters
definition Shortcut instance with the base definition of the option

Public Methods

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.

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.

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.

Protected Methods

protected ComposedContextMenuBuilder getComposedContextMenuBuilder (TransformContext context)

protected 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.

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)