public class

FolderCreateDocumentFromTheme

extends AbstractFolderContextMenuItemBuilder
java.lang.Object
   ↳ com.microstrategy.web.app.gui.ContextMenu.DefaultContextMenuItemBuilder
     ↳ com.microstrategy.web.app.transforms.contextmenus.AbstractFolderContextMenuItemBuilder
       ↳ com.microstrategy.web.app.transforms.contextmenus.FolderCreateDocumentFromTheme

Summary

Public Constructors
FolderCreateDocumentFromTheme(Shortcut definition)
Public Methods
String getItemKey(TransformContext context)
Retrieve the key will be set on the context menu item corresponding to the context input.
boolean isItemAvailable(TransformContext context)
Returns true if the corresponding flag is on and the the corresponding action is available.
Protected Methods
int getContextMenuFlag()
Indicates the abstract class which is the context-menu flag associated with this item.
WebEvent getEvent(TransformContext context)
Provides the abstract class with the corresponding event to execution with this item.
String iframeParam(FolderViewTransform transform)
boolean isActionEnabled(TransformContext context)
Indicates the abstract class if the corresponding action of this item is available.
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.contextmenus.AbstractFolderContextMenuItemBuilder
From class com.microstrategy.web.app.gui.ContextMenu.DefaultContextMenuItemBuilder
From class java.lang.Object
From interface com.microstrategy.web.app.gui.ContextMenuItemBuilder

Public Constructors

public FolderCreateDocumentFromTheme (Shortcut definition)

Public Methods

public 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 boolean isItemAvailable (TransformContext context)

Returns true if the corresponding flag is on and the the corresponding action is available.

Parameters
context TransformContext with context information.
Returns
  • true if the context-menu-item is available and should be included.

Protected Methods

protected int getContextMenuFlag ()

Indicates the abstract class which is the context-menu flag associated with this item.

protected WebEvent getEvent (TransformContext context)

Provides the abstract class with the corresponding event to execution with this item.

protected String iframeParam (FolderViewTransform transform)

protected boolean isActionEnabled (TransformContext context)

Indicates the abstract class if the corresponding action of this item is available.