Package com.microstrategy.web.app.transforms

Class AbstractReportGridCellTitle

java.lang.Object

com.microstrategy.web.app.transforms.AbstractReportGridDisplayCell

com.microstrategy.web.app.transforms.AbstractReportGridCellTitle

All Implemented Interfaces:

ReportGridCellTitle, ReportGridDisplayCell, java.lang.Cloneable

Direct Known Subclasses:

ReportGridCellColTitleImpl, ReportGridCellRowTitleImpl

public abstract class AbstractReportGridCellTitle
extends AbstractReportGridDisplayCell
implements ReportGridCellTitle

This class serves as base implementation for other classes such as ReportGridCellColTitleImpl and ReportGridCellRowTitleImpl which render Cell Title information of a Grid to be presented to the user.

Since:

MicroStrategy Web 8.0.1

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	AbstractReportGridCellTitle.TitlePivotButtonInfo	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.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
AbstractReportGridCellTitle()

Method Summary

Modifier and Type	Method	Description
protected void	addContextMenuAttributes(java.util.Map atts)	Adds into the Map instance the tag attributes required for processing context menus.
boolean	canAddShortcutMetric(int shortcutMetricType)	Returns whether specified shortcut metric could be created based on current cell.
boolean	canDrillAdvanced()	Utility methood for determining if the cell object is enabled for displaying the user the option for advanced drilling on it
boolean	canEditControl()	Utility methood for determining if the cell object is enabled for displaying the user the option to edit control
boolean	canFilterOn()	Utility methood for determining if the cell object is enabled for displaying the user the option to filter on it
boolean	canHaveDerivedElements()
boolean	canHyperLink()	Utility method for determining if the cell object is enabled for displaying the user the option to navigate to custom hyperlinks
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
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
boolean	canRename()	Utility methood for determining if the cell object is enabled for displaying the user the option to rename it
boolean	canSort()	Utility methood for determining if the cell object is enabled for displaying the user the option to sort it
protected boolean	cellNeedsLink()	Utility method for determining if the current cell being displayed needs to be a link or not, for example, in case of drilling available.
protected void	generateContent(MarkupOutput mo)	Extends generateContent by adding a URL link to the cell's text.
protected AnchorTag	generateControlAnchor()
protected AnchorTag	generateDrillAnchor()	Utility method for generating the AnchorTag instance with all the drill information if available for the current cell being displayed by this instance.
protected AnchorTag	generateElementAnchor()	Utility method for generating the AnchorTag instance for the element being rendered .
protected Tag	generatePivotButton(int type)	Generate the pivot button tag, according to the type of manipulation that should perform
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
WebEvent	getAddShortcutMetricEvent(int shortcutMetricType)	Returns the WebEvent to add shortcut metric based on current cell.
protected void	getCellAttributes(java.util.Map attributes)
WebEvent	getDerivedElementsEvent()
WebDrillPath	getDrillPathWithHighImportance()	Obtain the Drill path with high importance information for the current cell being analyzed
WebEvent	getFilterOnEvent()	Get the event for filter on the cell header instance
protected WebTemplate	getGridTemplate()	Utility method for obtaining the WebTemplate object for the grid being rendered
int	getKey()
protected int	getMaxPosition()
WebEvent	getOpenFormatEditorEvent()	Get the event for opening the format editor for the requested target.
protected WebEvent	getPivotEvent(int type)	Generate the pivot event, according to the type of manipulation that should perform
protected int	getPosition()
protected WebEvent	getRemoveEvent()	Generate the remove event for the currently selected object in the template.
WebEvent	getRenameEvent()	Get the event for renaming the current cell
protected WebEvent	getSelectorEvent()	get selector Event by assigning the selected element as 'All elements'
WebEvent	getSetFormatEditorTargetEvent()	Get the event for setting the current target of the format editor to be this cell instance
int	getUnitType()
protected java.lang.StringBuffer	getURLBuffer()	Deprecated. if the link information for drilling should be modified, please update the generateDrillAnchor() method.
WebTemplateUnit	getWebTemplateUnit()	Obtain the WebTemplateUnit instance associated with this class
WebTitle	getWebTitle()	Obtain the WebTitle instance associated with this class
protected boolean	hasRuntimeUnitLimit()
void	init(TransformContext context, WebTemplateUnit unit)	This method is called to initialize the cell in design mode.
void	init(WebComponent wc, WebTemplateUnit unit, java.util.HashMap cachedObjects)	Deprecated. please use the interface that takes Context object instances as parameter
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 abstract boolean	isDrillPathAvailable(WebTitle title)	Utility method to determine if the current title has drill information available
protected boolean	isFirst()
protected boolean	isLast()
void	reset()	Reset all of the instance variables.
protected void	setWebTemplateUnit(WebTemplateUnit unit)	Define the WebTemplateUnit instance to be rendered.
protected void	setWebTitle(WebTitle title)	Define the WebTitle instance to be rendered.
protected boolean	shouldHiliteOnServer()	Indicate if it's necessary to hilight the selected element on server side.
protected boolean	showRemoveFromReport()	Determine whether to show the 'Remove from Report' option according to the objects already defined on the template.

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

