Summary: Inherited Constants | Methods | Inherited Methods | [Expand All]

public interface

ReportGridCellHeader

implements ReportGridDisplayCell

com.microstrategy.web.app.transforms.ReportGridCellHeader

Known Indirect Subclasses

AbstractReportGridCellHeader, IPhoneReportGridCellColHeaderImpl, IPhoneReportGridCellRowHeaderImpl, ReportGridCellColHeader, ReportGridCellColHeaderImpl, ReportGridCellRowHeader, ReportGridCellRowHeaderImpl, ReportGridDisplayCellColHeader, ReportGridDisplayCellRowHeader, ReportGridExcelCellColHeaderImpl, ReportGridExcelCellRowHeaderImpl

Summary

[Expand]

Inherited Constants

From interface com.microstrategy.web.app.transforms.ReportGridDisplayCell

Public Methods
abstract WebEvent	getInsertMetricPercentToTotalEvent(int axisBitMap) Get the event for inserting a new metric based on Percent to Total
abstract WebEvent	getInsertMetricPercentToTotalEvent(int axisBitMap, String attributeID) Get the event for inserting a new metric based on Percent to Total
abstract WebEvent	getInsertMetricRankEvent(String attributeID, int sortOrder) Get the event for inserting a new metric based on a rank
abstract WebEvent	getInsertMetricTransformationEvent(String transformationID, int formulaType) Get the event for inserting a new metric based on a transformation
abstract WebHeader	getWebHeader() Obtain the `WebHeader` instance associated with this class
abstract WebTemplateMetric	getWebTemplateMetric() Obtain the `WebTemplateMetric` instance directly associated with this class
abstract WebTemplateMetric	getWebTemplateMetric(boolean retrieve) Obtain the `WebTemplateMetric` instance associated with this class
abstract void	init(WebComponent wc, WebHeader header, HashMap cachedObjects) This method is deprecated. please use the interface that takes a `TransformContext` object instance as parameter
abstract void	init(TransformContext context, WebHeader header) This method is called to initialize the cell in view mode.
abstract void	init(WebComponent wc, WebTemplateMetric metric, HashMap cachedObjects) This method is deprecated. please use the interface that takes a `TransformContext` object instance as parameter
abstract void	init(TransformContext context, WebTemplateMetric metric) This method is called to initialize the cell in design mode.
abstract boolean	isMetric() Utility method for determining if the current cell represents a metric or not.
abstract boolean	isMetricDrillable(WebHeader header, WebDrillPath drillPath) Utility method for determining if the current cell represents a drillable metric or not

[Expand]

Inherited Methods

From interface com.microstrategy.web.app.transforms.ReportGridDisplayCell

