Package com.microstrategy.web.app.transforms

Class ReportGridDisplayCellRowHeader

java.lang.Object

com.microstrategy.web.app.transforms.ReportGridDisplayCellImpl

com.microstrategy.web.app.transforms.ReportGridDisplayCellRowHeader

All Implemented Interfaces:

ReportGridCell, ReportGridCellHeader, ReportGridCellRowHeader, ReportGridDisplayCell, java.lang.Cloneable

public class ReportGridDisplayCellRowHeader
extends ReportGridDisplayCellImpl
implements ReportGridCellRowHeader

Deprecated.

Please use the ReportGridCellRowHeader interface or extend the ReportGridCellRowHeaderImpl class.

This class represents a Row Header cell cell of the report grid.
This class has been deprecated along with all the ReportGridDisplayCell classes.
In its place, the Transform manipulates the cells through the ReportGridCell interface.

Since:

MicroStrategy Web 7.3.1 or earlier

Nested Class Summary

Nested classes/interfaces inherited from interface com.microstrategy.web.app.transforms.ReportGridDisplayCell

ReportGridDisplayCell.Context

Field Summary

Fields inherited from class com.microstrategy.web.app.transforms.ReportGridDisplayCellImpl

_advDrillEditorProcessEvent, _advdrillEvent, _appliedSorts, _cachedObjects, _drillEditorName, _drillEditorProcessEvent, _drillEvent, _drillFilterOnSelectionProcessEvent, _drillFilterPageBy, _imgBasePath, _isIFrameRequest, _isNetscape, _itemsAddedToContextMenu, _maxColHeaderDepth, _sortEvent, _sortSubtotalColPosition, _sortSubtotalPostion, _specifyIDForCell, _specifyWidthForCell, _text, formalParas, rb

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

Constructor Summary

Constructors

Constructor	Description
ReportGridDisplayCellRowHeader()	Deprecated. Constructor used for creating a generic display cell.
ReportGridDisplayCellRowHeader(ReportBean rb, WebHeader header, java.util.HashMap cachedObjects)	Deprecated. Constructor used to display row header in report grid in execute mode.
ReportGridDisplayCellRowHeader(ReportBean rb, WebTemplateMetric metric, FormalParameters formalParas)	Deprecated. Constructor used for creating a dummy display cell of row header in design mode when it's corresponding to a metric.
ReportGridDisplayCellRowHeader(ReportBean rb, WebTemplateUnit unit, FormalParameters formalParas)	Deprecated. Constructor used for creating a dummy display cell of row header in design mode when it's not corresponding to a metric.
ReportGridDisplayCellRowHeader(FormalParameters formalParas)	Deprecated. Constructor used for creating a generic display cell.

Method Summary

