Class ReportGridCellRowHeaderImpl
- java.lang.Object
-
- com.microstrategy.web.app.transforms.AbstractReportGridDisplayCell
-
- com.microstrategy.web.app.transforms.AbstractReportGridCellHeader
-
- com.microstrategy.web.app.transforms.ReportGridCellRowHeaderImpl
-
- All Implemented Interfaces:
ReportGridCellHeader
,ReportGridCellRowHeader
,ReportGridDisplayCell
,java.lang.Cloneable
- Direct Known Subclasses:
IPhoneReportGridCellRowHeaderImpl
,ReportGridExcelCellRowHeaderImpl
public class ReportGridCellRowHeaderImpl extends AbstractReportGridCellHeader implements ReportGridCellRowHeader
The
This class can handle two different types ofReportGridCellRowHeaderImpl
is used to generate the HTML of a cell of that is a value of the row axis.SDK
objects:WebHeader
: used in view mode, this is the SDK object that represents a value of the row axis.WebTemplateMetric
: used in design mode when the metrics are located in the column axis, each metric is represented as a row header.
The
ReportGridCellRowHeaderImpl
extends theAbstractReportGridDisplayCell
which controls the exeuction flow.Users who intend to programatically modify the HTML generated for a row 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 ReportGridCellRowHeaderImpl { 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/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.ReportGridDisplayCell
PIVOT_DECREASE_POSITION, PIVOT_INCREASE_POSITION, PIVOT_REMOVE, PIVOT_SWITCH_AXIS, PIVOT_TO_PAGE_BY
-
-
Constructor Summary
Constructors Constructor Description ReportGridCellRowHeaderImpl()
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
canMetricFilterOn()
Utility method for determining if the cell object is enabled for displaying the user the option to apply a metric filter 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
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 void
generateOutlineModeImage(MarkupOutput mo)
Generate the javascript images for collapse and expand for outline mode.protected void
generateOutlineSubTotalName(MarkupOutput mo)
Generate the name of the subtotal type next to the header element for outline mode.protected Tag
generatePivotButton(int type)
protected void
generatePreContent(MarkupOutput mo)
Generates the preContent of the cell.java.lang.String
getExtraStyle()
Returns the extra style information required for the formatting of the cell as registered by the Transform.protected WebGridData
getGridData()
protected WebTemplate
getGridTemplate()
protected int
getOutlinemodeRowCount()
get row count for outline modeprotected java.lang.String
getOutlinemodeSubTotalName()
get subtotal name for outline modeprotected boolean
getShowOutlinemodeImage()
get whether display outline mode imageprotected java.lang.String
getSortID()
This method return the ID to use for sorting this cell.protected WebTemplateUnit
getWebTemplateUnit()
Returns theWebTemplateUnit
associated with the class.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)
Initializes the instance.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, FormalParameters formalParas)
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, WebTemplateUnit unit, 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(WebComponent wc, java.util.HashMap cachedObjects)
Deprecated.use the init interface that receives aReportGridTransformImpl.Context
objectvoid
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 availableboolean
isMetric()
determine if the row header is containing a metricboolean
isMetricDrillable(WebHeader header, WebDrillPath drillPath)
return whether the header has a drillable metricprotected void
renderContextMenu(MarkupOutput mo)
Deprecated.void
reset()
Reset all of the instance variables.void
setOutlinemodeRowCount(int OutlinemodeRowCount)
In outline mode, this is used to indicate the cell in which row it is being rendered.void
setOutlinemodeSubTotalName(java.lang.String OutlineodeSubtotalName)
In outline mode, this is used to indicate the name of the subtotal whose values are being displayed in this row.void
setOutlinemodeWrapHeaderText(boolean isWrap)
Indicates the header text of the outline mode cell need to be wrap up with related html tags.void
setShowOutlinemodeImage(boolean value)
Indicates the cell that this header can be expanded in outline mode and that an image to expand/collapse the header needs to be rendered.-
Methods inherited from class com.microstrategy.web.app.transforms.AbstractReportGridCellHeader
addContextMenuAttributes, addToHeaderMetricValueJsonMap, canAddThresholds, canDrill, canDrillAdvanced, canEditControl, canExpandCollapse, canFilter, canFilterOn, canFilterOnSelection, canFormat, canHaveDerivedElements, canHyperLink, canHyperlinkForCurrentHTMLMode, canModifyAttributeForm, canOpenAlerts, canQuickGroup, 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, isHeaderMVJsonMovable, isTemplateMetric, isTotal, isTypeMetric, processHyperLinkNavigationInfo, setWebHeader, setWebTemplateMetric, shouldHiliteOnServer, showPivotForLastAttrRowInCol
-
Methods inherited from class com.microstrategy.web.app.transforms.AbstractReportGridDisplayCell
addContextMenuAttributes, addDragAndDropAttributes, addExtraAttribute, addTooltipAttributes, addToStyle, buildGenericTooltipInformation, canDefineDerivedElements, canEditMetricFilter, canPivot, canUse, clone, convertNonbreakingSpaceOnMV, decodeEuro, encodeMV, generateAnchor, generateContextMenu, generateDragAndDrop, generateDragAndDropAttributes, generateDrillCheckBox, generateDrillCheckBox, generateDrillContextMenu, generateDrillOpenLink, generateDrillOpenLink, generateFilterOnSelectionCheckBox, generateFilterOnSelectionCheckBox, generateHeaderDrillContextMenu, generateHeaderDrillContextMenu, generateHeaderSortContextMenu, generateHeaderSortContextMenu, generateInnerHTML, generateOutput, generatePivotButtons, generatePostContent, generateRowValueDrillContextMenu, generateRowValueDrillContextMenu, generateSortButton, generateSortButton, generateSortContextMenu, generateThresholdSymbol, generateTitleDrillContextMenu, generateTitleDrillContextMenu, generateTitleSortContextMenu, generateTitleSortContextMenu, generateTooltip, generateTooltipForHeaders, generateTooltipForRowValue, generateTooltipForTitles, getAccessibilityInfo, getBaseBean, getCellColor, getCellID, getCellType, getColHeaderWebMetric, getColSpan, getContext, getContext, getContextMenu, getContextMenu, getContextMenuAttributes, getContextMenuAttributes, getContextMenuManager, getControlElementSelectorEvent, getCssPrefix, getDefaultAdvancedDrillEvent, getDefaultAdvancedDrillProcessEvent, getDefaultDrillEditorProcessEvent, getDefaultDrillEvent, getDefaultDrillEvent, getDefaultDrillFilterOnSelectionEvent, getDefaultSortEvent, getDerivedElementsEvent, getDescription, getDescriptor, getDescriptor, getDrillEvent, getDrillKey, getDrillParametersForDHTML, getDrillPath, getDrillpathKey, getDrillPathKey, getDrillpathKeyInOldFormat, getEventManager, getExtraInfo, 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, getSortEventByAxis, getSortEventByAxisBySortOrder, getSortStatus, getStyle, getStyleForNonBuiltInFormat, getSubTitle, getSubtitleIndex, getTargetKeys, getText, getTitleDrillParametersForDHTML, getTitleDrillParametersForDHTML, getTitleDrillURL, getTitleDrillURL, getTooltip, getViewBean, getWidth, groupContextMenuDrillPathsByType, hasDrillPathsWithHighImportanceAvailable, 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, 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
-
Methods inherited from interface com.microstrategy.web.app.transforms.ReportGridDisplayCell
addExtraAttribute, canAddThresholds, canDrill, canDrillAdvanced, canEditControl, canEditMetricFilter, canFilterOn, canFilterOnSelection, canFormat, canHaveDerivedElements, canHyperLink, canModifyAttributeForm, canOpenAlerts, canPivot, canQuickGroup, canRename, generateOutput, getAccessibilityInfo, getCellID, getCellType, getColSpan, getControlElementSelectorEvent, getDerivedElementsEvent, getDrillEvent, getDrillPathWithHighImportance, getExtraInfo, getFilterOnEvent, getHeaderContent, getKey, getOpenFormatEditorEvent, getRenameEvent, getRowSpan, getSetFormatEditorTargetEvent, getStyle, getText, getTooltip, getWidth, 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
-
getWebTemplateUnit
protected WebTemplateUnit getWebTemplateUnit()
Returns theWebTemplateUnit
associated with the class.- Returns:
WebTemplateUnit
-
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 usesinit(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 usesinit(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, java.util.HashMap cachedObjects)
Deprecated.use the init interface that receives aReportGridTransformImpl.Context
objectDescription 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 component.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)
Description copied from interface:ReportGridDisplayCell
Initializes the instance.- Specified by:
init
in interfaceReportGridDisplayCell
- Overrides:
init
in classAbstractReportGridDisplayCell
- Parameters:
context
-TransformContext
instance that contains a reference to the transform being used to render the overall grid information- Since:
- MicroStrategy Web 8.0.1
-
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(WebComponent wc, WebTemplateMetric metric, FormalParameters formalParas)
Deprecated.please use the interface that receivesTransformContext
instance instead.Description copied from interface:ReportGridCellRowHeader
This method is called to initialize the cell in design mode. It receives aWebTemplateMetric
as the underlying SDK object.- Specified by:
init
in interfaceReportGridCellRowHeader
- Parameters:
wc
- The bean being transformed.metric
- TheWebTemplateMetric
corresponding to this cell.formalParas
- all the formal parameters from the report transform. Used to control some output generation.- Since:
- MicroStrategy Web 7.5.2
-
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 8.0.0
-
init
public void init(WebComponent wc, WebTemplateUnit unit, FormalParameters formalParas)
Deprecated.please use the interface that receivesTransformContext
instance instead.Description copied from interface:ReportGridCellRowHeader
This method is called to initialize the cell in design mode. It receives aWebTemplateUnit
as the underlying SDK object.- Specified by:
init
in interfaceReportGridCellRowHeader
- Parameters:
wc
- The bean being transformed.unit
- TheWebTemplateUnit
corresponding to this cell.formalParas
- all the formal parameters from the report transform. Used to control some output generation.- Since:
- MicroStrategy Web 7.5.2
-
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
-
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
-
isDrillAvailable
protected boolean isDrillAvailable()
- Specified by:
isDrillAvailable
in classAbstractReportGridCellHeader
- Since:
- MicroStrategy Web 8.0.0
-
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
-
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
-
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
-
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 classAbstractReportGridCellHeader
- 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 classAbstractReportGridCellHeader
- Returns:
- boolean value indicating if the manipulation should be enabled
- Since:
- MicroStrategy Web 8.0.1
-
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.- 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.- Overrides:
generateFilterOnSelectionCheckBox
in classAbstractReportGridDisplayCell
- Parameters:
mo
-MarkupOutput
instance where the HTML content generated by this method will be saved
-
isMetric
public boolean isMetric()
determine if the row header is containing a metric- Specified by:
isMetric
in interfaceReportGridCellHeader
- Overrides:
isMetric
in classAbstractReportGridCellHeader
- Returns:
- whether the cell is containing a metric
-
canMetricFilterOn
public boolean canMetricFilterOn()
Description copied from class:AbstractReportGridDisplayCell
Utility method for determining if the cell object is enabled for displaying the user the option to apply a metric filter on it- Specified by:
canMetricFilterOn
in interfaceReportGridDisplayCell
- Overrides:
canMetricFilterOn
in classAbstractReportGridCellHeader
- Returns:
- boolean value indicating if the manipulation should be enabled
- Since:
- MicroStrategy Web 9.0.0
-
generateOutlineModeImage
protected void generateOutlineModeImage(MarkupOutput mo)
Description copied from class:AbstractReportGridDisplayCell
Generate the javascript images for collapse and expand for outline mode.- Overrides:
generateOutlineModeImage
in classAbstractReportGridDisplayCell
- Parameters:
mo
- the output object
-
generateOutlineSubTotalName
protected void generateOutlineSubTotalName(MarkupOutput mo)
Description copied from class:AbstractReportGridDisplayCell
Generate the name of the subtotal type next to the header element for outline mode.- Overrides:
generateOutlineSubTotalName
in classAbstractReportGridDisplayCell
- Parameters:
mo
- the output object
-
getOutlinemodeRowCount
protected int getOutlinemodeRowCount()
get row count for outline mode- Returns:
- row count for outline mode
-
setOutlinemodeRowCount
public void setOutlinemodeRowCount(int OutlinemodeRowCount)
Description copied from interface:ReportGridCellRowHeader
In outline mode, this is used to indicate the cell in which row it is being rendered. This information needs to be added to the cell'stag
to enable expanding/collapsing of its child rows.- Specified by:
setOutlinemodeRowCount
in interfaceReportGridCellRowHeader
- Parameters:
OutlinemodeRowCount
- The row number this cell is being rendered in.
-
getOutlinemodeSubTotalName
protected java.lang.String getOutlinemodeSubTotalName()
get subtotal name for outline mode- Returns:
- subtotal name for outline mode
-
setOutlinemodeSubTotalName
public void setOutlinemodeSubTotalName(java.lang.String OutlineodeSubtotalName)
Description copied from interface:ReportGridCellRowHeader
In outline mode, this is used to indicate the name of the subtotal whose values are being displayed in this row.
In outline mode, the Transform automatically shows the values of the first subtotal for the current level. This enables users to analize the data even if the level is collapsed. The cell should display the name of this subtotal.
- Specified by:
setOutlinemodeSubTotalName
in interfaceReportGridCellRowHeader
- Parameters:
OutlineodeSubtotalName
- String with the subtotal's name.
-
getShowOutlinemodeImage
protected boolean getShowOutlinemodeImage()
get whether display outline mode image- Returns:
- whether display outline mode image
-
setShowOutlinemodeImage
public void setShowOutlinemodeImage(boolean value)
Description copied from interface:ReportGridCellRowHeader
Indicates the cell that this header can be expanded in outline mode and that an image to expand/collapse the header needs to be rendered.- Specified by:
setShowOutlinemodeImage
in interfaceReportGridCellRowHeader
- Parameters:
value
- If set totrue
, the cell needs to include the image to expand/collapse the cell
-
setOutlinemodeWrapHeaderText
public void setOutlinemodeWrapHeaderText(boolean isWrap)
Description copied from interface:ReportGridCellRowHeader
Indicates the header text of the outline mode cell need to be wrap up with related html tags.- Specified by:
setOutlinemodeWrapHeaderText
in interfaceReportGridCellRowHeader
- Parameters:
isWrap
- If set totrue
, the header text need to do format converting.
-
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
-
getExtraStyle
public java.lang.String getExtraStyle()
Description copied from class:AbstractReportGridDisplayCell
Returns the extra style information required for the formatting of the cell as registered by the Transform. This text is assigned to theSTYLE
attribute of theTD
tag.- Specified by:
getExtraStyle
in interfaceReportGridDisplayCell
- Overrides:
getExtraStyle
in classAbstractReportGridDisplayCell
- Returns:
- The extra style info as registered by the Transform.
-
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.
-
getGridData
protected WebGridData getGridData() throws WebBeanException, WebObjectsException
- Throws:
WebBeanException
WebObjectsException
- Since:
- MicroStrategy Web 8.0.0
-
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
-
getGridTemplate
protected WebTemplate getGridTemplate() throws WebBeanException, WebObjectsException
- Throws:
WebBeanException
WebObjectsException
- 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
-
generatePivotButton
protected Tag generatePivotButton(int type)
- Specified by:
generatePivotButton
in classAbstractReportGridDisplayCell
-
-