abstract void	addExtraAttribute(String attributeName, String attributeValue) Define extra tag attributes and their values that shall be included on the table cell definition for the current instance being rendered
abstract boolean	canAddThresholds() Utility method for determining if the cell object is enabled for displaying the user the option to add advanced thresholds
abstract boolean	canDrill() Utility methood for determining if the cell object is enabled for displaying the user the option to drill on it
abstract boolean	canDrillAdvanced() Utility methood for determining if the cell object is enabled for displaying the user the option for advanced drilling on it
abstract boolean	canEditControl() Utility methood for determining if the cell object is enabled for displaying the user the option to edit control
abstract boolean	canEditMetricFilter() Utility method for determining if the cell object is enabled editing a metric filter
abstract boolean	canFilterOn() Utility methood for determining if the cell object is enabled for displaying the user the option to filter on it
abstract boolean	canFilterOnSelection()
abstract boolean	canFormat() Utility methood for determining if the cell object is enabled for displaying the user the option to format it
abstract boolean	canHaveDerivedElements()
abstract boolean	canHyperLink() Utility method for determining if the cell object is enabled for displaying the user the option to navigate to custom hyperlinks
abstract boolean	canInsertShortcutMetric() Utility methood for determining if the cell object is enabled for displaying the user the option to insert shortcut metrics based on it
abstract boolean	canMetricFilterOn() Utility method for determining if the cell object is enabled for displaying the user the option to modify the attribute forms on it
abstract boolean	canModifyAttributeForm() Utility methood for determining if the cell object is enabled for displaying the user the option to modify the attribute forms on it
abstract boolean	canOpenAlerts()
abstract boolean	canPivot(int type) Utility methood for determining if the cell object is enabled for displaying the user the option to pivot it according to the type specified
abstract boolean	canPivot() Utility methood for determining if the cell object is enabled for displaying the user the option to pivot it
abstract boolean	canQuickGroup()
abstract boolean	canRemoveFromGrid() Utility methood for determining if the cell object is enabled for displaying the user the option to remove it from the grid.
abstract boolean	canRemoveFromReport() Utility methood for determining if the cell object is enabled for displaying the user the option to remove it from the report
abstract boolean	canRename() Utility methood for determining if the cell object is enabled for displaying the user the option to rename it
abstract boolean	canSort() Utility methood for determining if the cell object is enabled for displaying the user the option to sort it
abstract void	generateOutput(MarkupOutput mo) This is the main entry point to generate the output of the cell.
abstract String	getAccessibilityInfo() This method is deprecated. `addExtraAttribute(String, String)` is used instead for specifying the accessibility information, for example, `addExtraAttribute("scope", "row");`
abstract String	getCellID() Returns the id for this cell, this should be the one used as the `ID` attribute of `TD` tag.
abstract int	getCellType() This method is deprecated. The cell type is not significant anymore for the application.
abstract int	getColSpan() Returns the column span for this cell, this should be the one used as the `COLSPAN` attribute of `TD` tag.
abstract WebEvent	getControlElementSelectorEvent(RWControl control, String elementList)
abstract WebEvent	getDerivedElementsEvent()
abstract WebEvent	getDrillEvent(WebDrillPath dp, String elementKey, WebTitle title) Returns the WebEvent to drill from the cell to the given drill path.
abstract WebDrillPath	getDrillPathWithHighImportance() Obtain the Drill path with high importance information for the current cell being analyzed.
abstract String	getExtraInfo() Returns the text assigned as extra information of the cell.
abstract String	getExtraStyle() Returns the extra style information required for the formatting of the cell.
abstract WebEvent	getFilterOnEvent() Get the event for filter on the cell header instance
abstract String	getHeaderContent(WebHeader header) This method is deprecated. The Transform doesn't call this method. Users who require to customize the text-content of a header should override `getText()`
abstract int	getKey()
abstract WebEvent	getOpenFormatEditorEvent() Get the event for opening the format editor
abstract WebEvent	getRenameEvent() Get the event for renaming the current cell
abstract int	getRowSpan() Returns the row span for this cell, this should be the one used as the `ROWSPAN` attribute of `TD` tag.
abstract WebEvent	getSetFormatEditorTargetEvent() Get the event for setting the current target of the format editor to be this cell instance
abstract String	getStyle() Returns the css class name associated with the cell.
abstract String	getText() Returns the text content of this cell.
abstract String	getTooltip() Returns the tooltip text for this cell.
abstract String	getWidth() Returns the width for this cell, this should be the one used as the `WIDTH` attribute of `TD` tag.
abstract void	init(TransformContext context) Initializes the instance.
abstract void	init(WebComponent wc, FormalParameters formalParas) This method is deprecated. This method is not used by the Transform anymore. To initialize empty cells it now uses `init(TransformContext)`.
abstract void	init(WebComponent wc, HashMap cachedObjects) This method is deprecated. use the init interface that receives a `ReportGridTransformImpl.Context` object
abstract void	init(FormalParameters formalParas) This method is deprecated. This method is not used by the Transform anymore. To initialize empty cells it now uses `init(TransformContext)`.
abstract boolean	isRW() Utility methood for determining whether it is a RW execution.
abstract void	reset() Reset all of the instance variables.
abstract void	setAccessibilityInfo(String accessibilityInfo) This method is deprecated. please use `addExtraAttribute(String, String)` instead, for example, `addExtraAttribute("scope", "row");`
abstract void	setCellID(String cellID) Registers the id for this cell, this should be used as the `ID` attribute of `TD` tag.
abstract void	setColSpan(int colSpan) Registers the column span for this cell, this should be used as the `COLSPAN` attribute of `TD` tag.
abstract void	setContent(String content) This method is deprecated. The Transform doesn't call this method. Users who require to customize the content should override `generateContent(MarkupOutput)`
abstract void	setContextMenu(String contextMenu) This method is deprecated. use the context menu infrastructure for defining this information, or the `addExtraAttribute(String, String)` method for adding tag attributes.
abstract void	setExtraInfo(String extraInfo) Registers any extra information that should be appended as part of the `TD`'s open tag.
abstract void	setExtraStyle(String value, boolean append) Updates values to the `STYLE` attribute of the `TD` tag.
abstract void	setExtraStyle(String extraStyle) This method is deprecated. use `instead`
abstract void	setHTML(String html) This method is deprecated. The Transform doesn't call this method. Users who require to customize the HTML should override `generateOutput(MarkupOutput)`
abstract void	setInnerHTML(String innerHTML) This method is deprecated. The Transform doesn't call this method. Users who require to customize the inner HTML should override `generateInnerHTML(MarkupOutput)`
abstract void	setPostContent(String content) This method is deprecated. The Transform doesn't call this method. Users who require to customize the post-content should override `generatePostContent(MarkupOutput)`
abstract void	setPreContent(String content) This method is deprecated. The Transform doesn't call this method. Users who require to customize the pre-content should override `generatePreContent(MarkupOutput)`
abstract void	setRowSpan(int rowSpan) Registers the row span for this cell, this should be used as the `ROWSPAN` attribute of `TD` tag.
abstract void	setStyle(String style) Registers the css style name associated with the cell.
abstract void	setText(String text) Registers the text content of this cell.
abstract void	setTooltip(String tooltip) Registers the text for the tooltop of this cell.
abstract void	setWidth(String width) Registers the width for this cell, this should be used as `WIDTH` attribute of `TD` tag.