Modifier and Type	Method	Description
protected void	generateContent(MarkupOutput mo)	Deprecated. Override the protected method of ReportDisplayCellImpl.
protected void	generateContextMenu(MarkupOutput mo)	Deprecated. Override the protected method of ReportDisplayCellImpl.
protected void	generateDrillCheckBox(MarkupOutput mo)	Deprecated. Override the protected method of ReportDisplayCellImpl.
protected void	generateFilterOnSelectionCheckBox(MarkupOutput mo)	Deprecated. Override the protected method of ReportDisplayCellImpl.
protected void	generateOutlineModeImage(MarkupOutput mo)	Deprecated. Override the protected method of ReportDisplayCellImpl.
protected void	generateOutlineSubTotalName(MarkupOutput mo)	Deprecated. Override the protected method of ReportDisplayCellImpl.
void	generateRowHeaderContent(MarkupOutput out)	Deprecated.
protected void	generateTooltip(MarkupOutput mo)	Deprecated. Generate the tool tip for this cell.
int	getCellType()	Deprecated. Returns the cell type
WebEvent	getDerivedElementsEvent()	Deprecated.
WebEvent	getFilterOnEvent()	Deprecated. Get the event for filter on the cell header instance
WebEvent	getInsertMetricPercentToTotalEvent(int axisBitMap)	Deprecated. Get the event for inserting a new metric based on Percent to Total
WebEvent	getInsertMetricPercentToTotalEvent(int axisBitMap, java.lang.String attributeID)	Deprecated. Get the event for inserting a new metric based on Percent to Total
WebEvent	getInsertMetricRankEvent(java.lang.String attributeID, int sortOrder)	Deprecated. Get the event for inserting a new metric based on a rank
WebEvent	getInsertMetricTransformationEvent(java.lang.String transformationID, int formulaType)	Deprecated. Get the event for inserting a new metric based on a transformation
int	getKey()	Deprecated.
WebEvent	getOpenFormatEditorEvent()	Deprecated. Get the event for opening the format editor
protected int	getOutlinemodeRowCount()	Deprecated. get row count for outline mode
protected java.lang.String	getOutlinemodeSubTotalName()	Deprecated. get subtotal name for outline mode
WebEvent	getRenameEvent()	Deprecated. Get the event for renaming the current cell
WebEvent	getSetFormatEditorTargetEvent()	Deprecated. Get the event for setting the current target of the format editor to be this cell instance
protected boolean	getShowOutlinemodeImage()	Deprecated. get whether display outline mode image
WebHeader	getWebHeader()	Deprecated. return the WebHeader object associated with this cell
WebTemplateMetric	getWebTemplateMetric()	Deprecated. return the WebTemplateMetric object associated with this cell
WebTemplateMetric	getWebTemplateMetric(boolean retrieve)	Deprecated. Obtain the WebTemplateMetric instance associated with this class
protected WebTemplateUnit	getWebTemplateUnit()	Deprecated. return the getWebTemplateUnit object associated with this cell
void	init(TransformContext context, WebHeader header)	Deprecated. This method is called to initialize the cell in view mode.
void	init(TransformContext context, WebTemplateMetric metric)	Deprecated. This method is called to initialize the cell in design mode.
void	init(WebComponent wc, WebHeader header, java.util.HashMap cachedObjects)	Deprecated. This method is called to initialize the cell in view mode.
void	init(WebComponent wc, WebTemplateMetric metric, FormalParameters formalParas)	Deprecated. This method is called to initialize the cell in design mode.
void	init(WebComponent wc, WebTemplateMetric metric, java.util.HashMap cachedObjects)	Deprecated. This method is called to initialize the cell in design mode.
void	init(WebComponent wc, WebTemplateUnit unit, FormalParameters formalParas)	Deprecated. This method is called to initialize the cell in design mode.
protected void	initDNDForDesignMode(DragAndDropItem item)	Deprecated. initialize a drag and drop item for a row header cell in design mode
protected void	initDNDForExecuteMode(DragAndDropItem item)	Deprecated. initialize a drag and drop item for a row header cell in execute mode
boolean	isMetric()	Deprecated. determine if the row header is containing a metric
boolean	isMetricDrillable(WebHeader header, WebDrillPath drillPath)	Deprecated. return whether the header has a drillable metric
protected boolean	isTotal()	Deprecated.
void	reset()	Deprecated. Reset all of the instance variables.
void	setOutlinemodeRowCount(int value)	Deprecated. set row count for outline mode
void	setOutlinemodeSubTotalName(java.lang.String value)	Deprecated. get subtotal name for outline mode
void	setOutlinemodeWrapHeaderText(boolean isWrap)	Deprecated. Indicates the header text of the outline mode cell need to be wrap up with related html tags.
void	setShowOutlinemodeImage(boolean value)	Deprecated. set whether display outline mode image

Methods inherited from class com.microstrategy.web.app.transforms.ReportGridDisplayCellImpl

