public abstract class

AbstractReportGridDisplayCell

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

Class Overview

The AbstractReportGridDisplayCell is the base class for those that generate a grid's cell output in Microstrategy Web.

It serves as a place holder for common properties and logic, but most important is the one who controls the execution flow that generates a cell's HTML.

This class encloses every cell into a <TD> tag. The generateOutput(MarkupOutput) method generates the tag and its attributes, then it calls generateInnerHTML(MarkupOutput).

generateInnerHTML(MarkupOutput) divides the cell's inner content into three methods:

  1. generatePreContent(MarkupOutput): generates the content that goes before the cell's text, typically used for checkboxes needed for drilling or filter on selections
  2. generateContent(MarkupOutput): generates the cell core content, that is, the text displayed to the end user. It will generate the necessary <A> tag if this text needs a link (like in the case of drilling), and then call generateText(MarkupOutput) to render the text itself.
  3. generatePostContent(MarkupOutput): generates the content that coes after the cell's text, typically used for pivoting or sorting buttons.

    As an example, assume the following output from a ReportGridDisplayCell:

    output:
    Cell's text [>]
    underlying html (simplified): <td><input type="checkbox"><a href="#">Cell's text</a><a href="#">[>]</a></td>
    is generated by these methods:
    generateOutput(MarkupOutput)
    generateInnerHTML(MarkupOutput)
    generatePreContent(MarkupOutput) generateContent(MarkupOutput) generatePostContent(MarkupOutput)
    generateText(MarkupOutput)
    <td> <input type="checkbox"> <a href="#"> Cell's text </a> <a href="#">[>]</a> </td>

Summary

Nested Classes
class AbstractReportGridDisplayCell.Context Implements TransformContext
class AbstractReportGridDisplayCell.PivotButtonInfo  
Constants
String NO
String RETAIN_PARENT_FORMAL_PARAMETER
String RETAIN_THRESHOLDS_FORMAL_PARAMETER
String YES
[Expand]
Inherited Constants
From interface com.microstrategy.web.app.transforms.ReportGridDisplayCell
Fields
protected final String DISPLAY_CELL_CLASS
protected WebEvent _advDrillEditorProcessEvent This field is deprecated. Please use the get event methods defined on this class, its children, or on the transform that uses this class.
protected WebEvent _advdrillEvent This field is deprecated. Please use the get event methods defined on this class, its children, or on the transform that uses this class.
protected String[][] _appliedColSorts
protected String[][] _appliedSorts
protected AnchorTag _blankDrillAnchorTag
protected Map _cachedObjects This field is deprecated. The cached objects approach has been replaced with the TransformContext object. Please obtain the required information from the context object.
protected String _drillEditorName This field is deprecated. This property is no longer used in the logic of this class
protected WebEvent _drillEditorProcessEvent This field is deprecated. use getDefaultDrillEditorProcessEvent() instead
protected WebEvent _drillEvent This field is deprecated. use getDefaultDrillEvent() instead
protected WebEvent _drillFilterOnSelectionProcessEvent This field is deprecated. use getDefaultDrillFilterOnSelectionEvent() instead
protected String _imgBasePath
protected Boolean _isIFrameRequest This field is deprecated. please use the isIFrameRequest() method instead.
protected boolean _isNetscape
protected boolean _isWrapHeaderText
protected boolean _itemsAddedToContextMenu This field is deprecated. Context menus should be added by modifying the xml definition associated through the AbstractAppTransform's contextMenus formal parameter. Please see the MSDL context menu scenarios for the new approach.
protected int _maxColHeaderDepth This field is deprecated. please use getMaxColHeaderDepth() method instead
protected int _pivotImgHeight
protected int _pivotImgWidth
protected SharedCellProperties _sharedCellProperties
protected WebEvent _sortEvent This field is deprecated. Please use the get event methods defined on this class, its children, or on the transform that uses this class.
protected int _sortImgHeight
protected int _sortImgWidth
protected String _sortSubtotalColPosition
protected String _sortSubtotalPosition
protected String _sortSubtotalPostion
protected boolean _specifyIDForCell This field is deprecated. This property is no longer used in the logic of this class
protected boolean _specifyWidthForCell
protected String _text This field is deprecated. please use setText(String) and getText() instead
protected String _typicalURLBeanState
protected FormalParameters formalParas This field is deprecated. Please access the formal parameter information via the transform defined on the Context object of this instance.
protected ReportBean rb This field is deprecated. please use getBaseBean() instead, which will return ViewBean or ReportBean instance (for old usage).
Public Constructors
AbstractReportGridDisplayCell()
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
void addToStyle(String value)
Adds values to the STYLE attribute of the TD tag.
boolean canAddThresholds()
Utility methood for determining if the cell object is enabled for displaying the user the option to add threshold 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 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 apply a metric 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)

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

String getAccessibilityInfo()
This method is deprecated. addExtraAttribute(String, String) is used instead for specifying the accessibility information, for example, addExtraAttribute("scope", "row");
WebComponent getBaseBean()
Returns the base bean associated with this display cell.
String getCellID()
Returns the id for this cell, this will be used as the ID attribute of TD tag.
int getCellType()
This method is deprecated. The cell type is not significant anymore for the application.
int getColSpan()
Returns the column span for this cell as registered by the Transform.
WebEvent getControlElementSelectorEvent(RWControl control, String elementList)
Returns the WebEvent to drill from the cell to the given drill path.
WebEvent getDrillEvent(WebDrillPath dp, String elementId, WebTitle title)
Returns the WebEvent to drill from the cell to the given drill path.
String getDrillKey(WebDrillPath dp, WebTitle title)
This method is deprecated. 9.0.1 use getDrillpathKeyInOldFormat
static String getDrillPathKey(WebDrillPath dp, WebTitle title, ViewBean vb)
WebDrillPath getDrillPathWithHighImportance()
Obtain the Drill path with high importance information for the current cell being analyzed
static String getDrillpathKey(WebDrillPath dp, WebTitle title)
This method is deprecated. 9.0.1 use getDrillpathKeyInOldFormat
static String getDrillpathKeyInOldFormat(WebDrillPath dp, WebTitle title)
String getExtraInfo()
Returns the text assigned by the Transform as extra information of the cell.
String getExtraStyle()
Returns the extra style information required for the formatting of the cell as registered by the Transform.
String getExtraUrl()
get extra url for the cell
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()
int getMaxColHeaderDepth()
WebEvent getOpenFormatEditorEvent()
Get the event for opening the format editor for the requested target.
ReportBean getReportBean()
This method is deprecated. use getViewBean() instead
int getReportDesignMode()
This method is deprecated. Please check the reportDesignMode formal parameter value instead.
int getRowSpan()
Returns the row span for this cell as registered by the Transform, this is used as the ROWSPAN attribute of TD tag.
WebEvent getSetFormatEditorTargetEvent()
Get the event for setting the current target of the format editor to be this cell instance
String getStyle()
Returns the css class name associated with the cell as registered by the Transform.
WebSubTitle getSubTitle()
Returns the underlying SDK object associated with this cell.
int getSubtitleIndex()
If attribute forms are displayed, returns the position of the WebSubTitle within the subtitles collection.
String getText()

Returns the text content of this cell.

String getTooltip()
Returns the tooltip text for this cell as registered by the Transform.
ViewBean getViewBean()
Returns the view bean associated with this display cell
String getWidth()
Returns the width for this cell as registered by the Transform, this is used as the WIDTH attribute of TD tag.
void init(TransformContext transformContext)
Initializes the instance.
void init(WebComponent wc, HashMap cachedObjects)
This method is deprecated. use the init interface that receives a ReportGridTransformImpl.Context object
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).
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).
boolean isMetric()
Indicates if the underlying object of a cell is a metric header.
boolean isRW()
Indicates if the cell is being rendered in the context of report writing (documents).
void reset()
Reset all of the instance variables.
void setAccessibilityInfo(String accessibilityInfo)
This method is deprecated. please use addExtraAttribute(String, String) instead, for example, addExtraAttribute("scope", "row");
void setCellID(String cellID)
Registers the id for this cell, this is used as the ID attribute of TD tag.
void setCellType(int cellType)
This method is deprecated. The cell type is not significant anymore for the application.
void setColSpan(int colSpan)
Sets the col span for this cell
void setContent(String content)
Registers the main content of the 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)
Sets the drillPath for this cell.
void setExtraInfo(String extraInfo)
Registers any extra information that should be appended as part of the TD's open tag.
void setExtraStyle(String extraStyle, boolean append)
Updates values to the STYLE attribute of the TD tag.
void setExtraStyle(String extraStyle)
Registers any extra information required for the formatting of the cell.
void setExtraUrl(String value)
set extra url for the cell
void setHTML(String html)
Registers the HTML for this cell.
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)
void setPostContent(String postContent)
Registers the post-content of the cell.
void setPreContent(String preContent)
Registers the pre-content of the cell.
void setRowSpan(int rowSpan)
Registers the row span for this cell, this is used as the ROWSPAN attribute of TD tag.
void setStyle(String style)
Registers the css style name associated with the cell.
void setSubTitle(WebSubTitle subtitle)
Registers the underlying SDK object associated with this cell.
void setSubTitleIndex(int subtitleIndex)
Registers the position of the underlying WebSubTitle within the subtitles collection.
void setText(String text)

