Class ReportGridCellColHeaderImpl
- java.lang.Object
-
- com.microstrategy.web.app.transforms.AbstractReportGridDisplayCell
-
- com.microstrategy.web.app.transforms.AbstractReportGridCellHeader
-
- com.microstrategy.web.app.transforms.ReportGridCellColHeaderImpl
-
- All Implemented Interfaces:
ReportGridCellColHeader
,ReportGridCellHeader
,ReportGridDisplayCell
,java.lang.Cloneable
- Direct Known Subclasses:
IPhoneReportGridCellColHeaderImpl
,ReportGridExcelCellColHeaderImpl
public class ReportGridCellColHeaderImpl extends AbstractReportGridCellHeader implements ReportGridCellColHeader
The
This class can handle two different types ofReportGridCellColHeaderImpl
is used to generate the HTML of a cell of that is a value of the column axis.SDK
objects:WebHeader
: used in view mode, this is the SDK object that represents a value of the column axis.WebTemplateMetric
: used in design mode when the metrics are located in the column axis, each metric is represented as a column header.
The
ReportGridCellColHeaderImpl
extends theAbstractReportGridDisplayCell
which controls the exeuction flow.Users who intend to programatically modify the HTML generated for a column header 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 theWebHeader
content.AbstractReportGridCellHeader.generateText(com.microstrategy.web.beans.MarkupOutput)
method of this class based on the header's semantics:public class CustomColHeader extends ReportGridCellColHeaderImpl { public void generateText(MarkupOutput mo) { WebHeader header = getWebHeader(); if (header != null) { switch (header.getSemantics()) { case EnumDSSXMLBaseFormType.DssXmlBaseFormPicture: mo.append("<IMG SRC=\""); mo.append(getText()); mo.append("\" ALT=\"\" BORDER=0 />"); break; case EnumDSSXMLBaseFormType.DssXmlBaseFormUrl: case EnumDSSXMLBaseFormType.DssXmlBaseFormEmail: mo.append("<A HREF=\""); if (header.getSemantics() == EnumDSSXMLBaseFormType.DssXmlBaseFormEmail) mo.append("mailto:"); mo.append(getText()); mo.append("\">"); mo.append(getText()); mo.append("</A>"); break; case EnumDSSXMLBaseFormType.DssXmlBaseFormHTMLTag: mo.append(HTMLHelper.decode(getText())); break; default: super.generateText(mo); break; } } else { super.generateText(mo); } } }
- Since:
- MicroStrategy Web 7.5.1
- See Also:
ReportGridDisplayCell
,ReportGridTransformImpl
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description protected static class
ReportGridCellColHeaderImpl.ColHeaderPivotButtonInfo
Helper class for storing pivot button information - such as JavaScript id, descriptor (tooltip) and image name - based on the action that can be performed given the current selected target.-
Nested classes/interfaces inherited from class com.microstrategy.web.app.transforms.AbstractReportGridCellHeader
AbstractReportGridCellHeader.AxisDepth
-
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.ReportGridCellColHeader
SORT_TYPE_ASCENDING, SORT_TYPE_DESCENDING
-
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 ReportGridCellColHeaderImpl()
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
appendContextMenuItems(ContextMenu rhMenu)
Deprecated.Please use the new approach for generating context menus, seeReportCellRemoveFromGrid
,ReportCellMove
, etcboolean
canInsertShortcutMetric()
Utility methood for determining if the cell object is enabled for displaying the user the option to insert shortcut metrics based on itboolean
canPivot()
Utility methood for determining if the cell object is enabled for displaying the user the option to pivot itboolean
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 specifiedboolean
canSort()
Utility methood for determining if the cell object is enabled for displaying the user the option to sort itprotected void
generateDrillCheckBox(MarkupOutput mo)
Obtains the check box tag information for Drill and renders it out.protected void
generateFilterOnSelectionCheckBox(MarkupOutput mo)
Obtains the check box tag information for Filter On Selection and renders it out.protected Tag
generatePivotButton(int type)
Generate the pivot button tag, according to the type of manipulation that should performprotected void
generatePivotButtons(MarkupOutput mo)
Calls forgeneratePivotButton(int)
for each one of the buttons this instance normally supportsprotected void
generatePreContent(MarkupOutput mo)
Generates the preContent of the cell.protected Tag
generateSortButton()
Generate the sort button tag information for this objectprotected void
generateSortButton(MarkupOutput mo)
Deprecated.usegenerateSortButton()
instead.protected WebMetric
getColHeaderWebMetric(WebHeader header)
get the metric object for the column headerprotected WebTemplate
getGridTemplate()
Returns an instance ofWebTemplate
from the View Bean.protected WebEvent
getPivotEvent(int type)
Generate the pivot event, according to the type of manipulation that should performprotected WebEvent
getRemoveEvent()
Get the remove event for the current object.WebEvent
getSortEvent(int type)
Get theWebEvent
instance with the information for sorting the current cell valuesprotected WebEvent
getSortEventByAxis(int axis)
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
init(TransformContext context, WebHeader header)
This method is called to initialize the cell in view mode.void
init(TransformContext context, WebTemplateMetric metric)
This method is called to initialize the cell in design mode.void
init(WebComponent wc, WebHeader header, java.util.HashMap cachedObjects)
Deprecated.please use the interface that receivesTransformContext
instance instead.void
init(WebComponent wc, WebTemplateMetric metric, java.util.HashMap cachedObjects)
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 boolean
isDrillAvailable()
protected boolean
isDrillPathAvailable(WebHeader header)
Utility method to determine if the current header has drill information availableprotected boolean
isHeaderMVJsonMovable()
Fix Issue 418196 for sort in column, if the head cell can be used in sort, it don't use Jsonmap for optimization.boolean
isMetricDrillable(WebHeader header, WebDrillPath drillPath)
return whether the header has a drillable metricboolean
isSortAscending()
boolean
isSorted()
protected boolean
isTotal()
protected void
renderContextMenu(MarkupOutput mo)
Deprecated.void
reset()
Reset all of the instance variables.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-
Methods inherited from class com.microstrategy.web.app.transforms.AbstractReportGridCellHeader
addContextMenuAttributes, addToHeaderMetricValueJsonMap, canAddThresholds, canDrill, canDrillAdvanced, canEditControl, canExpandCollapse, canFilter, canFilterOn, canFilterOnSelection, canFormat, canHaveDerivedElements, canHyperLink, canHyperlinkForCurrentHTMLMode, canMetricFilterOn, canModifyAttributeForm, canOpenAlerts, canQuickGroup, canRemoveFromGrid, canRemoveFromReport, canRename, cellNeedsLink, generateContent, generateControlAnchor, generateDrillAnchor, generateDrillCheckBoxTag, generateElementAnchor, generateFilterOnSelectionCheckBoxTag, generateHyperLinkAnchor, generateRAPreContent, generateStaticHyperLinkAnchor, generateText, generateTooltipContent, getAxisDepth, getCellAttributes, getCellLevelAttributes, getDerivedElementsEvent, getDrillParametersForDHTML, getDrillPathWithHighImportance, getFilterOnEvent, getInsertMetricPercentToTotalEvent, getInsertMetricPercentToTotalEvent, getInsertMetricRankEvent, getInsertMetricTransformationEvent, getKey, getMaxPosition, getMetricID, getOnClickAttForDrillPath, getOpenFormatEditorEvent, getParentElementIndex, getParentFormValueIndex, getPosition, getRenameEvent, getSelectorEvent, getSetFormatEditorTargetEvent, getURLBuffer, getWebHeader, getWebTemplateMetric, getWebTemplateMetric, hasMetricFilterCondition, hasRuntimeUnitLimit, isDerivedMetric, isMetric, isTemplateMetric, isTypeMetric, processHyperLinkNavigationInfo, setWebHeader, setWebTemplateMetric, shouldHiliteOnServer, showPivotForLastAttrRowInCol
-
Methods inherited from class com.microstrategy.web.app.transforms.AbstractReportGridDisplayCell
addContextMenuAttributes, addDragAndDropAttributes, addExtraAttribute, addTooltipAttributes, addToStyle, buildGenericTooltipInformation, canDefineDerivedElements, canEditMetricFilter, canUse, clone, convertNonbreakingSpaceOnMV, decodeEuro, encodeMV, generateAnchor, generateContextMenu, generateDragAndDrop, generateDragAndDropAttributes, generateDrillCheckBox, generateDrillCheckBox, generateDrillContextMenu, generateDrillOpenLink, generateDrillOpenLink, generateFilterOnSelectionCheckBox, generateFilterOnSelectionCheckBox, generateHeaderDrillContextMenu, generateHeaderDrillContextMenu, generateHeaderSortContextMenu, generateHeaderSortContextMenu, generateInnerHTML, generateOutlineModeImage, generateOutlineSubTotalName, generateOutput, generatePostContent, generateRowValueDrillContextMenu, generateRowValueDrillContextMenu, generateSortContextMenu, generateThresholdSymbol, generateTitleDrillContextMenu, generateTitleDrillContextMenu, generateTitleSortContextMenu, generateTitleSortContextMenu, generateTooltip, generateTooltipForHeaders, generateTooltipForRowValue, generateTooltipForTitles, getAccessibilityInfo, getBaseBean, getCellColor, getCellID, getCellType, 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, getPostTextForMetricValue, getPostTextForNonMetricValue, getPreTextForMetricValue, getPreTextForNonMetricValue, getRenameEvent, getReportBean, getReportDesignMode, getReportGridTransform, getRowSpan, getRowValueDrillElements, getRowValueDrillParametersForDHTML, getRowValueDrillParametersForDHTML, getRowValueDrillPathWithHighImportance, getRowValueDrillPathWithHighImportance, getRowValueDrillURL, getRowValueDrillURL, getRWDDrillOutEvent, getShowDescriptionAsTooltip, getSortAscendingEvent, getSortDescendingEvent, getSortEvent, getSortEventByAxisBySortOrder, getSortStatus, getStyle, getStyleForNonBuiltInFormat, getSubTitle, getSubtitleIndex, getTargetKeys, getText, getTitleDrillParametersForDHTML, getTitleDrillParametersForDHTML, getTitleDrillURL, getTitleDrillURL, getTooltip, getViewBean, getWidth, groupContextMenuDrillPathsByType, hasDrillPathsWithHighImportanceAvailable, init, init, initDragAndDrop, isAccessibilityMode, isContextMenuEnabled, isContextMenusEnabled, isDerivedMetric, isDesignMode, isDhtml, isDragAndDropEnabled, isFeatureAvailable, isFPTrue, isFPTrue, isHeaderNeedLink, isIframeEnabled, isIFrameEnabled, isIframeRequest, isIFrameRequest, isItemsAddedToContextMenu, 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, showAdvancedDrillingOptionsInContextMenu, showBanding, showDrillAdvanced, showDrillCheckBox, showDrillDownOnly, showDrillHyperlink, showDrillHyperlinkMetric, showDrillMetric, showDrillPathSetNamesSubMenuAtTopLevel, showDrillRMC, showDrillRMCMetric, showExtraRemoveRMC, showFilterOnSelectionCheckBox, showFormattingRMC, showPivot, showPivotRMC, showRemove, 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.ReportGridCellHeader
getInsertMetricPercentToTotalEvent, getInsertMetricPercentToTotalEvent, getInsertMetricRankEvent, getInsertMetricTransformationEvent, getWebHeader, getWebTemplateMetric, getWebTemplateMetric, isMetric
-
Methods inherited from interface com.microstrategy.web.app.transforms.ReportGridDisplayCell
addExtraAttribute, canAddThresholds, canDrill, canDrillAdvanced, canEditControl, canEditMetricFilter, canFilterOn, canFilterOnSelection, canFormat, canHaveDerivedElements, canHyperLink, canMetricFilterOn, canModifyAttributeForm, canOpenAlerts, canQuickGroup, canRemoveFromGrid, canRemoveFromReport, canRename, generateOutput, getAccessibilityInfo, getCellID, getCellType, getColSpan, getControlElementSelectorEvent, getDerivedElementsEvent, getDrillEvent, getDrillPathWithHighImportance, getExtraInfo, getExtraStyle, getFilterOnEvent, getHeaderContent, getKey, getOpenFormatEditorEvent, getRenameEvent, getRowSpan, getSetFormatEditorTargetEvent, getStyle, 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 classAbstractReportGridCellHeader
-
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 uses init(TransformContext, WebTemplateUnit).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 uses init(TransformContext, WebTemplateUnit).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, java.util.HashMap cachedObjects)
Deprecated.please use the interface that receivesTransformContext
instance instead.Description copied from class:AbstractReportGridCellHeader
Initialize this class with the cell information to consider for HTML generation- Specified by:
init
in interfaceReportGridCellHeader
- Overrides:
init
in classAbstractReportGridCellHeader
- Parameters:
wc
-WebComponent
base instancemetric
-WebTemplateMetric
instance related with the cell to be renderedcachedObjects
- HashMap instance with information relevant to this instance for HTML generation.- Since:
- MicroStrategy Web 7.5.2
-
init
public void init(TransformContext context, WebTemplateMetric metric)
Description copied from interface:ReportGridCellHeader
This method is called to initialize the cell in design mode. It receives aWebTemplateMetric
as the underlying SDK object.- Specified by:
init
in interfaceReportGridCellHeader
- Overrides:
init
in classAbstractReportGridCellHeader
- Parameters:
context
-TransformContext
instance initialized with the grid's transform information.metric
-WebTemplateMetric
instance corresponding to the cell to be displayed.- Since:
- MicroStrategy Web 8.0.1
-
init
public void init(TransformContext context, WebHeader header)
Description copied from interface:ReportGridCellHeader
This method is called to initialize the cell in view mode. It receives aWebHeader
instance as the underlying SDK object- Specified by:
init
in interfaceReportGridCellHeader
- Parameters:
context
-TransformContext
instance initialized with the grid's transform information.header
-WebHeader
instance coresponding to the cell to be displayed.- Since:
- MicroStrategy Web 8.0.1
-
init
public void init(WebComponent wc, WebHeader header, java.util.HashMap cachedObjects)
Deprecated.please use the interface that receivesTransformContext
instance instead.Description copied from interface:ReportGridCellHeader
This method is called to initialize the cell in view mode. It receives aWebHeader
as the underlying SDK object.- Specified by:
init
in interfaceReportGridCellHeader
- Parameters:
wc
- The bean being transformed.header
- TheWebHeader
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
-
generateSortButton
protected Tag generateSortButton()
Generate the sort button tag information for this object- Overrides:
generateSortButton
in classAbstractReportGridDisplayCell
- Returns:
Tag
instance initialized if sort is supported.- Since:
- MicroStrategy Web 8.0.1
-
isMetricDrillable
public boolean isMetricDrillable(WebHeader header, WebDrillPath drillPath)
Description copied from class:AbstractReportGridDisplayCell
return whether the header has a drillable metric- Specified by:
isMetricDrillable
in interfaceReportGridCellHeader
- Overrides:
isMetricDrillable
in classAbstractReportGridCellHeader
- Parameters:
header
- the header objectdrillPath
- the drill path- Returns:
- whether the header has a drillable metric
- Since:
- MicroStrategy Web 8.0.1
-
isSorted
public boolean isSorted()
- Specified by:
isSorted
in interfaceReportGridCellColHeader
- Returns:
- boolean value indicating if the current cell is sorted or not
- Since:
- MicroStrategy Web 8.0.1
-
isSortAscending
public boolean isSortAscending()
- Specified by:
isSortAscending
in interfaceReportGridCellColHeader
- Returns:
- boolean value indicating if the current cell is sorted ascending or not
- Since:
- MicroStrategy Web 8.0.1
-
getSortEvent
public WebEvent getSortEvent(int type)
Description copied from interface:ReportGridCellColHeader
Get theWebEvent
instance with the information for sorting the current cell values- Specified by:
getSortEvent
in interfaceReportGridCellColHeader
- Parameters:
type
- int value with the identifier for the sort order to generate. Values expected includeReportGridCellColHeader.SORT_TYPE_ASCENDING
andReportGridCellColHeader.SORT_TYPE_DESCENDING
- Returns:
- WebEvent
- Since:
- MicroStrategy Web 8.0.1
-
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
-
generateSortButton
protected void generateSortButton(MarkupOutput mo)
Deprecated.usegenerateSortButton()
instead.Generate the HTML for the sort button- Overrides:
generateSortButton
in classAbstractReportGridDisplayCell
- Parameters:
mo
- MarkupOutput instnace where the HTML generated will be saved
-
generatePivotButtons
protected void generatePivotButtons(MarkupOutput mo)
Calls forgeneratePivotButton(int)
for each one of the buttons this instance normally supports- Overrides:
generatePivotButtons
in classAbstractReportGridDisplayCell
- Parameters:
mo
-MarkupOutput
instance where the HTML generated by this method will be saved.
-
isDrillAvailable
protected boolean isDrillAvailable()
- Specified by:
isDrillAvailable
in classAbstractReportGridCellHeader
- Since:
- MicroStrategy Web 8.0.0
-
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
-
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
-
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
-
generateDrillCheckBox
protected void generateDrillCheckBox(MarkupOutput mo)
Obtains the check box tag information for Drill and renders it out. If a check box is rendered, an empty line is also added to the final HTML output.- Overrides:
generateDrillCheckBox
in classAbstractReportGridDisplayCell
- Parameters:
mo
-MarkupOutput
instance where the HTML content generated by this method will be saved
-
generateFilterOnSelectionCheckBox
protected void generateFilterOnSelectionCheckBox(MarkupOutput mo)
Obtains the check box tag information for Filter On Selection and renders it out. If a check box is rendered, an empty line is also added to the final HTML output.- Overrides:
generateFilterOnSelectionCheckBox
in classAbstractReportGridDisplayCell
- Parameters:
mo
-MarkupOutput
instance where the HTML content generated by this method will be saved
-
showRemoveFromReport
protected boolean showRemoveFromReport(int metricSize, int wkSetSize)
Description copied from class:AbstractReportGridDisplayCell
Determine if we should show the 'Remove from Report' option depending on the number of metrics and the working set size- Overrides:
showRemoveFromReport
in classAbstractReportGridDisplayCell
- Parameters:
metricSize
- number of metricswkSetSize
- working set size- Returns:
true
if working set is not empty or if the working set size is greater than the metrics size.- Since:
- MicroStrategy Web 8.0.0
-
generatePreContent
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
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 extendAbstractReportGridDisplayCell.setPreContent(java.lang.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.AbstractReportGridDisplayCell
:
public void generatePreContent(MarkupOutput mo) { super.generatePreContent(mo); mo.append("<LI>"); }
- Overrides:
generatePreContent
in classAbstractReportGridDisplayCell
- Parameters:
mo
- the output object- 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
-
isDrillPathAvailable
protected boolean isDrillPathAvailable(WebHeader header)
Utility method to determine if the current header has drill information available- Specified by:
isDrillPathAvailable
in classAbstractReportGridCellHeader
- Parameters:
header
-WebHeader
instance to analyze- Returns:
- boolean value indicating if there is drill path information available or not, for the specified title.
-
isTotal
protected boolean isTotal()
- Overrides:
isTotal
in classAbstractReportGridCellHeader
-
getGridTemplate
protected WebTemplate getGridTemplate() throws WebBeanException, WebObjectsException
Returns an instance ofWebTemplate
from the View Bean.- Returns:
WebTemplate
The Grid Template.- Throws:
WebBeanException
WebObjectsException
-
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
-
getSortEventByAxis
protected WebEvent getSortEventByAxis(int axis)
- Overrides:
getSortEventByAxis
in classAbstractReportGridDisplayCell
- Parameters:
axis
- specifies the axisEnumViewBeanEvents
on which the sort is defined- Since:
- MicroStrategy Web 8.0.2
-
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
-
generatePivotButton
protected Tag generatePivotButton(int type)
Generate the pivot button tag, according to the type of manipulation that should perform- Specified by:
generatePivotButton
in classAbstractReportGridDisplayCell
- Parameters:
type
- integer value that indicates which type of pivot action it should execute. Values come from theReportGridDisplayCell.PIVOT_INCREASE_POSITION
,ReportGridDisplayCell.PIVOT_DECREASE_POSITION
andReportGridDisplayCell.PIVOT_REMOVE
constants.- Returns:
Tag
initialized instance with the information for the pivot manipulation. It will returnnull
if not supported. It might return a simple IMG tag in case the manipulation shall be processed in JavaScript, or an INPUT of type IMAGE if it will be processed as part of a FORM, or an A anchor tag with an IMG inside if it's to be a button link.- Since:
- MicroStrategy Web 8.0.1
-
getRemoveEvent
protected WebEvent getRemoveEvent()
Get the remove event for the current object. This only supports objects that are metrics.- Returns:
WebEvent
initialized instance if manipulation is supported, otherwise returnsnull
.- 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
-
canPivot
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- Specified by:
canPivot
in interfaceReportGridDisplayCell
- Overrides:
canPivot
in classAbstractReportGridDisplayCell
- Parameters:
type
- value indicating which type of pivot manipulation is being tested. Values come from theReportGridDisplayCell.PIVOT_INCREASE_POSITION
,ReportGridDisplayCell.PIVOT_DECREASE_POSITION
,ReportGridDisplayCell.PIVOT_SWITCH_AXIS
,ReportGridDisplayCell.PIVOT_TO_PAGE_BY
andReportGridDisplayCell.PIVOT_REMOVE
constants.- Returns:
- boolean value indicating if the manipulation should be enabled
- Since:
- MicroStrategy Web 8.0.1
-
getPivotEvent
protected WebEvent getPivotEvent(int type)
Generate the pivot event, according to the type of manipulation that should perform- Parameters:
type
- integer value that indicates which type of pivot action it should execute. Values come from theReportGridDisplayCell.PIVOT_INCREASE_POSITION
,ReportGridDisplayCell.PIVOT_DECREASE_POSITION
ReportGridDisplayCell.PIVOT_SWITCH_AXIS
andReportGridDisplayCell.PIVOT_TO_PAGE_BY
constants.- Returns:
WebEvent
initialized instance with the information for the pivot manipulation. It will returnnull
if not supported.- Since:
- MicroStrategy Web 8.0.1
-
getColHeaderWebMetric
protected WebMetric getColHeaderWebMetric(WebHeader header)
get the metric object for the column header- Overrides:
getColHeaderWebMetric
in classAbstractReportGridDisplayCell
- Parameters:
header
- the column header- Returns:
- the corresponding
WebMetric
object - Since:
- MicroStrategy Web 8.0.1
-
isHeaderMVJsonMovable
protected boolean isHeaderMVJsonMovable()
Fix Issue 418196 for sort in column, if the head cell can be used in sort, it don't use Jsonmap for optimization.- Overrides:
isHeaderMVJsonMovable
in classAbstractReportGridCellHeader
- Returns:
- boolean value indicating if the Jsonmap should be used
- Since:
- MicroStrategy Web 9.0.2
-
-