public class

ReportGridDisplayCellImpl

extends Object
implements ReportGridCell ReportGridDisplayCell Cloneable
java.lang.Object
   ↳ com.microstrategy.web.app.transforms.ReportGridDisplayCellImpl
Known Direct Subclasses

This class is deprecated.
Please use the ReportGridCellImpl instead.

Class Overview

This class represents the base implementation of a report grid cell. It is used to represent a generic cell
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.ReportGridDisplayCell
Fields
protected WebEvent _advDrillEditorProcessEvent
protected WebEvent _advdrillEvent
protected String[][] _appliedSorts
protected Map _cachedObjects
protected String _drillEditorName
protected WebEvent _drillEditorProcessEvent
protected WebEvent _drillEvent
protected WebEvent _drillFilterOnSelectionProcessEvent
protected String _drillFilterPageBy
protected String _imgBasePath
protected Boolean _isIFrameRequest
protected boolean _isNetscape
protected boolean _itemsAddedToContextMenu
protected int _maxColHeaderDepth
protected WebEvent _sortEvent
protected String _sortSubtotalColPosition
protected String _sortSubtotalPostion
protected boolean _specifyIDForCell
protected boolean _specifyWidthForCell
protected String _text
protected FormalParameters formalParas
protected ReportBean rb
Public Constructors
ReportGridDisplayCellImpl()
Constructor used for creating a generic display cell.
Public Methods
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
boolean canAddThresholds()
Utility methood for determining if the cell object is enabled for displaying the user the option to add thresholds to it
boolean canDrill()
Utility methood for determining if the cell object is enabled for displaying the user the option to drill on it
boolean canDrillAdvanced()
Utility methood for determining if the cell object is enabled for displaying the user the option for advanced drilling on it
boolean canEditControl()
Utility methood for determining if the cell object is enabled for displaying the user the option to edit control
boolean canEditMetricFilter()
Utility method for determining if the cell object is enabled editing a metric filter
boolean canFilterOn()
Utility methood for determining if the cell object is enabled for displaying the user the option to filter on it
boolean canFilterOnSelection()
boolean canFormat()
Utility methood for determining if the cell object is enabled for displaying the user the option to format it
boolean canHaveDerivedElements()
boolean canHyperLink()
Utility method for determining if the cell object is enabled for displaying the user the option to navigate to custom hyperlinks
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
boolean canMetricFilterOn()
Utility method for determining if the cell object is enabled for displaying the user the option to filter on it
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
boolean canOpenAlerts()
boolean canPivot()
Utility methood for determining if the cell object is enabled for displaying the user the option to pivot it
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
boolean canQuickGroup()
boolean canRemoveFromGrid()
Utility methood for determining if the cell object is enabled for displaying the user the option to remove it from the grid.
boolean canRemoveFromReport()
Utility methood for determining if the cell object is enabled for displaying the user the option to remove it from the report
boolean canRename()
Utility methood for determining if the cell object is enabled for displaying the user the option to rename it
boolean canSort()
Utility methood for determining if the cell object is enabled for displaying the user the option to sort it
Object clone()
Utility method to clone this object.
void generateOutput(MarkupOutput mo)
Generate complete HTML for this cell.
String getAccessibilityInfo()
This method is deprecated. addExtraAttribute(String, String) is used instead for specifying the accessibility information, for example, addExtraAttribute("scope", "row");
String getCellID()
Returns the id for this cell, will be used as ID attribute of
in HTML
int getCellType()
Returns the cell type
int getColSpan()
Returns the col span for this cell
WebEvent getControlElementSelectorEvent(RWControl control, String elementList)
WebEvent getDerivedElementsEvent()
WebEvent getDrillEvent(WebDrillPath dp, String elementKey, WebTitle title)
Returns the WebEvent to drill from the cell to the given drill path.
WebDrillPath getDrillPathWithHighImportance()
Obtain the Drill path with high importance information for the current cell being analyzed
String getExtraInfo()
Returns the extra info for this cell
String getExtraStyle()
Returns the extra style info for this cell
String getExtraUrl()
get extra url for the cell
WebEvent getFilterOnEvent()
Get the event for filter on the cell header instance
String getHeaderContent(WebHeader header)
generate output for a header
int getKey()
WebEvent getOpenFormatEditorEvent()
Get the event for opening the format editor
WebEvent getRenameEvent()
Get the event for renaming the current cell
ReportBean getReportBean()
Returns the report bean associated with this display cell
int getReportDesignMode()
This method is deprecated. Please check the reportDesignMode formal parameter value instead.
int getRowSpan()
Returns the row span for this cell
WebEvent getSetFormatEditorTargetEvent()
Get the event for setting the current target of the format editor to be this cell instance
String getStyle()
Returns the css style name for this cell
WebSubTitle getSubTitle()
Returns the subtitle for this cell
int getSubtitleIndex()
Returns the subtitle index for this cell
String getText()
Returns the text for this cell
String getTooltip()
Returns the tooltip text for this cell
String getWidth()
Returns the width for this cell
void init(TransformContext context)
Initializes the instance.
void init(WebComponent wc, HashMap cachedObjects)
This method is deprecated. please use the interface that takes Context object instances as parameter
void init(FormalParameters formalParas)
Init method used for creating a generic display cell.
void init(WebComponent wc, FormalParameters formalParas)
Init method used for creating a generic display cell.
boolean isRW()
Utility methood for determining whether it is a RW execution.
void reset()
Reset all of the instance variables.
void setAccessibilityInfo(String accessibilityInfo)
Sets any information that should be used in case Accessibility Mode (508) is enabled by the user
void setCellID(String cellID)
Sets the id for this cell, will be used as ID attribute of
in HTML
void setCellType(int cellType)
Sets the type for this cell, value should be from EnumReportGridDisplayCellTypes
void setColSpan(int colSpan)
Sets the col span for this cell
void setContent(String content)
set the content (HTML format) for this cell.
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.
void setDrillPath(String drillPath)
void setExtraInfo(String extraInfo)
Sets the extra info for this cell
void setExtraStyle(String extraStyle)
Sets the extra style info for this cell
void setExtraStyle(String extraStyle, boolean append)
Updates values to the STYLE attribute of the TD tag.
void setExtraUrl(String value)
set extra url for the cell
void setHTML(String html)
Sets the complete HTML for this cell.
void setInnerHTML(String innerHTML)
Sets the inner HTML for this cell.
void setPostContent(String postContent)
set the post-content (HTML format) for this cell.
void setPreContent(String preContent)
set the pre-content (HTML format) for this cell.
void setRowSpan(int rowSpan)
Sets the row span for this cell
void setStyle(String style)
Sets the css style name for this cell
void setSubTitle(WebSubTitle subtitle)
Sets the subtitle for this cell
void setSubTitleIndex(int subtitleIndex)
Sets the subtitle index for this cell
void setText(String text)
Sets the text for this cell
void setTooltip(String tooltip)
Sets the tooltop for the text in this cell
void setWidth(String width)
Sets the width for this cell
Protected Methods
boolean convertNonbreakingSpaceOnMV()
This method is deprecated. This functionality has been moved to the excel-only related classes such as ReportGridExcelCellMetricValueImpl and ReportGridExcelTransform. This method now always returns false.
boolean decodeEuro()
This method is deprecated. This method as well as the decodeEuro formal parameter itself are not used anymore on the application.
boolean encodeMV()
This method is deprecated. This method is only required at the metric value cell, please use encodeMetricValue().
void generateContent(MarkupOutput mo)
Generate the core HTML for this cell.
void generateContextMenu(MarkupOutput mo)
Generate the context menu for this cell.
void generateDragAndDrop(MarkupOutput mo)
Generate drag and drop properties.
boolean generateDrillCheckBox(MarkupOutput mo, ReportBean rb, WebHeader header)
generate output for checkboxes for drill
void generateDrillCheckBox(MarkupOutput mo)
Generate the drill check box.
void generateDrillOpenLink(MarkupOutput mo, ReportBean rb, String url, String title, boolean javascriptUsedForDrill, String sElementID)
generate open anchor for drill link for header elements
boolean generateFilterOnSelectionCheckBox(MarkupOutput mo, ReportBean rb, WebHeader header)
generate output for the checkbox for Filter on Selections
void generateFilterOnSelectionCheckBox(MarkupOutput mo)
Generate the filter on selection check box.
void generateHeaderDrillContextMenu(MarkupOutput mo, ReportBean rb, WebHeader header, StringBuffer sHeaderURL, ContextMenu rhMenu)
generate the drilling context menu for headers
void generateHeaderSortContextMenu(MarkupOutput mo, ReportBean rb, WebHeader header, ContextMenu rhMenu)
generate the output for sorting context menu for headers
void generateInnerHTML(MarkupOutput mo)
Returns the inner HTML for this cell.
void generateOutlineModeImage(MarkupOutput mo)
Generate the javascript images for collapse and expand for outline mode.
void generateOutlineSubTotalName(MarkupOutput mo)
Generate the name of the subtotal type next to the header element for outline mode.
void generatePivotButtons(MarkupOutput mo)
Generate pivot buttons.
void generatePostContent(MarkupOutput mo)
Generate the postContent of the cell.
void generatePreContent(MarkupOutput mo)
Generate the preContent of the cell.
void generateRowValueDrillContextMenu(MarkupOutput mo, ReportBean rb, WebRowValue rowValue, StringBuffer sHeaderURL, ContextMenu rhMenu)
generate the drilling context menu for row values
void generateSortButton(MarkupOutput mo)
Generate sort button for this cell.
void generateTitleDrillContextMenu(MarkupOutput mo, ReportBean rb, WebTitle title, StringBuffer sTitleURL, ContextMenu rhMenu)
generate output for drilling context menu for titles
void generateTitleSortContextMenu(MarkupOutput mo, ReportBean rb, WebTitle title, ContextMenu rhMenu)
generate the output for sorting context menu for titles
void generateTooltip(MarkupOutput mo)
Generate the context menu for this cell.
String generateTooltipContent()
void generateTooltipForHeaders(MarkupOutput mo)
Generate the tool tip for this cell.
void generateTooltipForRowValue(MarkupOutput mo)
Generate the tool tip for this cell.
void generateTooltipForTitles(MarkupOutput mo)
Generate the tool tip for this cell.
WebMetric getColHeaderWebMetric(WebHeader header)
get the metric object for the column header
Map getContextMenuAttributes()
Obtain the tag attributes that should be added to the cell's definition for processing context menus
ContextMenuManager getContextMenuManager()
get the ContextMenuManager object
String getCssPrefix()
This method is deprecated. Please check the cssPrefix formal parameter value instead.
String getDescription()
Returns the description for this cell.
String getDescriptor(ReportBean rb, int key)
Get descriptor for this key
String getDrillPath()
EventManager getEventManager()
get the EventManager object
int getFPIntValue(String fpName)
get formal parameter value as an integer value
String getFPStringValue(String fpName)
get the formal parameter value as a string value
String getHeaderDrillParametersForDHTML(ReportBean rb, WebDrillPath dp, WebHeader header)
generate drilling url parameters for DHTML mode
WebDrillPath getHeaderDrillPathWithHighImportance(ReportBean rb, WebHeader header)
generate drilling url parameters for DHTML mode
String getHeaderDrillURL(ReportBean rb, WebDrillPath dp, WebHeader header)
generate the output for drilling URL for headers
String getImgName(String fpName)
get the corresponding image name for a formal parameter representing an image
int getMaxSortAllowed()
This method is deprecated. Please check the maxSortAllowed formal parameter value instead.
String getPostTextForMetricValue()
This method is deprecated. Please check the postTextForMetricValue formal parameter value instead.
String getPostTextForNonMetricValue()
This method is deprecated. Please check the postTextForNonMetricValue formal parameter value instead.
String getPreTextForMetricValue()
This method is deprecated. Please check the preTextForMetricValue formal parameter value instead.
String getPreTextForNonMetricValue()
This method is deprecated. Please check the preTextForNonMetricValue formal parameter value instead.
String getRowValueDrillElements(WebRowValue rowValue)
String getRowValueDrillParametersForDHTML(ReportBean rb, WebDrillPath dp)
generate drilling url parameters for row value in DHTML mode
WebDrillPath getRowValueDrillPathWithHighImportance(ReportBean rb, WebRowValue rowValue)
generate drilling url parameters for row value in DHTML mode
String getRowValueDrillURL(ReportBean rb, WebDrillPath dp, WebRowValue rowValue)
generate the output for drilling URL for row value
int getShowDescriptionAsTooltip(String fpName)
get formal parameter value as an int value
boolean getSortStatus(String sSortID, String[][] appliedSorts)
get the sort statys
String getTitleDrillParametersForDHTML(ReportBean rb, WebDrillPath dp, WebTitle title)
generate drilling url parameters for DHTML mode
String getTitleDrillURL(ReportBean rb, WebDrillPath dp, WebTitle title)
generate the output for drilling URL for titles
void initDNDForDesignMode(DragAndDropItem item)
void initDNDForExecuteMode(DragAndDropItem item)
void initDragAndDrop(DragAndDropItem item)
boolean isContextMenuEnabled()
This method is deprecated. Please check the isContextMenuEnabled formal parameter value instead.
boolean isDesignMode()
is design mode or not
boolean isDragAndDropEnabled()
This method is deprecated. Please check the isDragAndDropEnabled formal parameter value instead.
boolean isFPTrue(String fpName, boolean defValue)
boolean isFPTrue(String fpName)
get formal parameter value as a boolean value
boolean isHeaderNeedLink(WebHeader header)
return whether to display link for drill
boolean isIFrameEnabled()
whether ifram is enabled
boolean isIFrameRequest()
whether it's an iframe request
boolean isItemsAddedToContextMenu()
return whether there is any item added to the context menu
boolean isMetric()
determine if the cell is containing a metric
boolean isMetricDrillable(WebHeader header, WebDrillPath drillPath)
return whether the header has a drillable metric
boolean isOutlineModeEnabled()
is outline more feature enabled
boolean isRowValueNeedLink(WebRowValue rowValue)
return whether to display link for drill
boolean isSortAscending(String sSortID, String[][] appliedSorts)
check if the sort is ascending
boolean isTitleNeedLink(WebTitle title)
return whether to display link for drill
void setDescription(String description)
Sets the description for this cell.
void setStyleForNonBuiltInFormat(String style, int rowOrdinal)
set the style for the cell when not using the built in report formatting
boolean showBanding()
This method is deprecated. Please check the showBanding formal parameter value instead.
boolean showDrillAdvanced()
This method is deprecated. Please check the showDrillAdvanced formal parameter value instead.
boolean showDrillCheckBox()
This method is deprecated. Please check the showDrillCheckBox formal parameter value instead.
boolean showDrillDownOnly()
This method is deprecated. Please check the showDrillDownOnly formal parameter value instead.
boolean showDrillHyperlink()
This method is deprecated. Please check the showDrillHyperlink formal parameter value instead.
boolean showDrillHyperlinkMetric()
This method is deprecated. Please check the showDrillHyperlinkMetric formal parameter value instead.
boolean showDrillMetric()
This method is deprecated. Please check the showDrillMetric formal parameter value instead.
boolean showDrillRMC()
This method is deprecated. Please check the showDrillRMC formal parameter value instead.
boolean showDrillRMCMetric()
This method is deprecated. Please check the showDrillRMCMetric formal parameter value instead.
boolean showFilterOnSelectionCheckBox()
This method is deprecated. Please check the showFilterOnSelectionCheckBox formal parameter value instead.
boolean showFormattingRMC()
This method is deprecated. Please check the showFormattingRMC formal parameter value instead.
boolean showPivot()
This method is deprecated. Please check the showPivot formal parameter value instead.
boolean showPivotRMC()
This method is deprecated. Please check the showPivotRMC formal parameter value instead.
boolean showRemove()
This method is deprecated. Please check the showRemove formal parameter value instead.
boolean showRemoveRMC()
This method is deprecated. Please check the showRemoveRMC formal parameter value instead.
boolean showRenameRMC()
This method is deprecated. Please check the showRenameRMC formal parameter value instead.
boolean showSortButtonsForAttributes()
This method is deprecated. Please check the showSortButtonsForAttributes formal parameter value instead.
boolean showSortButtonsForMetrics()
This method is deprecated. Please check the showSortButtonsForMetrics formal parameter value instead.
boolean showSortRMCForAttributes()
This method is deprecated. Please check the showSortRMCForAttributes formal parameter value instead.
boolean showSortRMCForMetrics()
This method is deprecated. Please check the showSortRMCForMetrics formal parameter value instead.
boolean showSubTitle()
whethere display sub title
boolean useBuiltInFormat()
This method is deprecated. Please check the useBuiltInFormat formal parameter value instead.
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.microstrategy.web.app.transforms.ReportGridDisplayCell

