Package com.microstrategy.web.app.transforms

Class ReportGridCellImpl

java.lang.Object

com.microstrategy.web.app.transforms.AbstractReportGridDisplayCell

com.microstrategy.web.app.transforms.ReportGridCellImpl

All Implemented Interfaces:

ReportGridCell, ReportGridDisplayCell, java.lang.Cloneable

public class ReportGridCellImpl
extends AbstractReportGridDisplayCell
implements ReportGridCell

The ReportGridCellColHeaderImpl is a simple implementation of the ReportGridDisplayCell. It's mainly used to generate the HTML for empty cells.

It extends the AbstractReportGridDisplayCell which controls the exeuction flow.

Users who intend to programatically modify the HTML generated for emty generic cells should extend this class. Using this technique developers could define their own rules of the text to display based on the WebHeader content.

The following is an example of a class that extends the AbstractReportGridDisplayCell.generateText(com.microstrategy.web.beans.MarkupOutput) method of this class to add a hyphen if the cell content is empty:

 public class CustomCellImpl extends ReportGridCellImpl

     public void generateText(MarkupOutput mo) {
         String text = getText();

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

 }
 

Since:

MicroStrategy Web 7.5.2

See Also:

ReportGridDisplayCell, ReportGridTransformImpl

Nested Class Summary

Nested classes/interfaces inherited from class com.microstrategy.web.app.transforms.AbstractReportGridDisplayCell

AbstractReportGridDisplayCell.Context, AbstractReportGridDisplayCell.PivotButtonInfo

Nested classes/interfaces inherited from interface com.microstrategy.web.app.transforms.ReportGridDisplayCell

ReportGridDisplayCell.Context

Field Summary

Fields inherited from class com.microstrategy.web.app.transforms.AbstractReportGridDisplayCell

_advDrillEditorProcessEvent, _advdrillEvent, _appliedColSorts, _appliedSorts, _blankDrillAnchorTag, _cachedObjects, _drillEditorName, _drillEditorProcessEvent, _drillEvent, _drillFilterOnSelectionProcessEvent, _imgBasePath, _isIFrameRequest, _isNetscape, _isWrapHeaderText, _itemsAddedToContextMenu, _maxColHeaderDepth, _pivotImgHeight, _pivotImgWidth, _sharedCellProperties, _sortEvent, _sortImgHeight, _sortImgWidth, _sortSubtotalColPosition, _sortSubtotalPosition, _sortSubtotalPostion, _specifyIDForCell, _specifyWidthForCell, _text, _typicalURLBeanState, DISPLAY_CELL_CLASS, formalParas, NO, rb, RETAIN_PARENT_FORMAL_PARAMETER, RETAIN_THRESHOLDS_FORMAL_PARAMETER, YES

Fields inherited from interface com.microstrategy.web.app.transforms.ReportGridDisplayCell

PIVOT_DECREASE_POSITION, PIVOT_INCREASE_POSITION, PIVOT_REMOVE, PIVOT_SWITCH_AXIS, PIVOT_TO_PAGE_BY

Constructor Summary

Constructors

Constructor	Description
ReportGridCellImpl()	Constructor for displaying column title in execute mode

Method Summary

Modifier and Type	Method	Description
boolean	canHaveDerivedElements()
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
protected Tag	generatePivotButton(int type)
WebEvent	getDerivedElementsEvent()
WebEvent	getFilterOnEvent()	Get the event for filter on the cell header instance
int	getKey()
WebEvent	getRenameEvent()	Get the event for renaming the current cell
protected java.lang.String	getSortID()	This method return the ID to use for sorting this cell.
protected boolean	hasWebObject()	This method allows the abstract class to identify whether the cell has been initialized with a valid WebObject.
void	reset()	Reset all of the instance variables.

Methods inherited from class com.microstrategy.web.app.transforms.AbstractReportGridDisplayCell

