Package com.microstrategy.web.app.transforms

Class ReportGridExcelCellMetricValueImpl

java.lang.Object

com.microstrategy.web.app.transforms.AbstractReportGridDisplayCell

com.microstrategy.web.app.transforms.ReportGridCellMetricValueImpl

com.microstrategy.web.app.transforms.ReportGridExcelCellMetricValueImpl

All Implemented Interfaces:

ReportGridCellMetricValue, ReportGridDisplayCell, java.lang.Cloneable

public class ReportGridExcelCellMetricValueImpl
extends ReportGridCellMetricValueImpl

Since:

MicroStrategy Web 9.0.0

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
ReportGridExcelCellMetricValueImpl()	Constructor used for creating a generic display cell.

Method Summary

Modifier and Type	Method	Description
boolean	canDrill()	Utility methood for determining if the cell object is enabled for displaying the user the option to drill on it
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.
protected boolean	encodeMetricValue()	Whether to HTML-encode metric values (based on the preference value)
protected void	initRowValueInformation(WebRowValue rowValue)
void	reset()	Reset all of the instance variables.

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

addContextMenuAttributes, addToHeaderMetricValueJsonMap, appendContextMenuItems, canDrillAdvanced, canFilterOn, canFormat, canHaveDerivedElements, canHyperLink, canInsertShortcutMetric, canModifyAttributeForm, canPivot, canRemoveFromGrid, canRemoveFromReport, canRename, canSort, generateContent, generateDrillAnchor, generateHyperLinkAnchor, generatePivotButton, generateText, generateThresholdSymbol, generateTooltipContent, getCellAttributes, getCellLevelAttributes, getCellType, getDerivedElementsEvent, getDrillPathWithHighImportance, getFilterOnEvent, getKey, getParentElementIndex, getParentFormValueIndex, getRenameEvent, getRowValueForURL, getSortID, getStyle, getWebRowValue, getWebTemplateMetric, hasWebObject, init, init, init, init, init, initCell, initDNDForDesignMode, initDNDForExecuteMode, isDrillPathAvailable, isHeaderMVJsonMovable, renderContextMenu

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

addContextMenuAttributes, addDragAndDropAttributes, addExtraAttribute, addTooltipAttributes, addToStyle, buildGenericTooltipInformation, canAddThresholds, canDefineDerivedElements, canEditControl, canEditMetricFilter, canFilterOnSelection, canMetricFilterOn, canOpenAlerts, canPivot, canQuickGroup, canUse, checkOwnerAndPrivilgeForHTMLExecution, clone, convertNonbreakingSpaceOnMV, decodeEuro, encodeMV, generateAnchor, 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, generateThresholdSymbol, generateTitleDrillContextMenu, generateTitleDrillContextMenu, generateTitleSortContextMenu, generateTitleSortContextMenu, generateTooltip, generateTooltipForHeaders, generateTooltipForRowValue, generateTooltipForTitles, getAccessibilityInfo, getBaseBean, getCellColor, getCellID, 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, 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, getStyleForNonBuiltInFormat, getSubTitle, getSubtitleIndex, getTargetKeys, getText, getTitleDrillParametersForDHTML, getTitleDrillParametersForDHTML, getTitleDrillURL, getTitleDrillURL, getTooltip, getViewBean, getWidth, groupContextMenuDrillPathsByType, hasDrillPathsWithHighImportanceAvailable, hasMetricFilterCondition, init, init, initDragAndDrop, isAccessibilityMode, isContextMenuEnabled, isContextMenusEnabled, isDerivedMetric, isDesignMode, isDhtml, isDragAndDropEnabled, isFeatureAvailable, isFPTrue, isFPTrue, isHeaderNeedLink, isHTMLExecutionAllowed, isIframeEnabled, isIFrameEnabled, isIframeRequest, isIFrameRequest, isItemsAddedToContextMenu, isMetric, isMetricDrillable, isOutlineModeEnabled, isRemoveAvailable, isRowValueNeedLink, isRW, isSortAscending, isTitleNeedLink, newContext, newNamespaceEncoder, 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, canEditControl, canEditMetricFilter, canFilterOnSelection, canMetricFilterOn, canOpenAlerts, canPivot, canQuickGroup, generateOutput, getAccessibilityInfo, getCellID, getColSpan, getControlElementSelectorEvent, getDrillEvent, getExtraInfo, getExtraStyle, getHeaderContent, getOpenFormatEditorEvent, getRowSpan, getSetFormatEditorTargetEvent, getText, getTooltip, getWidth, init, init, isRW, setAccessibilityInfo, setCellID, setColSpan, setContent, setContextMenu, setExtraInfo, setExtraStyle, setExtraStyle, setHTML, setInnerHTML, setPostContent, setPreContent, setRowSpan, setStyle, setText, setTooltip, setWidth

Constructor Detail

ReportGridExcelCellMetricValueImpl

public ReportGridExcelCellMetricValueImpl()

Constructor used for creating a generic display cell.

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 ReportGridCellMetricValueImpl

encodeMetricValue

protected boolean encodeMetricValue()

Description copied from class: ReportGridCellMetricValueImpl

Whether to HTML-encode metric values (based on the preference value)

Overrides:

encodeMetricValue in class ReportGridCellMetricValueImpl

Returns:

boolean false value since for Export to Excel we should not encode the value of the metrics

initRowValueInformation

protected void initRowValueInformation(WebRowValue rowValue)

Overrides:

initRowValueInformation in class ReportGridCellMetricValueImpl

cellNeedsLink

protected boolean cellNeedsLink()

Description copied from class: AbstractReportGridDisplayCell

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

Overrides:

cellNeedsLink in class ReportGridCellMetricValueImpl

Returns:

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

canDrill

public boolean canDrill()

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

Specified by:

canDrill in interface ReportGridDisplayCell

Overrides:

canDrill in class ReportGridCellMetricValueImpl

Returns:

boolean value indicating if the manipulation should be enabled