Fields

protected WebEvent _advDrillEditorProcessEvent

protected WebEvent _advdrillEvent

protected String[][] _appliedSorts

protected Map _cachedObjects

protected String _drillEditorName

protected WebEvent _drillEditorProcessEvent

protected WebEvent _drillEvent

protected WebEvent _drillFilterOnSelectionProcessEvent

protected String _drillFilterPageBy

protected String _imgBasePath

protected Boolean _isIFrameRequest

protected boolean _isNetscape

protected boolean _itemsAddedToContextMenu

protected int _maxColHeaderDepth

protected WebEvent _sortEvent

protected String _sortSubtotalColPosition

protected String _sortSubtotalPostion

protected boolean _specifyIDForCell

protected boolean _specifyWidthForCell

protected String _text

protected FormalParameters formalParas

protected ReportBean rb

Public Constructors

public ReportGridDisplayCellImpl ()

Constructor used for creating a generic display cell.

Public Methods

public 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 boolean canAddThresholds ()

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

Returns
  • boolean value indicating if the manipulation should be enabled

public 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 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 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 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 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 boolean canFilterOnSelection ()

public 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 boolean canHaveDerivedElements ()

public 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 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 boolean canMetricFilterOn ()

Utility method 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 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 boolean canOpenAlerts ()