addExtraAttribute, canAddThresholds, canDrill, canDrillAdvanced, canEditControl, canEditMetricFilter, canFilterOn, canFilterOnSelection, canFormat, canHaveDerivedElements, canHyperLink, canInsertShortcutMetric, canMetricFilterOn, canModifyAttributeForm, canOpenAlerts, canPivot, canPivot, canQuickGroup, canRemoveFromGrid, canRemoveFromReport, canRename, canSort, clone, convertNonbreakingSpaceOnMV, decodeEuro, encodeMV, generateDragAndDrop, generateDrillCheckBox, generateDrillOpenLink, generateFilterOnSelectionCheckBox, generateHeaderDrillContextMenu, generateHeaderSortContextMenu, generateInnerHTML, generateOutput, generatePivotButtons, generatePostContent, generatePreContent, generateRowValueDrillContextMenu, generateSortButton, generateTitleDrillContextMenu, generateTitleSortContextMenu, generateTooltipContent, generateTooltipForHeaders, generateTooltipForRowValue, generateTooltipForTitles, getAccessibilityInfo, getCellID, getColHeaderWebMetric, getColSpan, getContextMenuAttributes, getContextMenuManager, getControlElementSelectorEvent, getCssPrefix, getDescription, getDescriptor, getDrillEvent, getDrillPath, getDrillPathWithHighImportance, getEventManager, getExtraInfo, getExtraStyle, getExtraUrl, getFPIntValue, getFPStringValue, getHeaderContent, getHeaderDrillParametersForDHTML, getHeaderDrillPathWithHighImportance, getHeaderDrillURL, getImgName, getMaxSortAllowed, getPostTextForMetricValue, getPostTextForNonMetricValue, getPreTextForMetricValue, getPreTextForNonMetricValue, getReportBean, getReportDesignMode, getRowSpan, getRowValueDrillElements, getRowValueDrillParametersForDHTML, getRowValueDrillPathWithHighImportance, getRowValueDrillURL, getShowDescriptionAsTooltip, getSortStatus, getStyle, getSubTitle, getSubtitleIndex, getText, getTitleDrillParametersForDHTML, getTitleDrillURL, getTooltip, getWidth, init, init, init, init, initDragAndDrop, isContextMenuEnabled, isDesignMode, isDragAndDropEnabled, isFPTrue, isFPTrue, isHeaderNeedLink, isIFrameEnabled, isIFrameRequest, isItemsAddedToContextMenu, isOutlineModeEnabled, isRowValueNeedLink, isRW, isSortAscending, isTitleNeedLink, setAccessibilityInfo, setCellID, setCellType, setColSpan, setContent, setContextMenu, setDescription, setDrillPath, setExtraInfo, setExtraStyle, setExtraStyle, setExtraUrl, setHTML, setInnerHTML, setPostContent, setPreContent, setRowSpan, setStyle, setStyleForNonBuiltInFormat, setSubTitle, setSubTitleIndex, setText, setTooltip, setWidth, showBanding, showDrillAdvanced, showDrillCheckBox, showDrillDownOnly, showDrillHyperlink, showDrillHyperlinkMetric, showDrillMetric, showDrillRMC, showDrillRMCMetric, showFilterOnSelectionCheckBox, showFormattingRMC, showPivot, showPivotRMC, showRemove, showRemoveRMC, showRenameRMC, showSortButtonsForAttributes, showSortButtonsForMetrics, showSortRMCForAttributes, showSortRMCForMetrics, showSubTitle, useBuiltInFormat

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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, getColSpan, getControlElementSelectorEvent, getDrillEvent, getDrillPathWithHighImportance, getExtraInfo, getExtraStyle, getHeaderContent, getRowSpan, getStyle, getText, getTooltip, getWidth, init, init, init, init, isRW, setAccessibilityInfo, setCellID, setColSpan, setContent, setContextMenu, setExtraInfo, setExtraStyle, setExtraStyle, setHTML, setInnerHTML, setPostContent, setPreContent, setRowSpan, setStyle, setText, setTooltip, setWidth

Constructor Detail

ReportGridDisplayCellRowHeader

public ReportGridDisplayCellRowHeader()

Deprecated.

Constructor used for creating a generic display cell.

Since:

MicroStrategy Web 8.0.0

ReportGridDisplayCellRowHeader

public ReportGridDisplayCellRowHeader(FormalParameters formalParas)

