public interface

ReportGridCellRowHeader

implements ReportGridCellHeader
com.microstrategy.web.app.transforms.ReportGridCellRowHeader
Known Indirect Subclasses

Class Overview

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.

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.web.app.transforms.ReportGridDisplayCell
Public Methods
abstract void init(WebComponent wc, WebTemplateMetric metric, FormalParameters formalParas)
This method is deprecated. This method is not used by the Transform anymore. To initialize cells with a WebTemplateMetric, it now uses init(WebComponent, WebTemplateMetric, HashMap).
abstract void init(WebComponent wc, WebTemplateUnit unit, FormalParameters formalParas)
This method is deprecated. Classes need not to support WebTemplateUnit as the underlying SDK object.
abstract void setOutlinemodeRowCount(int OutlinemodeRowCount)
In outline mode, this is used to indicate the cell in which row it is being rendered.
abstract void setOutlinemodeSubTotalName(String OutlineodeSubtotalName)

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

abstract void setOutlinemodeWrapHeaderText(boolean isWrap)
Indicates the header text of the outline mode cell need to be wrap up with related html tags.
abstract 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.
[Expand]
Inherited Methods
From interface com.microstrategy.web.app.transforms.ReportGridCellHeader
From interface com.microstrategy.web.app.transforms.ReportGridDisplayCell

Public Methods

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

This method is deprecated.
This method is not used by the Transform anymore. To initialize cells with a WebTemplateMetric, it now uses 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.

public abstract void init (WebComponent wc, WebTemplateUnit unit, FormalParameters formalParas)

This method is 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.

public abstract 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.

public abstract void setOutlinemodeSubTotalName (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.

public abstract 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.

public abstract 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