Class ReportCellHyperLinkNavigation.AbstractHyperLinkNavigationContextMenuBuilder
- java.lang.Object
-
- com.microstrategy.web.app.transforms.contextmenus.ReportCellHyperLinkNavigation.AbstractHyperLinkNavigationContextMenuBuilder
-
- All Implemented Interfaces:
ComposedContextMenuBuilder
,ReportCellHyperLinkNavigation.HyperLinkNavigationContextMenuBuilder
- Enclosing class:
- ReportCellHyperLinkNavigation
protected abstract static class ReportCellHyperLinkNavigation.AbstractHyperLinkNavigationContextMenuBuilder extends java.lang.Object implements ReportCellHyperLinkNavigation.HyperLinkNavigationContextMenuBuilder
Abstract base implementation of theReportCellDrill.DrillContextMenuBuilder
class.- Since:
- MicroStrategy Web 8.1.2
-
-
Constructor Summary
Constructors Constructor Description AbstractHyperLinkNavigationContextMenuBuilder(ReportGridDisplayCell.Context context)
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description ContextMenu
generateSubMenu()
Method that generates aContextMenu
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 descriptorprotected abstract WebHyperLinks
getHyperLinks()
protected int
getIntValue(java.lang.String fpName, int defaultValue)
Utility method for obtaining the integer value of a given formal parameterprotected 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 parameterprotected ContextMenu
getSubMenu()
protected abstract WebTitle
getWebTitle()
Utility method for obtaining the currentWebTitle
instance related to the cell being processedprotected void
internalPopulate()
protected boolean
isFeatureAvailable(java.lang.String featureName)
Utility method for determining if a feature is available or notboolean
isIframeEnabled()
protected boolean
isTrue(java.lang.String fpName)
Utility method for obtaining the boolean value of a given formal parameterboolean
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
-
-
-
-
Constructor Detail
-
AbstractHyperLinkNavigationContextMenuBuilder
public AbstractHyperLinkNavigationContextMenuBuilder(ReportGridDisplayCell.Context context)
-
-
Method Detail
-
getWebTitle
protected abstract WebTitle getWebTitle()
Utility method for obtaining the currentWebTitle
instance related to the cell being processed- Returns:
WebTitle
instance related with the cell being processed. Returnsnull
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 interfaceComposedContextMenuBuilder
- 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 interfaceComposedContextMenuBuilder
- Parameters:
value
- boolean value indicating if the options to generate will be iframe enabled or not
-
isIframeEnabled
public boolean isIframeEnabled()
- Specified by:
isIframeEnabled
in interfaceComposedContextMenuBuilder
- 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 aContextMenu
instance with all the possible sub menu options enabled for the report cell provided.- Specified by:
generateSubMenu
in interfaceComposedContextMenuBuilder
- 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 testdefaultValue
- 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 testdefaultValue
- 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.
-
-