Deprecated.

Constructor used for creating a generic display cell.

Parameters:

formalParas - all the formal parameters from the report transform. Used to control some output generation. For example, the cssPrefix is needed for the empty cells in design mode.

ReportGridDisplayCellRowHeader

public ReportGridDisplayCellRowHeader(ReportBean rb,
                                      WebTemplateMetric metric,
                                      FormalParameters formalParas)

Deprecated.

Constructor used for creating a dummy display cell of row header in design mode when it's corresponding to a metric. When the metrics are on row axis, the row header will display the corresponding metric name.

Parameters:

rb - the associated report bean

metric - the associated metric on template

formalParas - all the formal parameters from the report transform. Used to control some output generation. For example, the cssPrefix is needed for the empty cells in design mode.

ReportGridDisplayCellRowHeader

public ReportGridDisplayCellRowHeader(ReportBean rb,
                                      WebTemplateUnit unit,
                                      FormalParameters formalParas)

Deprecated.

Constructor used for creating a dummy display cell of row header in design mode when it's not corresponding to a metric. Basically the row header will contain the information to the corresponding Template unit.

Parameters:

rb - the associated report bean

unit - the associated template unit

formalParas - all the formal parameters from the report transform. Used to control some output generation. For example, the cssPrefix is needed for the empty cells in design mode.

ReportGridDisplayCellRowHeader

public ReportGridDisplayCellRowHeader(ReportBean rb,
                                      WebHeader header,
                                      java.util.HashMap cachedObjects)

Deprecated.

Constructor used to display row header in report grid in execute mode.

Parameters:

rb - the associated report bean

header - the associated row header object

cachedObjects - cached object, used to store some information shared across multiple cells

Method Detail

reset

public void reset()

Deprecated.

Description copied from interface: ReportGridDisplayCell

Reset all of the instance variables. This method is very important when improve the memory performance: we create only one instance for a particular cell type and reuse it instead of creating a new instance for each concrete grid cell. Therefore, it saves a lot of memory. For implementation of this method, please follow the workflow of how all the instance variables are initialized in the class hierarchy when a new instance is created: superclass instance variables are initialized first, subclass instance variables are initialized second. Note: for the purpose of cell reuse.

Specified by:

reset in interface ReportGridDisplayCell

Overrides:

reset in class ReportGridDisplayCellImpl

init

public void init(TransformContext context,
                 WebHeader header)

Deprecated.

Description copied from interface: ReportGridCellHeader

This method is called to initialize the cell in view mode. It receives a WebHeader instance as the underlying SDK object

Specified by:

init in interface ReportGridCellHeader

Parameters:

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

header - WebHeader instance coresponding to the cell to be displayed.

Since:

MicroStrategy Web 8.0.1

init

public void init(TransformContext context,
                 WebTemplateMetric metric)

Deprecated.

Description copied from interface: ReportGridCellHeader

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

Specified by:

init in interface ReportGridCellHeader

Parameters:

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

metric - WebTemplateMetric instance corresponding to the cell to be displayed.

Since:

MicroStrategy Web 8.0.1

getCellType

public int getCellType()

Deprecated.

Returns the cell type

Specified by:

getCellType in interface ReportGridDisplayCell

Overrides:

getCellType in class ReportGridDisplayCellImpl

Returns:

the cell type - EnumReportGridDisplayCellTypes.EnumReportGridDisplayCellTypeRowHeader. It's read-only.

getWebHeader

public WebHeader getWebHeader()

Deprecated.

return the WebHeader object associated with this cell

Specified by:

getWebHeader in interface ReportGridCellHeader

Returns:

the WebHeader object

getWebTemplateMetric

public WebTemplateMetric getWebTemplateMetric()

Deprecated.

return the WebTemplateMetric object associated with this cell

Specified by:

getWebTemplateMetric in interface ReportGridCellHeader

Returns:

the getWebTemplateUnitWebTemplateMetric object

getWebTemplateUnit

protected WebTemplateUnit getWebTemplateUnit()

Deprecated.