addContextMenuAttributes, addDragAndDropAttributes, addExtraAttribute, addToHeaderMetricValueJsonMap, addTooltipAttributes, addToStyle, appendContextMenuItems, buildGenericTooltipInformation, canAddThresholds, canDefineDerivedElements, canDrill, canEditMetricFilter, canFilterOnSelection, canFormat, canInsertShortcutMetric, canMetricFilterOn, canOpenAlerts, canPivot, canQuickGroup, canRemoveFromGrid, canRemoveFromReport, 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, generateText, generateThresholdSymbol, generateTitleDrillContextMenu, generateTitleDrillContextMenu, generateTitleSortContextMenu, generateTitleSortContextMenu, generateTooltip, generateTooltipForHeaders, generateTooltipForRowValue, generateTooltipForTitles, getAccessibilityInfo, getBaseBean, getCellColor, getCellID, getCellLevelAttributes, 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, 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, getSortEventByAxis, getSortEventByAxisBySortOrder, getSortID, getSortStatus, getStyle, getStyleForNonBuiltInFormat, getSubTitle, getSubtitleIndex, getTargetKeys, getText, getTitleDrillParametersForDHTML, getTitleDrillParametersForDHTML, getTitleDrillURL, getTitleDrillURL, getTooltip, getViewBean, getWidth, groupContextMenuDrillPathsByType, hasDrillPathsWithHighImportanceAvailable, hasMetricFilterCondition, hasWebObject, init, init, initCell, initDNDForDesignMode, initDNDForExecuteMode, initDragAndDrop, isAccessibilityMode, isContextMenuEnabled, isContextMenusEnabled, isDerivedMetric, isDesignMode, isDhtml, isDragAndDropEnabled, isFeatureAvailable, isFPTrue, isFPTrue, isHeaderMVJsonMovable, isHeaderNeedLink, isIframeEnabled, isIFrameEnabled, isIframeRequest, isIFrameRequest, isItemsAddedToContextMenu, isMetric, isMetricDrillable, isOutlineModeEnabled, isRemoveAvailable, isRowValueNeedLink, isRW, isSortAscending, isTitleNeedLink, newContext, newNamespaceEncoder, renderContextMenu, 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.ReportGridCellTitle

getSubTitle, getSubtitleIndex, init, init, setSubTitle, setSubTitleIndex

Methods inherited from interface com.microstrategy.web.app.transforms.ReportGridDisplayCell

addExtraAttribute, canAddThresholds, canDrill, canEditMetricFilter, canFilterOnSelection, canFormat, canInsertShortcutMetric, canMetricFilterOn, canOpenAlerts, canPivot, canQuickGroup, canRemoveFromGrid, canRemoveFromReport, generateOutput, getAccessibilityInfo, getCellID, getCellType, getColSpan, getControlElementSelectorEvent, getDrillEvent, getExtraInfo, getExtraStyle, getHeaderContent, getRowSpan, getStyle, getText, getTooltip, getWidth, init, init, isRW, setAccessibilityInfo, setCellID, setColSpan, setContent, setContextMenu, setExtraInfo, setExtraStyle, setExtraStyle, setHTML, setInnerHTML, setPostContent, setPreContent, setRowSpan, setStyle, setText, setTooltip, setWidth

Constructor Detail

AbstractReportGridCellTitle

public AbstractReportGridCellTitle()

Method Detail

reset

public void reset()

Description copied from interface: ReportGridDisplayCell