Registers the text content of this cell.

void setTooltip(String tooltip)
Registers the text for the tooltop of this cell.
void setWidth(String width)
Registers the width for this cell, this is used as WIDTH attribute of TD tag.
Protected Methods
void addContextMenuAttributes(Map atts, String menuName, int flag)
Adds into the Map instance the tag attributes required for processing context menus.
void addContextMenuAttributes(Map atts)
Adds into the Map instance the tag attributes required for processing context menus.
void addDragAndDropAttributes(Map atts)
Adds into the Map instance the tag attributes required to enable drag and drop operations.
void addToHeaderMetricValueJsonMap(String key, String value)
void addTooltipAttributes(Map attributes)
void appendContextMenuItems(ContextMenu menu)
This method is deprecated. Context menus should be added by modifying the xml definition associated through the AbstractAppTransform's contextMenus formal parameter.Please see the MSDL context menu scenarios for the new approach.
String buildGenericTooltipInformation()
Generate generic tooltip information for the current cell being rendered.
boolean canDefineDerivedElements()
boolean canUse(WebMetric m)
boolean cellNeedsLink()
Utility method for determining if the current cell being displayed needs to be a link or not, for example, in case of drilling available.
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().
AnchorTag generateAnchor(WebEvent event)
Creates an <a> tag from the EventManager with the Iframe information required if supported.
void generateContent(MarkupOutput mo)
Generates the core HTML for this cell.
void generateContextMenu(MarkupOutput out)
This method is deprecated. please use getContextMenu() instead
void generateDragAndDrop(MarkupOutput mo)
Generate drag and drop properties used in javascript.
Map generateDragAndDropAttributes()
This method is deprecated. Use addDragAndDropAttributes(Map)
boolean generateDrillCheckBox(MarkupOutput mo, ReportBean rb, WebHeader header)
This method is deprecated. Use method that doesn't receive the ReportBean as an argument.
void generateDrillCheckBox(MarkupOutput mo)
Generate the drill check box HTML information for this cell.
boolean generateDrillCheckBox(MarkupOutput mo, WebHeader header)
This method is deprecated. please use generateDrillCheckBoxTag() instead
Tag generateDrillCheckBoxTag()
Generates the tag information for a check box for drilling, if all privileges and conditions required are met
void generateDrillContextMenu(WebHeader header, WebTitle title, WebRowValue rowValue, StringBuffer sHeaderURL, ContextMenu rhMenu)
This method is deprecated. please use the new approach for generating context menu options. See ReportCellDrill
void generateDrillOpenLink(MarkupOutput mo, ReportBean rb, String url, String title, boolean javascriptUsedForDrill, String sElementID)
This method is deprecated. Use method that doesn't receive the ReportBean as an argument.
void generateDrillOpenLink(MarkupOutput mo, String url, String title, boolean javascriptUsedForDrill, String sElementID)
This method is deprecated. use generateAnchor(WebEvent) instead
boolean generateFilterOnSelectionCheckBox(MarkupOutput mo, WebHeader header)
This method is deprecated. please use generateFilterOnSelectionCheckBoxTag() instead
boolean generateFilterOnSelectionCheckBox(MarkupOutput mo, ReportBean rb, WebHeader header)
This method is deprecated. Use method that doesn't receive the ReportBean as an argument.
void generateFilterOnSelectionCheckBox(MarkupOutput mo)
Generate the filter on selections check box HTML information
Tag generateFilterOnSelectionCheckBoxTag()
Generates the tag information for a check box for filter on selection, if all privileges and conditions required are met
void generateHeaderDrillContextMenu(WebHeader header, StringBuffer sHeaderURL, ContextMenu rhMenu)
This method is deprecated. please use the new approach for generating context menu options. See ReportCellDrill
void generateHeaderDrillContextMenu(MarkupOutput mo, ReportBean rb, WebHeader header, StringBuffer sHeaderURL, ContextMenu rhMenu)
This method is deprecated. Use method that doesn't receive the ReportBean as an argument.
void generateHeaderSortContextMenu(WebHeader header, ContextMenu rhMenu)
This method is deprecated. please use generateSortContextMenu(ContextMenu) instead
void generateHeaderSortContextMenu(MarkupOutput mo, ReportBean rb, WebHeader header, ContextMenu rhMenu)
This method is deprecated. Use method that doesn't receive the ReportBean as an argument.
void generateInnerHTML(MarkupOutput mo)

This method generates the HTML that goes inside of the <TD> tag.

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.
abstract Tag generatePivotButton(int type)
void generatePivotButtons(MarkupOutput mo)
Generate pivot buttons.
void generatePostContent(MarkupOutput mo)

Generates the postContent of the cell.

void generatePreContent(MarkupOutput mo)

Generates the preContent of the cell.

void generateRowValueDrillContextMenu(MarkupOutput mo, ReportBean rb, WebRowValue rowValue, StringBuffer sHeaderURL, ContextMenu rhMenu)
This method is deprecated. Use method that doesn't receive the ReportBean as an argument.
void generateRowValueDrillContextMenu(WebRowValue rowValue, StringBuffer sHeaderURL, ContextMenu rhMenu)
This method is deprecated. please use the new approach for generating context menu options. See ReportCellDrill
void generateSortButton(MarkupOutput mo)
This method is deprecated. use generateSortButton() instead
Tag generateSortButton()
Generate the sort button tag information for this object
void generateSortContextMenu(ContextMenu rhMenu)
This method is deprecated. please use the new approach for generating context menu options. See ReportCellSort
void generateText(MarkupOutput mo)

Generates the text of the cell.

