public class

FolderOpenInLibrary

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.FolderOpenInLibrary

Summary

Public Constructors
FolderOpenInLibrary(Shortcut definition)
Public Methods
String getItemKey(TransformContext context)
Needed to override this method so that it would create a new menu item for each unique Dossier.
Protected Methods
int getContextMenuFlag()
This is deprecated.
String getJSCode(TransformContext context)
Calls openInLibrary(docId) function in DHTML.js file to use the LibraryHelper.js class to construct the url and open the Dossier in Library.
boolean isActionEnabled(TransformContext context)
Only enable this action if the object is a Dossier(formerly VI) with execute privileges and if a link to Library application exists.
[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 FolderOpenInLibrary (Shortcut definition)

Public Methods

public String getItemKey (TransformContext context)

Needed to override this method so that it would create a new menu item for each unique Dossier. Otherwise getJSCode will only be called once and every Dossier will try to open to the first encountered Dossier on the folder browsing page.

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.

Protected Methods

protected int getContextMenuFlag ()

This is deprecated. The folderContextMenu.xml file is used to customize the context menu. However, it is still a required function to implement.

protected String getJSCode (TransformContext context)

Calls openInLibrary(docId) function in DHTML.js file to use the LibraryHelper.js class to construct the url and open the Dossier in Library.

protected boolean isActionEnabled (TransformContext context)

Only enable this action if the object is a Dossier(formerly VI) with execute privileges and if a link to Library application exists.

Returns
  • true if the above conditions are true and false otherwise