public interface

ReportGridCellColHeader

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

Class Overview

The ReportGridCellColHeader represents a value of the column 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 value of the column axis.
  2. WebTemplateMetric: used in design mode when the metrics are located in the column axis, each metric is represented as a column 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 ReportGridCellColHeaderImpl.

Summary

Constants
int SORT_TYPE_ASCENDING Identifier for the sort order ascending
int SORT_TYPE_DESCENDING Identifier for the sort order descending
[Expand]
Inherited Constants
From interface com.microstrategy.web.app.transforms.ReportGridDisplayCell
Public Methods
abstract WebEvent getSortEvent(int type)
Get the WebEvent instance with the information for sorting the current cell values
abstract boolean isSortAscending()
abstract boolean isSorted()
[Expand]
Inherited Methods
From interface com.microstrategy.web.app.transforms.ReportGridCellHeader
From interface com.microstrategy.web.app.transforms.ReportGridDisplayCell

Constants

public static final int SORT_TYPE_ASCENDING

Identifier for the sort order ascending

Constant Value: 1 (0x00000001)

public static final int SORT_TYPE_DESCENDING

Identifier for the sort order descending

Constant Value: 0 (0x00000000)

Public Methods

public abstract WebEvent getSortEvent (int type)

Get the WebEvent instance with the information for sorting the current cell values

Parameters
type int value with the identifier for the sort order to generate. Values expected include SORT_TYPE_ASCENDING and SORT_TYPE_DESCENDING
Returns
  • WebEvent

public abstract boolean isSortAscending ()

Returns
  • boolean value indicating if the current cell is sorted ascending or not

public abstract boolean isSorted ()

Returns
  • boolean value indicating if the current cell is sorted or not