ReportGridCellColHeader (Web API 2021)

All Superinterfaces:

java.lang.Cloneable, ReportGridCellHeader, ReportGridDisplayCell

All Known Implementing Classes:

IPhoneReportGridCellColHeaderImpl, ReportGridCellColHeaderImpl, ReportGridDisplayCellColHeader, ReportGridExcelCellColHeaderImpl
```
public interface ReportGridCellColHeader
extends ReportGridCellHeader
```
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.
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
Modifier and Type Field Description

static int SORT_TYPE_ASCENDING
Identifier for the sort order ascending

static int SORT_TYPE_DESCENDING
Identifier for the sort order descending
- 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

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`WebEvent`	`getSortEvent(int type)`	Get the `WebEvent` instance with the information for sorting the current cell values
`boolean`	`isSortAscending()`
`boolean`	`isSorted()`

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

- Field Detail
  - SORT_TYPE_ASCENDING
```
static final int SORT_TYPE_ASCENDING
```
    Identifier for the sort order ascending
    
    Since:
    
    MicroStrategy Web 8.0.1
    
    See Also:
    
    Constant Field Values
  - SORT_TYPE_DESCENDING
```
static final int SORT_TYPE_DESCENDING
```
    Identifier for the sort order descending
    
    Since:
    
    MicroStrategy Web 8.0.1
    
    See Also:
    
    Constant Field Values
- Method Detail
  - isSorted
```
boolean isSorted()
```
    Returns:
    
    boolean value indicating if the current cell is sorted or not
    
    Since:
    
    MicroStrategy Web 8.0.1
  - isSortAscending
```
boolean isSortAscending()
```
    Returns:
    
    boolean value indicating if the current cell is sorted ascending or not
    
    Since:
    
    MicroStrategy Web 8.0.1
  - getSortEvent
```
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
    
    Since:
    
    MicroStrategy Web 8.0.1