public interface

ReportGridDisplayCell

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

Class Overview

This is the base interface of those used by the ReportGridTransformImpl to generate the content of a single cell.

To generate the HTML for a grid, the Transform iterates through its data and for each cell it will:

  1. Create an instance of the cell using reflexion.
  2. Call the corresponding init method.
  3. Call its generateOutput method.

Users can modify the HTML generated for a cell by creating a custom class that implements this interface. The easiest way to accomplish this is to extend one of the out-of-the-box implementations provided by Microstrateg Web, all of which extend the AbstractReportGridDisplayCell.

To learn how the Transform assigns a class for a particular cell type, please refer to ReportGridTransformImpl.

Summary

Nested Classes
interface ReportGridDisplayCell.Context Implements TransformContext
Constants
int PIVOT_DECREASE_POSITION Identifier for the pivot button that will decrease the position of the object in the collection, for example, move it to the left in case of row title, or move it up if a column title
int PIVOT_INCREASE_POSITION Identifier for the pivot button that will increase the position of the object in the collection, for example, move it to the right in case of row title, or move it down if a column title
int PIVOT_REMOVE Identifier for the pivot button that will remove the object from the template
int PIVOT_SWITCH_AXIS Identifier for the pivot button that will change of axis the object in the template, for example, move it to columns in case of row title, or move it to rows if a column title
int PIVOT_TO_PAGE_BY Identifier for the pivot button that will move the object to the page by section
Public Methods
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, HashMap cachedObjects)
This method is deprecated. use the init interface that receives a ReportGridTransformImpl.Context object
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(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 extraStyle)
This method is deprecated. use instead
abstract void setExtraStyle(String value, boolean append)
Updates values to the STYLE attribute of the TD tag.
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.

Constants

public static final int PIVOT_DECREASE_POSITION

Identifier for the pivot button that will decrease the position of the object in the collection, for example, move it to the left in case of row title, or move it up if a column title

Constant Value: 2 (0x00000002)

public static final int PIVOT_INCREASE_POSITION

Identifier for the pivot button that will increase the position of the object in the collection, for example, move it to the right in case of row title, or move it down if a column title

Constant Value: 1 (0x00000001)

public static final int PIVOT_REMOVE

Identifier for the pivot button that will remove the object from the template

Constant Value: 5 (0x00000005)

public static final int PIVOT_SWITCH_AXIS

Identifier for the pivot button that will change of axis the object in the template, for example, move it to columns in case of row title, or move it to rows if a column title

Constant Value: 3 (0x00000003)

public static final int PIVOT_TO_PAGE_BY

Identifier for the pivot button that will move the object to the page by section

Constant Value: 4 (0x00000004)

Public Methods

public 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

Parameters
attributeName String value with the name of the attribute to add
attributeValue String value with the value of the attribute to add

public abstract boolean canAddThresholds ()

Utility method for determining if the cell object is enabled for displaying the user the option to add advanced thresholds

Returns
  • boolean value indicating if the manipulation should be enabled

public abstract boolean canDrill ()

Utility methood for determining if the cell object is enabled for displaying the user the option to drill on it

Returns
  • boolean value indicating if the manipulation should be enabled

public abstract boolean canDrillAdvanced ()

Utility methood for determining if the cell object is enabled for displaying the user the option for advanced drilling on it

Returns
  • boolean value indicating if the manipulation should be enabled

public abstract boolean canEditControl ()

Utility methood for determining if the cell object is enabled for displaying the user the option to edit control

Returns
  • boolean value indicating if the manipulation should be enabled

public abstract boolean canEditMetricFilter ()

Utility method for determining if the cell object is enabled editing a metric filter

Returns
  • boolean value indicating if the manipulation should be enabled

public abstract boolean canFilterOn ()

Utility methood for determining if the cell object is enabled for displaying the user the option to filter on it

Returns
  • boolean value indicating if the manipulation should be enabled

public abstract boolean canFilterOnSelection ()

public abstract boolean canFormat ()

Utility methood for determining if the cell object is enabled for displaying the user the option to format it

Returns
  • boolean value indicating if the manipulation should be enabled

public abstract boolean canHaveDerivedElements ()

public abstract boolean canHyperLink ()

Utility method for determining if the cell object is enabled for displaying the user the option to navigate to custom hyperlinks

Returns
  • boolean value indicating if the manipulation should be enabled

public 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

Returns
  • boolean value indicating if the manipulation should be enabled

public 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

Returns
  • boolean value indicating if the manipulation should be enabled

public 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

Returns
  • boolean value indicating if the manipulation should be enabled

public abstract boolean canOpenAlerts ()

public 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