Public Methods

public abstract WebEvent getInsertMetricPercentToTotalEvent (int axisBitMap)

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

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.

public abstract WebEvent getInsertMetricPercentToTotalEvent (int axisBitMap, String attributeID)

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

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.

public abstract WebEvent getInsertMetricRankEvent (String attributeID, int sortOrder)

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

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 `SORT_ORDER_ASCENDING` and `SORT_ORDER_DESCENDING`

Returns

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

public abstract WebEvent getInsertMetricTransformationEvent (String transformationID, int formulaType)

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

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.

public abstract WebHeader getWebHeader ()

Obtain the WebHeader instance associated with this class

Returns

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

public abstract WebTemplateMetric getWebTemplateMetric ()

Obtain the WebTemplateMetric instance directly associated with this class

Returns

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

public abstract WebTemplateMetric getWebTemplateMetric (boolean retrieve)

Obtain the WebTemplateMetric instance associated with this class

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.

public abstract void init (WebComponent wc, WebHeader header, HashMap cachedObjects)

This method is deprecated.
please use the interface that takes a TransformContext object instance as parameter

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

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.

public abstract void init (TransformContext context, WebHeader header)

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

Parameters

context	`TransformContext` instance initialized with the grid's transform information.
header	`WebHeader` instance coresponding to the cell to be displayed.

public abstract void init (WebComponent wc, WebTemplateMetric metric, HashMap cachedObjects)

This method is deprecated.
please use the interface that takes a TransformContext object instance as parameter

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.
cachedObjects	A `HashMap` populated by the transform and used to store information shared across multiple cells.

public abstract void init (TransformContext context, WebTemplateMetric metric)

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

Parameters

context	`TransformContext` instance initialized with the grid's transform information.
metric	`WebTemplateMetric` instance corresponding to the cell to be displayed.

public abstract boolean isMetric ()

Utility method for determining if the current cell represents a metric or not.

Returns

boolean value indicating if the current cell instance corresponds to a metric or not.

public abstract boolean isMetricDrillable (WebHeader header, WebDrillPath drillPath)

Utility method for determining if the current cell represents a drillable metric or not

Parameters

header	`WebHeader` instance of the cell currently being analyzed
drillPath	`WebDrillPath` information available for the cell being analyzed

Returns

boolean value indicating if the current cell is a drillable metric or not

Interfaces

Classes

ReportGridCellHeader

Summary

Public Methods

public abstract WebEvent getInsertMetricPercentToTotalEvent (int axisBitMap)

Parameters

Returns

public abstract WebEvent getInsertMetricPercentToTotalEvent (int axisBitMap, String attributeID)

Parameters

Returns

public abstract WebEvent getInsertMetricRankEvent (String attributeID, int sortOrder)

Parameters

Returns

public abstract WebEvent getInsertMetricTransformationEvent (String transformationID, int formulaType)

Parameters

Returns

public abstract WebHeader getWebHeader ()

Returns

public abstract WebTemplateMetric getWebTemplateMetric ()

Returns

public abstract WebTemplateMetric getWebTemplateMetric (boolean retrieve)

Parameters

Returns

public abstract void init (WebComponent wc, WebHeader header, HashMap cachedObjects)

Parameters

public abstract void init (TransformContext context, WebHeader header)

Parameters

public abstract void init (WebComponent wc, WebTemplateMetric metric, HashMap cachedObjects)

Parameters

public abstract void init (TransformContext context, WebTemplateMetric metric)

Parameters

public abstract boolean isMetric ()

Returns

public abstract boolean isMetricDrillable (WebHeader header, WebDrillPath drillPath)

Parameters

Returns