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

Class AbstractReportCellMove

java.lang.Object

com.microstrategy.web.app.gui.ContextMenu.DefaultContextMenuItemBuilder

com.microstrategy.web.app.transforms.contextmenus.AbstractReportCellContextMenuItemBuilder

com.microstrategy.web.app.transforms.contextmenus.AbstractReportCellMove

All Implemented Interfaces:

ContextMenuItemBuilder

Direct Known Subclasses:

ReportCellMoveDown, ReportCellMoveLeft, ReportCellMoveRight, ReportCellMoveToColumns, ReportCellMoveToPageBy, ReportCellMoveToRows, ReportCellMoveUp

public abstract class AbstractReportCellMove
extends AbstractReportCellContextMenuItemBuilder

AbstractReportCellMove is the base class for generating pivot options for the different cells on a report grid. Children of this class are expected to define what manipulation the pivot option will be generated, for example, to pivot left or right.

Since:

MicroStrategy Web 8.0.1

Constructor Summary

Constructors

Constructor	Description
AbstractReportCellMove(Shortcut definition)	Class constructor

Method Summary

Modifier and Type	Method	Description
protected java.lang.String	getJSCode(TransformContext context)	Generate the JavaScript code the context menu item generated by this builder instance will trigger when the user selects it.
protected abstract int	getPivotCode()	Utility method for being able to recognize the different pivot manipulations that can be generated.
protected boolean	isActionEnabled(TransformContext context)	Called by AbstractReportCellContextMenuItemBuilder.isItemAvailable(com.microstrategy.web.app.transforms.TransformContext), indicates the abstract class if the corresponding action of this item is available.
protected boolean	isCellSupported(TransformContext context)	Utility method for determining if the pivot option to be built supports the cell as specified on the current context.

Methods inherited from class com.microstrategy.web.app.transforms.contextmenus.AbstractReportCellContextMenuItemBuilder

canDefineDerivedElements, createItem, getCell, getFormalParameter, getIntValue, getPassThroughMode, getStringValue, getTransform, isFeatureAvailable, isIframeEnabled, isItemAvailable, isRW, isTrue

Methods inherited from class com.microstrategy.web.app.gui.ContextMenu.DefaultContextMenuItemBuilder

createItem, getDefinition, getItemKey, getScript

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractReportCellMove

public AbstractReportCellMove(Shortcut definition)

Class constructor

Parameters:

definition - Shortcut instance with the base definition of the option

Method Detail

isActionEnabled

protected boolean isActionEnabled(TransformContext context)

Called by AbstractReportCellContextMenuItemBuilder.isItemAvailable(com.microstrategy.web.app.transforms.TransformContext), indicates the abstract class if the corresponding action of this item is available.

Specified by:

isActionEnabled in class AbstractReportCellContextMenuItemBuilder

Parameters:

context - TransformContext initialized instance with the information on where this option will be used

Returns:

boolean value indicating if the option should be enabled to the user or not, given the properties available on the context object.

getJSCode

protected java.lang.String getJSCode(TransformContext context)

Generate the JavaScript code the context menu item generated by this builder instance will trigger when the user selects it.

Specified by:

getJSCode in class AbstractReportCellContextMenuItemBuilder

Parameters:

context - TransformContext initialized instance with the information on where this option will be used

Returns:

String value with the JavaScript information to trigger when the option is selected. By default, it will return the same code as specified on the onclick property of the XML definition.

getPivotCode

protected abstract int getPivotCode()

Utility method for being able to recognize the different pivot manipulations that can be generated.

Returns:

int value identifying the pivot manipulation this builder will support. Values are from the ReportGridDisplayCell constants such as ReportGridDisplayCell.PIVOT_DECREASE_POSITION, ReportGridDisplayCell.PIVOT_INCREASE_POSITION, etc.

isCellSupported

protected boolean isCellSupported(TransformContext context)

Utility method for determining if the pivot option to be built supports the cell as specified on the current context.

Parameters:

context - TransformContext initialized instance with the information on where this option will be used

Returns:

boolean value which by default is true. Children classes of this implementation are expected to overwrite this method with the specific conditions required by the pivot manipulation.