protected static abstract class

PageByHyperLinkNavigation.AbstractHyperLinkNavigationContextMenuBuilder

extends Object
implements ComposedContextMenuBuilder PageByHyperLinkNavigation.HyperLinkNavigationContextMenuBuilder
java.lang.Object
   ↳ com.microstrategy.web.app.transforms.contextmenus.PageByHyperLinkNavigation.AbstractHyperLinkNavigationContextMenuBuilder

Class Overview

Abstract base implementation of the ReportCellDrill.DrillContextMenuBuilder class.

Summary

Fields
protected PageByUnit unit
Public Constructors
AbstractHyperLinkNavigationContextMenuBuilder(TransformContext context, PageByUnit _unit)
Public Methods
ContextMenu generateSubMenu()
Method that generates a ContextMenu instance with all the possible sub menu options enabled for the report cell provided.
TransformContext getContext()
boolean isIframeEnabled()
boolean isValid()
void setIframeEnabled(boolean value)
Define if the options to generate will be iframe enabled or not
Protected Methods
String getDescriptor(int key)
Utility method for obtaining the string of a descriptor
abstract WebHyperLinks getHyperLinks()
int getIntValue(String fpName, int defaultValue)
Utility method for obtaining the integer value of a given formal parameter
String getJSCode(WebHyperLink link, int linkIndex)
abstract int getPosition()
String getStringValue(String fpName, String defaultValue)
Utility method for obtaining the string value of a given formal parameter
ContextMenu getSubMenu()
WebTitle getWebTitle()
Utility method for obtaining the current WebTitle instance related to the cell being processed
void internalPopulate()
boolean isFeatureAvailable(String featureName)
Utility method for determining if a feature is available or not
boolean isTrue(String fpName)
Utility method for obtaining the boolean value of a given formal parameter
void processHyperLinkElement(WebHyperLink link, int linkIndex)
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.microstrategy.web.app.transforms.contextmenus.ComposedContextMenuBuilder

Fields

protected PageByUnit unit

Public Constructors

public AbstractHyperLinkNavigationContextMenuBuilder (TransformContext context, PageByUnit _unit)

Public Methods

public ContextMenu generateSubMenu ()

Method that generates a ContextMenu instance with all the possible sub menu options enabled for the report cell provided.

Returns
  • ContextMenu instance with the drilling options that can be displayed to the user

public TransformContext getContext ()

Returns
  • Context instance with the information about the context (cell, transform, etc) where this menu item will be displayed.

public boolean isIframeEnabled ()

Returns
  • boolean value indicating if the options generated by this builder are iframe enabled or not

public boolean isValid ()

public void setIframeEnabled (boolean value)

Define if the options to generate will be iframe enabled or not

Parameters
value boolean value indicating if the options to generate will be iframe enabled or not

Protected Methods

protected 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

protected abstract WebHyperLinks getHyperLinks ()

protected int getIntValue (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.

protected String getJSCode (WebHyperLink link, int linkIndex)

protected abstract int getPosition ()

protected String getStringValue (String fpName, 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.

protected ContextMenu getSubMenu ()

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

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.

protected void internalPopulate ()

protected boolean isFeatureAvailable (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.

protected boolean isTrue (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.

protected void processHyperLinkElement (WebHyperLink link, int linkIndex)