Package com.microstrategy.web.app.transforms

Interface ReportGridCellMetricValue

All Superinterfaces:

java.lang.Cloneable, ReportGridDisplayCell

All Known Implementing Classes:

IPhoneReportGridCellMetricValueImpl, ReportGridCellMetricValueImpl, ReportGridDisplayCellMetricValue, ReportGridExcelCellMetricValueImpl

public interface ReportGridCellMetricValue
extends ReportGridDisplayCell

The ReportGridCellMetricValue represents a value of the report data.

Classes implementing this interface uses a WebRowValue as the underlying SDK objects to retrieve the information from.

Users can modify the HTML generated for these cells 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 ReportGridCellMetricValueImpl.

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
WebRowValue	getWebRowValue()	Returns the underlying SDK object associated with this cell.
WebTemplateMetric	getWebTemplateMetric()	return the WebTemplateMetric object associated with this cell
void	init(TransformContext context, WebRowValue rowValue)	This method is called to initialize the cell with the corresponding WebRowValue as the underlying SDK object
void	init(WebComponent wc, WebRowValue rowValue, java.util.HashMap cachedObjects)	Deprecated. please use the interface that takes a TransformContext instance object as parameter
void	init(WebComponent wc, WebTemplateMetric metric, FormalParameters formalParas)	Deprecated. The Transform doesn't use this method to initialize a non-empty cell, it always uses init(TransformContext, WebRowValue).

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

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

Deprecated.

The Transform doesn't use this method to initialize a non-empty cell, it always uses init(TransformContext, WebRowValue).

Since:

MicroStrategy Web 7.5.2

init

@Deprecated
void init(WebComponent wc,
          WebRowValue rowValue,
          java.util.HashMap cachedObjects)

Deprecated.

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

This method is called to initialize the cell with the corresponding WebRowValue as the underlying SDK object.

Parameters:

wc - The bean being transformed.

rowValue - The WebRowValue corresponding to this cell.

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

Since:

MicroStrategy Web 7.5.2

init

void init(TransformContext context,
          WebRowValue rowValue)

This method is called to initialize the cell with the corresponding WebRowValue as the underlying SDK object

Parameters:

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

rowValue - WebRowValue instance corresponding to the cell to be displayed.

Since:

MicroStrategy Web 8.0.1

getWebRowValue

WebRowValue getWebRowValue()

Returns the underlying SDK object associated with this cell. It should always return null if the instance represents an empty cell.

Returns:

The underlying SDK object.

Since:

MicroStrategy Web 8.0.0

getWebTemplateMetric

WebTemplateMetric getWebTemplateMetric()

return the WebTemplateMetric object associated with this cell

Returns:

the WebTemplateMetric object

Since:

MicroStrategy Web 8.1.2