public 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 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 boolean canQuickGroup ()

public 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 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 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 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 Object clone ()

Utility method to clone this object.

Returns
  • the cloned object

public void generateOutput (MarkupOutput mo)

Generate complete HTML for this cell.

Parameters
mo the output object

public String getAccessibilityInfo ()

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

Get any information that should be used in case Accessibility Mode (508) is enabled by the user

Returns
  • the extra accessibility info for this cell

public String getCellID ()

Returns the id for this cell, will be used as ID attribute of in HTML

Returns
  • the id for this cell

public int getCellType ()

Returns the cell type

Returns
  • cell type - EnumReportGridDisplayCellTypes.EnumReportGridDisplayCellTypeGeneric. The cell type is read-only.

public int getColSpan ()

Returns the col span for this cell

Returns
  • col span

public WebEvent getControlElementSelectorEvent (RWControl control, String elementList)

public WebEvent getDerivedElementsEvent ()

public 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 WebDrillPath getDrillPathWithHighImportance ()

Obtain the Drill path with high importance information for the current cell being analyzed

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

public String getExtraInfo ()

Returns the extra info for this cell

Returns
  • the extra info for this cell

public String getExtraStyle ()

Returns the extra style info for this cell

Returns
  • the extra style info for this cell

public String getExtraUrl ()

