Class ReportGridDisplayCellMetricValue
- java.lang.Object
-
- com.microstrategy.web.app.transforms.ReportGridDisplayCellImpl
-
- com.microstrategy.web.app.transforms.ReportGridDisplayCellMetricValue
-
- All Implemented Interfaces:
ReportGridCell
,ReportGridCellMetricValue
,ReportGridDisplayCell
,java.lang.Cloneable
public class ReportGridDisplayCellMetricValue extends ReportGridDisplayCellImpl implements ReportGridCellMetricValue
Deprecated.Please use the ReportGridCellMetricValue interface or extend the ReportGridCellMetricValueImpl class.This class represents a metric value cell of the report grid.
This class has been deprecated along with the all the ReportGridDisplayCell classes.
In its place, the Transform manipulates the cells through the ReportGridCell interface.- Since:
- MicroStrategy Web 7.3.1 or earlier
-
-
Nested Class Summary
-
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.ReportGridDisplayCellImpl
_advDrillEditorProcessEvent, _advdrillEvent, _appliedSorts, _cachedObjects, _drillEditorName, _drillEditorProcessEvent, _drillEvent, _drillFilterOnSelectionProcessEvent, _drillFilterPageBy, _imgBasePath, _isIFrameRequest, _isNetscape, _itemsAddedToContextMenu, _maxColHeaderDepth, _sortEvent, _sortSubtotalColPosition, _sortSubtotalPostion, _specifyIDForCell, _specifyWidthForCell, _text, formalParas, rb
-
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 ReportGridDisplayCellMetricValue()
Deprecated.Constructor used for creating a generic display cell.ReportGridDisplayCellMetricValue(ReportBean rb, WebRowValue rowValue, java.util.HashMap cachedObjects)
Deprecated.Constructor for displaying metric values in report grid in execute mode.ReportGridDisplayCellMetricValue(ReportBean rb, WebTemplateMetric metric, FormalParameters formalParas)
Deprecated.Constructor used for creating a dummy display cell for metric value in design mode.ReportGridDisplayCellMetricValue(FormalParameters formalParas)
Deprecated.Constructor used for creating a generic display cell.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description protected void
generateContent(MarkupOutput mo)
Deprecated.override the protected method in ReportDisplayCellImpl.protected void
generateContextMenu(MarkupOutput mo)
Deprecated.Override the protected method of ReportDisplayCellImpl.void
generateMetricValueContent(MarkupOutput mo, WebRowValue rowValue)
Deprecated.protected void
generateTooltip(MarkupOutput mo)
Deprecated.Generate the tool tip for this cell.int
getCellType()
Deprecated.Returns the cell typeWebRowValue
getWebRowValue()
Deprecated.return the WebRowValue object associated with this cellWebTemplateMetric
getWebTemplateMetric()
Deprecated.return the WebTemplateMetric object associated with this cellvoid
init(TransformContext context, WebRowValue rowValue)
Deprecated.This method is called to initialize the cell with the correspondingWebRowValue
as the underlying SDK objectvoid
init(WebComponent wc, WebRowValue rowValue, java.util.HashMap cachedObjects)
Deprecated.This method is called to initialize the cell with the correspondingWebRowValue
as the underlying SDK object.void
init(WebComponent wc, WebTemplateMetric metric, FormalParameters formalParas)
Deprecated.protected void
initDNDForDesignMode(DragAndDropItem item)
Deprecated.initialize a drag and drop item for a metric value cell in design modeprotected void
initDNDForExecuteMode(DragAndDropItem item)
Deprecated.initialize a drag and drop item for a metric value cell in execute modevoid
reset()
Deprecated.Reset all of the instance variables.-
Methods inherited from class com.microstrategy.web.app.transforms.ReportGridDisplayCellImpl
addExtraAttribute, canAddThresholds, canDrill, canDrillAdvanced, canEditControl, canEditMetricFilter, canFilterOn, canFilterOnSelection, canFormat, canHaveDerivedElements, canHyperLink, canInsertShortcutMetric, canMetricFilterOn, canModifyAttributeForm, canOpenAlerts, canPivot, canPivot, canQuickGroup, canRemoveFromGrid, canRemoveFromReport, canRename, canSort, clone, convertNonbreakingSpaceOnMV, decodeEuro, encodeMV, generateDragAndDrop, generateDrillCheckBox, generateDrillCheckBox, generateDrillOpenLink, generateFilterOnSelectionCheckBox, generateFilterOnSelectionCheckBox, generateHeaderDrillContextMenu, generateHeaderSortContextMenu, generateInnerHTML, generateOutlineModeImage, generateOutlineSubTotalName, generateOutput, generatePivotButtons, generatePostContent, generatePreContent, generateRowValueDrillContextMenu, generateSortButton, generateTitleDrillContextMenu, generateTitleSortContextMenu, generateTooltipContent, generateTooltipForHeaders, generateTooltipForRowValue, generateTooltipForTitles, getAccessibilityInfo, getCellID, getColHeaderWebMetric, getColSpan, getContextMenuAttributes, getContextMenuManager, getControlElementSelectorEvent, getCssPrefix, getDerivedElementsEvent, getDescription, getDescriptor, getDrillEvent, getDrillPath, getDrillPathWithHighImportance, getEventManager, getExtraInfo, getExtraStyle, getExtraUrl, getFilterOnEvent, getFPIntValue, getFPStringValue, getHeaderContent, getHeaderDrillParametersForDHTML, getHeaderDrillPathWithHighImportance, getHeaderDrillURL, getImgName, getKey, getMaxSortAllowed, getOpenFormatEditorEvent, getPostTextForMetricValue, getPostTextForNonMetricValue, getPreTextForMetricValue, getPreTextForNonMetricValue, getRenameEvent, getReportBean, getReportDesignMode, getRowSpan, getRowValueDrillElements, getRowValueDrillParametersForDHTML, getRowValueDrillPathWithHighImportance, getRowValueDrillURL, getSetFormatEditorTargetEvent, getShowDescriptionAsTooltip, getSortStatus, getStyle, getSubTitle, getSubtitleIndex, getText, getTitleDrillParametersForDHTML, getTitleDrillURL, getTooltip, getWidth, init, init, init, init, initDragAndDrop, isContextMenuEnabled, isDesignMode, isDragAndDropEnabled, isFPTrue, isFPTrue, isHeaderNeedLink, isIFrameEnabled, isIFrameRequest, isItemsAddedToContextMenu, isMetric, isMetricDrillable, isOutlineModeEnabled, isRowValueNeedLink, isRW, isSortAscending, isTitleNeedLink, setAccessibilityInfo, setCellID, setCellType, setColSpan, setContent, setContextMenu, setDescription, setDrillPath, setExtraInfo, setExtraStyle, setExtraStyle, setExtraUrl, setHTML, setInnerHTML, setPostContent, setPreContent, setRowSpan, setStyle, setStyleForNonBuiltInFormat, setSubTitle, setSubTitleIndex, setText, setTooltip, setWidth, showBanding, showDrillAdvanced, showDrillCheckBox, showDrillDownOnly, showDrillHyperlink, showDrillHyperlinkMetric, showDrillMetric, showDrillRMC, showDrillRMCMetric, showFilterOnSelectionCheckBox, showFormattingRMC, showPivot, showPivotRMC, showRemove, showRemoveRMC, showRenameRMC, showSortButtonsForAttributes, showSortButtonsForMetrics, showSortRMCForAttributes, showSortRMCForMetrics, showSubTitle, 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, canHaveDerivedElements, canHyperLink, canInsertShortcutMetric, canMetricFilterOn, canModifyAttributeForm, canOpenAlerts, canPivot, canPivot, canQuickGroup, canRemoveFromGrid, canRemoveFromReport, canRename, canSort, generateOutput, getAccessibilityInfo, getCellID, getColSpan, getControlElementSelectorEvent, getDerivedElementsEvent, getDrillEvent, getDrillPathWithHighImportance, getExtraInfo, getExtraStyle, getFilterOnEvent, getHeaderContent, getKey, getOpenFormatEditorEvent, getRenameEvent, 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
-
ReportGridDisplayCellMetricValue
public ReportGridDisplayCellMetricValue()
Deprecated.Constructor used for creating a generic display cell.- Since:
- MicroStrategy Web 8.0.0
-
ReportGridDisplayCellMetricValue
public ReportGridDisplayCellMetricValue(FormalParameters formalParas)
Deprecated.Constructor used for creating a generic display cell.- Parameters:
formalParas
- all the formal parameters from the report transform. Used to control some output generation. For example, the cssPrefix is needed for the empty cells in design mode.
-
ReportGridDisplayCellMetricValue
public ReportGridDisplayCellMetricValue(ReportBean rb, WebTemplateMetric metric, FormalParameters formalParas)
Deprecated.Constructor used for creating a dummy display cell for metric value in design mode. the metric is the corresponding WebTemplateMetric info.- Parameters:
rb
- the associated report beanmetric
- the associated metric on templateformalParas
- all the formal parameters from the report transform. Used to control some output generation. For example, the cssPrefix is needed for the empty cells in design mode.
-
ReportGridDisplayCellMetricValue
public ReportGridDisplayCellMetricValue(ReportBean rb, WebRowValue rowValue, java.util.HashMap cachedObjects)
Deprecated.Constructor for displaying metric values in report grid in execute mode.- Parameters:
rb
- the associated report beanrowValue
- the associated WebRowValue objectcachedObjects
- cached object, used to store some information shared across multiple cells
-
-
Method Detail
-
reset
public void reset()
Deprecated.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 interfaceReportGridDisplayCell
- Overrides:
reset
in classReportGridDisplayCellImpl
-
getCellType
public int getCellType()
Deprecated.Returns the cell type- Specified by:
getCellType
in interfaceReportGridDisplayCell
- Overrides:
getCellType
in classReportGridDisplayCellImpl
- Returns:
- the cell type: EnumReportGridDisplayCellTypes.EnumReportGridDisplayCellTypeMetricValue. It's read-only.
-
getWebRowValue
public WebRowValue getWebRowValue()
Deprecated.return the WebRowValue object associated with this cell- Specified by:
getWebRowValue
in interfaceReportGridCellMetricValue
- Returns:
- the WebRowValue object
- Since:
- MicroStrategy Web 8.0.0
-
getWebTemplateMetric
public WebTemplateMetric getWebTemplateMetric()
Deprecated.return the WebTemplateMetric object associated with this cell- Specified by:
getWebTemplateMetric
in interfaceReportGridCellMetricValue
- Returns:
- the WebTemplateMetric object
-
init
public void init(WebComponent wc, WebRowValue rowValue, java.util.HashMap cachedObjects)
Deprecated.Description copied from interface:ReportGridCellMetricValue
This method is called to initialize the cell with the correspondingWebRowValue
as the underlying SDK object.- Specified by:
init
in interfaceReportGridCellMetricValue
- Parameters:
wc
- The bean being transformed.rowValue
- TheWebRowValue
corresponding to this cell.cachedObjects
- AHashMap
populated by the transform and used to store information shared across multiple cells.- Since:
- MicroStrategy Web 8.0.0
-
init
public void init(TransformContext context, WebRowValue rowValue)
Deprecated.Description copied from interface:ReportGridCellMetricValue
This method is called to initialize the cell with the correspondingWebRowValue
as the underlying SDK object- Specified by:
init
in interfaceReportGridCellMetricValue
- Parameters:
context
-TransformContext
instance initialized with the grid's transform information.rowValue
-WebRowValue
instance corresponding to the cell to be displayed.- Since:
- MicroStrategy Web 8.0.1
-
init
public void init(WebComponent wc, WebTemplateMetric metric, FormalParameters formalParas)
Deprecated.- Specified by:
init
in interfaceReportGridCellMetricValue
- Since:
- MicroStrategy Web 8.0.0
-
generateMetricValueContent
public void generateMetricValueContent(MarkupOutput mo, WebRowValue rowValue)
Deprecated.
-
generateContent
protected void generateContent(MarkupOutput mo)
Deprecated.override the protected method in ReportDisplayCellImpl.- Overrides:
generateContent
in classReportGridDisplayCellImpl
- Parameters:
mo
- the output object- Since:
- MicroStrategy Web 7.5.1
-
generateTooltip
protected void generateTooltip(MarkupOutput mo)
Deprecated.Generate the tool tip for this cell.- Overrides:
generateTooltip
in classReportGridDisplayCellImpl
- Parameters:
mo
- the output object
-
initDNDForDesignMode
protected void initDNDForDesignMode(DragAndDropItem item)
Deprecated.initialize a drag and drop item for a metric value cell in design mode- Overrides:
initDNDForDesignMode
in classReportGridDisplayCellImpl
- Parameters:
item
- theDragAndDropItem
item
-
initDNDForExecuteMode
protected void initDNDForExecuteMode(DragAndDropItem item)
Deprecated.initialize a drag and drop item for a metric value cell in execute mode- Overrides:
initDNDForExecuteMode
in classReportGridDisplayCellImpl
- Parameters:
item
- theDragAndDropItem
item
-
generateContextMenu
protected void generateContextMenu(MarkupOutput mo)
Deprecated.Override the protected method of ReportDisplayCellImpl.- Overrides:
generateContextMenu
in classReportGridDisplayCellImpl
- Parameters:
mo
- the output object- Since:
- MicroStrategy Web 7.5.0
-
-