ContextMenuItemBuilder

com.microstrategy.web.app.gui.ContextMenuItemBuilder

Known Indirect Subclasses

AbstractFilterOperatorContextMenuItemBuilder, AbstractFolderContextMenuItemBuilder, AbstractFolderParentMenu, AbstractInboxContextMenuItemBuilder, AbstractPagebyContextMenuItemBuilder, AbstractReportCellComposedContextMenuItemBuilder, AbstractReportCellContextMenuItemBuilder, AbstractReportCellInsertMetric, AbstractReportCellMove, AbstractReportCellParentMenu, AbstractReportCellSort, AbstractReportCellThresholds, AbstractUserMgrContextMenuItemBuilder, AddDimensionAttributeToGridOrFilter, AddDimensionElementToFilter, and 128 others.

AbstractFilterOperatorContextMenuItemBuilder	This class is used by Microstrategy Web as a base class for those used to populate operator's context-menus of the Filter editor.
AbstractFolderContextMenuItemBuilder	This class is used by Microstrategy Web as a base class for those used to populate context-menus used in the Folder page.
AbstractFolderParentMenu
AbstractInboxContextMenuItemBuilder	This class is used by Microstrategy Web as a base class for those used to populate context-menus used in the History List page.
AbstractPagebyContextMenuItemBuilder	This class is used by Microstrategy Web as a base class for those used to populate context-menus used with the PageBy transform.
AbstractReportCellComposedContextMenuItemBuilder	This is a base class for those context menu item builders for report cells that generate menu options with sub-menus associated to them.
AbstractReportCellContextMenuItemBuilder
AbstractReportCellInsertMetric	`AbstractReportCellInsertMetric` is the base class for the different Insert Metric options such as `ReportCellPercentGrandTotalMetric`, `ReportCellPercentOverColumnsMetric`, etc.
AbstractReportCellMove	`AbstractReportCellMove` is the base class for generating pivot options for the different cells on a report grid.
AbstractReportCellParentMenu	The `AbstractReportCellParentMenu` represents a context menu item builder that will hold a sub-menu structure with a list of the options - defined on the XML Configuration file - that a user will be enabled to select.
AbstractReportCellSort	`AbstractReportCellSort` is the base class for generating sort options for the different cells on a report grid.
AbstractReportCellThresholds
AbstractUserMgrContextMenuItemBuilder
AddDimensionAttributeToGridOrFilter
AddDimensionElementToFilter
AdminFolderDelete
AdminFolderEdit
ContextMenu.DefaultContextMenuItemBuilder	This class is the default implementation of a `ContextMenuItemBuilder`.
CreateSelectorControl
FilterAnd
FilterAndNot
FilterOr
FilterOrNot
FolderCopy
FolderCreateAnalysisFromReport
FolderCreateDocumentFromAnalysis
FolderCreateDocumentFromReport
FolderCreateDocumentFromTheme
FolderCreateHTML5VIFromReport
FolderCreateReportFromCube
FolderCreateShortcut
FolderDelete
FolderDisplayProperties
FolderEdit
FolderExportLink
FolderExportMstr	Class to support export to mstr (Download Dashboard option) from folder view.
FolderInlineRename
FolderMove
FolderNew	The context menu builder for the Folder's New RMC menu.
FolderNewFilter
FolderNewPrompt
FolderOpen
FolderQueryBuilder
FolderRename
FolderRun
FolderRunAs
FolderRunViewMedia
FolderShareLink
FolderSimpleAction
FolderTreeExportLink
FolderTreeShareLink
FolderVIDebug
GraphColorPicker
InboxDelete
InboxDetails
InboxExport
InboxPDF
InboxRename
InboxUnread
NCSRemoveRecipient
PageByAttrForms
PageByDelete
PageByHyperLinkEdit
PageByHyperLinkNavigation
PageByPivot
PageByProperties
PageByRemove
PageByRename
PageBySort
RWDrill	This class is used by Microstrategy Web as a base class for those used to populate drill context menus for RWDs.
ReportCellActionControlEditor
ReportCellAddShortcutMetric	The `ReportCellAddShortcutMetric` represents a context menu item builder that will allow users to insert new shortcut metrics over selected cell.
ReportCellAdvancedSort	The `ReportCellAdvancedSort` represents a context menu item that a user is enabled to sort the current grid.
ReportCellAdvancedThresholds
ReportCellAlert	Represents a context menu item builder to open the alerts editor.
ReportCellAlertEmail
ReportCellAlertMobile
ReportCellAttributeFormEditor	The `ReportCellAttributeFormEditor` represents a context menu item builder that will generate a link to the Attribute Form Editor.
ReportCellAttributeForms	The `ReportCellAttributeForms` represents a context menu item builder that will generate a sub-menu structure with a list of the options that a user is enabled to access for modifying the different attribute forms that can be viewed for the attribute cell currently selected, specified on the context.
ReportCellClearDerivedElements	The `ReportCellClearDerivedElements` represents a context menu item builder that will generate the option for being able to rename the current grid cell selected, specified on the context.
ReportCellCustomSort	The `ReportCellCustomSort` represents a context menu item builder that will generate the option for being able to rename the current grid cell selected, specified on the context.
ReportCellDEQuickGroup
ReportCellDEQuickGroupOperator
ReportCellDefaultMenu
ReportCellDerivedElements	The `ReportCellDerivedElements` represents a context menu item builder that will generate the option for being able to rename the current grid cell selected, specified on the context.
ReportCellDrill	The `ReportCellDrill` represents a context menu item builder that will generate a sub-menu structure with a list of the options that a user is enabled to access for navigating different drill paths for the current grid cell selected, specified on the context.
ReportCellEditDerived
ReportCellFilterOn	The `ReportCellFilterOn` represents a context menu item builder that will generate the option for being able to create a filter based on the current grid cell selected, specified on the context.
ReportCellFilterOnSelections	`ReportCellFilterOnSelections` is responsible for generating the Filter On Selections menu option.
ReportCellFormat	The `ReportCellFormat` represents a context menu item builder that will generate the option for being able to format the current grid cell selected, specified on the context.
ReportCellHyperLink	The `ReportCellHyperLink` represents a context menu item builder that will generate the option for being able to add hyper link to a template unit from the grid.
ReportCellHyperLinkNavigation
ReportCellInsertMetric	The `ReportCellInsertMetric` represents a context menu item builder that will hold a sub-menu structure with a list of the options that a user is enabled to access for inserting new metrics based on the current grid cell selected, specified on the context.
ReportCellInsertPercentToTotalMetric	The `ReportCellInsertPercentToTotalMetric` represents a context menu item builder that will hold a sub-menu structure with a list of the options that a user is enabled to access for inserting new metrics based on the percent to total of the current grid cell selected, specified on the context.
ReportCellKeepOnGrid	The `ReportCellKeepOnGrid` represents a context menu item builder that will generate the option for being able to keep the current grid cell selected (specified on the context) on the grid.
ReportCellMetricFilter	The `ReportCellMetricFilter` represents a context menu item builder that will hold a sub-menu structure with a list of the options that a user is enabled to access for view reports
ReportCellMetricFilterEdit	Context Menu Builder class used for the "Filter On..." context menu option on metrics in a grid
ReportCellMove	The `ReportCellMove` represents a context menu item builder that will hold a sub-menu structure with a list of the options that a user is enabled to access for pivoting the current grid cell element selected, indicated on the context.
ReportCellMoveDown	The `ReportCellMoveDown` class represents the pivot option that allows `ReportGridCellColTitle` cell instances to be moved down on the grid template.
ReportCellMoveLeft	The `ReportCellMoveLeft` class represents the pivot option that allows cells other than `ReportGridCellColTitle` instances to be moved left on the grid template.
ReportCellMoveRight	The `ReportCellMoveRight` class represents the pivot option that allows cells other than `ReportGridCellColTitle` instances to be moved right on the grid template.
ReportCellMoveToColumns	The `ReportCellMoveToColumns` class represents the pivot option that allows cells other than `ReportGridCellColTitle` and `ReportGridCellColHeader` instances to be moved to columns on the grid template.
ReportCellMoveToPageBy	The `ReportCellMoveToPageBy` class represents the pivot option that allows cell instances to be moved to the page by section on the grid template.
ReportCellMoveToRows	The `ReportCellMoveToRows` class represents the pivot option that allows `ReportGridCellColTitle` and `ReportGridCellColHeader` cell instances to be moved to rows on the grid template.
ReportCellMoveUp	The `ReportCellMoveUp` class represents the pivot option that allows `ReportGridCellColTitle` cell instances to be moved up on the grid template.
ReportCellNewCustomSort	The `ReportCellNewCustomSort` represents a context menu item builder that will generate the option for being able to rename the current grid cell selected, specified on the context.
ReportCellPercentForEachMetric	The `ReportCellPercentForEachMetric` represents a context menu item builder that will hold a sub-menu structure with a list of the options that a user is enabled to access for inserting new metrics based on the different grid elements, as specified on the context.
ReportCellPercentGrandTotalMetric	The `ReportCellPercentGrandTotalMetric` represents a context menu item builder that will allow users to insert new percent metrics based on the grand total.
ReportCellPercentOverColumnsMetric	The `ReportCellPercentOverColumnsMetric` represents a context menu item builder that will allow users to insert new percent metrics over column information.
ReportCellPercentOverPagesMetric	The `ReportCellPercentOverPagesMetric` represents a context menu item builder that will allow users to insert new percent metrics over page information.
ReportCellPercentOverRowsMetric	The `ReportCellPercentOverRowsMetric` represents a context menu item builder that will allow users to insert new percent metrics over row information.
ReportCellRankMetric	The `ReportCellRankMetric` represents a context menu item builder that will hold a sub-menu structure with a list of the options that a user is enabled to access for inserting new ranking metrics based on the grid information, available on the context.
ReportCellRemoveFromGrid	The `ReportCellRemoveFromGrid` represents a context menu item builder that will generate the option for being able to remove the current grid cell selected (specified on the context) from the grid.
ReportCellRemoveFromReport	The `ReportCellRemoveFromReport` represents a context menu item builder that will generate the option for being able to remove the current grid cell selected (specified on the context) from the report definition.
ReportCellRename	The `ReportCellRename` represents a context menu item builder that will generate the option for being able to rename the current grid cell selected, specified on the context.
ReportCellSelectorControlEditor
ReportCellSort	The `ReportCellSort` represents a context menu item builder that will hold a sub-menu structure with a list of the options that a user is enabled to access for sorting the current grid cell selected, specified on the context.
ReportCellSortAscending	`ReportCellSortAscending` will enable users to request the sorting of a given field on the grid in ascending order.
ReportCellSortColAscending	`ReportCellSortColAscending` will enable users to request the column sorting of a given field on the grid in ascending order.
ReportCellSortColDescending	`ReportCellSortColDescending` will enable users to request the column sorting of a given field on the grid in descending order.
ReportCellSortDescending	`ReportCellSortDescending` will enable users to request the sorting of a given field on the grid in descending order.
ReportCellThresholds	The `ReportCellThresholds` represents a context menu item builder that will generate the option for being able to add advanced thresholds for the current grid cell selected, specified on the context.
ReportCellTransformationMetric	The `ReportCellTransformationMetric` represents a context menu item builder that will hold a sub-menu structure with a list of the options that a user is enabled to access for inserting new transformation metrics based on the grid information, available on the context, and on the transformation roles available on the project.
ReportCellVisualThresholds
ReportGraphDrill
ReportGraphFill
ReportGraphFont
ReportGraphFormat
ReportGraphLine
ReportPageByCellDrill
ReportTitleInsertMetric	The `ReportTitleInsertMetric` represents a context menu item builder that will hold a sub-menu structure with a list of the options that a user is enabled to access for inserting new shortcut metrics based on the current grid title selected, specified on the context.
ReportWSDelete
RepublishCube
ScheduleCube
SelectControlTargets
TextHyperLinkNavigation	This class is used by Microstrategy Web as a base class for those used to populate drill context menus for RWDs.
UserMgrDelete
UserMgrEdit
UserMgrNew
UserMgrNewGroup
UserMgrNewGroupStandalone
UserMgrNewUser
UserMgrNewUserStandalone

