Package com.microstrategy.web.app.transforms.contextmenus

Class OndemandContextMenusTransform

java.lang.Object

com.microstrategy.web.transform.AbstractTransform

com.microstrategy.web.app.transforms.AbstractBasicReportTransform

com.microstrategy.web.app.transforms.contextmenus.OndemandContextMenusTransform

All Implemented Interfaces:

TransformContext, Transform

Direct Known Subclasses:

OndemandDrillContextMenusTransform

public class OndemandContextMenusTransform
extends AbstractBasicReportTransform
implements TransformContext

The OndemandContextMenusTransform class populates the ContextMenuManager with the context menus available as RMC on the report. The context menus data is then written in JSON format and added to the MarkupOutput out to be used by the client side (javascript). Currently this transform populates the on demand low priority drill paths, but this class could be used to handle other on context menus through OndemandContextMenuBuilderFactory class. This transform is used in both Reports as well as RWDs.

Since:

MicroStrategy Web 9.0.0

Field Summary

Fields

Modifier and Type	Field	Description
FormalParameter	drillWithinBehavior
FormalParameter	groupContextMenuDrillPathsByType
FormalParameter	showDrillDownOnly
FormalParameter	showDrillPathSetNamesSubMenuAtTopLevel
FormalParameter	showUniqueDrillPaths
FormalParameter	sortSetNamesAndDrillPaths

Fields inherited from class com.microstrategy.web.app.transforms.AbstractBasicReportTransform

_bean, _rb, _rwb, _vb

Constructor Summary

Constructors

Constructor	Description
OndemandContextMenusTransform()

Method Summary

Modifier and Type	Method	Description
AppContext	getAppContext()	Provides an instance of the AppContext for the current request.
protected TransformContext	getContext()	Returns a TransformContext object.
ContextMenuManager	getContextMenuManager()	Returns the ContextMenuManager instance used by this Transform.
protected java.lang.String	getContextMenuManagerName()	Returns the name to use for the ContextMenuManager of this Transform.
java.lang.String	getDescription()	Returns a textual description of the transform.
protected OndemandContextMenuBuilderFactory	getOndemandContextMenuBuilderFactory()	This method gets the OndemandContextMenuBuilderFactory object which is responsible for populating the context menus by delegating it to OnDemandContextMenuBuilder.
Transform	getTransform()	Provides the current Transform instance.
WebComponent	getWebComponent()	Provides the current WebComponent.
protected void	populateMenuItems()	Populates the ondemand menuitems for Grid/Graph.
protected void	render(MarkupOutput out)	This method is responsible for rendering the transform and is called in AbstractBasicReportTransform.transform(Transformable, MarkupOutput)
protected void	sendMenuItemsToOutput(MarkupOutput out)	This method gets the getContextMenuManager() and creates a menu elements datastructure string, adds it to a Block and sends it to the input parameter MarkupOutput out.
protected void	setFormalParameters()	sets the formal parameters.

Methods inherited from class com.microstrategy.web.app.transforms.AbstractBasicReportTransform

addFormalParameter, getElemsMapHelper, getGraphBean, getGridData, getHyperLinkHelper, getReportBean, getRWBean, getSupportedBeanType, getViewBean, getWebGridData, getWebReportGrid, getWebTemplate, initBeans, initGridData, isDesignMode, isFeatureAvailable, isReport, isTrue, supports, transform

Methods inherited from class com.microstrategy.web.transform.AbstractTransform

addFormalParam, canTransform, getEvents, getFormalParams, getID, getPreview, isPreviewAvailable, isResolved, removeFormalParam, setAnnotation, setDeprecated, supports

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

sortSetNamesAndDrillPaths

public FormalParameter sortSetNamesAndDrillPaths

groupContextMenuDrillPathsByType

public FormalParameter groupContextMenuDrillPathsByType

showDrillDownOnly

public FormalParameter showDrillDownOnly

showUniqueDrillPaths

public FormalParameter showUniqueDrillPaths

showDrillPathSetNamesSubMenuAtTopLevel

public FormalParameter showDrillPathSetNamesSubMenuAtTopLevel

drillWithinBehavior

public FormalParameter drillWithinBehavior

Constructor Detail

OndemandContextMenusTransform

public OndemandContextMenusTransform()

Method Detail

setFormalParameters

protected void setFormalParameters()

sets the formal parameters.

render

protected void render(MarkupOutput out)

Description copied from class: AbstractBasicReportTransform

This method is responsible for rendering the transform and is called in AbstractBasicReportTransform.transform(Transformable, MarkupOutput)

Specified by:

render in class AbstractBasicReportTransform

populateMenuItems

protected void populateMenuItems()

Populates the ondemand menuitems for Grid/Graph.

sendMenuItemsToOutput

protected void sendMenuItemsToOutput(MarkupOutput out)

This method gets the getContextMenuManager() and creates a menu elements datastructure string, adds it to a Block and sends it to the input parameter MarkupOutput out.

Parameters:

out - MarkupOutput object

getOndemandContextMenuBuilderFactory

protected OndemandContextMenuBuilderFactory getOndemandContextMenuBuilderFactory()

This method gets the OndemandContextMenuBuilderFactory object which is responsible for populating the context menus by delegating it to OnDemandContextMenuBuilder.

Returns:

a OndemandContextMenuBuilderFactory object.

getDescription

public java.lang.String getDescription()

Description copied from interface: Transform

Returns a textual description of the transform.

Specified by:

getDescription in interface Transform

Returns:

The textual description of the transform.

getContextMenuManager

public ContextMenuManager getContextMenuManager()

Returns the ContextMenuManager instance used by this Transform. This method will return a non-null instance, even if context menus are not enabled for this transform

Specified by:

getContextMenuManager in interface TransformContext

getAppContext

public AppContext getAppContext()

Description copied from interface: TransformContext

Provides an instance of the AppContext for the current request.

Specified by:

getAppContext in interface TransformContext

Returns:

AppContext instance related with the bean being transformed.

getContextMenuManagerName

protected java.lang.String getContextMenuManagerName()

Returns the name to use for the ContextMenuManager of this Transform.

getTransform

public Transform getTransform()

Description copied from interface: TransformContext

Provides the current Transform instance.

Specified by:

getTransform in interface TransformContext

getWebComponent

public WebComponent getWebComponent()

Description copied from interface: TransformContext

Provides the current WebComponent.

Specified by:

getWebComponent in interface TransformContext

getContext

protected TransformContext getContext()

Returns a TransformContext object.

Returns:

a TransformContext object.