Class ReportGridDisplayCellImpl
- java.lang.Object
-
- com.microstrategy.web.app.transforms.ReportGridDisplayCellImpl
-
- All Implemented Interfaces:
ReportGridCell
,ReportGridDisplayCell
,java.lang.Cloneable
- Direct Known Subclasses:
ReportGridDisplayCellColHeader
,ReportGridDisplayCellColTitle
,ReportGridDisplayCellMetricValue
,ReportGridDisplayCellRowHeader
,ReportGridDisplayCellRowTitle
public class ReportGridDisplayCellImpl extends java.lang.Object implements ReportGridDisplayCell, ReportGridCell, java.lang.Cloneable
Deprecated.Please use the ReportGridCellImpl instead.This class represents the base implementation of a report grid cell. It is used to represent a generic cell
This class has been deprecated along with all the ReportGridDisplayCell classes.
In its place, the Transform manipulates the cells through the ReportGridCell interface.- Since:
- MicroStrategy Web 7.3.1 or earlier
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface com.microstrategy.web.app.transforms.ReportGridDisplayCell
ReportGridDisplayCell.Context
-
-
Field Summary
Fields Modifier and Type Field Description protected WebEvent
_advDrillEditorProcessEvent
Deprecated.protected WebEvent
_advdrillEvent
Deprecated.protected java.lang.String[][]
_appliedSorts
Deprecated.protected java.util.Map
_cachedObjects
Deprecated.protected java.lang.String
_drillEditorName
Deprecated.protected WebEvent
_drillEditorProcessEvent
Deprecated.protected WebEvent
_drillEvent
Deprecated.protected WebEvent
_drillFilterOnSelectionProcessEvent
Deprecated.protected java.lang.String
_drillFilterPageBy
Deprecated.protected java.lang.String
_imgBasePath
Deprecated.protected java.lang.Boolean
_isIFrameRequest
Deprecated.protected boolean
_isNetscape
Deprecated.protected boolean
_itemsAddedToContextMenu
Deprecated.protected int
_maxColHeaderDepth
Deprecated.protected WebEvent
_sortEvent
Deprecated.protected java.lang.String
_sortSubtotalColPosition
Deprecated.protected java.lang.String
_sortSubtotalPostion
Deprecated.protected boolean
_specifyIDForCell
Deprecated.protected boolean
_specifyWidthForCell
Deprecated.protected java.lang.String
_text
Deprecated.protected FormalParameters
formalParas
Deprecated.protected ReportBean
rb
Deprecated.-
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 ReportGridDisplayCellImpl()
Deprecated.Constructor used for creating a generic display cell.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
addExtraAttribute(java.lang.String attributeName, java.lang.String attributeValue)
Deprecated.Define extra tag attributes and their values that shall be included on the table cell definition for the current instance being renderedboolean
canAddThresholds()
Deprecated.Utility methood for determining if the cell object is enabled for displaying the user the option to add thresholds to itboolean
canDrill()
Deprecated.Utility methood for determining if the cell object is enabled for displaying the user the option to drill on itboolean
canDrillAdvanced()
Deprecated.Utility methood for determining if the cell object is enabled for displaying the user the option for advanced drilling on itboolean
canEditControl()
Deprecated.Utility methood for determining if the cell object is enabled for displaying the user the option to edit controlboolean
canEditMetricFilter()
Deprecated.Utility method for determining if the cell object is enabled editing a metric filterboolean
canFilterOn()
Deprecated.Utility methood for determining if the cell object is enabled for displaying the user the option to filter on itboolean
canFilterOnSelection()
Deprecated.boolean
canFormat()
Deprecated.Utility methood for determining if the cell object is enabled for displaying the user the option to format itboolean
canHaveDerivedElements()
Deprecated.boolean
canHyperLink()
Deprecated.Utility method for determining if the cell object is enabled for displaying the user the option to navigate to custom hyperlinksboolean
canInsertShortcutMetric()
Deprecated.Utility methood for determining if the cell object is enabled for displaying the user the option to insert shortcut metrics based on itboolean
canMetricFilterOn()
Deprecated.Utility method for determining if the cell object is enabled for displaying the user the option to filter on itboolean
canModifyAttributeForm()
Deprecated.Utility methood for determining if the cell object is enabled for displaying the user the option to modify the attribute forms on itboolean
canOpenAlerts()
Deprecated.boolean
canPivot()
Deprecated.Utility methood for determining if the cell object is enabled for displaying the user the option to pivot itboolean
canPivot(int type)
Deprecated.Utility methood for determining if the cell object is enabled for displaying the user the option to pivot it according to the type specifiedboolean
canQuickGroup()
Deprecated.boolean
canRemoveFromGrid()
Deprecated.Utility methood for determining if the cell object is enabled for displaying the user the option to remove it from the grid.boolean
canRemoveFromReport()
Deprecated.Utility methood for determining if the cell object is enabled for displaying the user the option to remove it from the reportboolean
canRename()
Deprecated.Utility methood for determining if the cell object is enabled for displaying the user the option to rename itboolean
canSort()
Deprecated.Utility methood for determining if the cell object is enabled for displaying the user the option to sort itjava.lang.Object
clone()
Deprecated.Utility method to clone this object.protected boolean
convertNonbreakingSpaceOnMV()
Deprecated.This functionality has been moved to the excel-only related classes such asReportGridExcelCellMetricValueImpl
andReportGridExcelTransform
.protected boolean
decodeEuro()
Deprecated.This method as well as thedecodeEuro
formal parameter itself are not used anymore on the application.protected boolean
encodeMV()
Deprecated.This method is only required at the metric value cell, please useReportGridCellMetricValueImpl.encodeMetricValue()
.protected void
generateContent(MarkupOutput mo)
Deprecated.Generate the core HTML for this cell.protected void
generateContextMenu(MarkupOutput mo)
Deprecated.Generate the context menu for this cell.protected void
generateDragAndDrop(MarkupOutput mo)
Deprecated.Generate drag and drop properties.protected void
generateDrillCheckBox(MarkupOutput mo)
Deprecated.Generate the drill check box.protected boolean
generateDrillCheckBox(MarkupOutput mo, ReportBean rb, WebHeader header)
Deprecated.generate output for checkboxes for drillprotected void
generateDrillOpenLink(MarkupOutput mo, ReportBean rb, java.lang.String url, java.lang.String title, boolean javascriptUsedForDrill, java.lang.String sElementID)
Deprecated.generate open anchor for drill link for header elementsprotected void
generateFilterOnSelectionCheckBox(MarkupOutput mo)
Deprecated.Generate the filter on selection check box.protected boolean
generateFilterOnSelectionCheckBox(MarkupOutput mo, ReportBean rb, WebHeader header)
Deprecated.generate output for the checkbox for Filter on Selectionsprotected void
generateHeaderDrillContextMenu(MarkupOutput mo, ReportBean rb, WebHeader header, java.lang.StringBuffer sHeaderURL, ContextMenu rhMenu)
Deprecated.generate the drilling context menu for headersprotected void
generateHeaderSortContextMenu(MarkupOutput mo, ReportBean rb, WebHeader header, ContextMenu rhMenu)
Deprecated.generate the output for sorting context menu for headersprotected void
generateInnerHTML(MarkupOutput mo)
Deprecated.Returns the inner HTML for this cell.protected void
generateOutlineModeImage(MarkupOutput mo)
Deprecated.Generate the javascript images for collapse and expand for outline mode.protected void
generateOutlineSubTotalName(MarkupOutput mo)
Deprecated.Generate the name of the subtotal type next to the header element for outline mode.void
generateOutput(MarkupOutput mo)
Deprecated.Generate complete HTML for this cell.protected void
generatePivotButtons(MarkupOutput mo)
Deprecated.Generate pivot buttons.protected void
generatePostContent(MarkupOutput mo)
Deprecated.Generate the postContent of the cell.protected void
generatePreContent(MarkupOutput mo)
Deprecated.Generate the preContent of the cell.protected void
generateRowValueDrillContextMenu(MarkupOutput mo, ReportBean rb, WebRowValue rowValue, java.lang.StringBuffer sHeaderURL, ContextMenu rhMenu)
Deprecated.generate the drilling context menu for row valuesprotected void
generateSortButton(MarkupOutput mo)
Deprecated.Generate sort button for this cell.protected void
generateTitleDrillContextMenu(MarkupOutput mo, ReportBean rb, WebTitle title, java.lang.StringBuffer sTitleURL, ContextMenu rhMenu)
Deprecated.generate output for drilling context menu for titlesprotected void
generateTitleSortContextMenu(MarkupOutput mo, ReportBean rb, WebTitle title, ContextMenu rhMenu)
Deprecated.generate the output for sorting context menu for titlesprotected void
generateTooltip(MarkupOutput mo)
Deprecated.Generate the context menu for this cell.protected java.lang.String
generateTooltipContent()
Deprecated.protected void
generateTooltipForHeaders(MarkupOutput mo)
Deprecated.Generate the tool tip for this cell.protected void
generateTooltipForRowValue(MarkupOutput mo)
Deprecated.Generate the tool tip for this cell.protected void
generateTooltipForTitles(MarkupOutput mo)
Deprecated.Generate the tool tip for this cell.java.lang.String
getAccessibilityInfo()
Deprecated.addExtraAttribute(java.lang.String, java.lang.String)
is used instead for specifying the accessibility information, for example,addExtraAttribute("scope", "row");
java.lang.String
getCellID()
Deprecated.Returns the id for this cell, will be used as ID attribute of in HTMLint
getCellType()
Deprecated.Returns the cell typeprotected WebMetric
getColHeaderWebMetric(WebHeader header)
Deprecated.get the metric object for the column headerint
getColSpan()
Deprecated.Returns the col span for this cellprotected java.util.Map
getContextMenuAttributes()
Deprecated.Obtain the tag attributes that should be added to the cell's definition for processing context menusprotected ContextMenuManager
getContextMenuManager()
Deprecated.get theContextMenuManager
objectWebEvent
getControlElementSelectorEvent(RWControl control, java.lang.String elementList)
Deprecated.protected java.lang.String
getCssPrefix()
Deprecated.Please check thecssPrefix
formal parameter value instead.WebEvent
getDerivedElementsEvent()
Deprecated.protected java.lang.String
getDescription()
Deprecated.Returns the description for this cell.protected java.lang.String
getDescriptor(ReportBean rb, int key)
Deprecated.Get descriptor for this keyWebEvent
getDrillEvent(WebDrillPath dp, java.lang.String elementKey, WebTitle title)
Deprecated.Returns the WebEvent to drill from the cell to the given drill path.protected java.lang.String
getDrillPath()
Deprecated.WebDrillPath
getDrillPathWithHighImportance()
Deprecated.Obtain the Drill path with high importance information for the current cell being analyzedprotected EventManager
getEventManager()
Deprecated.get theEventManager
objectjava.lang.String
getExtraInfo()
Deprecated.Returns the extra info for this celljava.lang.String
getExtraStyle()
Deprecated.Returns the extra style info for this celljava.lang.String
getExtraUrl()
Deprecated.get extra url for the cellWebEvent
getFilterOnEvent()
Deprecated.Get the event for filter on the cell header instanceprotected int
getFPIntValue(java.lang.String fpName)
Deprecated.get formal parameter value as an integer valueprotected java.lang.String
getFPStringValue(java.lang.String fpName)
Deprecated.get the formal parameter value as a string valuejava.lang.String
getHeaderContent(WebHeader header)
Deprecated.generate output for a headerprotected java.lang.String
getHeaderDrillParametersForDHTML(ReportBean rb, WebDrillPath dp, WebHeader header)
Deprecated.generate drilling url parameters for DHTML modeprotected WebDrillPath
getHeaderDrillPathWithHighImportance(ReportBean rb, WebHeader header)
Deprecated.generate drilling url parameters for DHTML modeprotected java.lang.String
getHeaderDrillURL(ReportBean rb, WebDrillPath dp, WebHeader header)
Deprecated.generate the output for drilling URL for headersprotected java.lang.String
getImgName(java.lang.String fpName)
Deprecated.get the corresponding image name for a formal parameter representing an imageint
getKey()
Deprecated.protected int
getMaxSortAllowed()
Deprecated.Please check themaxSortAllowed
formal parameter value instead.WebEvent
getOpenFormatEditorEvent()
Deprecated.Get the event for opening the format editorprotected java.lang.String
getPostTextForMetricValue()
Deprecated.Please check thepostTextForMetricValue
formal parameter value instead.protected java.lang.String
getPostTextForNonMetricValue()
Deprecated.Please check thepostTextForNonMetricValue
formal parameter value instead.protected java.lang.String
getPreTextForMetricValue()
Deprecated.Please check thepreTextForMetricValue
formal parameter value instead.protected java.lang.String
getPreTextForNonMetricValue()
Deprecated.Please check thepreTextForNonMetricValue
formal parameter value instead.WebEvent
getRenameEvent()
Deprecated.Get the event for renaming the current cellReportBean
getReportBean()
Deprecated.Returns the report bean associated with this display cellint
getReportDesignMode()
Deprecated.Please check thereportDesignMode
formal parameter value instead.int
getRowSpan()
Deprecated.Returns the row span for this cellprotected java.lang.String
getRowValueDrillElements(WebRowValue rowValue)
Deprecated.protected java.lang.String
getRowValueDrillParametersForDHTML(ReportBean rb, WebDrillPath dp)
Deprecated.generate drilling url parameters for row value in DHTML modeprotected WebDrillPath
getRowValueDrillPathWithHighImportance(ReportBean rb, WebRowValue rowValue)
Deprecated.generate drilling url parameters for row value in DHTML modeprotected java.lang.String
getRowValueDrillURL(ReportBean rb, WebDrillPath dp, WebRowValue rowValue)
Deprecated.generate the output for drilling URL for row valueWebEvent
getSetFormatEditorTargetEvent()
Deprecated.Get the event for setting the current target of the format editor to be this cell instanceprotected int
getShowDescriptionAsTooltip(java.lang.String fpName)
Deprecated.get formal parameter value as an int valueprotected boolean
getSortStatus(java.lang.String sSortID, java.lang.String[][] appliedSorts)
Deprecated.get the sort statysjava.lang.String
getStyle()
Deprecated.Returns the css style name for this cellWebSubTitle
getSubTitle()
Deprecated.Returns the subtitle for this cellint
getSubtitleIndex()
Deprecated.Returns the subtitle index for this celljava.lang.String
getText()
Deprecated.Returns the text for this cellprotected java.lang.String
getTitleDrillParametersForDHTML(ReportBean rb, WebDrillPath dp, WebTitle title)
Deprecated.generate drilling url parameters for DHTML modeprotected java.lang.String
getTitleDrillURL(ReportBean rb, WebDrillPath dp, WebTitle title)
Deprecated.generate the output for drilling URL for titlesjava.lang.String
getTooltip()
Deprecated.Returns the tooltip text for this celljava.lang.String
getWidth()
Deprecated.Returns the width for this cellvoid
init(TransformContext context)
Deprecated.Initializes the instance.void
init(WebComponent wc, FormalParameters formalParas)
Deprecated.Init method used for creating a generic display cell.void
init(WebComponent wc, java.util.HashMap cachedObjects)
Deprecated.please use the interface that takesContext
object instances as parametervoid
init(FormalParameters formalParas)
Deprecated.Init method used for creating a generic display cell.protected void
initDNDForDesignMode(DragAndDropItem item)
Deprecated.protected void
initDNDForExecuteMode(DragAndDropItem item)
Deprecated.protected void
initDragAndDrop(DragAndDropItem item)
Deprecated.protected boolean
isContextMenuEnabled()
Deprecated.Please check theisContextMenuEnabled
formal parameter value instead.protected boolean
isDesignMode()
Deprecated.is design mode or notprotected boolean
isDragAndDropEnabled()
Deprecated.Please check theisDragAndDropEnabled
formal parameter value instead.protected boolean
isFPTrue(java.lang.String fpName)
Deprecated.get formal parameter value as a boolean valueprotected boolean
isFPTrue(java.lang.String fpName, boolean defValue)
Deprecated.protected boolean
isHeaderNeedLink(WebHeader header)
Deprecated.return whether to display link for drillprotected boolean
isIFrameEnabled()
Deprecated.whether ifram is enabledprotected boolean
isIFrameRequest()
Deprecated.whether it's an iframe requestprotected boolean
isItemsAddedToContextMenu()
Deprecated.return whether there is any item added to the context menuprotected boolean
isMetric()
Deprecated.determine if the cell is containing a metricprotected boolean
isMetricDrillable(WebHeader header, WebDrillPath drillPath)
Deprecated.return whether the header has a drillable metricprotected boolean
isOutlineModeEnabled()
Deprecated.is outline more feature enabledprotected boolean
isRowValueNeedLink(WebRowValue rowValue)
Deprecated.return whether to display link for drillboolean
isRW()
Deprecated.Utility methood for determining whether it is a RW execution.protected boolean
isSortAscending(java.lang.String sSortID, java.lang.String[][] appliedSorts)
Deprecated.check if the sort is ascendingprotected boolean
isTitleNeedLink(WebTitle title)
Deprecated.return whether to display link for drillvoid
reset()
Deprecated.Reset all of the instance variables.void
setAccessibilityInfo(java.lang.String accessibilityInfo)
Deprecated.Sets any information that should be used in case Accessibility Mode (508) is enabled by the uservoid
setCellID(java.lang.String cellID)
Deprecated.Sets the id for this cell, will be used as ID attribute of in HTMLvoid
setCellType(int cellType)
Deprecated.Sets the type for this cell, value should be from EnumReportGridDisplayCellTypesvoid
setColSpan(int colSpan)
Deprecated.Sets the col span for this cellvoid
setContent(java.lang.String content)
Deprecated.set the content (HTML format) for this cell.void
setContextMenu(java.lang.String contextMenu)
Deprecated.use the context menu infrastructure for defining this information, or theaddExtraAttribute(java.lang.String, java.lang.String)
method for adding tag attributes.protected void
setDescription(java.lang.String description)
Deprecated.Sets the description for this cell.void
setDrillPath(java.lang.String drillPath)
Deprecated.void
setExtraInfo(java.lang.String extraInfo)
Deprecated.Sets the extra info for this cellvoid
setExtraStyle(java.lang.String extraStyle)
Deprecated.Sets the extra style info for this cellvoid
setExtraStyle(java.lang.String extraStyle, boolean append)
Deprecated.Updates values to theSTYLE
attribute of theTD
tag.void
setExtraUrl(java.lang.String value)
Deprecated.set extra url for the cellvoid
setHTML(java.lang.String html)
Deprecated.Sets the complete HTML for this cell.void
setInnerHTML(java.lang.String innerHTML)
Deprecated.Sets the inner HTML for this cell.void
setPostContent(java.lang.String postContent)
Deprecated.set the post-content (HTML format) for this cell.void
setPreContent(java.lang.String preContent)
Deprecated.set the pre-content (HTML format) for this cell.void
setRowSpan(int rowSpan)
Deprecated.Sets the row span for this cellvoid
setStyle(java.lang.String style)
Deprecated.Sets the css style name for this cellprotected void
setStyleForNonBuiltInFormat(java.lang.String style, int rowOrdinal)
Deprecated.set the style for the cell when not using the built in report formattingvoid
setSubTitle(WebSubTitle subtitle)
Deprecated.Sets the subtitle for this cellvoid
setSubTitleIndex(int subtitleIndex)
Deprecated.Sets the subtitle index for this cellvoid
setText(java.lang.String text)
Deprecated.Sets the text for this cellvoid
setTooltip(java.lang.String tooltip)
Deprecated.Sets the tooltop for the text in this cellvoid
setWidth(java.lang.String width)
Deprecated.Sets the width for this cellprotected boolean
showBanding()
Deprecated.Please check theshowBanding
formal parameter value instead.protected boolean
showDrillAdvanced()
Deprecated.Please check theshowDrillAdvanced
formal parameter value instead.protected boolean
showDrillCheckBox()
Deprecated.Please check theshowDrillCheckBox
formal parameter value instead.protected boolean
showDrillDownOnly()
Deprecated.Please check theshowDrillDownOnly
formal parameter value instead.protected boolean
showDrillHyperlink()
Deprecated.Please check theshowDrillHyperlink
formal parameter value instead.protected boolean
showDrillHyperlinkMetric()
Deprecated.Please check theshowDrillHyperlinkMetric
formal parameter value instead.protected boolean
showDrillMetric()
Deprecated.Please check theshowDrillMetric
formal parameter value instead.protected boolean
showDrillRMC()
Deprecated.Please check theshowDrillRMC
formal parameter value instead.protected boolean
showDrillRMCMetric()
Deprecated.Please check theshowDrillRMCMetric
formal parameter value instead.protected boolean
showFilterOnSelectionCheckBox()
Deprecated.Please check theshowFilterOnSelectionCheckBox
formal parameter value instead.protected boolean
showFormattingRMC()
Deprecated.Please check theshowFormattingRMC
formal parameter value instead.protected boolean
showPivot()
Deprecated.Please check theshowPivot
formal parameter value instead.protected boolean
showPivotRMC()
Deprecated.Please check theshowPivotRMC
formal parameter value instead.protected boolean
showRemove()
Deprecated.Please check theshowRemove
formal parameter value instead.protected boolean
showRemoveRMC()
Deprecated.Please check theshowRemoveRMC
formal parameter value instead.protected boolean
showRenameRMC()
Deprecated.Please check theshowRenameRMC
formal parameter value instead.protected boolean
showSortButtonsForAttributes()
Deprecated.Please check theshowSortButtonsForAttributes
formal parameter value instead.protected boolean
showSortButtonsForMetrics()
Deprecated.Please check theshowSortButtonsForMetrics
formal parameter value instead.protected boolean
showSortRMCForAttributes()
Deprecated.Please check theshowSortRMCForAttributes
formal parameter value instead.protected boolean
showSortRMCForMetrics()
Deprecated.Please check theshowSortRMCForMetrics
formal parameter value instead.protected boolean
showSubTitle()
Deprecated.whethere display sub titleprotected boolean
useBuiltInFormat()
Deprecated.Please check theuseBuiltInFormat
formal parameter value instead.
-
-
-
Field Detail
-
_text
protected java.lang.String _text
Deprecated.
-
_itemsAddedToContextMenu
protected boolean _itemsAddedToContextMenu
Deprecated.
-
rb
protected ReportBean rb
Deprecated.
-
formalParas
protected FormalParameters formalParas
Deprecated.
-
_drillEvent
protected WebEvent _drillEvent
Deprecated.
-
_advdrillEvent
protected WebEvent _advdrillEvent
Deprecated.
-
_drillEditorProcessEvent
protected WebEvent _drillEditorProcessEvent
Deprecated.
-
_advDrillEditorProcessEvent
protected WebEvent _advDrillEditorProcessEvent
Deprecated.
-
_drillFilterOnSelectionProcessEvent
protected WebEvent _drillFilterOnSelectionProcessEvent
Deprecated.
-
_sortEvent
protected WebEvent _sortEvent
Deprecated.
-
_appliedSorts
protected java.lang.String[][] _appliedSorts
Deprecated.
-
_sortSubtotalPostion
protected java.lang.String _sortSubtotalPostion
Deprecated.
-
_sortSubtotalColPosition
protected java.lang.String _sortSubtotalColPosition
Deprecated.- Since:
- MicroStrategy Web 8.0.2
-
_drillEditorName
protected java.lang.String _drillEditorName
Deprecated.
-
_maxColHeaderDepth
protected int _maxColHeaderDepth
Deprecated.
-
_imgBasePath
protected java.lang.String _imgBasePath
Deprecated.
-
_cachedObjects
protected java.util.Map _cachedObjects
Deprecated.
-
_isIFrameRequest
protected java.lang.Boolean _isIFrameRequest
Deprecated.
-
_drillFilterPageBy
protected java.lang.String _drillFilterPageBy
Deprecated.
-
_isNetscape
protected boolean _isNetscape
Deprecated.
-
_specifyWidthForCell
protected boolean _specifyWidthForCell
Deprecated.
-
_specifyIDForCell
protected boolean _specifyIDForCell
Deprecated.
-
-
Method Detail
-
reset
public void reset()
Deprecated.Description copied from interface:ReportGridDisplayCell
Reset all of the instance variables. This method is very important when improve the memory performance: we create only one instance for a particular cell type and reuse it instead of creating a new instance for each concrete grid cell. Therefore, it saves a lot of memory. For implementation of this method, please follow the workflow of how all the instance variables are initialized in the class hierarchy when a new instance is created: superclass instance variables are initialized first, subclass instance variables are initialized second. Note: for the purpose of cell reuse.- Specified by:
reset
in interfaceReportGridDisplayCell
-
init
public void init(FormalParameters formalParas)
Deprecated.Init method used for creating a generic display cell.- Specified by:
init
in interfaceReportGridDisplayCell
- Parameters:
formalParas
- all the formal parameters from the report transform. Used to control some output generation. For example, the cssPrefix is needed for the empty cells in design mode.- Since:
- MicroStrategy Web 7.5.1
-
init
public void init(TransformContext context)
Deprecated.Description copied from interface:ReportGridDisplayCell
Initializes the instance.- Specified by:
init
in interfaceReportGridDisplayCell
- 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(WebComponent wc, FormalParameters formalParas)
Deprecated.Init method used for creating a generic display cell.- Specified by:
init
in interfaceReportGridDisplayCell
- Parameters:
wc
- associated web componentformalParas
- all the formal parameters from the report transform. Used to control some output generation. For example, the cssPrefix is needed for the empty cells in design mode.- Since:
- MicroStrategy Web 7.5.2
-
init
public void init(WebComponent wc, java.util.HashMap cachedObjects)
Deprecated.please use the interface that takesContext
object instances as parameterInit method used for creating a generic display cell.- Specified by:
init
in interfaceReportGridDisplayCell
- Parameters:
wc
- associated web componentcachedObjects
- cached object, used to store some information shared across multiple cells- Since:
- MicroStrategy Web 7.5.2
-
canRemoveFromGrid
public boolean canRemoveFromGrid()
Deprecated.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
- Returns:
- boolean value indicating if the manipulation should be enabled
- Since:
- MicroStrategy Web 8.0.1
-
isRW
public boolean isRW()
Deprecated.Description copied from interface:ReportGridDisplayCell
Utility methood for determining whether it is a RW execution.- Specified by:
isRW
in interfaceReportGridDisplayCell
- Returns:
- boolean value indicating if it is a RW execution.
- Since:
- MicroStrategy Web 8.1.0
-
canRemoveFromReport
public boolean canRemoveFromReport()
Deprecated.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
- Returns:
- boolean value indicating if the manipulation should be enabled
- Since:
- MicroStrategy Web 8.0.1
-
addExtraAttribute
public void addExtraAttribute(java.lang.String attributeName, java.lang.String attributeValue)
Deprecated.Description copied from interface:ReportGridDisplayCell
Define extra tag attributes and their values that shall be included on the table cell definition for the current instance being rendered- Specified by:
addExtraAttribute
in interfaceReportGridDisplayCell
- Parameters:
attributeName
- String value with the name of the attribute to addattributeValue
- String value with the value of the attribute to add- Since:
- MicroStrategy Web 8.0.1
-
canRename
public boolean canRename()
Deprecated.Utility methood for determining if the cell object is enabled for displaying the user the option to rename it- Specified by:
canRename
in interfaceReportGridDisplayCell
- Returns:
- boolean value indicating if the manipulation should be enabled
- Since:
- MicroStrategy Web 8.0.1
-
canAddThresholds
public boolean canAddThresholds()
Deprecated.Utility methood for determining if the cell object is enabled for displaying the user the option to add thresholds to it- Specified by:
canAddThresholds
in interfaceReportGridDisplayCell
- Returns:
- boolean value indicating if the manipulation should be enabled
- Since:
- MicroStrategy Web 9.0.0
-
canFilterOn
public boolean canFilterOn()
Deprecated.Utility methood for determining if the cell object is enabled for displaying the user the option to filter on it- Specified by:
canFilterOn
in interfaceReportGridDisplayCell
- Returns:
- boolean value indicating if the manipulation should be enabled
- Since:
- MicroStrategy Web 8.0.1
-
canFormat
public boolean canFormat()
Deprecated.Utility methood for determining if the cell object is enabled for displaying the user the option to format it- Specified by:
canFormat
in interfaceReportGridDisplayCell
- Returns:
- boolean value indicating if the manipulation should be enabled
- Since:
- MicroStrategy Web 8.0.1
-
canHaveDerivedElements
public boolean canHaveDerivedElements()
Deprecated.- Specified by:
canHaveDerivedElements
in interfaceReportGridDisplayCell
- Since:
- MicroStrategy Web 9.0.0
-
canQuickGroup
public boolean canQuickGroup()
Deprecated.- Specified by:
canQuickGroup
in interfaceReportGridDisplayCell
- Since:
- MicroStrategy Web 9.0.0
-
canSort
public boolean canSort()
Deprecated.Utility methood for determining if the cell object is enabled for displaying the user the option to sort it- Specified by:
canSort
in interfaceReportGridDisplayCell
- Returns:
- boolean value indicating if the manipulation should be enabled
- Since:
- MicroStrategy Web 8.0.1
-
canDrill
public boolean canDrill()
Deprecated.Utility methood for determining if the cell object is enabled for displaying the user the option to drill on it- Specified by:
canDrill
in interfaceReportGridDisplayCell
- Returns:
- boolean value indicating if the manipulation should be enabled
- Since:
- MicroStrategy Web 8.0.1
-
canHyperLink
public boolean canHyperLink()
Deprecated.Description copied from interface:ReportGridDisplayCell
Utility method for determining if the cell object is enabled for displaying the user the option to navigate to custom hyperlinks- Specified by:
canHyperLink
in interfaceReportGridDisplayCell
- Returns:
- boolean value indicating if the manipulation should be enabled
- Since:
- MicroStrategy Web 8.1.2
-
canDrillAdvanced
public boolean canDrillAdvanced()
Deprecated.Utility methood for determining if the cell object is enabled for displaying the user the option for advanced drilling on it- Specified by:
canDrillAdvanced
in interfaceReportGridDisplayCell
- Returns:
- boolean value indicating if the manipulation should be enabled
- Since:
- MicroStrategy Web 8.0.1
-
getDrillPathWithHighImportance
public WebDrillPath getDrillPathWithHighImportance()
Deprecated.Obtain the Drill path with high importance information for the current cell being analyzed- Specified by:
getDrillPathWithHighImportance
in interfaceReportGridDisplayCell
- Returns:
WebDrillPath
instance initialized, with the drill path with high importance information if available, otherwise returnsnull
- Since:
- MicroStrategy Web 8.0.1
-
getDrillEvent
public WebEvent getDrillEvent(WebDrillPath dp, java.lang.String elementKey, WebTitle title)
Deprecated.Returns the WebEvent to drill from the cell to the given drill path.- Specified by:
getDrillEvent
in interfaceReportGridDisplayCell
- Parameters:
dp
- The drill path to use for drilling.elementKey
- The key for the element to drill totitle
- The WebTitle to drill from.- Since:
- MicroStrategy Web 8.0.1
-
getControlElementSelectorEvent
public WebEvent getControlElementSelectorEvent(RWControl control, java.lang.String elementList)
Deprecated.- Specified by:
getControlElementSelectorEvent
in interfaceReportGridDisplayCell
- Since:
- MicroStrategy Web 8.1.0
-
canInsertShortcutMetric
public boolean canInsertShortcutMetric()
Deprecated.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
- Returns:
- boolean value indicating if the manipulation should be enabled
- Since:
- MicroStrategy Web 8.0.1
-
canPivot
public boolean canPivot()
Deprecated.Utility methood for determining if the cell object is enabled for displaying the user the option to pivot it- Specified by:
canPivot
in interfaceReportGridDisplayCell
- Returns:
- boolean value indicating if the manipulation should be enabled
- Since:
- MicroStrategy Web 8.0.1
-
canPivot
public boolean canPivot(int type)
Deprecated.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
- 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
-
canModifyAttributeForm
public boolean canModifyAttributeForm()
Deprecated.Utility methood for determining if the cell object is enabled for displaying the user the option to modify the attribute forms on it- Specified by:
canModifyAttributeForm
in interfaceReportGridDisplayCell
- Returns:
- boolean value indicating if the manipulation should be enabled
- Since:
- MicroStrategy Web 8.0.1
-
canMetricFilterOn
public boolean canMetricFilterOn()
Deprecated.Utility method for determining if the cell object is enabled for displaying the user the option to filter on it- Specified by:
canMetricFilterOn
in interfaceReportGridDisplayCell
- Returns:
- boolean value indicating if the manipulation should be enabled
- Since:
- MicroStrategy Web 9.0.0
-
canEditMetricFilter
public boolean canEditMetricFilter()
Deprecated.Description copied from interface:ReportGridDisplayCell
Utility method for determining if the cell object is enabled editing a metric filter- Specified by:
canEditMetricFilter
in interfaceReportGridDisplayCell
- Returns:
- boolean value indicating if the manipulation should be enabled
- Since:
- MicroStrategy Web 9.0.0
-
getStyle
public java.lang.String getStyle()
Deprecated.Returns the css style name for this cell- Specified by:
getStyle
in interfaceReportGridDisplayCell
- Returns:
- css style name
-
setStyle
public void setStyle(java.lang.String style)
Deprecated.Sets the css style name for this cell- Specified by:
setStyle
in interfaceReportGridDisplayCell
- Parameters:
style
- css style name to be used for this cell
-
setSubTitle
public void setSubTitle(WebSubTitle subtitle)
Deprecated.Sets the subtitle for this cell- Parameters:
subtitle
- to be used for this cell
-
getSubTitle
public WebSubTitle getSubTitle()
Deprecated.Returns the subtitle for this cell- Returns:
- subtitle
-
setSubTitleIndex
public void setSubTitleIndex(int subtitleIndex)
Deprecated.Sets the subtitle index for this cell- Parameters:
subtitleIndex
- to be used for this cell
-
getSubtitleIndex
public int getSubtitleIndex()
Deprecated.Returns the subtitle index for this cell- Returns:
- subtitle
-
setExtraStyle
public void setExtraStyle(java.lang.String extraStyle)
Deprecated.Sets the extra style info for this cell- Specified by:
setExtraStyle
in interfaceReportGridDisplayCell
- Parameters:
extraStyle
- the extra style info for this cell
-
setExtraStyle
public void setExtraStyle(java.lang.String extraStyle, boolean append)
Deprecated.Description copied from interface:ReportGridDisplayCell
Updates values to theSTYLE
attribute of theTD
tag. The style assigned this way will only apply to this cell. Based on the value of append, Information added through this method is appended to other information currently assigned to this attribute.- Specified by:
setExtraStyle
in interfaceReportGridDisplayCell
- Parameters:
extraStyle
- The text to addappend
- whether to overwrite or append to the existing style value. Note, the method does not append an automatic semi-colon. Best practice is to ensure that semi-colons are present at the end of value being set (e.g. text-decoration:none; ).- Since:
- MicroStrategy Web 9.0.0
-
getExtraStyle
public java.lang.String getExtraStyle()
Deprecated.Returns the extra style info for this cell- Specified by:
getExtraStyle
in interfaceReportGridDisplayCell
- Returns:
- the extra style info for this cell
-
setAccessibilityInfo
public void setAccessibilityInfo(java.lang.String accessibilityInfo)
Deprecated.Sets any information that should be used in case Accessibility Mode (508) is enabled by the user- Specified by:
setAccessibilityInfo
in interfaceReportGridDisplayCell
- Parameters:
accessibilityInfo
- the extra accessibility info for this cell
-
setExtraInfo
public void setExtraInfo(java.lang.String extraInfo)
Deprecated.Sets the extra info for this cell- Specified by:
setExtraInfo
in interfaceReportGridDisplayCell
- Parameters:
extraInfo
- the extra info for this cell
-
getAccessibilityInfo
public java.lang.String getAccessibilityInfo()
Deprecated.addExtraAttribute(java.lang.String, java.lang.String)
is used instead for specifying the accessibility information, for example,addExtraAttribute("scope", "row");
Get any information that should be used in case Accessibility Mode (508) is enabled by the user- Specified by:
getAccessibilityInfo
in interfaceReportGridDisplayCell
- Returns:
- the extra accessibility info for this cell
-
getExtraInfo
public java.lang.String getExtraInfo()
Deprecated.Returns the extra info for this cell- Specified by:
getExtraInfo
in interfaceReportGridDisplayCell
- Returns:
- the extra info for this cell
-
getText
public java.lang.String getText()
Deprecated.Returns the text for this cell- Specified by:
getText
in interfaceReportGridDisplayCell
- Returns:
- text for this cell
-
setText
public void setText(java.lang.String text)
Deprecated.Sets the text for this cell- Specified by:
setText
in interfaceReportGridDisplayCell
- Parameters:
text
- text for this cell
-
getDescription
protected java.lang.String getDescription()
Deprecated.Returns the description for this cell.- Returns:
- description for the cell.
-
setDescription
protected void setDescription(java.lang.String description)
Deprecated.Sets the description for this cell.- Parameters:
description
- description for this cell.
-
setDrillPath
public void setDrillPath(java.lang.String drillPath)
Deprecated.
-
getDrillPath
protected java.lang.String getDrillPath()
Deprecated.
-
getCellID
public java.lang.String getCellID()
Deprecated.Returns the id for this cell, will be used as ID attribute ofin HTML - Specified by:
getCellID
in interfaceReportGridDisplayCell
- Returns:
- the id for this cell
-
setCellID
public void setCellID(java.lang.String cellID)
Deprecated.Sets the id for this cell, will be used as ID attribute ofin HTML - Specified by:
setCellID
in interfaceReportGridDisplayCell
- Parameters:
cellID
- the id for this cell
-
getWidth
public java.lang.String getWidth()
Deprecated.Returns the width for this cell- Specified by:
getWidth
in interfaceReportGridDisplayCell
- Returns:
- width for the cell
-
setWidth
public void setWidth(java.lang.String width)
Deprecated.Sets the width for this cell- Specified by:
setWidth
in interfaceReportGridDisplayCell
- Parameters:
width
- text for this cell
-
getTooltip
public java.lang.String getTooltip()
Deprecated.Returns the tooltip text for this cell- Specified by:
getTooltip
in interfaceReportGridDisplayCell
- Returns:
- The cell's Tooltip text.
-
setTooltip
public void setTooltip(java.lang.String tooltip)
Deprecated.Sets the tooltop for the text in this cell- Specified by:
setTooltip
in interfaceReportGridDisplayCell
- Parameters:
tooltip
- the tooltip to display when the cursor goes over the cell
-
setContextMenu
public void setContextMenu(java.lang.String contextMenu)
Deprecated.use the context menu infrastructure for defining this information, or theaddExtraAttribute(java.lang.String, java.lang.String)
method for adding tag attributes.Sets the context menu for this cell- Specified by:
setContextMenu
in interfaceReportGridDisplayCell
- Parameters:
contextMenu
- the context menu for this cell
-
setInnerHTML
public void setInnerHTML(java.lang.String innerHTML)
Deprecated.Sets the inner HTML for this cell. Inner HTML is the html code betweenand .- Specified by:
setInnerHTML
in interfaceReportGridDisplayCell
- Parameters:
innerHTML
- inner HTML for this cell
-
getRowSpan
public int getRowSpan()
Deprecated.Returns the row span for this cell- Specified by:
getRowSpan
in interfaceReportGridDisplayCell
- Returns:
- row span
-
setRowSpan
public void setRowSpan(int rowSpan)
Deprecated.Sets the row span for this cell- Specified by:
setRowSpan
in interfaceReportGridDisplayCell
- Parameters:
rowSpan
- the row span for this cell
-
getColSpan
public int getColSpan()
Deprecated.Returns the col span for this cell- Specified by:
getColSpan
in interfaceReportGridDisplayCell
- Returns:
- col span
-
setColSpan
public void setColSpan(int colSpan)
Deprecated.Sets the col span for this cell- Specified by:
setColSpan
in interfaceReportGridDisplayCell
- Parameters:
colSpan
- col span for this cell
-
getCellType
public int getCellType()
Deprecated.Returns the cell type- Specified by:
getCellType
in interfaceReportGridDisplayCell
- Returns:
- cell type - EnumReportGridDisplayCellTypes.EnumReportGridDisplayCellTypeGeneric. The cell type is read-only.
-
setCellType
public void setCellType(int cellType)
Deprecated.Sets the type for this cell, value should be from EnumReportGridDisplayCellTypes- Parameters:
cellType
- the type for this cell
-
getReportDesignMode
public int getReportDesignMode()
Deprecated.Please check thereportDesignMode
formal parameter value instead.Returns the mode from EnumReportViewModes- Returns:
- cell type - EnumReportGridDisplayCellTypes.EnumReportGridDisplayCellTypeGeneric. The cell type is read-only.
-
clone
public java.lang.Object clone()
Deprecated.Utility method to clone this object.- Overrides:
clone
in classjava.lang.Object
- Returns:
- the cloned object
-
setHTML
public void setHTML(java.lang.String html)
Deprecated.Sets the complete HTML for this cell. Sets the inner HTML for this cell. It's the html code beginning withand ending with .- Specified by:
setHTML
in interfaceReportGridDisplayCell
- Parameters:
html
- the HTML string
-
setContent
public void setContent(java.lang.String content)
Deprecated.set the content (HTML format) for this cell.- Specified by:
setContent
in interfaceReportGridDisplayCell
- Parameters:
content
- content for this cell.- See Also:
ReportGridDisplayCell.setInnerHTML(java.lang.String)
-
setPreContent
public void setPreContent(java.lang.String preContent)
Deprecated.set the pre-content (HTML format) for this cell.- Specified by:
setPreContent
in interfaceReportGridDisplayCell
- Parameters:
preContent
- pre-content for this cell- See Also:
ReportGridDisplayCell.setInnerHTML(java.lang.String)
-
setPostContent
public void setPostContent(java.lang.String postContent)
Deprecated.set the post-content (HTML format) for this cell.- Specified by:
setPostContent
in interfaceReportGridDisplayCell
- Parameters:
postContent
- post content for this cell- See Also:
ReportGridDisplayCell.setInnerHTML(java.lang.String)
-
generateOutput
public void generateOutput(MarkupOutput mo)
Deprecated.Generate complete HTML for this cell.- Specified by:
generateOutput
in interfaceReportGridDisplayCell
- Parameters:
mo
- the output object
-
getReportBean
public ReportBean getReportBean()
Deprecated.Returns the report bean associated with this display cell- Returns:
- the report bean
-
generateInnerHTML
protected void generateInnerHTML(MarkupOutput mo)
Deprecated.Returns the inner HTML for this cell. InnerHTML is composed of precontent, followed by content, followed by post-content. Could be overrided by subclasses.
-
generatePreContent
protected void generatePreContent(MarkupOutput mo)
Deprecated.Generate the preContent of the cell. The pre-Content means the html content before real core content of the cell. An sample would be a checkbox before the text.- Parameters:
mo
- the output object- Since:
- MicroStrategy Web 7.5.1
-
generateContent
protected void generateContent(MarkupOutput mo)
Deprecated.Generate the core HTML for this cell. By default, it's the text of the cell.- Parameters:
mo
- the output object- Since:
- MicroStrategy Web 7.5.1
-
generatePostContent
protected void generatePostContent(MarkupOutput mo)
Deprecated.Generate the postContent of the cell. The post-Content means the html content after the real core content of the cell. An sample would be a sort button after the text.- Parameters:
mo
- the output object- Since:
- MicroStrategy Web 7.5.1
-
generateContextMenu
protected void generateContextMenu(MarkupOutput mo)
Deprecated.Generate the context menu for this cell.- Parameters:
mo
- the output object
-
getContextMenuAttributes
protected java.util.Map getContextMenuAttributes()
Deprecated.Obtain the tag attributes that should be added to the cell's definition for processing context menus- Returns:
- Map instance with the attribute context menu information
- Since:
- MicroStrategy Web 8.0.1
-
generateTooltip
protected void generateTooltip(MarkupOutput mo)
Deprecated.Generate the context menu for this cell.- Parameters:
mo
- the output object
-
generateTooltipContent
protected java.lang.String generateTooltipContent()
Deprecated.- Since:
- MicroStrategy Web 8.0.1
-
generateDrillCheckBox
protected void generateDrillCheckBox(MarkupOutput mo)
Deprecated.Generate the drill check box.- Parameters:
mo
- the output object
-
generateDrillOpenLink
protected void generateDrillOpenLink(MarkupOutput mo, ReportBean rb, java.lang.String url, java.lang.String title, boolean javascriptUsedForDrill, java.lang.String sElementID)
Deprecated.generate open anchor for drill link for header elements- Parameters:
mo
- the MarkupOutput objectrb
- the ReportBean objecturl
- the url for the linktitle
- the WebTitle objectjavascriptUsedForDrill
- whether use javascript for drillingsElementID
- The drill element ID for this header element
-
generateFilterOnSelectionCheckBox
protected void generateFilterOnSelectionCheckBox(MarkupOutput mo)
Deprecated.Generate the filter on selection check box.- Parameters:
mo
- the output object
-
generateOutlineModeImage
protected void generateOutlineModeImage(MarkupOutput mo)
Deprecated.Generate the javascript images for collapse and expand for outline mode.- Parameters:
mo
- the output object
-
generateOutlineSubTotalName
protected void generateOutlineSubTotalName(MarkupOutput mo)
Deprecated.Generate the name of the subtotal type next to the header element for outline mode.- Parameters:
mo
- the output object
-
generateSortButton
protected void generateSortButton(MarkupOutput mo)
Deprecated.Generate sort button for this cell.- Parameters:
mo
- the output object
-
generatePivotButtons
protected void generatePivotButtons(MarkupOutput mo)
Deprecated.Generate pivot buttons.- Parameters:
mo
- the output object
-
generateTooltipForTitles
protected void generateTooltipForTitles(MarkupOutput mo)
Deprecated.Generate the tool tip for this cell.- Parameters:
mo
- the output object
-
generateTooltipForHeaders
protected void generateTooltipForHeaders(MarkupOutput mo)
Deprecated.Generate the tool tip for this cell.- Parameters:
mo
- the output object
-
generateTooltipForRowValue
protected void generateTooltipForRowValue(MarkupOutput mo)
Deprecated.Generate the tool tip for this cell.- Parameters:
mo
- the output object- Since:
- MicroStrategy Web 7.5.0
-
isMetric
protected boolean isMetric()
Deprecated.determine if the cell is containing a metric- Returns:
- whether the cell is containing a metric
-
generateDragAndDrop
protected void generateDragAndDrop(MarkupOutput mo)
Deprecated.Generate drag and drop properties.- Parameters:
mo
- the output object
-
initDragAndDrop
protected void initDragAndDrop(DragAndDropItem item)
Deprecated.
-
initDNDForDesignMode
protected void initDNDForDesignMode(DragAndDropItem item)
Deprecated.
-
initDNDForExecuteMode
protected void initDNDForExecuteMode(DragAndDropItem item)
Deprecated.
-
getHeaderContent
public java.lang.String getHeaderContent(WebHeader header)
Deprecated.generate output for a header- Specified by:
getHeaderContent
in interfaceReportGridDisplayCell
- Parameters:
header
- the WebHeader object- Returns:
- Header Content as a String
-
getDescriptor
protected java.lang.String getDescriptor(ReportBean rb, int key)
Deprecated.Get descriptor for this key- Parameters:
key
- input key as an int- Returns:
- descriptor as a String
-
useBuiltInFormat
protected boolean useBuiltInFormat()
Deprecated.Please check theuseBuiltInFormat
formal parameter value instead.whether use report's built-in formatting, ie the formatting defined in the report definition.- Returns:
- whether use report's built-in formatting
-
showPivot
protected boolean showPivot()
Deprecated.Please check theshowPivot
formal parameter value instead.whether display pivot buttons- Returns:
- whether display pivot buttons
-
showRemove
protected boolean showRemove()
Deprecated.Please check theshowRemove
formal parameter value instead.whether display remove buttons- Returns:
- whether display remove buttons
-
showBanding
protected boolean showBanding()
Deprecated.Please check theshowBanding
formal parameter value instead.whether display banding for the report- Returns:
- whether display banding for the report
-
showDrillRMC
protected boolean showDrillRMC()
Deprecated.Please check theshowDrillRMC
formal parameter value instead.whether display drill RMC (right mouse click context menu)- Returns:
- whether display drill RMC (right mouse click context menu)
-
showDrillRMCMetric
protected boolean showDrillRMCMetric()
Deprecated.Please check theshowDrillRMCMetric
formal parameter value instead.whether display drill RMC (right mouse click context menu) for metric- Returns:
- whether display drill RMC (right mouse click context menu) for metric
-
showDrillHyperlink
protected boolean showDrillHyperlink()
Deprecated.Please check theshowDrillHyperlink
formal parameter value instead.whether display drill link- Returns:
- whether display drill link
-
showDrillHyperlinkMetric
protected boolean showDrillHyperlinkMetric()
Deprecated.Please check theshowDrillHyperlinkMetric
formal parameter value instead.whether display drill link for metric- Returns:
- whether display drill link for metric
-
showDrillAdvanced
protected boolean showDrillAdvanced()
Deprecated.Please check theshowDrillAdvanced
formal parameter value instead.whether display advanced drilling- Returns:
- whether display advanced drilling
-
showDrillDownOnly
protected boolean showDrillDownOnly()
Deprecated.Please check theshowDrillDownOnly
formal parameter value instead.whether only display drill down paths- Returns:
- whether only display drill down paths
-
showDrillMetric
protected boolean showDrillMetric()
Deprecated.Please check theshowDrillMetric
formal parameter value instead.whether display drill on metric- Returns:
- whether display drill on metric
-
showDrillCheckBox
protected boolean showDrillCheckBox()
Deprecated.Please check theshowDrillCheckBox
formal parameter value instead.whether display checkbox for drill- Returns:
- whether display checkbox for drill
-
showFilterOnSelectionCheckBox
protected boolean showFilterOnSelectionCheckBox()
Deprecated.Please check theshowFilterOnSelectionCheckBox
formal parameter value instead.whether display checkbox for filter on selection- Returns:
- whether display checkbox for filter on selection
-
showSortButtonsForAttributes
protected boolean showSortButtonsForAttributes()
Deprecated.Please check theshowSortButtonsForAttributes
formal parameter value instead.whether display sort buttons for attributes- Returns:
- whether display sort buttons for attributes
-
showSortRMCForAttributes
protected boolean showSortRMCForAttributes()
Deprecated.Please check theshowSortRMCForAttributes
formal parameter value instead.whether display sort RMC for attributes- Returns:
- whether display sort RMC for attributes
-
showSortButtonsForMetrics
protected boolean showSortButtonsForMetrics()
Deprecated.Please check theshowSortButtonsForMetrics
formal parameter value instead.whether display sort buttons for metrics- Returns:
- whether display sort buttons for metrics
-
showSortRMCForMetrics
protected boolean showSortRMCForMetrics()
Deprecated.Please check theshowSortRMCForMetrics
formal parameter value instead.whether display sort RMC for metrics- Returns:
- whether display sort RMC for metrics
-
getMaxSortAllowed
protected int getMaxSortAllowed()
Deprecated.Please check themaxSortAllowed
formal parameter value instead.get the max number of sorts- Returns:
- max number of sorts
-
isDragAndDropEnabled
protected boolean isDragAndDropEnabled()
Deprecated.Please check theisDragAndDropEnabled
formal parameter value instead.is drag and drop feature enabled- Returns:
- drag and drop feature enabled
-
isContextMenuEnabled
protected boolean isContextMenuEnabled()
Deprecated.Please check theisContextMenuEnabled
formal parameter value instead.is context menu featuer enabled- Returns:
- is context menu featuer enabled
-
isOutlineModeEnabled
protected boolean isOutlineModeEnabled()
Deprecated.is outline more feature enabled- Returns:
- is outline more feature enabled
-
showSubTitle
protected boolean showSubTitle()
Deprecated.whethere display sub title- Returns:
- whethere display sub title
-
isDesignMode
protected boolean isDesignMode()
Deprecated.is design mode or not- Returns:
- is design mode or not
-
getCssPrefix
protected java.lang.String getCssPrefix()
Deprecated.Please check thecssPrefix
formal parameter value instead.get the prefix for the css class name- Returns:
- the prefix for the css class name
-
getPreTextForMetricValue
protected java.lang.String getPreTextForMetricValue()
Deprecated.Please check thepreTextForMetricValue
formal parameter value instead.the text before displaying the metric value itself- Returns:
- the text before displaying the metric value itself
-
getPostTextForMetricValue
protected java.lang.String getPostTextForMetricValue()
Deprecated.Please check thepostTextForMetricValue
formal parameter value instead.the text after displaying the metric value itself- Returns:
- the text after displaying the metric value itself
-
getPreTextForNonMetricValue
protected java.lang.String getPreTextForNonMetricValue()
Deprecated.Please check thepreTextForNonMetricValue
formal parameter value instead.the text before displaying the non-metric value itself- Returns:
- the text before displaying the non-metric value itself
-
getPostTextForNonMetricValue
protected java.lang.String getPostTextForNonMetricValue()
Deprecated.Please check thepostTextForNonMetricValue
formal parameter value instead.the text after displaying the non-metric value itself- Returns:
- the text after displaying the non-metric value itself
-
getImgName
protected java.lang.String getImgName(java.lang.String fpName)
Deprecated.get the corresponding image name for a formal parameter representing an image- Parameters:
fpName
- formal parameter name- Returns:
- image name
-
getFPStringValue
protected java.lang.String getFPStringValue(java.lang.String fpName)
Deprecated.get the formal parameter value as a string value- Parameters:
fpName
- formal parameter name- Returns:
- formal parameter value
-
getFPIntValue
protected int getFPIntValue(java.lang.String fpName)
Deprecated.get formal parameter value as an integer value- Parameters:
fpName
- formal parameter name- Returns:
- formal parameter value
-
isFPTrue
protected boolean isFPTrue(java.lang.String fpName, boolean defValue)
Deprecated.
-
isFPTrue
protected boolean isFPTrue(java.lang.String fpName)
Deprecated.get formal parameter value as a boolean value- Parameters:
fpName
- formal parameter name- Returns:
- formal parameter value
-
setStyleForNonBuiltInFormat
protected void setStyleForNonBuiltInFormat(java.lang.String style, int rowOrdinal)
Deprecated.set the style for the cell when not using the built in report formatting- Parameters:
style
- style namerowOrdinal
- row ordial
-
generateHeaderDrillContextMenu
protected void generateHeaderDrillContextMenu(MarkupOutput mo, ReportBean rb, WebHeader header, java.lang.StringBuffer sHeaderURL, ContextMenu rhMenu)
Deprecated.generate the drilling context menu for headers- Parameters:
mo
- the MarkupOutput objectrb
- the ReportBean objectheader
- the WebHeader objectsHeaderURL
- the header's urlrhMenu
- the context menu object
-
generateRowValueDrillContextMenu
protected void generateRowValueDrillContextMenu(MarkupOutput mo, ReportBean rb, WebRowValue rowValue, java.lang.StringBuffer sHeaderURL, ContextMenu rhMenu)
Deprecated.generate the drilling context menu for row values- Parameters:
mo
- the MarkupOutput objectrb
- the ReportBean objectrowValue
- the WebRowValue objectsHeaderURL
- the header's urlrhMenu
- the context menu object- Since:
- MicroStrategy Web 7.5.0
-
getRowValueDrillParametersForDHTML
protected java.lang.String getRowValueDrillParametersForDHTML(ReportBean rb, WebDrillPath dp)
Deprecated.generate drilling url parameters for row value in DHTML mode- Parameters:
rb
- the ReportBean objectdp
- the drill path- Returns:
- the url string
- Since:
- MicroStrategy Web 7.5.0
-
generateTitleDrillContextMenu
protected void generateTitleDrillContextMenu(MarkupOutput mo, ReportBean rb, WebTitle title, java.lang.StringBuffer sTitleURL, ContextMenu rhMenu)
Deprecated.generate output for drilling context menu for titles- Parameters:
mo
- the MarkupOutput objectrb
- the ReportBean objecttitle
- the WebTitle objectsTitleURL
- the title's urlrhMenu
- the context menu object
-
generateHeaderSortContextMenu
protected void generateHeaderSortContextMenu(MarkupOutput mo, ReportBean rb, WebHeader header, ContextMenu rhMenu)
Deprecated.generate the output for sorting context menu for headers- Parameters:
mo
- the MarkupOutput objectrb
- the ReportBean objectheader
- the WebHeader objectrhMenu
- the context menu object
-
generateTitleSortContextMenu
protected void generateTitleSortContextMenu(MarkupOutput mo, ReportBean rb, WebTitle title, ContextMenu rhMenu)
Deprecated.generate the output for sorting context menu for titles- Parameters:
mo
- the MarkupOutput objectrb
- the ReportBean objecttitle
- the WebTitle objectrhMenu
- the context menu object
-
getHeaderDrillURL
protected java.lang.String getHeaderDrillURL(ReportBean rb, WebDrillPath dp, WebHeader header)
Deprecated.generate the output for drilling URL for headers- Parameters:
rb
- the ReportBean objectdp
- the drill pathheader
- the WebHeader object
-
getRowValueDrillURL
protected java.lang.String getRowValueDrillURL(ReportBean rb, WebDrillPath dp, WebRowValue rowValue)
Deprecated.generate the output for drilling URL for row value- Parameters:
rb
- the ReportBean objectdp
- the drill pathrowValue
- the WebRowValue object- Since:
- MicroStrategy Web 7.5.0
-
getTitleDrillURL
protected java.lang.String getTitleDrillURL(ReportBean rb, WebDrillPath dp, WebTitle title)
Deprecated.generate the output for drilling URL for titles- Parameters:
rb
- the ReportBean objectdp
- the drill pathtitle
- the WebTitle object
-
getHeaderDrillParametersForDHTML
protected java.lang.String getHeaderDrillParametersForDHTML(ReportBean rb, WebDrillPath dp, WebHeader header)
Deprecated.generate drilling url parameters for DHTML mode- Parameters:
rb
- the ReportBean objectdp
- the drill pathheader
- the WebHeader object- Returns:
- the url string
-
getTitleDrillParametersForDHTML
protected java.lang.String getTitleDrillParametersForDHTML(ReportBean rb, WebDrillPath dp, WebTitle title)
Deprecated.generate drilling url parameters for DHTML mode- Parameters:
rb
- the ReportBean objectdp
- the drill pathtitle
- the WebTitle object- Returns:
- the url string
-
getHeaderDrillPathWithHighImportance
protected WebDrillPath getHeaderDrillPathWithHighImportance(ReportBean rb, WebHeader header)
Deprecated.generate drilling url parameters for DHTML mode- Parameters:
rb
- the ReportBean objectheader
- the WebHeader object- Returns:
- The drill path with high importance
-
getRowValueDrillPathWithHighImportance
protected WebDrillPath getRowValueDrillPathWithHighImportance(ReportBean rb, WebRowValue rowValue)
Deprecated.generate drilling url parameters for row value in DHTML mode- Parameters:
rb
- the ReportBean objectrowValue
- the WebRowValue object- Returns:
- The drill path with high importance
- Since:
- MicroStrategy Web 7.5.0
-
generateDrillCheckBox
protected boolean generateDrillCheckBox(MarkupOutput mo, ReportBean rb, WebHeader header)
Deprecated.generate output for checkboxes for drill- Parameters:
mo
- the MarkupOutput objectrb
- the ReportBean objectheader
- the WebHeader object- Returns:
- if any checkbox is rendered
-
generateFilterOnSelectionCheckBox
protected boolean generateFilterOnSelectionCheckBox(MarkupOutput mo, ReportBean rb, WebHeader header)
Deprecated.generate output for the checkbox for Filter on Selections- Parameters:
mo
- the MarkupOutput objectrb
- the ReportBean objectheader
- the WebHeader object- Returns:
- if any checkbox is rendered
-
isHeaderNeedLink
protected boolean isHeaderNeedLink(WebHeader header)
Deprecated.return whether to display link for drill- Parameters:
header
- the WebHeader object- Returns:
- whether to display link for drill
-
isTitleNeedLink
protected boolean isTitleNeedLink(WebTitle title)
Deprecated.return whether to display link for drill- Parameters:
title
- the WebTitle object- Returns:
- whether to display link for drill
-
isRowValueNeedLink
protected boolean isRowValueNeedLink(WebRowValue rowValue)
Deprecated.return whether to display link for drill- Parameters:
rowValue
- the WebRowValue object- Returns:
- whether to display link for drill
- Since:
- MicroStrategy Web 7.5.0
-
getSortStatus
protected boolean getSortStatus(java.lang.String sSortID, java.lang.String[][] appliedSorts)
Deprecated.get the sort statys- Parameters:
sSortID
- sortIDappliedSorts
- the sort information array- Returns:
- whether the sortID is in the sort information array
-
isSortAscending
protected boolean isSortAscending(java.lang.String sSortID, java.lang.String[][] appliedSorts)
Deprecated.check if the sort is ascending- Parameters:
sSortID
- the sort idappliedSorts
- the sort information array- Returns:
- whether the sort is ascending
-
isItemsAddedToContextMenu
protected boolean isItemsAddedToContextMenu()
Deprecated.return whether there is any item added to the context menu- Returns:
- whether there is any item added to the context menu
-
getColHeaderWebMetric
protected WebMetric getColHeaderWebMetric(WebHeader header)
Deprecated.get the metric object for the column header- Parameters:
header
- the column header- Returns:
- the corresponding
WebMetric
object
-
setExtraUrl
public void setExtraUrl(java.lang.String value)
Deprecated.set extra url for the cell- Parameters:
value
- extra url for the cell
-
getExtraUrl
public java.lang.String getExtraUrl()
Deprecated.get extra url for the cell- Returns:
- extra url for the cell
-
isIFrameEnabled
protected boolean isIFrameEnabled()
Deprecated.whether ifram is enabled- Returns:
- whether ifram is enabled
-
getContextMenuManager
protected ContextMenuManager getContextMenuManager()
Deprecated.get theContextMenuManager
object- Returns:
ContextMenuManager
object
-
isMetricDrillable
protected boolean isMetricDrillable(WebHeader header, WebDrillPath drillPath)
Deprecated.return whether the header has a drillable metric- Parameters:
header
- the header objectdrillPath
- the drill path- Returns:
- whether the header has a drillable metric
-
showPivotRMC
protected boolean showPivotRMC()
Deprecated.Please check theshowPivotRMC
formal parameter value instead.whether display pivot RMC (right mouse click context menu)- Returns:
- display pivot RMC (right mouse click context menu)
-
showRemoveRMC
protected boolean showRemoveRMC()
Deprecated.Please check theshowRemoveRMC
formal parameter value instead.whether display remove RMC (right mouse click context menu)- Returns:
- display remove RMC (right mouse click context menu)
-
showFormattingRMC
protected boolean showFormattingRMC()
Deprecated.Please check theshowFormattingRMC
formal parameter value instead.whether display formatting RMC (right mouse click context menu)- Returns:
- display formatting RMC (right mouse click context menu)
-
showRenameRMC
protected boolean showRenameRMC()
Deprecated.Please check theshowRenameRMC
formal parameter value instead.whether display rename RMC (right mouse click context menu)- Returns:
- display rename RMC (right mouse click context menu)
-
decodeEuro
protected boolean decodeEuro()
Deprecated.This method as well as thedecodeEuro
formal parameter itself are not used anymore on the application.Whether to decode the Euro symbol on the metric values- Returns:
- whether to decode the Euro symbol on the metric values
-
encodeMV
protected boolean encodeMV()
Deprecated.This method is only required at the metric value cell, please useReportGridCellMetricValueImpl.encodeMetricValue()
.Whether to HTML-encode metric values.- Returns:
- Whether to HTML-encode metric values.
- Since:
- MicroStrategy Web 7.5.1
-
convertNonbreakingSpaceOnMV
protected boolean convertNonbreakingSpaceOnMV()
Deprecated.This functionality has been moved to the excel-only related classes such asReportGridExcelCellMetricValueImpl
andReportGridExcelTransform
. This method now always returns false.Whether to convert nonbreaking spaces (char 160) to normal spaces (char 32) on metric values. Used for Exporting to Excel on French Environments.- Returns:
- Whether to convert nonbreaking spaces (char 160) to normal spaces (char 32) on metric values.
- Since:
- MicroStrategy Web 7.5.1
-
getEventManager
protected EventManager getEventManager()
Deprecated.get theEventManager
object- Returns:
- the
EventManager
object
-
isIFrameRequest
protected boolean isIFrameRequest()
Deprecated.whether it's an iframe request- Returns:
- whether it's an iframe request
-
getShowDescriptionAsTooltip
protected int getShowDescriptionAsTooltip(java.lang.String fpName)
Deprecated.get formal parameter value as an int value- Parameters:
fpName
- formal parameter name- Returns:
- formal parameter value
-
getRowValueDrillElements
protected java.lang.String getRowValueDrillElements(WebRowValue rowValue)
Deprecated.- Since:
- MicroStrategy Web 7.5.0
-
canEditControl
public boolean canEditControl()
Deprecated.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 interfaceReportGridDisplayCell
- Returns:
- boolean value indicating if the manipulation should be enabled
- Since:
- MicroStrategy Web 8.1.0
-
getFilterOnEvent
public WebEvent getFilterOnEvent()
Deprecated.Description copied from interface:ReportGridDisplayCell
Get the event for filter on the cell header instance- Specified by:
getFilterOnEvent
in interfaceReportGridDisplayCell
- Returns:
WebEvent
instance initialized for filtering on the information of this cell- Since:
- MicroStrategy Web 9.0.0
-
getOpenFormatEditorEvent
public WebEvent getOpenFormatEditorEvent()
Deprecated.Description copied from interface:ReportGridDisplayCell
Get the event for opening the format editor- Specified by:
getOpenFormatEditorEvent
in interfaceReportGridDisplayCell
- Returns:
WebEvent
instance initialized for opening the format editor- Since:
- MicroStrategy Web 9.0.0
-
getSetFormatEditorTargetEvent
public WebEvent getSetFormatEditorTargetEvent()
Deprecated.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 interfaceReportGridDisplayCell
- Returns:
WebEvent
instance initialized for setting the target of the format editor to be the current cell instance.- Since:
- MicroStrategy Web 9.0.0
-
getRenameEvent
public WebEvent getRenameEvent()
Deprecated.Description copied from interface:ReportGridDisplayCell
Get the event for renaming the current cell- Specified by:
getRenameEvent
in interfaceReportGridDisplayCell
- Returns:
WebEvent
instance initialized with the information for renaming the current cell.- Since:
- MicroStrategy Web 9.0.0
-
getDerivedElementsEvent
public WebEvent getDerivedElementsEvent()
Deprecated.- Specified by:
getDerivedElementsEvent
in interfaceReportGridDisplayCell
- Since:
- MicroStrategy Web 9.0.0
-
getKey
public int getKey()
Deprecated.- Specified by:
getKey
in interfaceReportGridDisplayCell
- Returns:
- int value with the key information about the cell being analyzed.
- Since:
- MicroStrategy Web 9.0.0
-
canOpenAlerts
public boolean canOpenAlerts()
Deprecated.- Specified by:
canOpenAlerts
in interfaceReportGridDisplayCell
- Since:
- MicroStrategy Web 9.0.0
-
canFilterOnSelection
public boolean canFilterOnSelection()
Deprecated.- Specified by:
canFilterOnSelection
in interfaceReportGridDisplayCell
- Since:
- MicroStrategy Web 9.0.0
-
-