Class AbstractFolderContextMenuItemBuilder

    • Constructor Detail

      • AbstractFolderContextMenuItemBuilder

        public AbstractFolderContextMenuItemBuilder​(Shortcut definition)
    • Method Detail

      • getJSCode

        protected java.lang.String getJSCode​(TransformContext context)
        Returns the javascript code to use with this context-menu-item
      • getTarget

        protected java.lang.String getTarget​(TransformContext context)
        Since:
        MicroStrategy Web 9.0.0
      • iframeParam

        protected java.lang.String iframeParam​(FolderViewTransform transform)
        Since:
        MicroStrategy Web 9.0.0
      • getObjectInfo

        protected WebObjectInfo getObjectInfo​(TransformContext context)
        Helper method to retrieve the WebObjectInfo from the context.
      • getContextMenuFlag

        protected abstract int getContextMenuFlag()
        Indicates the abstract class which is the context-menu flag associated with this item.
      • isActionEnabled

        protected abstract boolean isActionEnabled​(TransformContext context)
        Indicates the abstract class if the corresponding action of this item is available.
      • getEvent

        protected WebEvent getEvent​(TransformContext context)
        Provides the abstract class with the corresponding event to execution with this item.
      • getItemKey

        public java.lang.String getItemKey​(TransformContext context)
        Description copied from class: ContextMenu.DefaultContextMenuItemBuilder
        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 ContextMenu.DefaultContextMenuItemBuilder.createItem(TransformContext) to check whether the item already exists in the menu to avoid unnecessary creation.
        Specified by:
        getItemKey in interface ContextMenuItemBuilder
        Overrides:
        getItemKey in class ContextMenu.DefaultContextMenuItemBuilder
        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