AbstractFolderContextMenuItemBuilder

Class Overview

This class is used by Microstrategy Web as a base class for those used to populate context-menus used in the Folder page.

New context-menus-builders can be created simply by extending this class and implementing three methods:

1. getContextMenuFlag(): Used to maintain backwards compatibility, these builders check for the contextMenuFlags FormalParameter to make sure they can enabled. New builders should return in this method the flag associated with the context-menu-item, for example, a "copy" context-menu would return CM_FLAG_COPY.
2. isActionEnabled(): Besides checking the context-menu flag, this method enables the builder to check for other conditions to enable the action. For example, to check whether the user has enough privileges/access control. Subclasses can ultimately delegate this logic to the transform.
3. getEvent(): This method returns the WebEvent to execute when this menu item is selected. Also in this case, subclasses can ultimately delegate this logic to the transform.

The following would be an example of a subclass used to populate an "Edit" context-menu-item:

 public class FolderEdit extends AbstractFolderContextMenuItemBuilder {

     public FolderEdit(Shortcut definition) {
         super(definition);
     }

     protected int getContextMenuFlag() {
      //No flag is defined for this action:
         return FolderViewTransform.CM_FLAG_ALL;
     }

     protected boolean isActionEnabled(TransformContext context) {
         FolderViewTransform t = getTransform(context);
         WebObjectInfo object = getObjectInfo(context);

         return t.canEdit(object);
     }

     protected WebEvent getEvent(TransformContext context) {
         FolderViewTransform t = getTransform(context);
         WebObjectInfo object = getObjectInfo(context);

         return t.getEditEvent(object);
     }

 }
 

Summary

[Expand] Inherited Methods
From class com.microstrategy.web.app.gui.ContextMenu.DefaultContextMenuItemBuilder ContextMenuItem createItem(TransformContext context) Creates and populates a ContextMenuItem based on the information in the Shortcut used as defintion. ContextMenuItem createItem(TransformContext context, String name) Creates and populates a ContextMenuItem based on the information in the Shortcut used as defintion. Shortcut getDefinition() Get the definition of the <@link Shortcut> shortcut object String getItemKey(TransformContext context) Retrieve the key will be set on the context menu item corresponding to the context input. String getScript(String baseBone, String script) Adds "microstrategy.bone(id)." to the script if baseBone is not empty and the script doesn't start already with "microstrategy". boolean isItemAvailable(TransformContext context) Returns true if the underlying Shortcut used as definition is available (based on the features defined on the <shortcut> xml.
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait(long arg0, int arg1) final void wait(long arg0) final void wait()
From interface com.microstrategy.web.app.gui.ContextMenuItemBuilder 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.