Package com.microstrategy.web.app.gui
Interface ContextMenuItemBuilder
-
- All Known Implementing Classes:
AbstractFilterOperatorContextMenuItemBuilder
,AbstractFolderContextMenuItemBuilder
,AbstractFolderParentMenu
,AbstractInboxContextMenuItemBuilder
,AbstractPagebyContextMenuItemBuilder
,AbstractReportCellComposedContextMenuItemBuilder
,AbstractReportCellContextMenuItemBuilder
,AbstractReportCellInsertMetric
,AbstractReportCellMove
,AbstractReportCellParentMenu
,AbstractReportCellSort
,AbstractReportCellThresholds
,AbstractUserMgrContextMenuItemBuilder
,AddDimensionAttributeToGridOrFilter
,AddDimensionElementToFilter
,AdminFolderDelete
,AdminFolderEdit
,ContextMenu.DefaultContextMenuItemBuilder
,CreateSelectorControl
,EditWithAppschema
,FilterAnd
,FilterAndNot
,FilterOr
,FilterOrNot
,FolderCopy
,FolderCreateAnalysisFromReport
,FolderCreateDocumentFromAnalysis
,FolderCreateDocumentFromReport
,FolderCreateDocumentFromTheme
,FolderCreateHTML5VIFromReport
,FolderCreateReportFromCube
,FolderCreateShortcut
,FolderDelete
,FolderDisplayProperties
,FolderEdit
,FolderExportLink
,FolderExportMstr
,FolderInlineRename
,FolderMove
,FolderNew
,FolderNewFilter
,FolderNewPrompt
,FolderOpen
,FolderOpenInLibrary
,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
,ReportCellActionControlEditor
,ReportCellAddShortcutMetric
,ReportCellAdvancedSort
,ReportCellAdvancedThresholds
,ReportCellAlert
,ReportCellAlertEmail
,ReportCellAlertMobile
,ReportCellAttributeFormEditor
,ReportCellAttributeForms
,ReportCellClearDerivedElements
,ReportCellCustomSort
,ReportCellDefaultMenu
,ReportCellDEQuickGroup
,ReportCellDEQuickGroupOperator
,ReportCellDerivedElements
,ReportCellDrill
,ReportCellEditDerived
,ReportCellFilterOn
,ReportCellFilterOnSelections
,ReportCellFormat
,ReportCellHyperLink
,ReportCellHyperLinkNavigation
,ReportCellInsertMetric
,ReportCellInsertPercentToTotalMetric
,ReportCellKeepOnGrid
,ReportCellMetricFilter
,ReportCellMetricFilterEdit
,ReportCellMove
,ReportCellMoveDown
,ReportCellMoveLeft
,ReportCellMoveRight
,ReportCellMoveToColumns
,ReportCellMoveToPageBy
,ReportCellMoveToRows
,ReportCellMoveUp
,ReportCellNewCustomSort
,ReportCellPercentForEachMetric
,ReportCellPercentGrandTotalMetric
,ReportCellPercentOverColumnsMetric
,ReportCellPercentOverPagesMetric
,ReportCellPercentOverRowsMetric
,ReportCellRankMetric
,ReportCellRemoveFromGrid
,ReportCellRemoveFromReport
,ReportCellRename
,ReportCellSelectorControlEditor
,ReportCellSort
,ReportCellSortAscending
,ReportCellSortColAscending
,ReportCellSortColDescending
,ReportCellSortDescending
,ReportCellThresholds
,ReportCellTransformationMetric
,ReportCellVisualThresholds
,ReportGraphDrill
,ReportGraphFill
,ReportGraphFont
,ReportGraphFormat
,ReportGraphLine
,ReportPageByCellDrill
,ReportTitleInsertMetric
,ReportWSDelete
,RepublishCube
,RWDrill
,ScheduleCube
,SelectControlTargets
,TextHyperLinkNavigation
,UserMgrDelete
,UserMgrEdit
,UserMgrNew
,UserMgrNewGroup
,UserMgrNewGroupStandalone
,UserMgrNewUser
,UserMgrNewUserStandalone
public interface ContextMenuItemBuilder
Title: ContextMenuItemBuilder.
Description: This interface is used by the
ContextMenu
to create instances ofContextMenuItem
. Each different class implementing this interface is responsible to create and populate aContextMenuItem
that will perform a particular action.Copyright: Copyright (c) 2002
Company: Microstrategy, Inc.
- Since:
- MicroStrategy Web 8.0.1
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ContextMenuItem
createItem(TransformContext context)
Creates and populates new instance of aContextMenuItem
.java.lang.String
getItemKey(TransformContext context)
Retrieve the key will be set on the context menu item corresponding to the context input.boolean
isItemAvailable(TransformContext context)
Return true if the corresponding ContextMenuItem is available and should be created.
-
-
-
Method Detail
-
isItemAvailable
boolean isItemAvailable(TransformContext context)
Return true if the corresponding ContextMenuItem is available and should be created.- Parameters:
context
- Context Information.- Returns:
true
if the correspondingContextMenuItem
can be created based on the context information
-
createItem
ContextMenuItem createItem(TransformContext context)
Creates and populates new instance of aContextMenuItem
.- Parameters:
context
- Context Information.- Returns:
- A new
ContextMenuItem
populated to perform the corresponding action.
-
getItemKey
java.lang.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 callingcreateItem(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. - Since:
- MicroStrategy Web 9.0.0
-
-