Parameters
type value indicating which type of pivot manipulation is being tested. Values come from the PIVOT_INCREASE_POSITION, PIVOT_DECREASE_POSITION, PIVOT_SWITCH_AXIS, PIVOT_TO_PAGE_BY and PIVOT_REMOVE constants.
Returns
  • boolean value indicating if the manipulation should be enabled

public abstract boolean canPivot ()

Utility methood for determining if the cell object is enabled for displaying the user the option to pivot it

Returns
  • boolean value indicating if the manipulation should be enabled

public abstract boolean canQuickGroup ()

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

Returns
  • boolean value indicating if the manipulation should be enabled

public 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

Returns
  • boolean value indicating if the manipulation should be enabled

public abstract boolean canRename ()

Utility methood for determining if the cell object is enabled for displaying the user the option to rename it

Returns
  • boolean value indicating if the manipulation should be enabled

public abstract boolean canSort ()

Utility methood for determining if the cell object is enabled for displaying the user the option to sort it

Returns
  • boolean value indicating if the manipulation should be enabled

public abstract void generateOutput (MarkupOutput mo)

This is the main entry point to generate the output of the cell.

This method is the one used by the Transform to delegate execution. It is responsible for generating the complete HTML output for the cell.

Users interested in modifying a cell's HTML should consider extending generateOutput(MarkupOutput).

Parameters
mo the output object

public abstract String getAccessibilityInfo ()

This method is deprecated.
addExtraAttribute(String, String) is used instead for specifying the accessibility information, for example, addExtraAttribute("scope", "row");

Returns any extra information to be appended as part of the TD's open tag only when the cell will be rendered in Accessibility Mode (508).

Returns
  • The extra accessibility info for this cell

public abstract String getCellID ()

Returns the id for this cell, this should be the one used as the ID attribute of TD tag.

Returns
  • the id for this cell

public abstract int getCellType ()

This method is deprecated.
The cell type is not significant anymore for the application.

Returns the cell type, should be a value from the EnumReportGridDisplayCellTypes enumeration.

public abstract int getColSpan ()

Returns the column span for this cell, this should be the one used as the COLSPAN attribute of TD tag.

Returns
  • The cell's col span

public abstract WebEvent getControlElementSelectorEvent (RWControl control, String elementList)

public abstract WebEvent getDerivedElementsEvent ()

public abstract WebEvent getDrillEvent (WebDrillPath dp, String elementKey, WebTitle title)

Returns the WebEvent to drill from the cell to the given drill path.

Parameters
dp The drill path to use for drilling.
elementKey The key for the element to drill to
title The WebTitle to drill from.

public abstract WebDrillPath getDrillPathWithHighImportance ()

Obtain the Drill path with high importance information for the current cell being analyzed. This drill-path will be the one used to generate the drilling link for the cell.

Returns
  • WebDrillPath instance initialized, with the drill path with high importance information to use if available, otherwise returns null

public abstract String getExtraInfo ()

Returns the text assigned as extra information of the cell. This text should be the one appended to the TD's open tag.

Returns
  • The extra info for this cell

public abstract String getExtraStyle ()

Returns the extra style information required for the formatting of the cell. This text should be the one assigned to the STYLE attribute of the TD tag.

Returns
  • The extra style info for this cell

public abstract 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 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()

For those cells that uses a WebHeader as their underlying WebObject, this method should returns the cell's text content.

Parameters
header the WebHeader object
Returns
  • Header Content as a String

public abstract int getKey ()

Returns
  • int value with the key information about the cell being analyzed.

public abstract WebEvent getOpenFormatEditorEvent ()

Get the event for opening the format editor

Returns
  • WebEvent instance initialized for opening the format editor

public abstract WebEvent getRenameEvent ()

Get the event for renaming the current cell

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

public abstract int getRowSpan ()

Returns the row span for this cell, this should be the one used as the ROWSPAN attribute of TD tag.

Returns
  • The cell's row span

public abstract 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 abstract String getStyle ()

Returns the css class name associated with the cell.
This should be the one assigned to the CLASS attribute of the TD tag to control its formatting.

Returns
  • The css class name

public abstract String getText ()

Returns the text content of this cell. This represents the actual text displayed by the web browser.

Returns
  • Text for the cell

public abstract String getTooltip ()

Returns the tooltip text for this cell. This is the text displayed by the browser when the cursor goes over the cell.

Returns
  • The cell's Tooltip text.

public abstract String getWidth ()

Returns the width for this cell, this should be the one used as the WIDTH attribute of TD tag.

Returns
  • The cell's width

public abstract void init (TransformContext context)

Initializes the instance.

Parameters
context TransformContext instance that contains a reference to the transform being used to render the overall grid information

public abstract void init (WebComponent wc, HashMap cachedObjects)