return the getWebTemplateUnit object associated with this cell

Returns:

the WebTemplateUnit object

init

public void init(WebComponent wc,
                 WebHeader header,
                 java.util.HashMap cachedObjects)

Deprecated.

Description copied from interface: ReportGridCellHeader

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

Specified by:

init in interface ReportGridCellHeader

Parameters:

wc - The bean being transformed.

header - The WebHeader corresponding to this cell.

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

Since:

MicroStrategy Web 8.0.0

init

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

Deprecated.

Description copied from interface: ReportGridCellRowHeader

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

Specified by:

init in interface ReportGridCellRowHeader

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 8.0.0

init

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

Deprecated.

Description copied from interface: ReportGridCellRowHeader

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

Specified by:

init in interface ReportGridCellRowHeader

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 8.0.0

init

public void init(WebComponent wc,
                 WebTemplateMetric metric,
                 java.util.HashMap cachedObjects)

Deprecated.

Description copied from interface: ReportGridCellHeader

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

Specified by:

init in interface ReportGridCellHeader

Parameters:

wc - The bean being transformed.

metric - The WebTemplateMetric corresponding to this cell.

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

Since:

MicroStrategy Web 8.0.0

generateRowHeaderContent

public void generateRowHeaderContent(MarkupOutput out)

Deprecated.

Since:

MicroStrategy Web 8.0.0

generateContent

protected void generateContent(MarkupOutput mo)

Deprecated.

Override the protected method of ReportDisplayCellImpl.

Overrides:

generateContent in class ReportGridDisplayCellImpl

Parameters:

mo - the output object

Since:

MicroStrategy Web 7.5.1

generateContextMenu

protected void generateContextMenu(MarkupOutput mo)

Deprecated.

Override the protected method of ReportDisplayCellImpl.

Overrides:

generateContextMenu in class ReportGridDisplayCellImpl

Parameters:

mo - the output object

generateDrillCheckBox

protected void generateDrillCheckBox(MarkupOutput mo)

Deprecated.

Override the protected method of ReportDisplayCellImpl.

Overrides:

generateDrillCheckBox in class ReportGridDisplayCellImpl

Parameters:

mo - the output object

generateFilterOnSelectionCheckBox

protected void generateFilterOnSelectionCheckBox(MarkupOutput mo)

Deprecated.

Override the protected method of ReportDisplayCellImpl.

Overrides:

generateFilterOnSelectionCheckBox in class ReportGridDisplayCellImpl

Parameters:

mo - the output object

isMetric

public boolean isMetric()

Deprecated.

determine if the row header is containing a metric

Specified by:

isMetric in interface ReportGridCellHeader

Overrides:

isMetric in class ReportGridDisplayCellImpl

Returns:

whether the cell is containing a metric

isMetricDrillable

public boolean isMetricDrillable(WebHeader header,
                                 WebDrillPath drillPath)

Deprecated.

Description copied from class: ReportGridDisplayCellImpl

return whether the header has a drillable metric

Specified by:

isMetricDrillable in interface ReportGridCellHeader

Overrides:

isMetricDrillable in class ReportGridDisplayCellImpl

Parameters:

header - the header object

drillPath - the drill path

Returns:

whether the header has a drillable metric

Since:

MicroStrategy Web 8.0.1

generateTooltip

protected void generateTooltip(MarkupOutput mo)

Deprecated.

Generate the tool tip for this cell.

Overrides:

generateTooltip in class ReportGridDisplayCellImpl

Parameters:

mo - the output object

generateOutlineModeImage

protected void generateOutlineModeImage(MarkupOutput mo)

Deprecated.

Override the protected method of ReportDisplayCellImpl.

Overrides:

generateOutlineModeImage in class ReportGridDisplayCellImpl

Parameters:

mo - the output object

generateOutlineSubTotalName

protected void generateOutlineSubTotalName(MarkupOutput mo)

Deprecated.

Override the protected method of ReportDisplayCellImpl.

Overrides:

generateOutlineSubTotalName in class ReportGridDisplayCellImpl