Reset all of the instance variables. This method is very important when improve the memory performance: we create only one instance for a particular cell type and reuse it instead of creating a new instance for each concrete grid cell. Therefore, it saves a lot of memory. For implementation of this method, please follow the workflow of how all the instance variables are initialized in the class hierarchy when a new instance is created: superclass instance variables are initialized first, subclass instance variables are initialized second. Note: for the purpose of cell reuse.

Specified by:

reset in interface ReportGridDisplayCell

Overrides:

reset in class AbstractReportGridDisplayCell

getURLBuffer

protected java.lang.StringBuffer getURLBuffer()

Deprecated.

if the link information for drilling should be modified, please update the generateDrillAnchor() method.

Specify URL information to be used as drilling information for the title being rendered

Returns:

StringBuffer instance

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).

Initialize the instance with the formal parameter information provided.

Specified by:

init in interface ReportGridDisplayCell

Overrides:

init in class AbstractReportGridDisplayCell

Parameters:

formalParas - FormalParameters collection to be used for initializing the instance.

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).

Initialize the instance with the base WebComponent and formal parameter information as provided

Specified by:

init in interface ReportGridDisplayCell

Overrides:

init in class AbstractReportGridDisplayCell

Parameters:

wc - WebComponent instance

formalParas - FormalParameters collection to be used for initializing the instance

init

public void init(TransformContext context,
                 WebTemplateUnit unit)

Description copied from interface: ReportGridCellTitle

This method is called to initialize the cell in design mode. It receives a WebTemplateUnit instance as the underlying SDK object

Specified by:

init in interface ReportGridCellTitle

Parameters:

context - TransformContext instance initialized with the grid's transform information.

unit - WebTemplateUnit instance corresponding to the cell to display.

generateContent

protected void generateContent(MarkupOutput mo)

Extends generateContent 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 class AbstractReportGridDisplayCell

Parameters:

mo - the output object

Since:

MicroStrategy Web 8.1.0

generateElementAnchor

protected AnchorTag generateElementAnchor()

Utility method for generating the AnchorTag instance for the element being rendered .

Returns:

AnchorTag instance initialized with the drill details. If neither dashboarding controls nor drilling is supported given the information provided, it will return null

Since:

MicroStrategy Web 8.1.0

generateControlAnchor

protected AnchorTag generateControlAnchor()

Since:

MicroStrategy Web 8.1.0

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 interface ReportGridDisplayCell

Overrides:

canHyperLink in class AbstractReportGridDisplayCell

Returns:

boolean value indicating if the manipulation should be enabled

Since:

MicroStrategy Web 8.1.2

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 interface ReportGridDisplayCell

Overrides:

canDrillAdvanced in class AbstractReportGridDisplayCell

Returns:

boolean value indicating if the manipulation should be enabled

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 interface ReportGridDisplayCell

Overrides:

canSort in class AbstractReportGridDisplayCell

Returns:

boolean value indicating if the manipulation should be enabled

getRenameEvent

public WebEvent getRenameEvent()

Description copied from interface: ReportGridDisplayCell

Get the event for renaming the current cell

Specified by:

getRenameEvent in interface ReportGridDisplayCell

Returns:

WebEvent instance initialized with the information for renaming the current cell.

getDerivedElementsEvent

public WebEvent getDerivedElementsEvent()

Specified by:

getDerivedElementsEvent in interface ReportGridDisplayCell

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 interface ReportGridDisplayCell

Returns:

WebEvent instance initialized for filtering on the information of this cell

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 interface ReportGridDisplayCell

Overrides:

canFilterOn in class AbstractReportGridDisplayCell

Returns:

boolean value indicating if the manipulation should be enabled

showRemoveFromReport

protected boolean showRemoveFromReport()

Description copied from class: AbstractReportGridDisplayCell

Determine whether to show the 'Remove from Report' option according to the objects already defined on the template.

Overrides:

showRemoveFromReport in class AbstractReportGridDisplayCell

Returns:

true if should display the 'Remove from Report' option.

Since:

MicroStrategy Web 9.0.0

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 interface ReportGridDisplayCell

Overrides:

canPivot in class AbstractReportGridDisplayCell

Parameters:

type - value indicating which type of pivot manipulation is being tested. Values come from the ReportGridDisplayCell.PIVOT_INCREASE_POSITION, ReportGridDisplayCell.PIVOT_DECREASE_POSITION, ReportGridDisplayCell.PIVOT_SWITCH_AXIS, ReportGridDisplayCell.PIVOT_TO_PAGE_BY and ReportGridDisplayCell.PIVOT_REMOVE constants.