get extra url for the cell

Returns
  • extra url for the cell

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 String getHeaderContent (WebHeader header)

generate output for a header

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

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 ReportBean getReportBean ()

Returns the report bean associated with this display cell

Returns
  • the report bean

public int getReportDesignMode ()

This method is deprecated.
Please check the reportDesignMode formal parameter value instead.

Returns the mode from EnumReportViewModes

Returns
  • cell type - EnumReportGridDisplayCellTypes.EnumReportGridDisplayCellTypeGeneric. The cell type is read-only.

public int getRowSpan ()

Returns the row span for this cell

Returns
  • row span

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

Returns the css style name for this cell

Returns
  • css style name

public WebSubTitle getSubTitle ()

Returns the subtitle for this cell

Returns
  • subtitle

public int getSubtitleIndex ()

Returns the subtitle index for this cell

Returns
  • subtitle

public String getText ()

Returns the text for this cell

Returns
  • text for this cell

public String getTooltip ()

Returns the tooltip text for this cell

Returns
  • The cell's Tooltip text.

public String getWidth ()

Returns the width for this cell

Returns
  • width for the cell

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

This method is deprecated.
please use the interface that takes Context object instances as parameter

Init method used for creating a generic display cell.

Parameters
wc associated web component
cachedObjects cached object, used to store some information shared across multiple cells

