public class

ReportGridDisplayCellColHeader

extends ReportGridDisplayCellImpl
implements ReportGridCellColHeader
java.lang.Object
   ↳ com.microstrategy.web.app.transforms.ReportGridDisplayCellImpl
     ↳ com.microstrategy.web.app.transforms.ReportGridDisplayCellColHeader

This class is deprecated.
Please use the ReportGridCellColHeader interface or extend the ReportGridCellColHeaderImpl class.

Class Overview

This class represents a Column 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.

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.web.app.transforms.ReportGridCellColHeader
From interface com.microstrategy.web.app.transforms.ReportGridDisplayCell
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.ReportGridDisplayCellImpl
Public Constructors
ReportGridDisplayCellColHeader()
Constructor used for creating a generic display cell.
ReportGridDisplayCellColHeader(FormalParameters formalParas)
Constructor used for creating a generic display cell.
ReportGridDisplayCellColHeader(ReportBean rb, WebTemplateMetric metric, HashMap cachedObjects)
Constructor used for template editor in design mode.
ReportGridDisplayCellColHeader(ReportBean rb, WebHeader header, HashMap cachedObjects)
Constructor used for column header display in execute mode.
Public Methods
void generateColHeaderContent(MarkupOutput mo)
int getCellType()
Returns the cell type
WebEvent getDerivedElementsEvent()
WebEvent getFilterOnEvent()
Get the event for filter on the cell header instance
WebEvent getInsertMetricPercentToTotalEvent(int axisBitMap)
Get the event for inserting a new metric based on Percent to Total
WebEvent getInsertMetricPercentToTotalEvent(int axisBitMap, String attributeID)
Get the event for inserting a new metric based on Percent to Total
WebEvent getInsertMetricRankEvent(String attributeID, int sortOrder)
Get the event for inserting a new metric based on a rank
WebEvent getInsertMetricTransformationEvent(String transformationID, int formulaType)
Get the event for inserting a new metric based on a transformation
int getKey()
WebEvent getOpenFormatEditorEvent()
Get the event for opening the format editor
WebEvent getRenameEvent()
Get the event for renaming the current cell
WebEvent getSetFormatEditorTargetEvent()
Get the event for setting the current target of the format editor to be this cell instance
WebEvent getSortEvent(int type)
Get the WebEvent instance with the information for sorting the current cell values
WebHeader getWebHeader()
if in report execute mode, return the WebHeader object associated with this cell if in report design mode, return null
WebTemplateMetric getWebTemplateMetric(boolean retrieve)
Obtain the WebTemplateMetric instance associated with this class
WebTemplateMetric getWebTemplateMetric()
if in report design mode, return the WebTemplateMetric object associated with this cell; if in report execute mode, return null
void init(TransformContext context, WebTemplateMetric metric)
This method is called to initialize the cell in design mode.
void init(WebComponent wc, WebHeader header, HashMap cachedObjects)
This method is called to initialize the cell in view mode.
void init(TransformContext context, WebHeader header)
This method is called to initialize the cell in view mode.
void init(WebComponent wc, WebTemplateMetric metric, HashMap cachedObjects)
This method is called to initialize the cell in design mode.
boolean isMetric()
determine if the col header is containing a metric
boolean isMetricDrillable(WebHeader header, WebDrillPath drillPath)
return whether the header has a drillable metric
boolean isSortAscending()
boolean isSorted()
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 in ReportDisplayCellImpl
void generateDrillCheckBox(MarkupOutput mo)
Override the protected method of ReportDisplayCellImpl.
void generateFilterOnSelectionCheckBox(MarkupOutput mo)
Override the protected method of ReportDisplayCellImpl.
void generatePivotButtons(MarkupOutput mo)
override the protected method in ReportDisplayCellImpl
void generateSortButton(MarkupOutput mo)
override the protected method from ReportDisplayCellImpl
void generateTooltip(MarkupOutput mo)
Generate the tool tip for this cell.
void initDNDForDesignMode(DragAndDropItem item)
initialize a drag and drop item for a column header cell in design mode
void initDNDForExecuteMode(DragAndDropItem item)
initialize a drag and drop item for a column header cell in execute mode
boolean isTotal()
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.ReportGridDisplayCellImpl
From class java.lang.Object
From interface com.microstrategy.web.app.transforms.ReportGridCellColHeader
From interface com.microstrategy.web.app.transforms.ReportGridCellHeader
From interface com.microstrategy.web.app.transforms.ReportGridDisplayCell

