Package com.microstrategy.web.app.transforms

Interface ReportGridCellTitle

All Superinterfaces:

java.lang.Cloneable, ReportGridDisplayCell

All Known Subinterfaces:

ReportGridCellColTitle, ReportGridCellRowTitle

All Known Implementing Classes:

AbstractReportGridCellTitle, ReportGridCellColTitleImpl, ReportGridCellRowTitleImpl, ReportGridDisplayCellColTitle, ReportGridDisplayCellRowTitle, ReportGridExcelCellColTitleImpl, ReportGridExcelCellRowTitleImpl

public interface ReportGridCellTitle
extends ReportGridDisplayCell

Since:

MicroStrategy Web 8.0.1

Nested Class Summary

Nested classes/interfaces inherited from interface com.microstrategy.web.app.transforms.ReportGridDisplayCell

ReportGridDisplayCell.Context

Field Summary

Fields inherited from interface com.microstrategy.web.app.transforms.ReportGridDisplayCell

PIVOT_DECREASE_POSITION, PIVOT_INCREASE_POSITION, PIVOT_REMOVE, PIVOT_SWITCH_AXIS, PIVOT_TO_PAGE_BY

Method Summary

Modifier and Type	Method	Description
boolean	canAddShortcutMetric(int shortcutMetricType)	Returns whether specified shortcut metric could be created based on current cell.
WebEvent	getAddShortcutMetricEvent(int shortcutMetricType)	Returns the WebEvent to add shortcut metric based on current cell.
WebSubTitle	getSubTitle()	Returns the underlying SDK object associated with this cell.
int	getSubtitleIndex()	If attribute forms are displayed, returns the position of the WebSubTitle within the subtitles collection.
WebTemplateUnit	getWebTemplateUnit()	Obtain the WebTemplateUnit instance associated with this class
WebTitle	getWebTitle()	Obtain the WebTitle instance associated with this class
void	init(TransformContext context, WebTemplateUnit unit)	This method is called to initialize the cell in design mode.
void	init(TransformContext context, WebTitle title)	This method is called to initialize the cell in view mode.
void	init(WebComponent wc, WebTemplateUnit unit, java.util.HashMap cachedObjects)	Deprecated. please use the interface that takes a TransformContext object instance as parameter
void	init(WebComponent wc, WebTitle title, java.util.HashMap cachedObjects)	Deprecated. please use the interface that takes a TransformContext object instance as parameter
void	setSubTitle(WebSubTitle subtitle)	Registers the underlying SDK object associated with this cell.
void	setSubTitleIndex(int subtitleIndex)	Registers the position of the underlying WebSubTitle within the subtitles collection.

Methods inherited from interface com.microstrategy.web.app.transforms.ReportGridDisplayCell

addExtraAttribute, canAddThresholds, canDrill, canDrillAdvanced, canEditControl, canEditMetricFilter, canFilterOn, canFilterOnSelection, canFormat, canHaveDerivedElements, canHyperLink, canInsertShortcutMetric, canMetricFilterOn, canModifyAttributeForm, canOpenAlerts, canPivot, canPivot, canQuickGroup, canRemoveFromGrid, canRemoveFromReport, canRename, canSort, generateOutput, getAccessibilityInfo, getCellID, getCellType, getColSpan, getControlElementSelectorEvent, getDerivedElementsEvent, getDrillEvent, getDrillPathWithHighImportance, getExtraInfo, getExtraStyle, getFilterOnEvent, getHeaderContent, getKey, getOpenFormatEditorEvent, getRenameEvent, getRowSpan, getSetFormatEditorTargetEvent, getStyle, getText, getTooltip, getWidth, init, init, init, init, isRW, reset, setAccessibilityInfo, setCellID, setColSpan, setContent, setContextMenu, setExtraInfo, setExtraStyle, setExtraStyle, setHTML, setInnerHTML, setPostContent, setPreContent, setRowSpan, setStyle, setText, setTooltip, setWidth

Method Detail

init

void init(TransformContext context,
          WebTitle title)

This method is called to initialize the cell in view mode. It receives a WebTitle instance as the underlying SDK object

Parameters:

context - TransformContext instance initialized with the grid's transform information.

title - WebTitle instance corresponding to the cell to be displayed.

init

void init(WebComponent wc,
          WebTemplateUnit unit,
          java.util.HashMap cachedObjects)

Deprecated.

please use the interface that takes a TransformContext object instance as parameter

This method is called to initialize the cell in design mode. It receives a WebTemplateUnit as the underlying SDK object.

Parameters:

wc - The bean being transformed.

unit - The WebTemplateUnit corresponding to this cell.

cachedObjects - A HashMap populated by the transform and used to store information shared across multiple cells.

init

void init(WebComponent wc,
          WebTitle title,
          java.util.HashMap cachedObjects)

Deprecated.

please use the interface that takes a TransformContext object instance as parameter

This method is called to initialize the cell in view mode. It receives a WebTitle as the underlying SDK object.

Parameters:

wc - The bean being transformed.

title - The WebTitle corresponding to this cell.

cachedObjects - A HashMap populated by the transform and used to store information shared across multiple cells.

init

void init(TransformContext context,
          WebTemplateUnit unit)

This method is called to initialize the cell in design mode. It receives a WebTemplateUnit instance as the underlying SDK object

Parameters:

context - TransformContext instance initialized with the grid's transform information.

unit - WebTemplateUnit instance corresponding to the cell to display.

getSubTitle

WebSubTitle getSubTitle()

Returns the underlying SDK object associated with this cell. If the report is in execute mode and attribute forms are displayed, returns the corresponding WebSubTitle; when in design mode, this method should return null.
It should always return null if the instance represents an empty cell.

Returns:

The underlying SDK object.

setSubTitle

void setSubTitle(WebSubTitle subtitle)

Registers the underlying SDK object associated with this cell. If the report is in execute mode and attribute forms are displayed, the Transform will call this method to associate a WebSubTitle with the cell.

Parameters:

subtitle - The corresponding WebSubTitle to associate with the cell.

getSubtitleIndex

int getSubtitleIndex()

If attribute forms are displayed, returns the position of the WebSubTitle within the subtitles collection.

Returns:

The WebSubTitle position

setSubTitleIndex

void setSubTitleIndex(int subtitleIndex)

Registers the position of the underlying WebSubTitle within the subtitles collection.

Parameters:

subtitleIndex - the position of the corresponding WebSubTitle

getWebTemplateUnit

WebTemplateUnit getWebTemplateUnit()

Obtain the WebTemplateUnit instance associated with this class

Returns:

WebTemplateUnit instance from where the information to be rendered by this class will be retrieved.

getWebTitle

WebTitle getWebTitle()

Obtain the WebTitle instance associated with this class

Returns:

WebTitle instance from where the information to be rendered by this class will be retrieved.

canAddShortcutMetric

boolean canAddShortcutMetric(int shortcutMetricType)

Returns whether specified shortcut metric could be created based on current cell.

Parameters:

shortcutMetricType - The metric type in (@link EnumShortcutMetricTypes}.

getAddShortcutMetricEvent

WebEvent getAddShortcutMetricEvent(int shortcutMetricType)

Returns the WebEvent to add shortcut metric based on current cell.

Parameters:

shortcutMetricType - The metric type in (@link EnumShortcutMetricTypes}.