String generateThresholdSymbol(int thresholdValue)
Generates the HTML when the metric value is a "quick symbol" threshold.
void generateTitleDrillContextMenu(MarkupOutput mo, ReportBean rb, WebTitle title, StringBuffer sTitleURL, ContextMenu rhMenu)
This method is deprecated. Use method that doesn't receive the ReportBean as an argument.
void generateTitleDrillContextMenu(WebTitle title, StringBuffer sTitleURL, ContextMenu rhMenu)
This method is deprecated. please use the new approach for generating context menu options. See ReportCellDrill
void generateTitleSortContextMenu(MarkupOutput mo, ReportBean rb, WebTitle title, ContextMenu rhMenu)
This method is deprecated. Use method that doesn't receive the ReportBean as an argument.
void generateTitleSortContextMenu(WebTitle title, ContextMenu rhMenu)
This method is deprecated. please use generateSortContextMenu(ContextMenu) instead
void generateTooltip(MarkupOutput mo)
This method is deprecated. use generateTooltipContent() instead
String generateTooltipContent()
Generates the string with the tooltip information to be assigned to the TITLE attribute of the cell tag for this instance
void generateTooltipForHeaders(MarkupOutput mo)
This method is deprecated. please use the corresponding generateTooltip(MarkupOutput) method of the cell class instance (from the AbstractReportGridCellHeader hierarchy).
void generateTooltipForRowValue(MarkupOutput mo)
This method is deprecated. please use the corresponding generateTooltip(MarkupOutput) method of the cell class instance (from the ReportGridCellMetricValueImpl hierarchy).
void generateTooltipForTitles(MarkupOutput mo)
This method is deprecated. please use the corresponding generateTooltip(MarkupOutput) method of the cell class instance (from the AbstractReportGridCellTitle hierarchy).
void getCellAttributes(Map attributes)
void getCellLevelAttributes(Map cell)
Obtains the type of cell and the grid title index that it belongs to
WebMetric getColHeaderWebMetric(WebHeader header)
This method is deprecated. please refer to the getWebMetric method on the ReportGridCellColHeaderImpl class.
TransformContext getContext(TransformContext transformContext)
TransformContext getContext()
Returns the instance of TransformContext with context information for this Transform.
ContextMenu getContextMenu(String menuName)
Returns the corresponding context-menu.
ContextMenu getContextMenu()
Returns the context menu instance for this cell.
Map getContextMenuAttributes()
This method is deprecated. Use addContextMenuAttributes(Map)
Map getContextMenuAttributes(String menuName, int flag)
This method is deprecated. Use addContextMenuAttributes(Map)
ContextMenuManager getContextMenuManager()
get the ContextMenuManager object
String getCssPrefix()
This method is deprecated. Please check the cssPrefix formal parameter value instead.
WebEvent getDefaultAdvancedDrillEvent()
WebEvent getDefaultAdvancedDrillProcessEvent()
WebEvent getDefaultDrillEditorProcessEvent()
WebEvent getDefaultDrillEvent(WebDrillPath dp)
WebEvent getDefaultDrillEvent()
WebEvent getDefaultDrillFilterOnSelectionEvent()
WebEvent getDefaultSortEvent()
WebEvent getDerivedElementsEvent(int key)
String getDescription()
Returns the text registered as the description of the underlying web object associated with this cell.
String getDescriptor(int key)
Get descriptor for this key
String getDescriptor(ReportBean rb, int key)
This method is deprecated. Use method that doesn't receive the ReportBean as an argument.
String getDrillParametersForDHTML(WebDrillPath dp, WebTitle title)
Returns parameters required for drilling when using javascript for WebTitle cells.
String getDrillPath()
Returns the drillPath associated with this cell.
EventManager getEventManager()
get the EventManager object
int getFPIntValue(String fpName)
Returns tha value of a formal parameter which has an integer value
String getFPStringValue(String fpName)
Returns tha value of a formal parameter which has a string value
WebEvent getFilterOnEvent(WebObjectInfo targetObject, String alias)
ReportGridDisplayCell getGridCell(String className)
Creates a new instance of a ReportGridDisplayCell
String getHeaderDrillParametersForDHTML(ReportBean rb, WebDrillPath dp, WebHeader header)
This method is deprecated. Use method that doesn't receive the ReportBean as an argument.
String getHeaderDrillParametersForDHTML(WebDrillPath dp, WebHeader header)
This method is deprecated. please use the corresponding getDrillParametersForDHTML(WebDrillPath, WebTitle) interface, depending if it's a header or a title being handled.
WebDrillPath getHeaderDrillPathWithHighImportance(WebHeader header)
This method is deprecated. please use getDrillPathWithHighImportance() instead
WebDrillPath getHeaderDrillPathWithHighImportance(ReportBean rb, WebHeader header)
This method is deprecated. Use method that doesn't receive the ReportBean as an argument.
String getHeaderDrillURL(ReportBean rb, WebDrillPath dp, WebHeader header)
This method is deprecated. Use method that doesn't receive the ReportBean as an argument.
String getHeaderDrillURL(WebDrillPath dp, WebHeader header)
This method is deprecated. use generateAnchor(WebEvent) instead
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.
WebHeader getNearestNonMetricRowHeader(WebRowValue rowValue)
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.
WebEvent getRWDDrillOutEvent()
WebEvent getRenameEvent(int key)
Get the event for renaming the current cell
ReportGridTransformImpl getReportGridTransform()
Utility method for returning the ReportGridTransformImpl instance associated with the context of this object
String getRowValueDrillElements(WebRowValue rowValue)
String getRowValueDrillParametersForDHTML(ReportBean rb, WebDrillPath dp)
This method is deprecated. Use method that doesn't receive the ReportBean as an argument.
String getRowValueDrillParametersForDHTML(WebDrillPath dp)
This method is deprecated. please use the getDrillParametersForDHTML(WebDrillPath, WebTitle) corresponding interface.
WebDrillPath getRowValueDrillPathWithHighImportance(WebRowValue rowValue)
This method is deprecated. please use getDrillPathWithHighImportance() instead
WebDrillPath getRowValueDrillPathWithHighImportance(ReportBean rb, WebRowValue rowValue)
This method is deprecated. Use method that doesn't receive the ReportBean as an argument.
String getRowValueDrillURL(ReportBean rb, WebDrillPath dp, WebRowValue rowValue)
This method is deprecated. Use method that doesn't receive the ReportBean as an argument.
String getRowValueDrillURL(WebDrillPath dp, WebRowValue rowValue)
This method is deprecated. use generateAnchor(WebEvent) instead
WebEvent getSelectorEvent()
get the selector Event to gnereate the anchor in HTML mode
int getShowDescriptionAsTooltip(String fpName)
This method is deprecated. Please check the showDescriptionAsTooltip formal parameter value instead.
WebEvent getSortAscendingEvent()
WebEvent getSortDescendingEvent()
WebEvent getSortEvent()
This method is deprecated. Please use getSortEvent(int axis EnumViewBeanEvents)
WebEvent getSortEventByAxis(int axis)
WebEvent getSortEventByAxisBySortOrder(int axis, int sortOrder)
abstract String getSortID()
This method return the ID to use for sorting this cell.
boolean getSortStatus(String sSortID, String[][] appliedSorts)
get the sort status
String getStyleForNonBuiltInFormat(String style, int rowOrdinal)
String getTargetKeys(RWControl ctl, boolean[] usePartialDisplay)
String getTitleDrillParametersForDHTML(WebDrillPath dp, WebTitle title)
This method is deprecated. please use the getDrillParametersForDHTML(WebDrillPath, WebTitle) interface instead
String getTitleDrillParametersForDHTML(ReportBean rb, WebDrillPath dp, WebTitle title)
This method is deprecated. Use method that doesn't receive the ReportBean as an argument.
String getTitleDrillURL(ReportBean rb, WebDrillPath dp, WebTitle title)
This method is deprecated. Use method that doesn't receive the ReportBean as an argument.
String getTitleDrillURL(WebDrillPath dp, WebTitle title)
This method is deprecated. use generateAnchor(WebEvent) instead
boolean groupContextMenuDrillPathsByType()
This method is deprecated. Please check the groupContextMenuDrillPathsByType formal parameter value instead.
boolean hasDrillPathsWithHighImportanceAvailable(WebDrillMap wdm)
Helper method to determine if there are drill paths with high importance available for the current cell being rendered
boolean hasMetricFilterCondition()
abstract boolean hasWebObject()
This method allows the abstract class to identify whether the cell has been initialized with a valid WebObject.
void initCell()
Initialize the cell title information
void initDNDForDesignMode(DragAndDropItem item)
This method initializes properties used in javascript for drag and drop in design mode.
void initDNDForExecuteMode(DragAndDropItem item)
This method initializes properties used in javascript for drag and drop in view mode.
void initDragAndDrop(DragAndDropItem item)
This method initializes properties used in javascript for drag and drop.
boolean isAccessibilityMode()
Indicates if the Transform is rendering data in accessibility (508) mode
boolean isContextMenuEnabled()
This method is deprecated. Please check the isContextMenuEnabled formal parameter value instead.
boolean isContextMenusEnabled()
boolean isDerivedMetric(WebMetric m)
boolean isDesignMode()
Indicates if the Transform is rendering data in design mode
boolean isDhtml()
Indicates if DHTML (javascript) is enabled
boolean isDragAndDropEnabled()
This method is deprecated. Please check the isDragAndDropEnabled formal parameter value instead.
boolean isFPTrue(String fpName, boolean defValue)
Returns tha value of a formal parameter which has a boolean value.
boolean isFPTrue(String fpName)
Returns tha value of a formal parameter which has a boolean value.
boolean isFeatureAvailable(String name)
Checks if the given feature is available.
boolean isHeaderMVJsonMovable()
boolean isHeaderNeedLink(WebHeader header)
This method is deprecated. please use cellNeedsLink()
boolean isIFrameEnabled()
This method is deprecated. use isIframeEnabled()
boolean isIFrameRequest()
This method is deprecated. use isIframeRequest
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 isMetricDrillable(WebHeader header, WebDrillPath drillPath)
return whether the header has a drillable metric
boolean isOutlineModeEnabled()
Indicates whether outline more is enabled for this transform
boolean isRemoveAvailable()
This method is deprecated. please use canRemoveFromGrid() or canRemoveFromReport()
boolean isRowValueNeedLink(WebRowValue rowValue)
This method is deprecated. please use cellNeedsLink()
boolean isSortAscending(String sSortID, String[][] appliedSorts)
check if the sort is ascending
boolean isTitleNeedLink(WebTitle title)
This method is deprecated. please use cellNeedsLink()
TransformContext newContext(TransformContext transformContext)
Creates a new instance of a TransformContext.
NamespaceEncoder newNamespaceEncoder()
Convenience method to retrieve a new Namespace Encoder object from the stored AppContext.
void renderContextMenu(MarkupOutput mo)
This method is deprecated. use getContextMenuAttributes() instead
void renderPivotButtons(MarkupOutput mo)
void setArgumentFromFormalParameter(WebEvent event, int argumentID, String paramName)
void setDescription(String description)