public void init (FormalParameters formalParas)

Init method 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 void init (WebComponent wc, FormalParameters formalParas)

Init method used for creating a generic display cell.

Parameters
wc associated web component
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 boolean isRW ()

Utility methood for determining whether it is a RW execution.

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

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.

public void setAccessibilityInfo (String accessibilityInfo)

Sets any information that should be used in case Accessibility Mode (508) is enabled by the user

Parameters
accessibilityInfo the extra accessibility info for this cell

public void setCellID (String cellID)

Sets the id for this cell, will be used as ID attribute of in HTML

Parameters
cellID the id for this cell

public void setCellType (int cellType)

Sets the type for this cell, value should be from EnumReportGridDisplayCellTypes

Parameters
cellType the type for this cell

public void setColSpan (int colSpan)

Sets the col span for this cell

Parameters
colSpan col span for this cell

public void setContent (String content)

set the content (HTML format) for this cell.

Parameters
content content for this cell.

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

Sets the context menu for this cell

Parameters
contextMenu the context menu for this cell

public void setDrillPath (String drillPath)

public void setExtraInfo (String extraInfo)

Sets the extra info for this cell

Parameters
extraInfo the extra info for this cell

public void setExtraStyle (String extraStyle)

Sets the extra style info for this cell

Parameters
extraStyle the extra style info for this cell