addContextMenuAttributes, addContextMenuAttributes, addDragAndDropAttributes, addExtraAttribute, addToHeaderMetricValueJsonMap, addTooltipAttributes, addToStyle, appendContextMenuItems, buildGenericTooltipInformation, canAddThresholds, canDefineDerivedElements, canDrill, canDrillAdvanced, canEditControl, canEditMetricFilter, canFilterOn, canFilterOnSelection, canFormat, canHyperLink, canInsertShortcutMetric, canMetricFilterOn, canModifyAttributeForm, canOpenAlerts, canPivot, canPivot, canQuickGroup, canRename, canSort, canUse, cellNeedsLink, checkOwnerAndPrivilgeForHTMLExecution, clone, convertNonbreakingSpaceOnMV, decodeEuro, encodeMV, generateAnchor, generateContent, generateContextMenu, generateDragAndDrop, generateDragAndDropAttributes, generateDrillCheckBox, generateDrillCheckBox, generateDrillCheckBox, generateDrillCheckBoxTag, generateDrillContextMenu, generateDrillOpenLink, generateDrillOpenLink, generateFilterOnSelectionCheckBox, generateFilterOnSelectionCheckBox, generateFilterOnSelectionCheckBox, generateFilterOnSelectionCheckBoxTag, generateHeaderDrillContextMenu, generateHeaderDrillContextMenu, generateHeaderSortContextMenu, generateHeaderSortContextMenu, generateInnerHTML, generateOutlineModeImage, generateOutlineSubTotalName, generateOutput, generatePivotButtons, generatePostContent, generatePreContent, generateRowValueDrillContextMenu, generateRowValueDrillContextMenu, generateSortButton, generateSortButton, generateSortContextMenu, generateText, generateThresholdSymbol, generateTitleDrillContextMenu, generateTitleDrillContextMenu, generateTitleSortContextMenu, generateTitleSortContextMenu, generateTooltip, generateTooltipContent, generateTooltipForHeaders, generateTooltipForRowValue, generateTooltipForTitles, getAccessibilityInfo, getBaseBean, getCellAttributes, getCellColor, getCellID, getCellLevelAttributes, getCellType, getColHeaderWebMetric, getColSpan, getContext, getContext, getContextMenu, getContextMenu, getContextMenuAttributes, getContextMenuAttributes, getContextMenuManager, getControlElementSelectorEvent, getCssPrefix, getDefaultAdvancedDrillEvent, getDefaultAdvancedDrillProcessEvent, getDefaultDrillEditorProcessEvent, getDefaultDrillEvent, getDefaultDrillEvent, getDefaultDrillFilterOnSelectionEvent, getDefaultSortEvent, getDerivedElementsEvent, getDescription, getDescriptor, getDescriptor, getDrillEvent, getDrillKey, getDrillParametersForDHTML, getDrillPath, getDrillpathKey, getDrillPathKey, getDrillpathKeyInOldFormat, getDrillPathWithHighImportance, getEventManager, getExtraInfo, getExtraStyle, getExtraUrl, getFilterOnEvent, getFPIntValue, getFPStringValue, getGridCell, getHeaderContent, getHeaderDrillParametersForDHTML, getHeaderDrillParametersForDHTML, getHeaderDrillPathWithHighImportance, getHeaderDrillPathWithHighImportance, getHeaderDrillURL, getHeaderDrillURL, getImgName, getMaxColHeaderDepth, getMaxSortAllowed, getNearestNonMetricRowHeader, getOpenFormatEditorEvent, getPostTextForMetricValue, getPostTextForNonMetricValue, getPreTextForMetricValue, getPreTextForNonMetricValue, getRenameEvent, getReportBean, getReportDesignMode, getReportGridTransform, getRowSpan, getRowValueDrillElements, getRowValueDrillParametersForDHTML, getRowValueDrillParametersForDHTML, getRowValueDrillPathWithHighImportance, getRowValueDrillPathWithHighImportance, getRowValueDrillURL, getRowValueDrillURL, getRWDDrillOutEvent, getSelectorEvent, getSetFormatEditorTargetEvent, getShowDescriptionAsTooltip, getSortAscendingEvent, getSortDescendingEvent, getSortEvent, getSortEventByAxis, getSortEventByAxisBySortOrder, getSortStatus, getStyle, getStyleForNonBuiltInFormat, getSubTitle, getSubtitleIndex, getTargetKeys, getText, getTitleDrillParametersForDHTML, getTitleDrillParametersForDHTML, getTitleDrillURL, getTitleDrillURL, getTooltip, getViewBean, getWidth, groupContextMenuDrillPathsByType, hasDrillPathsWithHighImportanceAvailable, hasMetricFilterCondition, init, init, init, init, initCell, initDNDForDesignMode, initDNDForExecuteMode, initDragAndDrop, isAccessibilityMode, isContextMenuEnabled, isContextMenusEnabled, isDerivedMetric, isDesignMode, isDhtml, isDragAndDropEnabled, isFeatureAvailable, isFPTrue, isFPTrue, isHeaderMVJsonMovable, isHeaderNeedLink, isHTMLExecutionAllowed, isIframeEnabled, isIFrameEnabled, isIframeRequest, isIFrameRequest, isItemsAddedToContextMenu, isMetric, isMetricDrillable, isOutlineModeEnabled, isRemoveAvailable, isRowValueNeedLink, isRW, isSortAscending, isTitleNeedLink, newContext, newNamespaceEncoder, renderContextMenu, renderPivotButtons, setAccessibilityInfo, setArgumentFromFormalParameter, setCellColor, setCellID, setCellType, setColSpan, setContent, setContextMenu, setDescription, setDrillPath, setExtraInfo, setExtraStyle, setExtraStyle, setExtraUrl, setHTML, setInnerHTML, setPostContent, setPreContent, setRowSpan, setStyle, setStyleForNonBuiltInFormat, setSubTitle, setSubTitleIndex, setText, setTooltip, setWidth, shouldHiliteOnServer, showAdvancedDrillingOptionsInContextMenu, showBanding, showDrillAdvanced, showDrillCheckBox, showDrillDownOnly, showDrillHyperlink, showDrillHyperlinkMetric, showDrillMetric, showDrillPathSetNamesSubMenuAtTopLevel, showDrillRMC, showDrillRMCMetric, showExtraRemoveRMC, showFilterOnSelectionCheckBox, showFormattingRMC, showPivot, showPivotRMC, showRemove, showRemoveFromReport, showRemoveFromReport, showRemoveRMC, showRenameRMC, showSortButtonsForAttributes, showSortButtonsForMetrics, showSortRMCForAttributes, showSortRMCForMetrics, showSubtitle, showSubTitle, sortSetNamesAndDrillPaths, useBuiltInFormat

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.microstrategy.web.app.transforms.ReportGridDisplayCell