Registers the description of the underlying web object associated with this cell.

void setStyleForNonBuiltInFormat(String style, int rowOrdinal)
set the style for the cell when not using the built in report formatting
boolean shouldHiliteOnServer()
Indicate if it's necessary to hilight the selected element on server side.
boolean showAdvancedDrillingOptionsInContextMenu()
This method is deprecated. Please check the advancedDrillingContextMenuDisplay formal parameter value instead.
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 showDrillPathSetNamesSubMenuAtTopLevel()
This method is deprecated. Please check the showDrillPathSetNamesSubMenuAtTopLevel 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 showExtraRemoveRMC()
This method is deprecated. Please check the showExtraRemoveRMC 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 showRemoveFromReport(int metricSize, int wkSetSize)
Determine if we should show the 'Remove from Report' option depending on the number of metrics and the working set size
boolean showRemoveFromReport()
Determine whether to show the 'Remove from Report' option according to the objects already defined on the template.
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()
This method is deprecated. Use showSubtitle instead.
boolean showSubtitle()
Indicates whether to display sub titles (attribute forms).
boolean sortSetNamesAndDrillPaths()
This method is deprecated. Please check the sortSetNamesAndDrillPaths formal parameter value instead.
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

Constants

protected static final String NO

Constant Value: "0"

protected static final String RETAIN_PARENT_FORMAL_PARAMETER

Constant Value: "drillRetainParent"

protected static final String RETAIN_THRESHOLDS_FORMAL_PARAMETER

Constant Value: "drillRetainThresholds"

protected static final String YES

Constant Value: "1"

Fields

protected final String DISPLAY_CELL_CLASS

Constant Value: "com.microstrategy.web.app.transforms.ReportGridDisplayCellImpl"

protected WebEvent _advDrillEditorProcessEvent

This field is deprecated.
Please use the get event methods defined on this class, its children, or on the transform that uses this class.

protected WebEvent _advdrillEvent

This field is deprecated.
Please use the get event methods defined on this class, its children, or on the transform that uses this class.

protected String[][] _appliedColSorts

protected String[][] _appliedSorts

protected AnchorTag _blankDrillAnchorTag

protected Map _cachedObjects

This field is deprecated.
The cached objects approach has been replaced with the TransformContext object. Please obtain the required information from the context object.

protected String _drillEditorName

This field is deprecated.
This property is no longer used in the logic of this class

protected WebEvent _drillEditorProcessEvent

This field is deprecated.
use getDefaultDrillEditorProcessEvent() instead

protected WebEvent _drillEvent

This field is deprecated.
use getDefaultDrillEvent() instead

protected WebEvent _drillFilterOnSelectionProcessEvent

This field is deprecated.
use getDefaultDrillFilterOnSelectionEvent() instead

protected String _imgBasePath

protected Boolean _isIFrameRequest

This field is deprecated.
please use the isIFrameRequest() method instead.

protected boolean _isNetscape

protected boolean _isWrapHeaderText

protected boolean _itemsAddedToContextMenu

This field is deprecated.
Context menus should be added by modifying the xml definition associated through the AbstractAppTransform's contextMenus formal parameter. Please see the MSDL context menu scenarios for the new approach.

See Also

protected int _maxColHeaderDepth

This field is deprecated.
please use getMaxColHeaderDepth() method instead

protected int _pivotImgHeight

protected int _pivotImgWidth

protected SharedCellProperties _sharedCellProperties

protected WebEvent _sortEvent

This field is deprecated.
Please use the get event methods defined on this class, its children, or on the transform that uses this class.

protected int _sortImgHeight

protected int _sortImgWidth

protected String _sortSubtotalColPosition

protected String _sortSubtotalPosition

protected String _sortSubtotalPostion

protected boolean _specifyIDForCell

This field is deprecated.
This property is no longer used in the logic of this class

protected boolean _specifyWidthForCell

protected String _text

This field is deprecated.
please use setText(String) and getText() instead

protected String _typicalURLBeanState

protected FormalParameters formalParas

This field is deprecated.
Please access the formal parameter information via the transform defined on the Context object of this instance.

protected ReportBean rb

This field is deprecated.
please use getBaseBean() instead, which will return ViewBean or ReportBean instance (for old usage).

Public Constructors

public AbstractReportGridDisplayCell ()

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 void addToStyle (String value)

Adds values to the STYLE attribute of the TD tag. The style assigned this way will only apply to this cell. Information added through this method is appended to other information currently assigned to this attribute.

Parameters
value The text to add

public boolean canAddThresholds ()

Utility methood for determining if the cell object is enabled for displaying the user the option to add threshold 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 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 apply a metric 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)

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.

Developers can overwrite the generateOutput(MarkupOutput) method to set any text they want to display for the 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");

Returns any extra information registered by the Transform 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 WebComponent getBaseBean ()

Returns the base bean associated with this display cell. The base bean should be used to calculate features and other general functionality from the underlying WebComponent.

Returns
  • the base bean

public String getCellID ()

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

Returns
  • the id for this cell

public int getCellType ()

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

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

public int getColSpan ()

Returns the column span for this cell as registered by the Transform. This is used as the COLSPAN attribute of TD tag.

Returns
  • The cell's col span

public WebEvent getControlElementSelectorEvent (RWControl control, String elementList)

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

Parameters
control RWControl
elementList String

public WebEvent getDrillEvent (WebDrillPath dp, String elementId, WebTitle title)

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

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

public String getDrillKey (WebDrillPath dp, WebTitle title)

This method is deprecated.
9.0.1 use getDrillpathKeyInOldFormat

public static String getDrillPathKey (WebDrillPath dp, WebTitle title, ViewBean vb)

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 static String getDrillpathKey (WebDrillPath dp, WebTitle title)

This method is deprecated.
9.0.1 use getDrillpathKeyInOldFormat

public static String getDrillpathKeyInOldFormat (WebDrillPath dp, WebTitle title)

public String getExtraInfo ()

Returns the text assigned by the Transform as extra information of the cell. This text is appended to the TD's open tag.

Returns
  • The extra info for this cell

public String getExtraStyle ()

Returns the extra style information required for the formatting of the cell as registered by the Transform. This text is assigned to the STYLE attribute of the TD tag.

Returns
  • The extra style info as registered by the Transform.

public String getExtraUrl ()

get extra url for the cell

Returns
  • extra url for the cell

public 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 returns the cell's text content.

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

public int getMaxColHeaderDepth ()

public WebEvent getOpenFormatEditorEvent ()

Get the event for opening the format editor for the requested target.

Returns
  • WebEvent initialized instance. If it could not be generated, it will return null

public ReportBean getReportBean ()

This method is deprecated.
use getViewBean() instead

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 EnumReportDesignMode

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

public int getRowSpan ()

Returns the row span for this cell as registered by the Transform, this is used as the ROWSPAN attribute of TD tag.

Returns
  • The cell's 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 class name associated with the cell as registered by the Transform.
If set, this is the one assigned to the CLASS attribute of the TD tag to control its formatting.

Returns
  • The css class name as registered by the Transform.

public WebSubTitle getSubTitle ()

Returns the underlying SDK object associated with this cell. If the report is in execute mode and attribute forms are displayed, it returns the corresponding WebSubTitle; when in design mode, this returns null.
It always returns null if the instance represents an empty cell.

Returns
  • The underlying SDK object.

public int getSubtitleIndex ()

If attribute forms are displayed, returns the position of the WebSubTitle within the subtitles collection.

Returns
  • The WebSubTitle position

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

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

Returns
  • The cell's Tooltip text.

public ViewBean getViewBean ()

Returns the view bean associated with this display cell