Returns:

boolean value indicating if the manipulation should be enabled

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 interface ReportGridDisplayCell

Overrides:

canModifyAttributeForm in class AbstractReportGridDisplayCell

Returns:

boolean value indicating if the manipulation should be enabled

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 interface ReportGridDisplayCell

Overrides:

canRename in class AbstractReportGridDisplayCell

Returns:

boolean value indicating if the manipulation should be enabled

getOpenFormatEditorEvent

public WebEvent getOpenFormatEditorEvent()

Description copied from class: AbstractReportGridDisplayCell

Get the event for opening the format editor for the requested target.

Specified by:

getOpenFormatEditorEvent in interface ReportGridDisplayCell

Overrides:

getOpenFormatEditorEvent in class AbstractReportGridDisplayCell

Returns:

WebEvent initialized instance. If it could not be generated, it will return null

getSetFormatEditorTargetEvent

public WebEvent getSetFormatEditorTargetEvent()

Description copied from interface: ReportGridDisplayCell

Get the event for setting the current target of the format editor to be this cell instance

Specified by:

getSetFormatEditorTargetEvent in interface ReportGridDisplayCell

Overrides:

getSetFormatEditorTargetEvent in class AbstractReportGridDisplayCell

Returns:

WebEvent instance initialized for setting the target of the format editor to be the current cell instance.

getMaxPosition

protected int getMaxPosition()

getPosition

protected int getPosition()

getKey

public int getKey()

Specified by:

getKey in interface ReportGridDisplayCell

Returns:

int value with the key information about the cell being analyzed.

getUnitType

public int getUnitType()

isFirst

protected boolean isFirst()

isLast

protected boolean isLast()

init

public void init(WebComponent wc,
                 WebTemplateUnit unit,
                 java.util.HashMap cachedObjects)

Deprecated.

please use the interface that takes Context object instances as parameter

Initialize with the base WebComponent, the WebTemplateUnit to be rendered and a HashMap with other relevant information for this instance.

Specified by:

init in interface ReportGridCellTitle

Parameters:

wc - WebComponent instance

unit - WebTemplateUnit instance to be rendered by this class

cachedObjects - HashMap with other relevant information for the initialization.

getWebTemplateUnit

public WebTemplateUnit getWebTemplateUnit()

Obtain the WebTemplateUnit instance associated with this class

Specified by:

getWebTemplateUnit in interface ReportGridCellTitle

Returns:

WebTemplateUnit instance from where the information to be rendered by this class will be retrieved.

getWebTitle

public WebTitle getWebTitle()

Obtain the WebTitle instance associated with this class

Specified by:

getWebTitle in interface ReportGridCellTitle

Returns:

WebTitle instance from where the information to be rendered by this class will be retrieved.

canHaveDerivedElements

public boolean canHaveDerivedElements()

Specified by:

canHaveDerivedElements in interface ReportGridDisplayCell

Since:

MicroStrategy Web 9.0.0

setWebTemplateUnit

protected void setWebTemplateUnit(WebTemplateUnit unit)

Define the WebTemplateUnit instance to be rendered.

Parameters:

unit - WebTemplateUnit instance from where the information to render by this class will be retrieved.

setWebTitle

protected void setWebTitle(WebTitle title)

Define the WebTitle instance to be rendered.

Parameters:

title - WebTitle instance from where the information to render by this class will be retrieved.

isDrillPathAvailable

protected abstract boolean isDrillPathAvailable(WebTitle title)

Utility method to determine if the current title has drill information available

Parameters:

title - WebTitle instance to analyze

Returns:

boolean value indicating if there is drill path information available or not, for the specified title.

addContextMenuAttributes

protected void addContextMenuAttributes(java.util.Map atts)

Description copied from class: AbstractReportGridDisplayCell

Adds into the Map instance the tag attributes required for processing context menus.

Overrides:

addContextMenuAttributes in class AbstractReportGridDisplayCell

Parameters:

atts - Map where attributes will be appended.

Since:

MicroStrategy Web 8.1.0

generateDrillAnchor

protected AnchorTag generateDrillAnchor()

Utility method for generating the AnchorTag 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 return null

getDrillPathWithHighImportance

public WebDrillPath getDrillPathWithHighImportance()

