public interface

ReportGridCellTitle

implements ReportGridDisplayCell
com.microstrategy.web.app.transforms.ReportGridCellTitle
Known Indirect Subclasses

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.web.app.transforms.ReportGridDisplayCell
Public Methods
abstract boolean canAddShortcutMetric(int shortcutMetricType)
Returns whether specified shortcut metric could be created based on current cell.
abstract WebEvent getAddShortcutMetricEvent(int shortcutMetricType)
Returns the WebEvent to add shortcut metric based on current cell.
abstract WebSubTitle getSubTitle()
Returns the underlying SDK object associated with this cell.
abstract int getSubtitleIndex()
If attribute forms are displayed, returns the position of the WebSubTitle within the subtitles collection.
abstract WebTemplateUnit getWebTemplateUnit()
Obtain the WebTemplateUnit instance associated with this class
abstract WebTitle getWebTitle()
Obtain the WebTitle instance associated with this class
abstract void init(TransformContext context, WebTemplateUnit unit)
This method is called to initialize the cell in design mode.
abstract void init(WebComponent wc, WebTitle title, HashMap cachedObjects)
This method is deprecated. please use the interface that takes a TransformContext object instance as parameter
abstract void init(WebComponent wc, WebTemplateUnit unit, HashMap cachedObjects)
This method is deprecated. please use the interface that takes a TransformContext object instance as parameter
abstract void init(TransformContext context, WebTitle title)
This method is called to initialize the cell in view mode.
abstract void setSubTitle(WebSubTitle subtitle)
Registers the underlying SDK object associated with this cell.
abstract void setSubTitleIndex(int subtitleIndex)
Registers the position of the underlying WebSubTitle within the subtitles collection.
[Expand]
Inherited Methods
From interface com.microstrategy.web.app.transforms.ReportGridDisplayCell

Public Methods

public abstract boolean canAddShortcutMetric (int shortcutMetricType)

Returns whether specified shortcut metric could be created based on current cell.

Parameters
shortcutMetricType The metric type in (@link EnumShortcutMetricTypes}.

public abstract WebEvent getAddShortcutMetricEvent (int shortcutMetricType)

Returns the WebEvent to add shortcut metric based on current cell.

Parameters
shortcutMetricType The metric type in (@link EnumShortcutMetricTypes}.

public abstract WebSubTitle getSubTitle ()

Returns the underlying SDK object associated with this cell. If the report is in execute mode and attribute forms are displayed, returns the corresponding WebSubTitle; when in design mode, this method should return null.
It should always return null if the instance represents an empty cell.

Returns
  • The underlying SDK object.

public abstract int getSubtitleIndex ()

If attribute forms are displayed, returns the position of the WebSubTitle within the subtitles collection.

Returns
  • The WebSubTitle position

public abstract WebTemplateUnit getWebTemplateUnit ()

Obtain the WebTemplateUnit instance associated with this class

Returns
  • WebTemplateUnit instance from where the information to be rendered by this class will be retrieved.

public abstract WebTitle getWebTitle ()

Obtain the WebTitle instance associated with this class

Returns
  • WebTitle instance from where the information to be rendered by this class will be retrieved.

public abstract void init (TransformContext context, WebTemplateUnit unit)

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

Parameters
context TransformContext instance initialized with the grid's transform information.
unit WebTemplateUnit instance corresponding to the cell to display.

public abstract void init (WebComponent wc, WebTitle title, 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 WebTitle as the underlying SDK object.

Parameters
wc The bean being transformed.
title The WebTitle corresponding to this cell.
cachedObjects A HashMap populated by the transform and used to store information shared across multiple cells.

public abstract void init (WebComponent wc, WebTemplateUnit unit, 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 WebTemplateUnit as the underlying SDK object.

Parameters
wc The bean being transformed.
unit The WebTemplateUnit 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, WebTitle title)

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

Parameters
context TransformContext instance initialized with the grid's transform information.
title WebTitle instance corresponding to the cell to be displayed.

public abstract void setSubTitle (WebSubTitle subtitle)

Registers the underlying SDK object associated with this cell. If the report is in execute mode and attribute forms are displayed, the Transform will call this method to associate a WebSubTitle with the cell.

Parameters
subtitle The corresponding WebSubTitle to associate with the cell.

public abstract void setSubTitleIndex (int subtitleIndex)

Registers the position of the underlying WebSubTitle within the subtitles collection.

Parameters
subtitleIndex the position of the corresponding WebSubTitle