Public Constructors

public ReportGridDisplayCellColHeader ()

Constructor used for creating a generic display cell.

public ReportGridDisplayCellColHeader (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 ReportGridDisplayCellColHeader (ReportBean rb, WebTemplateMetric metric, HashMap cachedObjects)

Constructor used for template editor in design mode. We only display column headers if they are of metric type in template editor. As single action doesn't apply the changes to I-server until "Execute"/"Sava as" button is done, ReportGrid is not updated, so we shall not use WebHeader to build this DisplayCell

Parameters
rb the associated report bean
metric the associated metric on template
cachedObjects cached object, used to store some information shared across multiple cells

public ReportGridDisplayCellColHeader (ReportBean rb, WebHeader header, HashMap cachedObjects)

Constructor used for column header display in execute mode.

Parameters
rb associated report bean
header associated column header
cachedObjects cached object, used to store some information shared across multiple cells

Public Methods

public void generateColHeaderContent (MarkupOutput mo)

public int getCellType ()

Returns the cell type

Returns
  • the cell type - EnumReportGridDisplayCellTypes.EnumReportGridDisplayCellTypeRowTitle. Cell type is read-only.

public WebEvent getDerivedElementsEvent ()

public WebEvent getFilterOnEvent ()

Get the event for filter on the cell header instance

Returns
  • WebEvent instance initialized for filtering on the information of this cell

public 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 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 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 EnumViewBeanEvents#SORT_ORDER_ASCENDING and EnumViewBeanEvents#SORT_ORDER_DESCENDING
Returns
  • WebEvent initialized with the event information for inserting a new metric.

public 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 int getKey ()

public WebEvent getOpenFormatEditorEvent ()

Get the event for opening the format editor

Returns
  • WebEvent instance initialized for opening the format editor

public WebEvent getRenameEvent ()

Get the event for renaming the current cell

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

public WebEvent getSetFormatEditorTargetEvent ()

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

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

public WebEvent getSortEvent (int type)

Get the WebEvent instance with the information for sorting the current cell values

Parameters
type int value with the identifier for the sort order to generate. Values expected include SORT_TYPE_ASCENDING and SORT_TYPE_DESCENDING
Returns
  • WebEvent

public WebHeader getWebHeader ()

if in report execute mode, return the WebHeader object associated with this cell if in report design mode, return null

Returns
  • the WebHeader object

public 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 WebTemplateMetric getWebTemplateMetric ()

if in report design mode, return the WebTemplateMetric object associated with this cell; if in report execute mode, return null

Returns
  • the WebTemplateMetric object

public 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 void init (WebComponent wc, WebHeader header, HashMap cachedObjects)

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 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 void init (WebComponent wc, WebTemplateMetric metric, HashMap cachedObjects)

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 boolean isMetric ()

determine if the col header is containing a metric

Returns
  • whether the cell is containing a metric

public boolean isMetricDrillable (WebHeader header, WebDrillPath drillPath)

return whether the header has a drillable metric

Parameters
header the header object
drillPath the drill path
Returns
  • whether the header has a drillable metric

public boolean isSortAscending ()

public boolean isSorted ()

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 in ReportDisplayCellImpl

Parameters
mo the output object

protected void generateDrillCheckBox (MarkupOutput mo)

Override the protected method of ReportDisplayCellImpl.

Parameters
mo the output object

protected void generateFilterOnSelectionCheckBox (MarkupOutput mo)

Override the protected method of ReportDisplayCellImpl.

Parameters
mo the output object

protected void generatePivotButtons (MarkupOutput mo)

override the protected method in ReportDisplayCellImpl

Parameters
mo the output object

protected void generateSortButton (MarkupOutput mo)

override the protected method from 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 column header cell in design mode

Parameters
item the DragAndDropItem item

protected void initDNDForExecuteMode (DragAndDropItem item)

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

Parameters
item the DragAndDropItem item

protected boolean isTotal ()