Returns
  • the view bean

public String getWidth ()

Returns the width for this cell as registered by the Transform, this is used as the WIDTH attribute of TD tag.

Returns
  • The cell's width

public void init (TransformContext transformContext)

Initializes the instance.

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

Indicates if the underlying object of a cell is a metric header.

Returns
  • whether the cell is containing a metric

public boolean isRW ()

Indicates if the cell is being rendered in the context of report writing (documents).

Returns
  • true if parent of the base bean is a RWBean

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)

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 void setCellID (String cellID)

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

Parameters
cellID The cell's ID

public void setCellType (int cellType)

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

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

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)

Registers the main content of the cell. When a non-null content is registered, the content of the cell is replaced by this text and the cell does not call the generateContent method.

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.

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

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

public void setDrillPath (String drillPath)

Sets the drillPath for this cell. This is used to generate the drill link of the cell.

Parameters
drillPath String

public 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 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 setExtraStyle (String extraStyle)

Registers any extra information required for the formatting of the cell.
This text is assigned to the STYLE attribute of the TD tag. The style assigned this way will only apply to this cell. Notice this method actually replaces the value of the style attribute with the provided parameter. If you actually require to add more information to the style attribute, you should use the addToStyle(String) method instead.

Parameters
extraStyle The text to use

public void setExtraUrl (String value)

set extra url for the cell

Parameters
value extra url for the cell

public void setHTML (String html)

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

Parameters
html The complete HTML string for this cell

public 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 is replaced by this text and the cell does not call the generateInnerHTML method.

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

public void setPostContent (String postContent)

Registers the post-content of the cell. When a non-null content is registered, the post-content of the cell is replaced by this text and the cell does not call the generatePostContent method.

Parameters
postContent post-content for this cell

public void setPreContent (String preContent)

Registers the pre-content of the cell. When a non-null content is registered, the pre-content of the cell is replaced by this text and the cell does not call the generatePreContent method.

Parameters
preContent pre-content for this cell

public void setRowSpan (int rowSpan)

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

Parameters
rowSpan row span

public void setStyle (String style)

Registers the css style name associated with the cell.
This text will 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 void setSubTitle (WebSubTitle subtitle)

Registers the underlying SDK object associated with this cell. If the report is in execute mode and attribute forms are displayed, the Transform calls this method to associate a WebSubTitle with the cell.

Parameters
subtitle The corresponding WebSubTitle to associate with the cell.

public void setSubTitleIndex (int subtitleIndex)

Registers the position of the underlying WebSubTitle within the subtitles collection.

Parameters
subtitleIndex the position of the corresponding WebSubTitle

public void setText (String text)

Registers the text content of this cell. When a non-null text is registered, this text is used as the core content of the cell.

Parameters
text text for this cell

public void setTooltip (String tooltip)

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

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

public void setWidth (String width)

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

Parameters
width text for this cell

Protected Methods

protected void addContextMenuAttributes (Map atts, String menuName, int flag)

Adds into the Map instance the tag attributes required for processing context menus.

Parameters
atts Map where attributes will be appended.
menuName The context-menu name, the name should correspond to a valid <shortcut-list> from the context-menus' xml definition, otherwise "default" is used.
flag The infoFlag attribute of the addTagAttributes(Map) method.

protected void addContextMenuAttributes (Map atts)

Adds into the Map instance the tag attributes required for processing context menus.

Parameters
atts Map where attributes will be appended.

protected void addDragAndDropAttributes (Map atts)

Adds into the Map instance the tag attributes required to enable drag and drop operations.

Parameters
atts Map where attributes will be appended.

protected void addToHeaderMetricValueJsonMap (String key, String value)

protected void addTooltipAttributes (Map attributes)

protected void appendContextMenuItems (ContextMenu menu)

This method is deprecated.
Context menus should be added by modifying the xml definition associated through the AbstractAppTransform's contextMenus formal parameter.Please see the MSDL context menu scenarios for the new approach.

See Also

protected String buildGenericTooltipInformation ()

Generate generic tooltip information for the current cell being rendered. Might include description, drill and generic hints as enabled and available.

Returns
  • String value with the tooltip information that can be added to the cell HTML output.

protected boolean canDefineDerivedElements ()

protected boolean canUse (WebMetric m)

protected boolean cellNeedsLink ()

Utility method for determining if the current cell being displayed needs to be a link or not, for example, in case of drilling available.

Returns
  • boolean value indicating if the current cell should be displayed as a link.

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 (based on the preference value)

Returns
  • Whether to HTML-encode metric values.

protected AnchorTag generateAnchor (WebEvent event)

Creates an <a> tag from the EventManager with the Iframe information required if supported.

Parameters
event the WebEvent to generate the link with the request
Returns
  • AnchorTag instance initialized with the information from the event

protected void generateContent (MarkupOutput mo)

Generates the core HTML for this cell. By default, this method just calls the generateText to include the cell's text.

Developers can either use the setContent(String) method to set any text they want to display for the contents of the cell or override this method to inherit its functionality and build on top of it.

The following is an example of the code that is executed by this method:

 public void generateContent(MarkupOutput mo) {
     generateText(mo);
 }
 

As an example, the following code could be used to extend this method to add a <BR> tag after content in any of the classes that extend AbstractReportGridDisplayCell:

 public void generateContent(MarkupOutput mo) {
     super.generateContent(mo);

     mo.append("<br>");
 }
 

Parameters
mo the output object

protected void generateContextMenu (MarkupOutput out)

This method is deprecated.
please use getContextMenu() instead

Generate the context menu for this cell.

Parameters
out the output object

protected void generateDragAndDrop (MarkupOutput mo)

Generate drag and drop properties used in javascript.

Parameters
mo the output object

protected Map generateDragAndDropAttributes ()

This method is deprecated.
Use addDragAndDropAttributes(Map)

Returns a Map with the tag attributes that should be added to the cell's definition to enable drag and drop operations.
Notice this method has been deprecated for performance reasons. If it's necessary to include extra attributes related to context-menus override the addDragAndDropAttributes(Map) method. Although this method is still invoked under normal cell execution, it now returns null. If a subclass overrides this method and returns a Map instance, the members of the Map are appended to the cell's tag attributes.

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

This method is deprecated.
Use method that doesn't receive the ReportBean as an argument.

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 HTML information for this cell.

Parameters
mo the output object

protected boolean generateDrillCheckBox (MarkupOutput mo, WebHeader header)

This method is deprecated.
please use generateDrillCheckBoxTag() instead

generate output for checkboxes for drill

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

protected Tag generateDrillCheckBoxTag ()

Generates the tag information for a check box for drilling, if all privileges and conditions required are met

Returns
  • Tag instance initialized with the information of a check box for requesting drill manipulations. If not enabled or available, returns null

protected void generateDrillContextMenu (WebHeader header, WebTitle title, WebRowValue rowValue, StringBuffer sHeaderURL, ContextMenu rhMenu)

This method is deprecated.
please use the new approach for generating context menu options. See ReportCellDrill

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

This method is deprecated.
Use method that doesn't receive the ReportBean as an argument.

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 void generateDrillOpenLink (MarkupOutput mo, String url, String title, boolean javascriptUsedForDrill, String sElementID)

This method is deprecated.
use generateAnchor(WebEvent) instead

Generate open anchor for drill link for header elements

Parameters
mo the MarkupOutput 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, WebHeader header)

This method is deprecated.
please use generateFilterOnSelectionCheckBoxTag() instead

generate output for the checkbox for Filter on Selections

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

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

This method is deprecated.
Use method that doesn't receive the ReportBean as an argument.

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 selections check box HTML information

Parameters
mo the output object

protected Tag generateFilterOnSelectionCheckBoxTag ()

Generates the tag information for a check box for filter on selection, if all privileges and conditions required are met

Returns
  • Tag instance initialized with the information of a check box for requesting a filter on selection manipulations. If not enabled or available, returns null

protected void generateHeaderDrillContextMenu (WebHeader header, StringBuffer sHeaderURL, ContextMenu rhMenu)

This method is deprecated.
please use the new approach for generating context menu options. See ReportCellDrill

Generate the drilling context menus for cells that use WebHeader as their underlying SDK object.

Parameters
header the WebHeader object
sHeaderURL the header's url
rhMenu the context menu object

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

This method is deprecated.
Use method that doesn't receive the ReportBean as an argument.

