AbstractPagebyContextMenuItemBuilder

Class Overview

This class is used by Microstrategy Web as a base class for those used to populate context-menus used with the PageBy transform. It provides convenience methods and common functionality shared by these classes.

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

1. createItem(): The default method that creates the context-menu item.
2. isActionEnabled(): To indicate this class if the specific action associated with this item is available.

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

 public class PageByRemove extends AbstractPagebyContextMenuItemBuilder {

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

     public boolean isActionEnabled(TransformContext context) {
         PageByUnit unit = getPageByUnit(context);

         if (unit == null) return false;

         return unit.isRemoveAvailable();
     }

     public ContextMenuItem createItem(TransformContext context) {
         ContextMenuItem __result = super.createItem(context);

         __result.setJSCode(getContextMenusScript(context, "'rmv'"));
         __result.setImageType(EnumMenuImages.MenuImageRemove);

         return __result;
     }

 }
 

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.