Class Overview

Title: ContextMenuItemBuilder.

Description: This interface is used by the ContextMenu to create instances of ContextMenuItem. Each different class implementing this interface is responsible to create and populate a ContextMenuItem that will perform a particular action.

Company: Microstrategy, Inc.

Summary

Public Methods
abstract ContextMenuItem	createItem(TransformContext context) Creates and populates new instance of a `ContextMenuItem`.
abstract String	getItemKey(TransformContext context) Retrieve the key will be set on the context menu item corresponding to the context input.
abstract boolean	isItemAvailable(TransformContext context) Return true if the corresponding ContextMenuItem is available and should be created.

Public Methods

public abstract ContextMenuItem createItem (TransformContext context)

Creates and populates new instance of a ContextMenuItem.

Parameters

context	Context Information.

Returns

A new ContextMenuItem populated to perform the corresponding action.

public abstract String getItemKey (TransformContext context)

Retrieve the key will be set on the context menu item corresponding to the context input. The context menu item generated based on the same context input will have the same key. This method can be called by context menu before calling createItem(TransformContext) to check whether the item already exists in the menu to avoid unnecessary creation.

Parameters

context	The context for context menu item creation

Returns

The key for the context menu item if created using the context. By default null will be return, which means build has no knowledge about the item key. Then context menu item may generate the key by itself. For builder who wants avoid unnecessary item creation should take advantage of this method by overriding with a meaningful implementation.

public abstract boolean isItemAvailable (TransformContext context)

Return true if the corresponding ContextMenuItem is available and should be created.

Parameters

context	Context Information.

Returns

true if the corresponding ContextMenuItem can be created based on the context information

Interfaces

Classes

ContextMenuItemBuilder

Class Overview

Summary

Public Methods

public abstract ContextMenuItem createItem (TransformContext context)

Parameters

Returns

public abstract String getItemKey (TransformContext context)

Parameters

Returns

public abstract boolean isItemAvailable (TransformContext context)

Parameters

Returns