Generate the drilling context menus for cells that use WebHeader as their underlying SDK object.

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 (WebHeader header, ContextMenu rhMenu)

This method is deprecated.
please use generateSortContextMenu(ContextMenu) instead

Generate the sort context menus for cells that use WebHeader as their underlying SDK object.

Parameters
header the WebHeader object
rhMenu the context menu object

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

This method is deprecated.
Use method that doesn't receive the ReportBean as an argument.

Generate the sort context menus for cells that use WebHeader as their underlying SDK object.

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

protected void generateInnerHTML (MarkupOutput mo)

This method generates the HTML that goes inside of the <TD> tag. It divides the output by calling three methods:

  1. generateContent: generates the core portion of the HTML, it include the cell's text and its corresponding HTML.
  2. generatePreContent: generates the HTML that goes before the content. This is used to generate the checkboxes for drilling.
  3. generatePostContent: generates the HTML that goes after the content. This is used to generate sorting and pivoting buttons.

Developers can either use the setInnerHTML(String) method to set any text they want for the inner HTML or override this method to inherit its functionality and build on top of it.

The following is an example of the code that is executed by this method:
 protected void generateInnerHTML(MarkupOutput mo) {
     generatePreContent(mo);
     generateContent(mo);
     generatePostContent(mo);
 }
 

Parameters
mo the output object

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 abstract Tag generatePivotButton (int type)

protected void generatePivotButtons (MarkupOutput mo)

Generate pivot buttons.

Parameters
mo the output object

protected void generatePostContent (MarkupOutput mo)

Generates the postContent of the cell. The post-Content means the html content after the core content of the cell. Usually this method generates sort and pivot buttons as well as subtotals for outline mode.

Developers can either use the setPostContent(String) method to set any text they want to display after the contents of the cell or override this method to inherit its functionality and build on top of it.

For example, the following code could be used to extend this method to add a submit button after the cell content in any of the classes that extend AbstractReportGridDisplayCell:
 public void generatePostContent(MarkupOutput mo) {
     super.generatePostContent(mo);

     mo.append("<INPUT TYPE=\"SUBMIT\" NAME=\"Submit request\" />");
 }
 

Parameters
mo the output object

protected void generatePreContent (MarkupOutput mo)

Generates the preContent of the cell. The pre-Content means the html content before the core content of the cell. An example would be a checkbox before the text.
By default, this method generates images for grids in outline mode, drilling checkboxes and filter on selection checkboxes.

Developers can either use the setPreContent(String) method to set any text they want to display before the contents of the cell or override this method to inherit its functionality and build on top of it.

For example, the following code could be used to extend this method to add a <LI> tag before the cell content in any of the classes that extend AbstractReportGridDisplayCell:
 public void generatePreContent(MarkupOutput mo) {
     super.generatePreContent(mo);

     mo.append("<LI>");
 }
 

Parameters
mo the output object

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

This method is deprecated.
Use method that doesn't receive the ReportBean as an argument.

Generate the drilling context menus for cells that use WebRowValue as their underlying SDK object.

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 generateRowValueDrillContextMenu (WebRowValue rowValue, StringBuffer sHeaderURL, ContextMenu rhMenu)

This method is deprecated.
please use the new approach for generating context menu options. See ReportCellDrill

Generate the drilling context menus for cells that use WebRowValue as their underlying SDK object.

Parameters
rowValue the WebRowValue object
sHeaderURL the header's url
rhMenu the context menu object

protected void generateSortButton (MarkupOutput mo)

This method is deprecated.
use generateSortButton() instead

Generate sort button for this cell.

Parameters
mo the output object

protected Tag generateSortButton ()

Generate the sort button tag information for this object

Returns
  • Tag instance initialized if sort is supported.

protected void generateSortContextMenu (ContextMenu rhMenu)

This method is deprecated.
please use the new approach for generating context menu options. See ReportCellSort

protected void generateText (MarkupOutput mo)

Generates the text of the cell. This is the the text that gets displayed by the browser.

Developers can either use the setText(String) method to set any text they want to display for the cell or override this method to inherit its functionality and build on top of it.

For example, the following code could be used to extend this method to render a hyphen if the cell content is empty:
 public void generateText(MarkupOutput mo) {
     String text = getText();

     if ("".equals(text) || "&nbsp;".equals(text)) {
         mo.append("-");
     } else {
         super.generateText(mo);
     }

 }
 

Parameters
mo the output object

protected String generateThresholdSymbol (int thresholdValue)

Generates the HTML when the metric value is a "quick symbol" threshold.

Parameters
thresholdValue the threshold id. A value from EnumDSSXMLSymbol.

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

This method is deprecated.
Use method that doesn't receive the ReportBean as an argument.

Generate the drilling context menus for cells that use WebTitle as their underlying SDK object.

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 generateTitleDrillContextMenu (WebTitle title, StringBuffer sTitleURL, ContextMenu rhMenu)

This method is deprecated.
please use the new approach for generating context menu options. See ReportCellDrill

Generate the drilling context menus for cells that use WebTitle as their underlying SDK object.

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

This method is deprecated.
Use method that doesn't receive the ReportBean as an argument.

Generate the sort context menus for cells that use WebTitle as their underlying SDK object.

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

protected void generateTitleSortContextMenu (WebTitle title, ContextMenu rhMenu)

This method is deprecated.
please use generateSortContextMenu(ContextMenu) instead

Generate the sort context menus for cells that use WebTitle as their underlying SDK object.

Parameters
title the WebTitle object
rhMenu the context menu object

protected void generateTooltip (MarkupOutput mo)

This method is deprecated.
use generateTooltipContent() instead

Generate the tooltip HTML attribute information for this cell.

Parameters
mo the output object

protected String generateTooltipContent ()

Generates the string with the tooltip information to be assigned to the TITLE attribute of the cell tag for this instance

Returns
  • String with the information about the tooltip to render for the current cell.

protected void generateTooltipForHeaders (MarkupOutput mo)

This method is deprecated.
please use the corresponding generateTooltip(MarkupOutput) method of the cell class instance (from the AbstractReportGridCellHeader hierarchy).

Generate the tool tip for cellS that uses a WebHeader as their underlying SDK object (for example, ReportGridCellRowHeaderImpl and ReportGridCellColHeaderImpl).

Parameters
mo the output object

protected void generateTooltipForRowValue (MarkupOutput mo)

This method is deprecated.
please use the corresponding generateTooltip(MarkupOutput) method of the cell class instance (from the ReportGridCellMetricValueImpl hierarchy).

Generate the tool tip for cells that use a WebRowValue as their underlying SDK object (for example ReportGridCellMetricValueImpl).

Parameters
mo the output object

protected void generateTooltipForTitles (MarkupOutput mo)

This method is deprecated.
please use the corresponding generateTooltip(MarkupOutput) method of the cell class instance (from the AbstractReportGridCellTitle hierarchy).

Generate the tool tip for cellS that use a WebTitle as their underlying SDK object (for example, ReportGridCellRowTitleImpl and ReportGridCellColTitleImpl).

Parameters
mo the output object

protected void getCellAttributes (Map attributes)

protected void getCellLevelAttributes (Map cell)

Obtains the type of cell and the grid title index that it belongs to

protected WebMetric getColHeaderWebMetric (WebHeader header)

This method is deprecated.
please refer to the getWebMetric method on the ReportGridCellColHeaderImpl class.

get the metric object for the column header

Parameters
header the column header
Returns

protected TransformContext getContext (TransformContext transformContext)

protected TransformContext getContext ()

Returns the instance of TransformContext with context information for this Transform.

See Also

protected ContextMenu getContextMenu (String menuName)

Returns the corresponding context-menu. If a valid ContextMenu has been provided, the transform will use it to populate the context-menu, otherwise it will return an empty ContextMenu instance.

Parameters
menuName Name of the context-menu
Returns
  • ContextMenu instance related with the name requested. If not found, it will be an empty instance returned.

protected ContextMenu getContextMenu ()

Returns the context menu instance for this cell. The cell should add menu items to this ContextMenu, this will be displayed to the end user when the it clicks over a cell with the mouse's right button.

Returns
  • The ContextMenu for this cell.

protected Map getContextMenuAttributes ()

This method is deprecated.
Use addContextMenuAttributes(Map)