Parameters:

mo - the output object

getOutlinemodeRowCount

protected int getOutlinemodeRowCount()

Deprecated.

get row count for outline mode

Returns:

row count for outline mode

setOutlinemodeRowCount

public void setOutlinemodeRowCount(int value)

Deprecated.

set row count for outline mode

Specified by:

setOutlinemodeRowCount in interface ReportGridCellRowHeader

Parameters:

value - row count

getOutlinemodeSubTotalName

protected java.lang.String getOutlinemodeSubTotalName()

Deprecated.

get subtotal name for outline mode

Returns:

subtotal name for outline mode

setOutlinemodeSubTotalName

public void setOutlinemodeSubTotalName(java.lang.String value)

Deprecated.

get subtotal name for outline mode

Specified by:

setOutlinemodeSubTotalName in interface ReportGridCellRowHeader

Parameters:

value - subtotal name for outline mode

getShowOutlinemodeImage

protected boolean getShowOutlinemodeImage()

Deprecated.

get whether display outline mode image

Returns:

whether display outline mode image

setShowOutlinemodeImage

public void setShowOutlinemodeImage(boolean value)

Deprecated.

set whether display outline mode image

Specified by:

setShowOutlinemodeImage in interface ReportGridCellRowHeader

Parameters:

value - whether display outline mode image

setOutlinemodeWrapHeaderText

public void setOutlinemodeWrapHeaderText(boolean isWrap)

Deprecated.

Description copied from interface: ReportGridCellRowHeader

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

Specified by:

setOutlinemodeWrapHeaderText in interface ReportGridCellRowHeader

Parameters:

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

initDNDForDesignMode

protected void initDNDForDesignMode(DragAndDropItem item)

Deprecated.

initialize a drag and drop item for a row header cell in design mode

Overrides:

initDNDForDesignMode in class ReportGridDisplayCellImpl

Parameters:

item - the DragAndDropItem item

initDNDForExecuteMode

protected void initDNDForExecuteMode(DragAndDropItem item)

Deprecated.

initialize a drag and drop item for a row header cell in execute mode

Overrides:

initDNDForExecuteMode in class ReportGridDisplayCellImpl

Parameters:

item - the DragAndDropItem item

isTotal

protected boolean isTotal()

Deprecated.

getInsertMetricPercentToTotalEvent

public WebEvent getInsertMetricPercentToTotalEvent(int axisBitMap)

Deprecated.

Description copied from interface: ReportGridCellHeader

Get the event for inserting a new metric based on Percent to Total

Specified by:

getInsertMetricPercentToTotalEvent in interface ReportGridCellHeader

Parameters:

axisBitMap - identifier of the axis to be used for calculating the metric information. Values expected come from the EnumDSSXMLAxesBitMap enumeration.

Returns:

WebEvent initialized with the event information for inserting a new metric.

Since:

MicroStrategy Web 8.0.1

getInsertMetricPercentToTotalEvent

public WebEvent getInsertMetricPercentToTotalEvent(int axisBitMap,
                                                   java.lang.String attributeID)

Deprecated.

Description copied from interface: ReportGridCellHeader

Get the event for inserting a new metric based on Percent to Total

Specified by:

getInsertMetricPercentToTotalEvent in interface ReportGridCellHeader

Parameters:

axisBitMap - identifier of the axis to be used for calculating the metric information. Values expected come from the EnumDSSXMLAxesBitMap enumeration.

attributeID - identifier of the attribute at which the metric will be calculated

Returns:

WebEvent initialized with the event information for inserting a new metric.

Since:

MicroStrategy Web 8.0.1

getInsertMetricTransformationEvent

public WebEvent getInsertMetricTransformationEvent(java.lang.String transformationID,
                                                   int formulaType)

Deprecated.

Description copied from interface: ReportGridCellHeader

Get the event for inserting a new metric based on a transformation

Specified by:

getInsertMetricTransformationEvent in interface ReportGridCellHeader

Parameters:

transformationID - identifier of the role of the transformation to be used