public void setExtraStyle (String extraStyle, 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
extraStyle 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 void setExtraUrl (String value)

set extra url for the cell

Parameters
value extra url for the cell

public void setHTML (String html)

Sets the complete HTML for this cell. Sets the inner HTML for this cell. It's the html code beginning with and ending with .

Parameters
html the HTML string

public void setInnerHTML (String innerHTML)

Sets the inner HTML for this cell. Inner HTML is the html code between and .

Parameters
innerHTML inner HTML for this cell

public void setPostContent (String postContent)

set the post-content (HTML format) for this cell.

Parameters
postContent post content for this cell

public void setPreContent (String preContent)

set the pre-content (HTML format) for this cell.

Parameters
preContent pre-content for this cell

public void setRowSpan (int rowSpan)

Sets the row span for this cell

Parameters
rowSpan the row span for this cell

public void setStyle (String style)

Sets the css style name for this cell

Parameters
style css style name to be used for this cell

public void setSubTitle (WebSubTitle subtitle)

Sets the subtitle for this cell

Parameters
subtitle to be used for this cell

public void setSubTitleIndex (int subtitleIndex)

Sets the subtitle index for this cell

Parameters
subtitleIndex to be used for this cell

public void setText (String text)

Sets the text for this cell

Parameters
text text for this cell

public void setTooltip (String tooltip)

Sets the tooltop for the text in this cell

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

public void setWidth (String width)

Sets the width for this cell

Parameters
width text for this cell

Protected Methods

protected boolean convertNonbreakingSpaceOnMV ()

This method is deprecated.
This functionality has been moved to the excel-only related classes such as ReportGridExcelCellMetricValueImpl and ReportGridExcelTransform. This method now always returns false.

Whether to convert nonbreaking spaces (char 160) to normal spaces (char 32) on metric values. Used for Exporting to Excel on French Environments.

Returns
  • Whether to convert nonbreaking spaces (char 160) to normal spaces (char 32) on metric values.

protected boolean decodeEuro ()

This method is deprecated.
This method as well as the decodeEuro formal parameter itself are not used anymore on the application.

Whether to decode the Euro symbol on the metric values

Returns
  • whether to decode the Euro symbol on the metric values

protected boolean encodeMV ()

This method is deprecated.
This method is only required at the metric value cell, please use encodeMetricValue().

Whether to HTML-encode metric values.

Returns
  • Whether to HTML-encode metric values.

protected void generateContent (MarkupOutput mo)

Generate the core HTML for this cell. By default, it's the text of the cell.

Parameters
mo the output object

protected void generateContextMenu (MarkupOutput mo)

Generate the context menu for this cell.

Parameters
mo the output object

protected void generateDragAndDrop (MarkupOutput mo)

Generate drag and drop properties.

Parameters
mo the output object

protected boolean generateDrillCheckBox (MarkupOutput mo, ReportBean rb, WebHeader header)

generate output for checkboxes for drill

Parameters
mo the MarkupOutput object
rb the ReportBean object
header the WebHeader object
Returns
  • if any checkbox is rendered

protected void generateDrillCheckBox (MarkupOutput mo)

Generate the drill check box.

Parameters
mo the output object

protected void generateDrillOpenLink (MarkupOutput mo, ReportBean rb, String url, String title, boolean javascriptUsedForDrill, String sElementID)

generate open anchor for drill link for header elements

Parameters
mo the MarkupOutput object
rb the ReportBean object
url the url for the link
title the WebTitle object
javascriptUsedForDrill whether use javascript for drilling
sElementID The drill element ID for this header element

protected boolean generateFilterOnSelectionCheckBox (MarkupOutput mo, ReportBean rb, WebHeader header)

generate output for the checkbox for Filter on Selections

Parameters
mo the MarkupOutput object
rb the ReportBean object
header the WebHeader object
Returns
  • if any checkbox is rendered

protected void generateFilterOnSelectionCheckBox (MarkupOutput mo)

Generate the filter on selection check box.

Parameters
mo the output object

protected void generateHeaderDrillContextMenu (MarkupOutput mo, ReportBean rb, WebHeader header, StringBuffer sHeaderURL, ContextMenu rhMenu)

generate the drilling context menu for headers

Parameters
mo the MarkupOutput object
rb the ReportBean object
header the WebHeader object
sHeaderURL the header's url
rhMenu the context menu object

protected void generateHeaderSortContextMenu (MarkupOutput mo, ReportBean rb, WebHeader header, ContextMenu rhMenu)

generate the output for sorting context menu for headers

Parameters
mo the MarkupOutput object
rb the ReportBean object
header the WebHeader object
rhMenu the context menu object

protected void generateInnerHTML (MarkupOutput mo)

Returns the inner HTML for this cell. InnerHTML is composed of precontent, followed by content, followed by post-content. Could be overrided by subclasses.

protected void generateOutlineModeImage (MarkupOutput mo)

Generate the javascript images for collapse and expand for outline mode.

Parameters
mo the output object

protected void generateOutlineSubTotalName (MarkupOutput mo)

Generate the name of the subtotal type next to the header element for outline mode.

Parameters
mo the output object

protected void generatePivotButtons (MarkupOutput mo)

Generate pivot buttons.

Parameters
mo the output object

protected void generatePostContent (MarkupOutput mo)

Generate the postContent of the cell. The post-Content means the html content after the real core content of the cell. An sample would be a sort button after the text.

Parameters
mo the output object

protected void generatePreContent (MarkupOutput mo)

Generate the preContent of the cell. The pre-Content means the html content before real core content of the cell. An sample would be a checkbox before the text.

Parameters
mo the output object

protected void generateRowValueDrillContextMenu (MarkupOutput mo, ReportBean rb, WebRowValue rowValue, StringBuffer sHeaderURL, ContextMenu rhMenu)

generate the drilling context menu for row values

Parameters
mo the MarkupOutput object
rb the ReportBean object
rowValue the WebRowValue object
sHeaderURL the header's url
rhMenu the context menu object

protected void generateSortButton (MarkupOutput mo)

Generate sort button for this cell.

Parameters
mo the output object

protected void generateTitleDrillContextMenu (MarkupOutput mo, ReportBean rb, WebTitle title, StringBuffer sTitleURL, ContextMenu rhMenu)

generate output for drilling context menu for titles

Parameters
mo the MarkupOutput object
rb the ReportBean object
title the WebTitle object
sTitleURL the title's url
rhMenu the context menu object

protected void generateTitleSortContextMenu (MarkupOutput mo, ReportBean rb, WebTitle title, ContextMenu rhMenu)

generate the output for sorting context menu for titles

Parameters
mo the MarkupOutput object
rb the ReportBean object
title the WebTitle object
rhMenu the context menu object

protected void generateTooltip (MarkupOutput mo)

Generate the context menu for this cell.

Parameters
mo the output object

protected String generateTooltipContent ()

protected void generateTooltipForHeaders (MarkupOutput mo)

Generate the tool tip for this cell.

Parameters
mo the output object

protected void generateTooltipForRowValue (MarkupOutput mo)

Generate the tool tip for this cell.

Parameters
mo the output object

protected void generateTooltipForTitles (MarkupOutput mo)

Generate the tool tip for this cell.

Parameters
mo the output object

protected WebMetric getColHeaderWebMetric (WebHeader header)

get the metric object for the column header

Parameters
header the column header
Returns

protected Map getContextMenuAttributes ()

Obtain the tag attributes that should be added to the cell's definition for processing context menus

Returns
  • Map instance with the attribute context menu information

protected ContextMenuManager getContextMenuManager ()

get the ContextMenuManager object

Returns

protected String getCssPrefix ()

This method is deprecated.
Please check the cssPrefix formal parameter value instead.

get the prefix for the css class name

Returns
  • the prefix for the css class name

protected String getDescription ()

Returns the description for this cell.

Returns
  • description for the cell.

protected String getDescriptor (ReportBean rb, int key)

Get descriptor for this key

Parameters
key input key as an int
Returns
  • descriptor as a String

protected String getDrillPath ()

protected EventManager getEventManager ()

get the EventManager object

Returns

protected int getFPIntValue (String fpName)

get formal parameter value as an integer value

Parameters
fpName formal parameter name
Returns
  • formal parameter value

protected String getFPStringValue (String fpName)

get the formal parameter value as a string value

Parameters
fpName formal parameter name
Returns
  • formal parameter value

protected String getHeaderDrillParametersForDHTML (ReportBean rb, WebDrillPath dp, WebHeader header)

generate drilling url parameters for DHTML mode

Parameters
rb the ReportBean object
dp the drill path
header the WebHeader object
Returns
  • the url string

protected WebDrillPath getHeaderDrillPathWithHighImportance (ReportBean rb, WebHeader header)

generate drilling url parameters for DHTML mode

Parameters
rb the ReportBean object
header the WebHeader object
Returns
  • The drill path with high importance

protected String getHeaderDrillURL (ReportBean rb, WebDrillPath dp, WebHeader header)

generate the output for drilling URL for headers

Parameters
rb the ReportBean object
dp the drill path
header the WebHeader object

protected String getImgName (String fpName)

get the corresponding image name for a formal parameter representing an image

Parameters
fpName formal parameter name
Returns
  • image name

protected int getMaxSortAllowed ()

This method is deprecated.
Please check the maxSortAllowed formal parameter value instead.

get the max number of sorts

Returns
  • max number of sorts

protected String getPostTextForMetricValue ()

This method is deprecated.
Please check the postTextForMetricValue formal parameter value instead.

the text after displaying the metric value itself

Returns
  • the text after displaying the metric value itself

protected String getPostTextForNonMetricValue ()

This method is deprecated.
Please check the postTextForNonMetricValue formal parameter value instead.

the text after displaying the non-metric value itself

Returns
  • the text after displaying the non-metric value itself

protected String getPreTextForMetricValue ()

This method is deprecated.
Please check the preTextForMetricValue formal parameter value instead.

the text before displaying the metric value itself

Returns
  • the text before displaying the metric value itself

protected String getPreTextForNonMetricValue ()

This method is deprecated.
Please check the preTextForNonMetricValue formal parameter value instead.

the text before displaying the non-metric value itself

Returns
  • the text before displaying the non-metric value itself

protected String getRowValueDrillElements (WebRowValue rowValue)

protected String getRowValueDrillParametersForDHTML (ReportBean rb, WebDrillPath dp)

generate drilling url parameters for row value in DHTML mode

Parameters
rb the ReportBean object
dp the drill path
Returns
  • the url string

protected WebDrillPath getRowValueDrillPathWithHighImportance (ReportBean rb, WebRowValue rowValue)

generate drilling url parameters for row value in DHTML mode

Parameters
rb the ReportBean object
rowValue the WebRowValue object
Returns
  • The drill path with high importance

protected String getRowValueDrillURL (ReportBean rb, WebDrillPath dp, WebRowValue rowValue)

generate the output for drilling URL for row value

Parameters
rb the ReportBean object
dp the drill path
rowValue the WebRowValue object

protected int getShowDescriptionAsTooltip (String fpName)

get formal parameter value as an int value

Parameters
fpName formal parameter name
Returns
  • formal parameter value

protected boolean getSortStatus (String sSortID, String[][] appliedSorts)

get the sort statys

Parameters
sSortID sortID
appliedSorts the sort information array
Returns
  • whether the sortID is in the sort information array

protected String getTitleDrillParametersForDHTML (ReportBean rb, WebDrillPath dp, WebTitle title)

generate drilling url parameters for DHTML mode

Parameters
rb the ReportBean object
dp the drill path
title the WebTitle object
Returns
  • the url string

protected String getTitleDrillURL (ReportBean rb, WebDrillPath dp, WebTitle title)

generate the output for drilling URL for titles

Parameters
rb the ReportBean object
dp the drill path
title the WebTitle object

protected void initDNDForDesignMode (DragAndDropItem item)

protected void initDNDForExecuteMode (DragAndDropItem item)

protected void initDragAndDrop (DragAndDropItem item)

protected boolean isContextMenuEnabled ()

This method is deprecated.
Please check the isContextMenuEnabled formal parameter value instead.

is context menu featuer enabled

Returns
  • is context menu featuer enabled

protected boolean isDesignMode ()

is design mode or not

Returns
  • is design mode or not

protected boolean isDragAndDropEnabled ()

This method is deprecated.
Please check the isDragAndDropEnabled formal parameter value instead.

is drag and drop feature enabled

Returns
  • drag and drop feature enabled

protected boolean isFPTrue (String fpName, boolean defValue)

protected boolean isFPTrue (String fpName)

get formal parameter value as a boolean value

Parameters
fpName formal parameter name
Returns
  • formal parameter value

protected boolean isHeaderNeedLink (WebHeader header)

return whether to display link for drill

Parameters
header the WebHeader object
Returns
  • whether to display link for drill

protected boolean isIFrameEnabled ()

whether ifram is enabled

Returns
  • whether ifram is enabled

protected boolean isIFrameRequest ()

whether it's an iframe request

Returns
  • whether it's an iframe request

protected boolean isItemsAddedToContextMenu ()

return whether there is any item added to the context menu

Returns
  • whether there is any item added to the context menu

protected boolean isMetric ()

determine if the cell is containing a metric

Returns
  • whether the cell is containing a metric

protected 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

protected boolean isOutlineModeEnabled ()

is outline more feature enabled

Returns
  • is outline more feature enabled

protected boolean isRowValueNeedLink (WebRowValue rowValue)

return whether to display link for drill

Parameters
rowValue the WebRowValue object
Returns
  • whether to display link for drill

protected boolean isSortAscending (String sSortID, String[][] appliedSorts)

check if the sort is ascending

Parameters
sSortID the sort id
appliedSorts the sort information array
Returns
  • whether the sort is ascending

protected boolean isTitleNeedLink (WebTitle title)

return whether to display link for drill

Parameters
title the WebTitle object
Returns
  • whether to display link for drill

protected void setDescription (String description)

Sets the description for this cell.

Parameters
description description for this cell.

protected void setStyleForNonBuiltInFormat (String style, int rowOrdinal)

set the style for the cell when not using the built in report formatting

Parameters
style style name
rowOrdinal row ordial

protected boolean showBanding ()

This method is deprecated.
Please check the showBanding formal parameter value instead.

whether display banding for the report

Returns
  • whether display banding for the report

protected boolean showDrillAdvanced ()

This method is deprecated.
Please check the showDrillAdvanced formal parameter value instead.

whether display advanced drilling

Returns
  • whether display advanced drilling

protected boolean showDrillCheckBox ()

This method is deprecated.
Please check the showDrillCheckBox formal parameter value instead.

whether display checkbox for drill

Returns
  • whether display checkbox for drill

protected boolean showDrillDownOnly ()

This method is deprecated.
Please check the showDrillDownOnly formal parameter value instead.

whether only display drill down paths

Returns
  • whether only display drill down paths

protected boolean showDrillHyperlink ()

This method is deprecated.
Please check the showDrillHyperlink formal parameter value instead.

whether display drill link

Returns
  • whether display drill link

protected boolean showDrillHyperlinkMetric ()

This method is deprecated.
Please check the showDrillHyperlinkMetric formal parameter value instead.

whether display drill link for metric

Returns
  • whether display drill link for metric

protected boolean showDrillMetric ()

This method is deprecated.
Please check the showDrillMetric formal parameter value instead.

whether display drill on metric

Returns
  • whether display drill on metric

protected boolean showDrillRMC ()

This method is deprecated.
Please check the showDrillRMC formal parameter value instead.

whether display drill RMC (right mouse click context menu)

Returns
  • whether display drill RMC (right mouse click context menu)

protected boolean showDrillRMCMetric ()

This method is deprecated.
Please check the showDrillRMCMetric formal parameter value instead.

whether display drill RMC (right mouse click context menu) for metric

Returns
  • whether display drill RMC (right mouse click context menu) for metric

protected boolean showFilterOnSelectionCheckBox ()

This method is deprecated.
Please check the showFilterOnSelectionCheckBox formal parameter value instead.

whether display checkbox for filter on selection

Returns
  • whether display checkbox for filter on selection

protected boolean showFormattingRMC ()

This method is deprecated.
Please check the showFormattingRMC formal parameter value instead.

whether display formatting RMC (right mouse click context menu)

Returns
  • display formatting RMC (right mouse click context menu)

protected boolean showPivot ()

This method is deprecated.
Please check the showPivot formal parameter value instead.

whether display pivot buttons

Returns
  • whether display pivot buttons

protected boolean showPivotRMC ()

This method is deprecated.
Please check the showPivotRMC formal parameter value instead.

whether display pivot RMC (right mouse click context menu)

Returns
  • display pivot RMC (right mouse click context menu)

protected boolean showRemove ()

This method is deprecated.
Please check the showRemove formal parameter value instead.

whether display remove buttons

Returns
  • whether display remove buttons

protected boolean showRemoveRMC ()

This method is deprecated.
Please check the showRemoveRMC formal parameter value instead.

whether display remove RMC (right mouse click context menu)

Returns
  • display remove RMC (right mouse click context menu)

protected boolean showRenameRMC ()

This method is deprecated.
Please check the showRenameRMC formal parameter value instead.

whether display rename RMC (right mouse click context menu)

Returns
  • display rename RMC (right mouse click context menu)

protected boolean showSortButtonsForAttributes ()

This method is deprecated.
Please check the showSortButtonsForAttributes formal parameter value instead.

whether display sort buttons for attributes

Returns
  • whether display sort buttons for attributes

protected boolean showSortButtonsForMetrics ()

This method is deprecated.
Please check the showSortButtonsForMetrics formal parameter value instead.

whether display sort buttons for metrics

Returns
  • whether display sort buttons for metrics

protected boolean showSortRMCForAttributes ()

This method is deprecated.
Please check the showSortRMCForAttributes formal parameter value instead.

whether display sort RMC for attributes

Returns
  • whether display sort RMC for attributes

protected boolean showSortRMCForMetrics ()

This method is deprecated.
Please check the showSortRMCForMetrics formal parameter value instead.

whether display sort RMC for metrics

Returns
  • whether display sort RMC for metrics

protected boolean showSubTitle ()

whethere display sub title

Returns
  • whethere display sub title

protected boolean useBuiltInFormat ()

This method is deprecated.
Please check the useBuiltInFormat formal parameter value instead.

whether use report's built-in formatting, ie the formatting defined in the report definition.

Returns
  • whether use report's built-in formatting