public class

ReportGridDisplayCellMetricValue

extends ReportGridDisplayCellImpl
implements ReportGridCellMetricValue
java.lang.Object
   ↳ com.microstrategy.web.app.transforms.ReportGridDisplayCellImpl
     ↳ com.microstrategy.web.app.transforms.ReportGridDisplayCellMetricValue

This class is deprecated.
Please use the ReportGridCellMetricValue interface or extend the ReportGridCellMetricValueImpl class.

Class Overview

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

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.web.app.transforms.ReportGridDisplayCell
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.ReportGridDisplayCellImpl
Public Constructors
ReportGridDisplayCellMetricValue()
Constructor used for creating a generic display cell.
ReportGridDisplayCellMetricValue(FormalParameters formalParas)
Constructor used for creating a generic display cell.
ReportGridDisplayCellMetricValue(ReportBean rb, WebTemplateMetric metric, FormalParameters formalParas)
Constructor used for creating a dummy display cell for metric value in design mode.
ReportGridDisplayCellMetricValue(ReportBean rb, WebRowValue rowValue, HashMap cachedObjects)
Constructor for displaying metric values in report grid in execute mode.
Public Methods
void generateMetricValueContent(MarkupOutput mo, WebRowValue rowValue)
int getCellType()
Returns the cell type
WebRowValue getWebRowValue()
return the WebRowValue object associated with this cell
WebTemplateMetric getWebTemplateMetric()
return the WebTemplateMetric object associated with this cell
void init(WebComponent wc, WebTemplateMetric metric, FormalParameters formalParas)
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, HashMap cachedObjects)
This method is called to initialize the cell with the corresponding WebRowValue as the underlying SDK object.
void reset()
Reset all of the instance variables.
Protected Methods
void generateContent(MarkupOutput mo)
override the protected method in ReportDisplayCellImpl.
void generateContextMenu(MarkupOutput mo)
Override the protected method of ReportDisplayCellImpl.
void generateTooltip(MarkupOutput mo)
Generate the tool tip for this cell.
void initDNDForDesignMode(DragAndDropItem item)
initialize a drag and drop item for a metric value cell in design mode
void initDNDForExecuteMode(DragAndDropItem item)
initialize a drag and drop item for a metric value cell in execute mode
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.ReportGridDisplayCellImpl
From class java.lang.Object
From interface com.microstrategy.web.app.transforms.ReportGridCellMetricValue
From interface com.microstrategy.web.app.transforms.ReportGridDisplayCell

Public Constructors

public ReportGridDisplayCellMetricValue ()

Constructor used for creating a generic display cell.

public ReportGridDisplayCellMetricValue (FormalParameters formalParas)

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.

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

Constructor used for creating a dummy display cell for metric value in design mode. the metric is the corresponding WebTemplateMetric info.

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.

public ReportGridDisplayCellMetricValue (ReportBean rb, WebRowValue rowValue, HashMap cachedObjects)

Constructor for displaying metric values in report grid in execute mode.

Parameters
rb the associated report bean
rowValue the associated WebRowValue object
cachedObjects cached object, used to store some information shared across multiple cells

Public Methods

public void generateMetricValueContent (MarkupOutput mo, WebRowValue rowValue)

public int getCellType ()

Returns the cell type

Returns
  • the cell type: EnumReportGridDisplayCellTypes.EnumReportGridDisplayCellTypeMetricValue. It's read-only.

public WebRowValue getWebRowValue ()

return the WebRowValue object associated with this cell

Returns
  • the WebRowValue object

public WebTemplateMetric getWebTemplateMetric ()

return the WebTemplateMetric object associated with this cell

Returns
  • the WebTemplateMetric object

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

public 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.

public void init (WebComponent wc, WebRowValue rowValue, HashMap cachedObjects)

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.

public void reset ()

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.

Protected Methods

protected void generateContent (MarkupOutput mo)

override the protected method in ReportDisplayCellImpl.

Parameters
mo the output object

protected void generateContextMenu (MarkupOutput mo)

Override the protected method of ReportDisplayCellImpl.

Parameters
mo the output object

protected void generateTooltip (MarkupOutput mo)

Generate the tool tip for this cell.

Parameters
mo the output object

protected void initDNDForDesignMode (DragAndDropItem item)

initialize a drag and drop item for a metric value cell in design mode

Parameters
item the DragAndDropItem item

protected void initDNDForExecuteMode (DragAndDropItem item)

initialize a drag and drop item for a metric value cell in execute mode

Parameters
item the DragAndDropItem item