This method is deprecated.
use the init interface that receives a ReportGridTransformImpl.Context object

Initializes an ReportGridDisplayCell. This is used to initialize empty cells that have no underlying WebObject.

Parameters
wc associated web component.
cachedObjects a HashMap populated by the transform and used to store information shared across multiple cells.

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

Initializes an ReportGridDisplayCell. This is used to initialize empty cells that have no underlying WebObject.

Parameters
wc associated web component
formalParas all the formal parameters from the report transform. Used to control some output generation.

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

Initializes an ReportGridDisplayCell. This is used to initialize empty cells that have no underlying WebObject.

Parameters
formalParas all the formal parameters from the report transform. Used to control some output generation.

public abstract boolean isRW ()

Utility methood for determining whether it is a RW execution.

Returns
  • boolean value indicating if it is a RW execution.

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

public abstract void setAccessibilityInfo (String accessibilityInfo)

This method is deprecated.
please use addExtraAttribute(String, String) instead, for example, addExtraAttribute("scope", "row");

Registers any extra information that should be appended as part of the TD's open tag only when the cell will be rendered in Accessibility Mode (508). This can be used, for example, to include extra attributes used by screen-reader browsers.

Parameters
accessibilityInfo the text to be appended as part of the open tag.

public abstract void setCellID (String cellID)

Registers the id for this cell, this should be used as the ID attribute of TD tag.

Parameters
cellID The cell's ID

public abstract void setColSpan (int colSpan)

Registers the column span for this cell, this should be used as the COLSPAN attribute of TD tag.

Parameters
colSpan col span

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

Registers the main content of the cell. When a non-null content is registered, the content of the cell should be replaced by this text.


Parameters
content content for this cell.

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

Registers the text used to enabled context menus for this cell. This text should be appended to the TD's open tag.

Parameters
contextMenu The trigger for the context-menu of this cell

public abstract void setExtraInfo (String extraInfo)

Registers any extra information that should be appended as part of the TD's open tag. This can be used, for example, to include extra attributes into the cell.

Parameters
extraInfo the text to be appended as part of the open tag.

public abstract void setExtraStyle (String extraStyle)

This method is deprecated.
use instead

Registers any extra information required for the formatting of the cell.
This text should be assigned to the STYLE attribute of the TD tag. The style assigned this way will only apply to this cell.

Parameters
extraStyle The text to use

public abstract void setExtraStyle (String value, boolean append)

Updates values to the STYLE attribute of the TD tag. The style assigned this way will only apply to this cell. Based on the value of append, Information added through this method is appended to other information currently assigned to this attribute.

Parameters
value The text to add
append whether to overwrite or append to the existing style value. Note, the method does not append an automatic semi-colon. Best practice is to ensure that semi-colons are present at the end of value being set (e.g. text-decoration:none; ).

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

Registers the HTML for this cell. When a non-null html is registered, the whole output of the cell should be replaced with this text.

Parameters
html The complete HTML string for this cell

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

Registers the inner HTML for this cell. When a non-null innerHTML is registered, all the HTML within the TD tag should be replaced by this text.

Notice that the ReportGridDisplayCell divides the innerHTML into three parts:
  1. content: generates the main portion of the HTML, it shall include the cell's text and its corresponding HTML.
  2. pre-content: generates the HTML that goes before the content. In the application this is used to generate the checkboxes for drilling.
  3. post-content: generates the HTML that goes after the content. In the application this is used to generate sorting and pivoting buttons.

Parameters
innerHTML The inner HTML string to use for this cell.

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

Registers the post-content of the cell. When a non-null content is registered, the post-content of the cell should be replaced by this text.


Parameters
content post content for this cell

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

Registers the pre-content of the cell. When a non-null content is registered, the pre-content of the cell should be replaced by this text.


Parameters
content precontent for this cell

public abstract void setRowSpan (int rowSpan)

Registers the row span for this cell, this should be used as the ROWSPAN attribute of TD tag.

Parameters
rowSpan row span

public abstract void setStyle (String style)

Registers the css style name associated with the cell.
This text should be assigned as the CLASS attribute of the TD tag to control the format of the cells that share the same CLASS.

Parameters
style The css class name

public abstract void setText (String text)

Registers the text content of this cell. When a non-null text is registered, this should be used as the core content of the cell; otherwise the alias of the underlying WebObject should be used.

Parameters
text text for this cell

public abstract void setTooltip (String tooltip)

Registers the text for the tooltop of this cell. This should be used as the TITLE attribute of TD tag.

Parameters
tooltip the tooltip to display when the cursor goes over the cell

public abstract void setWidth (String width)

Registers the width for this cell, this should be used as WIDTH attribute of TD tag.

Parameters
width text for this cell