Returns a Map with the tag attributes that should be added to the cell's definition for processing context menus.
Notice this method has been deprecated for performance reasons. If it's necessary to include extra attributes related to context-menus override the addContextMenuAttributes(Map) method. Although this method is still invoked under normal cell execution, it now returns null. If a subclass overrides this method and returns a Map instance, the members of the Map are appended to the cell's tag attributes.

protected Map getContextMenuAttributes (String menuName, int flag)

This method is deprecated.
Use addContextMenuAttributes(Map)

Returns a Map with the tag attributes that should be added to the cell's definition for processing context menus.

Notice this method has been deprecated for performance reasons. If it's necessary to include extra attributes related to context-menus override the addContextMenuAttributes(Map) method. Although this method is still invoked under normal cell execution, it now returns null. If a subclass overrides this method and returns a Map instance, the members of the Map are appended to the cell's tag attributes.

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 WebEvent getDefaultAdvancedDrillEvent ()

protected WebEvent getDefaultAdvancedDrillProcessEvent ()

protected WebEvent getDefaultDrillEditorProcessEvent ()

protected WebEvent getDefaultDrillEvent (WebDrillPath dp)

protected WebEvent getDefaultDrillEvent ()

protected WebEvent getDefaultDrillFilterOnSelectionEvent ()

protected WebEvent getDefaultSortEvent ()

protected WebEvent getDerivedElementsEvent (int key)

protected String getDescription ()

Returns the text registered as the description of the underlying web object associated with this cell.

Returns
  • description for the cell.

protected String getDescriptor (int key)

Get descriptor for this key

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

protected String getDescriptor (ReportBean rb, int key)

This method is deprecated.
Use method that doesn't receive the ReportBean as an argument.

Get descriptor for this key

Parameters
rb the ReportBean object
key input key as an int
Returns
  • descriptor as a String

protected String getDrillParametersForDHTML (WebDrillPath dp, WebTitle title)

Returns parameters required for drilling when using javascript for WebTitle cells.

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

protected String getDrillPath ()

Returns the drillPath associated with this cell.

Returns
  • String drill path registered fro this cell.

protected EventManager getEventManager ()

get the EventManager object

Returns

protected int getFPIntValue (String fpName)

Returns tha value of a formal parameter which has an integer value

Parameters
fpName formal parameter name
Returns
  • formal parameter value

protected String getFPStringValue (String fpName)

Returns tha value of a formal parameter which has a string value

Parameters
fpName formal parameter name
Returns
  • formal parameter value

protected WebEvent getFilterOnEvent (WebObjectInfo targetObject, String alias)

protected ReportGridDisplayCell getGridCell (String className)

Creates a new instance of a ReportGridDisplayCell

Parameters
className a fully qualified class name.
Returns
  • a new instance of a ReportGridDisplayCell

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

This method is deprecated.
Use method that doesn't receive the ReportBean as an argument.

Returns parameters required for drilling when using javascript for cells that use WebHeader as their underlying SDK object.

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

protected String getHeaderDrillParametersForDHTML (WebDrillPath dp, WebHeader header)

This method is deprecated.
please use the corresponding getDrillParametersForDHTML(WebDrillPath, WebTitle) interface, depending if it's a header or a title being handled.

Returns parameters required for drilling when using javascript for cells that use WebHeader as their underlying SDK object.

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

protected WebDrillPath getHeaderDrillPathWithHighImportance (WebHeader header)

This method is deprecated.
please use getDrillPathWithHighImportance() instead

generate drilling url parameters for DHTML mode

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

protected WebDrillPath getHeaderDrillPathWithHighImportance (ReportBean rb, WebHeader header)

This method is deprecated.
Use method that doesn't receive the ReportBean as an argument.

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)

This method is deprecated.
Use method that doesn't receive the ReportBean as an argument.

Returns the URL use for drilling cells that use a WebHeader as their underlying SDK object.

Parameters
rb the ReportBean object
dp the drill path
header the WebHeader object
Returns
  • String with the URL link for a header

protected String getHeaderDrillURL (WebDrillPath dp, WebHeader header)

This method is deprecated.
use generateAnchor(WebEvent) instead

Returns the URL use for drilling cells that use a WebHeader as their underlying SDK object.

Parameters
dp the drill path
header the WebHeader object
Returns
  • String with the URL link for a header

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.

Returns the maximum number of sorts allowed

Returns
  • max number of sorts

protected WebHeader getNearestNonMetricRowHeader (WebRowValue rowValue)

protected String getPostTextForMetricValue ()

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

Returns the text to use after displaying the metric value

Returns
  • the text to use after displaying the metric value itself

protected String getPostTextForNonMetricValue ()

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

Returns the text to use after displaying the content of a non-metric value cell

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.

Returns the text to be used before the metric value itself

Returns
  • the text to used before displaying the metric value itself

protected String getPreTextForNonMetricValue ()

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

Returns the text to use before displaying the content of a non-metric value cell

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

protected WebEvent getRWDDrillOutEvent ()

protected WebEvent getRenameEvent (int key)

Get the event for renaming the current cell

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

protected ReportGridTransformImpl getReportGridTransform ()

Utility method for returning the ReportGridTransformImpl instance associated with the context of this object

Returns
  • ReportGridTransformImpl instance as defined on the context object of this instance. If not available, it will return null

protected String getRowValueDrillElements (WebRowValue rowValue)

protected String getRowValueDrillParametersForDHTML (ReportBean rb, WebDrillPath dp)

This method is deprecated.
Use method that doesn't receive the ReportBean as an argument.

Returns parameters required for drilling when using javascript for cells that use WebRowValue as their underlying SDK object.

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

protected String getRowValueDrillParametersForDHTML (WebDrillPath dp)

This method is deprecated.
please use the getDrillParametersForDHTML(WebDrillPath, WebTitle) corresponding interface.

Returns parameters required for drilling when using javascript for cells that use WebRowValue as their underlying SDK object.

Parameters
dp the drill path
Returns
  • the url string

protected WebDrillPath getRowValueDrillPathWithHighImportance (WebRowValue rowValue)

This method is deprecated.
please use getDrillPathWithHighImportance() instead

generate drilling url parameters for row value in DHTML mode

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

protected WebDrillPath getRowValueDrillPathWithHighImportance (ReportBean rb, WebRowValue rowValue)

This method is deprecated.
Use method that doesn't receive the ReportBean as an argument.

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)

This method is deprecated.
Use method that doesn't receive the ReportBean as an argument.

Returns the URL use for drilling cells that use a WebRowValue as their underlying SDK object.

Parameters
rb the ReportBean object
dp the drill path
rowValue the WebRowValue object
Returns
  • the URL Link for a row value

protected String getRowValueDrillURL (WebDrillPath dp, WebRowValue rowValue)

This method is deprecated.
use generateAnchor(WebEvent) instead

Returns the URL use for drilling cells that use a WebRowValue as their underlying SDK object.

Parameters
dp the drill path
rowValue the WebRowValue object
Returns
  • the URL Link for a row value

protected WebEvent getSelectorEvent ()

get the selector Event to gnereate the anchor in HTML mode

protected int getShowDescriptionAsTooltip (String fpName)

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

get formal parameter value as an int value

Parameters
fpName formal parameter name
Returns
  • formal parameter value

protected WebEvent getSortAscendingEvent ()

protected WebEvent getSortDescendingEvent ()

protected WebEvent getSortEvent ()

This method is deprecated.
Please use getSortEvent(int axis EnumViewBeanEvents)

protected WebEvent getSortEventByAxis (int axis)

Parameters
axis specifies the axis EnumViewBeanEvents on which the sort is defined

protected WebEvent getSortEventByAxisBySortOrder (int axis, int sortOrder)

protected abstract String getSortID ()

This method return the ID to use for sorting this cell.

Returns
  • The ID to use for sorting this cell.

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

get the sort status

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

protected String getStyleForNonBuiltInFormat (String style, int rowOrdinal)

protected String getTargetKeys (RWControl ctl, boolean[] usePartialDisplay)

protected String getTitleDrillParametersForDHTML (WebDrillPath dp, WebTitle title)

This method is deprecated.
please use the getDrillParametersForDHTML(WebDrillPath, WebTitle) interface instead

Returns parameters required for drilling when using javascript for cells that use WebTitle as their underlying SDK object.

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

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

This method is deprecated.
Use method that doesn't receive the ReportBean as an argument.

Returns parameters required for drilling when using javascript for cells that use WebTitle as their underlying SDK object.

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)

This method is deprecated.
Use method that doesn't receive the ReportBean as an argument.

