Class ReportGridCellMetricValueImpl
- java.lang.Object
-
- com.microstrategy.web.app.transforms.AbstractReportGridDisplayCell
-
- com.microstrategy.web.app.transforms.ReportGridCellMetricValueImpl
-
- All Implemented Interfaces:
ReportGridCellMetricValue
,ReportGridDisplayCell
,java.lang.Cloneable
- Direct Known Subclasses:
IPhoneReportGridCellMetricValueImpl
,ReportGridExcelCellMetricValueImpl
public class ReportGridCellMetricValueImpl extends AbstractReportGridDisplayCell implements ReportGridCellMetricValue
The
ReportGridCellMetricValue
is used to generate the HTML of a cell value of the report data.It uses a
WebRowValue
as the underlyingSDK
objects to retrieve the information from.The
ReportGridCellColTitleImpl
extends theAbstractReportGridDisplayCell
which controls the exeuction flow.Users who intend to programatically modify the HTML generated for a metric value should extend this class. Using this technique developers could define their own rules of the text to display based on the
The following is an example of a class that extends theWebTitle
content.generateText(com.microstrategy.web.beans.MarkupOutput)
method of this class based on the title's template unit type:public class CustomMetricValueextends ReportGridCellMetricValueImpl { public void generateText(MarkupOutput mo) { WebRowValue rowValue = getWebRowValue(); if (rowValue != null) { String spanPrefix = ""; String spanPostfix = ""; switch (rowValue.getSemantics()) { case EnumDSSXMLBaseFormType.DssXmlBaseFormPicture: case EnumDSSXMLBaseFormType.DssXmlBaseFormUrl: //For threshold images Tag imgTag = TagsFactory.getInstance().newTag("img"); imgTag.setAttribute(EnumHTMLTags.ATT_SRC, rowValue.getValue()); imgTag.render(mo); break; case EnumDSSXMLBaseFormType.DssXmlBaseFormSymbol: //For thresholds quick symbols generateThresholdSymbol(mo, Integer.parseInt(rowValue.getValue())); break; case EnumDSSXMLBaseFormType.DssXmlBaseFormHTMLTag: mo.append(HTMLHelper.decode(rowValue.getValue())); break; default: super.generateText(mo); } } else { super.generateText(mo); }
- Since:
- MicroStrategy Web 7.5.1
- 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 ReportGridCellMetricValueImpl()
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
addContextMenuAttributes(java.util.Map atts)
Obtain the tag attributes that should be added to the cell's definition for processing context menusprotected void
addToHeaderMetricValueJsonMap(java.lang.String key, java.lang.String value)
protected void
appendContextMenuItems(ContextMenu rhMenu)
Deprecated.Please use the new approach for generating context menus, seeReportCellRemoveFromGrid
,ReportCellMove
, etcboolean
canDrill()
Utility methood for determining if the cell object is enabled for displaying the user the option to drill on itboolean
canDrillAdvanced()
Utility methood for determining if the cell object is enabled for displaying the user the option for advanced drilling on itboolean
canFilterOn()
Utility methood for determining if the cell object is enabled for displaying the user the option to filter on itboolean
canFormat()
Utility methood for determining if the cell object is enabled for displaying the user the option to format itboolean
canHaveDerivedElements()
boolean
canHyperLink()
Utility method for determining if the cell object is enabled for displaying the user the option to navigate to custom hyperlinksboolean
canInsertShortcutMetric()
Utility methood for determining if the cell object is enabled for displaying the user the option to insert shortcut metrics based on itboolean
canModifyAttributeForm()
Utility methood for determining if the cell object is enabled for displaying the user the option to modify the attribute forms on itboolean
canPivot()
Utility methood for determining if the cell object is enabled for displaying the user the option to pivot itboolean
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 reportboolean
canRename()
Utility methood for determining if the cell object is enabled for displaying the user the option to rename itboolean
canSort()
Utility methood for determining if the cell object is enabled for displaying the user the option to sort itprotected 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
generateContent(MarkupOutput mo)
ExtendsgenerateContent
by adding a URL link to the cell's text.protected AnchorTag
generateDrillAnchor()
Utility method for generating theAnchorTag
instance with all the drill information if available for the current cell being displayed by this instance.protected AnchorTag
generateHyperLinkAnchor()
protected Tag
generatePivotButton(int type)
void
generateText(MarkupOutput mo)
Generates the text of the cell.protected void
generateThresholdSymbol(MarkupOutput out, int thresholdValue)
Generates the HTML when the metric value is a "quick symbol" threshold.protected java.lang.String
generateTooltipContent()
Generates the string with the tooltip information to be assigned to the TITLE attribute of the cell tag for this instanceprotected void
getCellAttributes(java.util.Map attributes)
protected void
getCellLevelAttributes(java.util.Map cell)
CTY indicates the cell type UTP indicates the template unit that it belongs to, in the format of "axis,position"int
getCellType()
Returns the cell type, a value from theEnumReportGridDisplayCellTypes
enumeration.WebEvent
getDerivedElementsEvent()
WebDrillPath
getDrillPathWithHighImportance()
generate drilling url parameters for row value in DHTML modeWebEvent
getFilterOnEvent()
Get the event for filter on the cell header instanceint
getKey()
protected java.lang.String
getParentElementIndex()
protected java.lang.String
getParentFormValueIndex()
WebEvent
getRenameEvent()
Get the event for renaming the current cellprotected java.lang.String
getRowValueForURL()
Returns the value of the current row.protected java.lang.String
getSortID()
This method return the ID to use for sorting this cell.java.lang.String
getStyle()
Returns the css class name associated with the cell as registered by the Transform.WebRowValue
getWebRowValue()
Returns the underlyingSDK
object associated with this cell.WebTemplateMetric
getWebTemplateMetric()
return the WebTemplateMetric object associated with this cellprotected boolean
hasWebObject()
This method allows the abstract class to identify whether the cell has been initialized with a valid WebObject.void
init(TransformContext context, WebRowValue rowValue)
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.please use the interface that receivesTransformContext
instance instead.void
init(WebComponent wc, WebTemplateMetric metric, FormalParameters formalParas)
Deprecated.please use the interface that receivesTransformContext
instance instead.void
init(WebComponent wc, FormalParameters formalParas)
Deprecated.This method is not used by the Transform anymore.void
init(FormalParameters formalParas)
Deprecated.This method is not used by the Transform anymore.protected void
initCell()
Initialize the cell title informationprotected void
initDNDForDesignMode(DragAndDropItem item)
This method initializes properties used in javascript for drag and drop in design mode.protected void
initDNDForExecuteMode(DragAndDropItem item)
This method initializes properties used in javascript for drag and drop in view mode.protected void
initRowValueInformation(WebRowValue rowValue)
protected boolean
isDrillPathAvailable(WebRowValue rowValue)
Utility method to determine if the current row value has drill information availableprotected boolean
isHeaderMVJsonMovable()
protected void
renderContextMenu(MarkupOutput mo)
Deprecated.void
reset()
Reset all of the instance variables.-
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, 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, 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
-
-
-
-
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 interfaceReportGridDisplayCell
- Overrides:
reset
in classAbstractReportGridDisplayCell
-
getCellType
public int getCellType()
Description copied from class:AbstractReportGridDisplayCell
Returns the cell type, a value from theEnumReportGridDisplayCellTypes
enumeration.- Specified by:
getCellType
in interfaceReportGridDisplayCell
- Overrides:
getCellType
in classAbstractReportGridDisplayCell
-
getWebRowValue
public WebRowValue getWebRowValue()
Description copied from interface:ReportGridCellMetricValue
Returns the underlyingSDK
object associated with this cell. It should always returnnull
if the instance represents an empty cell.- Specified by:
getWebRowValue
in interfaceReportGridCellMetricValue
- Returns:
- The underlying SDK object.
- Since:
- MicroStrategy Web 8.0.0
-
initCell
protected void initCell()
Description copied from class:AbstractReportGridDisplayCell
Initialize the cell title information- Overrides:
initCell
in classAbstractReportGridDisplayCell
-
init
public void init(FormalParameters formalParas)
Deprecated.This method is not used by the Transform anymore. To initialize empty cells it now usesAbstractReportGridDisplayCell.init(TransformContext)
.Description copied from interface:ReportGridDisplayCell
Initializes anReportGridDisplayCell
. This is used to initialize empty cells that have no underlyingWebObject
.- Specified by:
init
in interfaceReportGridDisplayCell
- Overrides:
init
in classAbstractReportGridDisplayCell
- Parameters:
formalParas
- all the formal parameters from the report transform. Used to control some output generation.
-
init
public void init(WebComponent wc, FormalParameters formalParas)
Deprecated.This method is not used by the Transform anymore. To initialize empty cells it now usesAbstractReportGridDisplayCell.init(TransformContext)
.Description copied from interface:ReportGridDisplayCell
Initializes anReportGridDisplayCell
. This is used to initialize empty cells that have no underlyingWebObject
.- Specified by:
init
in interfaceReportGridDisplayCell
- Overrides:
init
in classAbstractReportGridDisplayCell
- Parameters:
wc
- associated web componentformalParas
- all the formal parameters from the report transform. Used to control some output generation.- Since:
- MicroStrategy Web 8.0.0
-
init
public void init(WebComponent wc, WebTemplateMetric metric, FormalParameters formalParas)
Deprecated.please use the interface that receivesTransformContext
instance instead.- Specified by:
init
in interfaceReportGridCellMetricValue
- Since:
- MicroStrategy Web 7.5.2
-
init
public void init(TransformContext context, WebRowValue rowValue)
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
-
encodeMetricValue
protected boolean encodeMetricValue()
Whether to HTML-encode metric values (based on the preference value)- Returns:
- Whether to HTML-encode metric values.
- Since:
- MicroStrategy Web 9.0.0
-
initRowValueInformation
protected void initRowValueInformation(WebRowValue rowValue)
- Since:
- MicroStrategy Web 8.0.1
-
getParentElementIndex
protected java.lang.String getParentElementIndex()
- Returns:
- the parent element index based on the WebHeader, null if
canHyperLink()
returns false
-
getParentFormValueIndex
protected java.lang.String getParentFormValueIndex()
- Returns:
- the parent element index based on the WebHeader, null if
canHyperLink()
returns false
-
canHyperLink
public boolean canHyperLink()
Description copied from interface:ReportGridDisplayCell
Utility method for determining if the cell object is enabled for displaying the user the option to navigate to custom hyperlinks- Specified by:
canHyperLink
in interfaceReportGridDisplayCell
- Overrides:
canHyperLink
in classAbstractReportGridDisplayCell
- Returns:
- boolean value indicating if the manipulation should be enabled
- Since:
- MicroStrategy Web 8.1.2
-
init
public void init(WebComponent wc, WebRowValue rowValue, java.util.HashMap cachedObjects)
Deprecated.please use the interface that receivesTransformContext
instance instead.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 7.5.2
-
generateContent
protected void generateContent(MarkupOutput mo)
ExtendsgenerateContent
by adding a URL link to the cell's text.Developers can either use the
AbstractReportGridDisplayCell.setContent(java.lang.String)
method to set any text they want to display as the cell's contents or override this method to inherit its functionality and build on top of it.As an example, the following code could be used to extend this method to add a <BR> tag after cell's content:
public void generateContent(MarkupOutput mo) { super.generateContent(mo); mo.append("<br>"); }
- Overrides:
generateContent
in classAbstractReportGridDisplayCell
- Parameters:
mo
- the output object
-
getWebTemplateMetric
public WebTemplateMetric getWebTemplateMetric()
Description copied from interface:ReportGridCellMetricValue
return the WebTemplateMetric object associated with this cell- Specified by:
getWebTemplateMetric
in interfaceReportGridCellMetricValue
- Returns:
- the WebTemplateMetric object
-
generateHyperLinkAnchor
protected AnchorTag generateHyperLinkAnchor()
- Since:
- MicroStrategy Web 8.1.2
-
generateDrillAnchor
protected AnchorTag generateDrillAnchor()
Utility method for generating theAnchorTag
instance with all the drill information if available for the current cell being displayed by this instance.- Returns:
AnchorTag
instance initialized with the drill details. If drilling is not supported given the information provided, it will returnnull
- Since:
- MicroStrategy Web 8.0.1
-
getStyle
public java.lang.String getStyle()
Description copied from class:AbstractReportGridDisplayCell
Returns the css class name associated with the cell as registered by the Transform.
If set, this is the one assigned to theCLASS
attribute of theTD
tag to control its formatting.- Specified by:
getStyle
in interfaceReportGridDisplayCell
- Overrides:
getStyle
in classAbstractReportGridDisplayCell
- Returns:
- The css class name as registered by the Transform.
- Since:
- MicroStrategy Web 8.1.1
-
getRowValueForURL
protected java.lang.String getRowValueForURL()
Returns the value of the current row.- Returns:
- String
-
generateText
public void generateText(MarkupOutput mo)
Description copied from class:AbstractReportGridDisplayCell
Generates the text of the cell. This is the the text that gets displayed by the browser.
Developers can either use the
For example, the following code could be used to extend this method to render a hyphen if the cell content is empty:AbstractReportGridDisplayCell.setText(java.lang.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.
public void generateText(MarkupOutput mo) { String text = getText(); if ("".equals(text) || " ".equals(text)) { mo.append("-"); } else { super.generateText(mo); } }
- Overrides:
generateText
in classAbstractReportGridDisplayCell
- Parameters:
mo
- the output object
-
generateTooltipContent
protected java.lang.String generateTooltipContent()
Generates the string with the tooltip information to be assigned to the TITLE attribute of the cell tag for this instance- Overrides:
generateTooltipContent
in classAbstractReportGridDisplayCell
- Returns:
- String with the information about the tooltip to render for the current cell.
- Since:
- MicroStrategy Web 8.0.1
-
initDNDForDesignMode
protected void initDNDForDesignMode(DragAndDropItem item)
Description copied from class:AbstractReportGridDisplayCell
This method initializes properties used in javascript for drag and drop in design mode.- Overrides:
initDNDForDesignMode
in classAbstractReportGridDisplayCell
- Parameters:
item
- DragAndDropItem
-
initDNDForExecuteMode
protected void initDNDForExecuteMode(DragAndDropItem item)
Description copied from class:AbstractReportGridDisplayCell
This method initializes properties used in javascript for drag and drop in view mode.- Overrides:
initDNDForExecuteMode
in classAbstractReportGridDisplayCell
- Parameters:
item
- DragAndDropItem
-
generateThresholdSymbol
protected void generateThresholdSymbol(MarkupOutput out, int thresholdValue)
Generates the HTML when the metric value is a "quick symbol" threshold.- Parameters:
out
- the output objectthresholdValue
- the threshold id. A value fromEnumDSSXMLSymbol
.
-
canDrillAdvanced
public boolean canDrillAdvanced()
Utility methood for determining if the cell object is enabled for displaying the user the option for advanced drilling on it- Specified by:
canDrillAdvanced
in interfaceReportGridDisplayCell
- Overrides:
canDrillAdvanced
in classAbstractReportGridDisplayCell
- Returns:
- boolean value indicating if the manipulation should be enabled
- Since:
- MicroStrategy Web 8.0.1
-
appendContextMenuItems
protected void appendContextMenuItems(ContextMenu rhMenu)
Deprecated.Please use the new approach for generating context menus, seeReportCellRemoveFromGrid
,ReportCellMove
, etc- Overrides:
appendContextMenuItems
in classAbstractReportGridDisplayCell
- Since:
- MicroStrategy Web 8.0.0
- See Also:
AbstractAppTransform.contextMenus
-
addContextMenuAttributes
protected void addContextMenuAttributes(java.util.Map atts)
Obtain the tag attributes that should be added to the cell's definition for processing context menus- Overrides:
addContextMenuAttributes
in classAbstractReportGridDisplayCell
- Parameters:
atts
-Map
where attributes will be appended.- Since:
- MicroStrategy Web 8.1.0
-
getCellAttributes
protected void getCellAttributes(java.util.Map attributes)
- Overrides:
getCellAttributes
in classAbstractReportGridDisplayCell
-
isHeaderMVJsonMovable
protected boolean isHeaderMVJsonMovable()
- Overrides:
isHeaderMVJsonMovable
in classAbstractReportGridDisplayCell
-
addToHeaderMetricValueJsonMap
protected void addToHeaderMetricValueJsonMap(java.lang.String key, java.lang.String value)
- Overrides:
addToHeaderMetricValueJsonMap
in classAbstractReportGridDisplayCell
-
getCellLevelAttributes
protected void getCellLevelAttributes(java.util.Map cell)
CTY indicates the cell type UTP indicates the template unit that it belongs to, in the format of "axis,position"- Overrides:
getCellLevelAttributes
in classAbstractReportGridDisplayCell
- Since:
- MicroStrategy Web 9.0.0
-
renderContextMenu
protected void renderContextMenu(MarkupOutput mo)
Deprecated.Description copied from class:AbstractReportGridDisplayCell
Render the context menu's trigger for this cell.- Overrides:
renderContextMenu
in classAbstractReportGridDisplayCell
- Parameters:
mo
- the output object- Since:
- MicroStrategy Web 8.0.0
-
isDrillPathAvailable
protected boolean isDrillPathAvailable(WebRowValue rowValue)
Utility method to determine if the current row value has drill information available- Parameters:
rowValue
- valueWebRowValue
instance to analyze- Returns:
- boolean value indicating if there is drill path information available or not, for the specified title.
-
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 classAbstractReportGridDisplayCell
- Returns:
- boolean value indicating if the current cell should be displayed as a link.
- Since:
- MicroStrategy Web 8.0.1
-
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 classAbstractReportGridDisplayCell
- 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 classAbstractReportGridDisplayCell
- Returns:
- true if the cell has underlying
WebObject
. - Since:
- MicroStrategy Web 8.0.0
-
getDrillPathWithHighImportance
public WebDrillPath getDrillPathWithHighImportance()
generate drilling url parameters for row value in DHTML mode- Specified by:
getDrillPathWithHighImportance
in interfaceReportGridDisplayCell
- Overrides:
getDrillPathWithHighImportance
in classAbstractReportGridDisplayCell
- Returns:
- The drill path with high importance
- Since:
- MicroStrategy Web 8.0.1
-
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 interfaceReportGridDisplayCell
- Overrides:
canRemoveFromGrid
in classAbstractReportGridDisplayCell
- 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 interfaceReportGridDisplayCell
- Overrides:
canRemoveFromReport
in classAbstractReportGridDisplayCell
- Returns:
- boolean value indicating if the manipulation should be enabled
- Since:
- MicroStrategy Web 8.0.1
-
canRename
public boolean canRename()
Utility methood for determining if the cell object is enabled for displaying the user the option to rename it- Specified by:
canRename
in interfaceReportGridDisplayCell
- Overrides:
canRename
in classAbstractReportGridDisplayCell
- Returns:
- boolean value indicating if the manipulation should be enabled
- Since:
- MicroStrategy Web 8.0.1
-
canFilterOn
public boolean canFilterOn()
Utility methood for determining if the cell object is enabled for displaying the user the option to filter on it- Specified by:
canFilterOn
in interfaceReportGridDisplayCell
- Overrides:
canFilterOn
in classAbstractReportGridDisplayCell
- Returns:
- boolean value indicating if the manipulation should be enabled
- Since:
- MicroStrategy Web 8.0.1
-
canFormat
public boolean canFormat()
Utility methood for determining if the cell object is enabled for displaying the user the option to format it- Specified by:
canFormat
in interfaceReportGridDisplayCell
- Overrides:
canFormat
in classAbstractReportGridDisplayCell
- Returns:
- boolean value indicating if the manipulation should be enabled
- Since:
- MicroStrategy Web 8.0.1
-
canHaveDerivedElements
public boolean canHaveDerivedElements()
- Specified by:
canHaveDerivedElements
in interfaceReportGridDisplayCell
- Since:
- MicroStrategy Web 9.0.0
-
canSort
public boolean canSort()
Utility methood for determining if the cell object is enabled for displaying the user the option to sort it- Specified by:
canSort
in interfaceReportGridDisplayCell
- Overrides:
canSort
in classAbstractReportGridDisplayCell
- Returns:
- boolean value indicating if the manipulation should be enabled
- Since:
- MicroStrategy Web 8.0.1
-
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 interfaceReportGridDisplayCell
- Overrides:
canDrill
in classAbstractReportGridDisplayCell
- Returns:
- boolean value indicating if the manipulation should be enabled
- Since:
- MicroStrategy Web 8.0.1
-
canInsertShortcutMetric
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- Specified by:
canInsertShortcutMetric
in interfaceReportGridDisplayCell
- Overrides:
canInsertShortcutMetric
in classAbstractReportGridDisplayCell
- Returns:
- boolean value indicating if the manipulation should be enabled
- Since:
- MicroStrategy Web 8.0.1
-
canPivot
public boolean canPivot()
Utility methood for determining if the cell object is enabled for displaying the user the option to pivot it- Specified by:
canPivot
in interfaceReportGridDisplayCell
- Overrides:
canPivot
in classAbstractReportGridDisplayCell
- Returns:
- boolean value indicating if the manipulation should be enabled
- Since:
- MicroStrategy Web 8.0.1
-
canModifyAttributeForm
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- Specified by:
canModifyAttributeForm
in interfaceReportGridDisplayCell
- Overrides:
canModifyAttributeForm
in classAbstractReportGridDisplayCell
- Returns:
- boolean value indicating if the manipulation should be enabled
- Since:
- MicroStrategy Web 8.0.1
-
getDerivedElementsEvent
public WebEvent getDerivedElementsEvent()
- Specified by:
getDerivedElementsEvent
in interfaceReportGridDisplayCell
- 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 interfaceReportGridDisplayCell
- 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 interfaceReportGridDisplayCell
- 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 interfaceReportGridDisplayCell
- Returns:
WebEvent
instance initialized with the information for renaming the current cell.- Since:
- MicroStrategy Web 9.0.0
-
generatePivotButton
protected Tag generatePivotButton(int type)
- Specified by:
generatePivotButton
in classAbstractReportGridDisplayCell
-
-