addExtraAttribute, canAddThresholds, canDrill, canDrillAdvanced, canEditControl, canEditMetricFilter, canFilterOn, canFilterOnSelection, canFormat, canHyperLink, canInsertShortcutMetric, canMetricFilterOn, canModifyAttributeForm, canOpenAlerts, canPivot, canPivot, canQuickGroup, canRename, canSort, generateOutput, getAccessibilityInfo, getCellID, getCellType, getColSpan, getControlElementSelectorEvent, getDrillEvent, getDrillPathWithHighImportance, getExtraInfo, getExtraStyle, getHeaderContent, getOpenFormatEditorEvent, getRowSpan, getSetFormatEditorTargetEvent, getStyle, getText, getTooltip, getWidth, init, init, init, init, isRW, setAccessibilityInfo, setCellID, setColSpan, setContent, setContextMenu, setExtraInfo, setExtraStyle, setExtraStyle, setHTML, setInnerHTML, setPostContent, setPreContent, setRowSpan, setStyle, setText, setTooltip, setWidth

Constructor Detail

ReportGridCellImpl

public ReportGridCellImpl()

Constructor for displaying column title in execute mode

Method Detail

reset

public void reset()

Description copied from interface: ReportGridDisplayCell

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.

Specified by:

reset in interface ReportGridDisplayCell

Overrides:

reset in class AbstractReportGridDisplayCell

getSortID

protected java.lang.String getSortID()

Description copied from class: AbstractReportGridDisplayCell

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

Specified by:

getSortID in class AbstractReportGridDisplayCell

Returns:

The ID to use for sorting this cell.

Since:

MicroStrategy Web 8.0.0

hasWebObject

protected boolean hasWebObject()

Description copied from class: AbstractReportGridDisplayCell

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.

Specified by:

hasWebObject in class AbstractReportGridDisplayCell

Returns:

true if the cell has underlying WebObject.

Since:

MicroStrategy Web 8.0.0

canRemoveFromGrid

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.

Specified by:

canRemoveFromGrid in interface ReportGridDisplayCell

Overrides:

canRemoveFromGrid in class AbstractReportGridDisplayCell

Returns:

boolean value indicating if the manipulation should be enabled

Since:

MicroStrategy Web 8.0.1

canRemoveFromReport

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

Specified by:

canRemoveFromReport in interface ReportGridDisplayCell

Overrides:

canRemoveFromReport in class AbstractReportGridDisplayCell

Returns:

boolean value indicating if the manipulation should be enabled

Since:

MicroStrategy Web 8.0.1

getDerivedElementsEvent

public WebEvent getDerivedElementsEvent()

Specified by:

getDerivedElementsEvent in interface ReportGridDisplayCell

Since:

MicroStrategy Web 9.0.0

getFilterOnEvent

public WebEvent getFilterOnEvent()

Description copied from interface: ReportGridDisplayCell

Get the event for filter on the cell header instance

Specified by:

getFilterOnEvent in interface ReportGridDisplayCell

Returns:

WebEvent instance initialized for filtering on the information of this cell

Since:

MicroStrategy Web 9.0.0

getKey

public int getKey()

Specified by:

getKey in interface ReportGridDisplayCell

Returns:

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

Since:

MicroStrategy Web 9.0.0

getRenameEvent

public WebEvent getRenameEvent()

Description copied from interface: ReportGridDisplayCell

Get the event for renaming the current cell

Specified by:

getRenameEvent in interface ReportGridDisplayCell

Returns:

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

Since:

MicroStrategy Web 9.0.0

canHaveDerivedElements

public boolean canHaveDerivedElements()

Specified by:

canHaveDerivedElements in interface ReportGridDisplayCell

Since:

MicroStrategy Web 9.0.0

generatePivotButton

protected Tag generatePivotButton(int type)

Specified by:

generatePivotButton in class AbstractReportGridDisplayCell