Returns the URL use for drilling cells that use a WebTitle as their underlying SDK object.

Parameters
rb the ReportBean object
dp the drill path
title the WebTitle object
Returns
  • the URL Link for a title cell

protected String getTitleDrillURL (WebDrillPath dp, WebTitle title)

This method is deprecated.
use generateAnchor(WebEvent) instead

Returns the URL use for drilling cells that use a WebTitle as their underlying SDK object.

Parameters
dp the drill path
title the WebTitle object
Returns
  • the URL Link for a title cell

protected boolean groupContextMenuDrillPathsByType ()

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

whether to group the drill paths by types in the Drilling RMC.

Returns
  • whether to group the drill paths by types in the Drilling RMC.

protected boolean hasDrillPathsWithHighImportanceAvailable (WebDrillMap wdm)

Helper method to determine if there are drill paths with high importance available for the current cell being rendered

Parameters
wdm WebDrillMap instance associated with the cell being rendered
Returns
  • boolean value indicating if there are drill paths with high importance available

protected boolean hasMetricFilterCondition ()

protected abstract boolean hasWebObject ()

This method allows the abstract class to identify whether the cell has been initialized with a valid WebObject. Some cells are created empty (with no underlying web object), they usually represent empty cells (like the ones used in design mode for metric values or row headers); in these cases some functionality needs to be disabled (liek context-menus or dnd), this method allow us to identify these cells.

Returns
  • true if the cell has underlying WebObject.

protected void initCell ()

Initialize the cell title information

protected void initDNDForDesignMode (DragAndDropItem item)

This method initializes properties used in javascript for drag and drop in design mode.

Parameters
item DragAndDropItem

protected void initDNDForExecuteMode (DragAndDropItem item)

This method initializes properties used in javascript for drag and drop in view mode.

Parameters
item DragAndDropItem

protected void initDragAndDrop (DragAndDropItem item)

This method initializes properties used in javascript for drag and drop.

Parameters
item DragAndDropItem

protected boolean isAccessibilityMode ()

Indicates if the Transform is rendering data in accessibility (508) mode

Returns
  • true if in 508 mode.

protected boolean isContextMenuEnabled ()

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

Indicates whether to is the context menu featuer enabled

Returns
  • true if context menus are enabled

protected boolean isContextMenusEnabled ()

protected boolean isDerivedMetric (WebMetric m)

protected boolean isDesignMode ()

Indicates if the Transform is rendering data in design mode

Returns
  • true if in design mode.

protected boolean isDhtml ()

Indicates if DHTML (javascript) is enabled

Returns
  • true if using DHTML.

protected boolean isDragAndDropEnabled ()

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

Indicates whether to drag and drop feature is enabled

Returns
  • true if drag and drop is enabled

protected boolean isFPTrue (String fpName, boolean defValue)

Returns tha value of a formal parameter which has a boolean value.

Parameters
fpName formal parameter name
defValue value to use if the formal parameter doesn't exist or if its value is null.
Returns
  • formal parameter value

protected boolean isFPTrue (String fpName)

Returns tha value of a formal parameter which has a boolean value.

Parameters
fpName formal parameter name
Returns
  • formal parameter value

protected boolean isFeatureAvailable (String name)

Checks if the given feature is available. It calls getBaseBean().isFeatureAvailable(name).

Parameters
name Feature name
Returns
  • false if the feature should be disabled.

protected boolean isHeaderMVJsonMovable ()

protected boolean isHeaderNeedLink (WebHeader header)

This method is deprecated.
please use cellNeedsLink()

return whether to display link for drill

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

protected boolean isIFrameEnabled ()

This method is deprecated.
use isIframeEnabled()

whether ifram is enabled

Returns
  • whether ifram is enabled

protected boolean isIFrameRequest ()

This method is deprecated.
use isIframeRequest

whether it's an iframe request

Returns
  • whether it's an iframe request

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

Indicates whether outline more is enabled for this transform

Returns
  • true if outline mode is enabled

protected boolean isRemoveAvailable ()

This method is deprecated.
please use canRemoveFromGrid() or canRemoveFromReport()

Validate if the remove option should be made available to the user or not

Returns
  • boolean value indicating if remove should be available or not.

protected boolean isRowValueNeedLink (WebRowValue rowValue)

This method is deprecated.
please use cellNeedsLink()

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)

This method is deprecated.
please use cellNeedsLink()

return whether to display link for drill

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

protected TransformContext newContext (TransformContext transformContext)

Creates a new instance of a TransformContext. It's used by the getContext method the first time is invoked. Transforms who require to include extra information in the context should create their own TransformContext implementation (possibly a subclass of AppTransformContext) and returns a new instance in this method.

protected NamespaceEncoder newNamespaceEncoder ()

Convenience method to retrieve a new Namespace Encoder object from the stored AppContext.

Returns
  • A new instance of a NamespaceEncoder object that encode names.

protected void renderContextMenu (MarkupOutput mo)

This method is deprecated.
use getContextMenuAttributes() instead

Render the context menu's trigger for this cell.

Parameters
mo the output object

protected void renderPivotButtons (MarkupOutput mo)

protected void setArgumentFromFormalParameter (WebEvent event, int argumentID, String paramName)

protected void setDescription (String description)

Registers the description of the underlying web object associated with this cell. Based on a formal parameter, this text might be used as the tooltip of the 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 shouldHiliteOnServer ()

Indicate if it's necessary to hilight the selected element on server side.

protected boolean showAdvancedDrillingOptionsInContextMenu ()

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

whether to show the set names submenu at the root level in the Drilling RMC or one level lower.

Returns
  • whether to show the set names submenu at the root level in the Drilling RMC or one level lower.

protected boolean showBanding ()

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

s * Indicates whether to display banding for the report

Returns
  • true if banding need to be displayed

protected boolean showDrillAdvanced ()

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

Indicates whether to display advanced drilling option

Returns
  • whether display advanced drilling

protected boolean showDrillCheckBox ()

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

Indicates whether to display a checkbox for drilling

Returns
  • whether display checkbox for drill

protected boolean showDrillDownOnly ()

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

Indicates whether to display only 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.

Indicates whether to display drill link

Returns
  • whether display drill link

protected boolean showDrillHyperlinkMetric ()

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

Indicates whether to 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.

Indicates whether to display drill on metric values

Returns
  • whether display drill on metric

protected boolean showDrillPathSetNamesSubMenuAtTopLevel ()

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

whether to show the set names submenu at the root level in the Drilling RMC or one level lower.

Returns
  • whether to show the set names submenu at the root level in the Drilling RMC or one level lower.

protected boolean showDrillRMC ()

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

Indicates whether to display drill 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.

Indicates whether to display drill right mouse click context menu for metrics

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

protected boolean showExtraRemoveRMC ()

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

whether display the extra remove RMC (right mouse click context menu)

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

protected boolean showFilterOnSelectionCheckBox ()

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

Indicates whether to display a checkbox for filter on selections

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.

Indicates whether display pivot buttons

Returns
  • true if pivot buttons need to be displayed

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.

Indicates whether display remove buttons

Returns
  • true if remove buttons needs to be displayed

protected boolean showRemoveFromReport (int metricSize, int wkSetSize)

Determine if we should show the 'Remove from Report' option depending on the number of metrics and the working set size

Parameters
metricSize number of metrics
wkSetSize working set size
Returns
  • true if working set is not empty or if the working set size is greater than the metrics size.

protected boolean showRemoveFromReport ()

Determine whether to show the 'Remove from Report' option according to the objects already defined on the template.

Returns
  • true if should display the 'Remove from Report' option.

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.

Indicates whether to 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.

Indicates whether to 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.

Indicates whether to 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.

Indicates whether to display sort RMC for metrics

Returns
  • whether display sort RMC for metrics

protected boolean showSubTitle ()

This method is deprecated.
Use showSubtitle instead.

Indicates whether to display sub titles (attribute forms).

Returns
  • true if the transform is displaying sub title

protected boolean showSubtitle ()

Indicates whether to display sub titles (attribute forms).

Returns
  • true if the transform is displaying sub title

protected boolean sortSetNamesAndDrillPaths ()

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

whether to sort the set names and drill paths in the drilling context menu.

Returns
  • whether to sort the set names and drill paths in the drilling context menu.

protected boolean useBuiltInFormat ()

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

Indicates whether to use report's built-in formatting, that is the formatting specified in the report definition

Returns
  • true if should use report's built-in formatting