Description copied from class: AbstractReportGridDisplayCell

Obtain the Drill path with high importance information for the current cell being analyzed

Specified by:

getDrillPathWithHighImportance in interface ReportGridDisplayCell

Overrides:

getDrillPathWithHighImportance in class AbstractReportGridDisplayCell

Returns:

WebDrillPath instance initialized, with the drill path with high importance information if available, otherwise returns null

getGridTemplate

protected WebTemplate getGridTemplate()
                               throws WebBeanException,
                                      WebObjectsException

Utility method for obtaining the WebTemplate object for the grid being rendered

Returns:

WebTemplate instance corresponding to the grid being rendered.

Throws:

WebBeanException - if an error happens while obtaining the template

WebObjectsException - if an error happens while obtaining the template

generatePivotButton

protected Tag generatePivotButton(int type)

Generate the pivot button tag, according to the type of manipulation that should perform

Specified by:

generatePivotButton in class AbstractReportGridDisplayCell

Parameters:

type - integer value that indicates which type of pivot action it should execute. Values come from the ReportGridDisplayCell.PIVOT_INCREASE_POSITION, ReportGridDisplayCell.PIVOT_DECREASE_POSITION, ReportGridDisplayCell.PIVOT_SWITCH_AXIS, ReportGridDisplayCell.PIVOT_TO_PAGE_BY and ReportGridDisplayCell.PIVOT_REMOVE constants.

Returns:

Tag initialized instance with the information for the pivot manipulation. It will return null 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.

getRemoveEvent

protected WebEvent getRemoveEvent()

Generate the remove event for the currently selected object in the template.

Returns:

WebEvent initialized instance with the information for the remove manipulation. It will return null if not supported.

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 the ReportGridDisplayCell.PIVOT_INCREASE_POSITION, ReportGridDisplayCell.PIVOT_DECREASE_POSITION, ReportGridDisplayCell.PIVOT_SWITCH_AXIS and ReportGridDisplayCell.PIVOT_TO_PAGE_BY constants.

Returns:

WebEvent initialized instance with the information for the pivot manipulation. It will return null if not supported.

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 class AbstractReportGridDisplayCell

Returns:

String with the information about the tooltip to render for the current cell.

cellNeedsLink

protected boolean cellNeedsLink()

Description copied from class: AbstractReportGridDisplayCell

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

Overrides:

cellNeedsLink in class AbstractReportGridDisplayCell

Returns:

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

canEditControl

public boolean canEditControl()

Description copied from interface: ReportGridDisplayCell

Utility methood for determining if the cell object is enabled for displaying the user the option to edit control

Specified by:

canEditControl in interface ReportGridDisplayCell

Overrides:

canEditControl in class AbstractReportGridDisplayCell

Returns:

boolean value indicating if the manipulation should be enabled

Since:

MicroStrategy Web 8.1.0

getSelectorEvent

protected WebEvent getSelectorEvent()

get selector Event by assigning the selected element as 'All elements'

Overrides:

getSelectorEvent in class AbstractReportGridDisplayCell

Returns:

shouldHiliteOnServer

protected boolean shouldHiliteOnServer()

Description copied from class: AbstractReportGridDisplayCell

Indicate if it's necessary to hilight the selected element on server side.

Overrides:

shouldHiliteOnServer in class AbstractReportGridDisplayCell

Returns:

canAddShortcutMetric

public boolean canAddShortcutMetric(int shortcutMetricType)

Description copied from interface: ReportGridCellTitle

Returns whether specified shortcut metric could be created based on current cell.

Specified by:

canAddShortcutMetric in interface ReportGridCellTitle

Parameters:

shortcutMetricType - The metric type in (@link EnumShortcutMetricTypes}.

getAddShortcutMetricEvent

public WebEvent getAddShortcutMetricEvent(int shortcutMetricType)

Description copied from interface: ReportGridCellTitle

Returns the WebEvent to add shortcut metric based on current cell.

Specified by:

getAddShortcutMetricEvent in interface ReportGridCellTitle

Parameters:

shortcutMetricType - The metric type in (@link EnumShortcutMetricTypes}.

getCellAttributes

protected void getCellAttributes(java.util.Map attributes)

Overrides:

getCellAttributes in class AbstractReportGridDisplayCell

hasRuntimeUnitLimit

protected boolean hasRuntimeUnitLimit()