Package com.microstrategy.web.app.transforms

Interface ReportGridCellRowHeader

All Superinterfaces:

java.lang.Cloneable, ReportGridCellHeader, ReportGridDisplayCell

All Known Implementing Classes:

IPhoneReportGridCellRowHeaderImpl, ReportGridCellRowHeaderImpl, ReportGridDisplayCellRowHeader, ReportGridExcelCellRowHeaderImpl

public interface ReportGridCellRowHeader
extends ReportGridCellHeader

The ReportGridCellRowHeader represents a value of the row axis.

Classes implementing this interface need to deal with two type of SDK objects:

1. WebHeader: used in view mode, this is the SDK object that represents a title of the row axis.
2. WebTemplateMetric: used in design mode when the metrics are located in the row axis, each metric is represented as a row header.

Users can modify the HTML generated for a column header cell by creating a custom class that implements this interface. The easiest way to accomplish this is to extend the out-of-the-box implementation provided by Microstrateg Web, that is the ReportGridCellRowHeaderImpl.

Since:

MicroStrategy Web 7.5.1

See Also:

ReportGridDisplayCell, ReportGridTransformImpl

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
void	init(WebComponent wc, WebTemplateMetric metric, FormalParameters formalParas)	Deprecated. This method is not used by the Transform anymore.
void	init(WebComponent wc, WebTemplateUnit unit, FormalParameters formalParas)	Deprecated. Classes need not to support WebTemplateUnit as the underlying SDK object.
void	setOutlinemodeRowCount(int OutlinemodeRowCount)	In outline mode, this is used to indicate the cell in which row it is being rendered.
void	setOutlinemodeSubTotalName(java.lang.String OutlineodeSubtotalName)	In outline mode, this is used to indicate the name of the subtotal whose values are being displayed in this row.
void	setOutlinemodeWrapHeaderText(boolean isWrap)	Indicates the header text of the outline mode cell need to be wrap up with related html tags.
void	setShowOutlinemodeImage(boolean value)	Indicates the cell that this header can be expanded in outline mode and that an image to expand/collapse the header needs to be rendered.

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

getInsertMetricPercentToTotalEvent, getInsertMetricPercentToTotalEvent, getInsertMetricRankEvent, getInsertMetricTransformationEvent, getWebHeader, getWebTemplateMetric, getWebTemplateMetric, init, init, init, init, isMetric, isMetricDrillable

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(WebComponent wc,
          WebTemplateUnit unit,
          FormalParameters formalParas)

Deprecated.

Classes need not to support WebTemplateUnit as the underlying SDK object.

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.

formalParas - all the formal parameters from the report transform. Used to control some output generation.

Since:

MicroStrategy Web 7.5.2

init

void init(WebComponent wc,
          WebTemplateMetric metric,
          FormalParameters formalParas)

Deprecated.

This method is not used by the Transform anymore. To initialize cells with a WebTemplateMetric, it now uses ReportGridCellHeader.init(WebComponent, WebTemplateMetric, HashMap).

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

Parameters:

wc - The bean being transformed.

metric - The WebTemplateMetric corresponding to this cell.

formalParas - all the formal parameters from the report transform. Used to control some output generation.

Since:

MicroStrategy Web 7.5.2

setShowOutlinemodeImage

void setShowOutlinemodeImage(boolean value)

Indicates the cell that this header can be expanded in outline mode and that an image to expand/collapse the header needs to be rendered.

Parameters:

value - If set to true, the cell needs to include the image to expand/collapse the cell

setOutlinemodeRowCount

void setOutlinemodeRowCount(int OutlinemodeRowCount)

In outline mode, this is used to indicate the cell in which row it is being rendered. This information needs to be added to the cell's tag to enable expanding/collapsing of its child rows.

Parameters:

OutlinemodeRowCount - The row number this cell is being rendered in.

setOutlinemodeSubTotalName

void setOutlinemodeSubTotalName(java.lang.String OutlineodeSubtotalName)

In outline mode, this is used to indicate the name of the subtotal whose values are being displayed in this row.

In outline mode, the Transform automatically shows the values of the first subtotal for the current level. This enables users to analize the data even if the level is collapsed. The cell should display the name of this subtotal.

Parameters:

OutlineodeSubtotalName - String with the subtotal's name.

setOutlinemodeWrapHeaderText

void setOutlinemodeWrapHeaderText(boolean isWrap)

Indicates the header text of the outline mode cell need to be wrap up with related html tags.

Parameters:

isWrap - If set to true, the header text need to do format converting.

Since:

MicroStrategy Web 9.2.1