public class

ReportGridDisplayCellColTitle

extends ReportGridDisplayCellImpl
implements ReportGridCellColTitle
java.lang.Object
   ↳ com.microstrategy.web.app.transforms.ReportGridDisplayCellImpl
     ↳ com.microstrategy.web.app.transforms.ReportGridDisplayCellColTitle

This class is deprecated.
Please use the ReportGridCellColTitle interface or extend the ReportGridCellColTitleImpl class.

Class Overview

This class represents a Column Title 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.ReportGridCellColTitle
From interface com.microstrategy.web.app.transforms.ReportGridDisplayCell
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.ReportGridDisplayCellImpl
Public Constructors
ReportGridDisplayCellColTitle()
Constructor for displaying column title in execute mode
ReportGridDisplayCellColTitle(FormalParameters formalParas)
Constructor used for creating a generic display cell.
ReportGridDisplayCellColTitle(ReportBean rb, WebTemplateUnit unit, HashMap cachedObjects)
Constructor used for template editor in design mode.
ReportGridDisplayCellColTitle(ReportBean rb, WebTitle title, HashMap cachedObjects)
Constructor for displaying column title in execute mode
Public Methods
boolean canAddShortcutMetric(int shortcutMetricType)
Returns whether specified shortcut metric could be created based on current cell.
void generateColTitleContent(MarkupOutput mo)
WebEvent getAddShortcutMetricEvent(int shortcutMetricType)
Returns the WebEvent to add shortcut metric based on current cell.
int getCellType()
Returns the cell type
WebEvent getDerivedElementsEvent()
WebEvent getFilterOnEvent()
Get the event for filter on the cell header instance
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
int getSubtitleIndex()
Returns the subtitle index for this cell
WebTemplateUnit getWebTemplateUnit()
if in report design mode, return the WebTemplateUnit object associated with this cell; if in report execute mode, return null
WebTitle getWebTitle()
if in report execute mode, return the WebTitle object associated with this cell if in report design mode, return null
void init(WebComponent wc, WebTitle title, HashMap cachedObjects)
This method is called to initialize the cell in view mode.
void init(TransformContext context, WebTemplateUnit unit)
This method is called to initialize the cell in design mode.
void init(WebComponent wc, WebTemplateUnit unit, HashMap cachedObjects)
This method is called to initialize the cell in design mode.
void init(TransformContext context, WebTitle title)
This method is called to initialize the cell in view mode.
boolean isSortAscending()
boolean isSorted()
void reset()
Reset all of the instance variables.
Protected Methods
void generateContent(MarkupOutput mo)
Override the protected method of ReportDisplayCellImpl.
void generateContextMenu(MarkupOutput mo)
Override the protected method in ReportDisplayCellImpl.
void generatePivotButtons(MarkupOutput mo)
Override the protected method in 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 title cell in design mode
void initDNDForExecuteMode(DragAndDropItem item)
initialize a drag and drop item for a column title 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.ReportGridCellColTitle
From interface com.microstrategy.web.app.transforms.ReportGridCellTitle
From interface com.microstrategy.web.app.transforms.ReportGridDisplayCell

Public Constructors

public ReportGridDisplayCellColTitle ()

Constructor for displaying column title in execute mode

public ReportGridDisplayCellColTitle (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 ReportGridDisplayCellColTitle (ReportBean rb, WebTemplateUnit unit, HashMap cachedObjects)

Constructor used for template editor in design mode. 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
unit the associated template unit
cachedObjects cached object, used to store some information shared across multiple cells

public ReportGridDisplayCellColTitle (ReportBean rb, WebTitle title, HashMap cachedObjects)

Constructor for displaying column title in execute mode

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

Public Methods

public 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 void generateColTitleContent (MarkupOutput mo)

public WebEvent getAddShortcutMetricEvent (int shortcutMetricType)

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

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

public int getCellType ()

Returns the cell type

Returns
  • the cell type: EnumReportGridDisplayCellTypes.EnumReportGridDisplayCellTypeColTitle. The 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 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 int getSubtitleIndex ()

Returns the subtitle index for this cell

Returns
  • subtitle

public WebTemplateUnit getWebTemplateUnit ()

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

Returns
  • the WebTemplateUnit object

public WebTitle getWebTitle ()

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

Returns
  • the WebTitle object

public void init (WebComponent wc, WebTitle title, HashMap cachedObjects)

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

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 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 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 of ReportDisplayCellImpl.

Parameters
mo the output object

protected void generateContextMenu (MarkupOutput mo)

Override the protected method in ReportDisplayCellImpl.

Parameters
mo the output object

protected void generatePivotButtons (MarkupOutput mo)

Override the protected method in 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 title cell in design mode

Parameters
item the DragAndDropItem item

protected void initDNDForExecuteMode (DragAndDropItem item)

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

Parameters
item the DragAndDropItem item