formulaType - identifier of the type of formula to be used. Values expected come from the EnumDSSXMLMetricFormulaType enumeration

Returns:

WebEvent initialized with the event information for inserting a new metric.

Since:

MicroStrategy Web 8.0.1

getInsertMetricRankEvent

public WebEvent getInsertMetricRankEvent(java.lang.String attributeID,
                                         int sortOrder)

Deprecated.

Description copied from interface: ReportGridCellHeader

Get the event for inserting a new metric based on a rank

Specified by:

getInsertMetricRankEvent in interface ReportGridCellHeader

Parameters:

attributeID - identifier of the attribute at which the metric will be calculated

sortOrder - int with the sort order to be used on the new rank metric. Values expected include EnumViewBeanEvents.SORT_ORDER_ASCENDING and EnumViewBeanEvents.SORT_ORDER_DESCENDING

Returns:

WebEvent initialized with the event information for inserting a new metric.

Since:

MicroStrategy Web 8.0.1

getFilterOnEvent

public WebEvent getFilterOnEvent()

Deprecated.

Description copied from interface: ReportGridDisplayCell

Get the event for filter on the cell header instance

Specified by:

getFilterOnEvent in interface ReportGridDisplayCell

Overrides:

getFilterOnEvent in class ReportGridDisplayCellImpl

Returns:

WebEvent instance initialized for filtering on the information of this cell

Since:

MicroStrategy Web 8.0.1

getOpenFormatEditorEvent

public WebEvent getOpenFormatEditorEvent()

Deprecated.

Description copied from interface: ReportGridDisplayCell

Get the event for opening the format editor

Specified by:

getOpenFormatEditorEvent in interface ReportGridDisplayCell

Overrides:

getOpenFormatEditorEvent in class ReportGridDisplayCellImpl

Returns:

WebEvent instance initialized for opening the format editor

Since:

MicroStrategy Web 8.0.1

getSetFormatEditorTargetEvent

public WebEvent getSetFormatEditorTargetEvent()

Deprecated.

Description copied from interface: ReportGridDisplayCell

Get the event for setting the current target of the format editor to be this cell instance

Specified by:

getSetFormatEditorTargetEvent in interface ReportGridDisplayCell

Overrides:

getSetFormatEditorTargetEvent in class ReportGridDisplayCellImpl

Returns:

WebEvent instance initialized for setting the target of the format editor to be the current cell instance.

Since:

MicroStrategy Web 8.0.1

getRenameEvent

public WebEvent getRenameEvent()

Deprecated.

Description copied from interface: ReportGridDisplayCell

Get the event for renaming the current cell

Specified by:

getRenameEvent in interface ReportGridDisplayCell

Overrides:

getRenameEvent in class ReportGridDisplayCellImpl

Returns:

WebEvent instance initialized with the information for renaming the current cell.

Since:

MicroStrategy Web 8.0.1

getDerivedElementsEvent

public WebEvent getDerivedElementsEvent()

Deprecated.

Specified by:

getDerivedElementsEvent in interface ReportGridDisplayCell

Overrides:

getDerivedElementsEvent in class ReportGridDisplayCellImpl

Since:

MicroStrategy Web 9.0.0

getKey

public int getKey()

Deprecated.

Specified by:

getKey in interface ReportGridDisplayCell

Overrides:

getKey in class ReportGridDisplayCellImpl

Returns:

int value with the key information about the cell being analyzed.

Since:

MicroStrategy Web 8.0.1

getWebTemplateMetric

public WebTemplateMetric getWebTemplateMetric(boolean retrieve)

Deprecated.

Description copied from interface: ReportGridCellHeader

Obtain the WebTemplateMetric instance associated with this class

Specified by:

getWebTemplateMetric in interface ReportGridCellHeader

Parameters:

retrieve - boolean flag that if true indicates it will search also on the header information and the template's metric collection for the metric represented here.

Returns:

WebTemplateMetric instance from where the information to be rendered by this class will be retrieved.

Since:

MicroStrategy Web 8.1.2