Package com.microstrategy.web.app.transforms

Class ReportGridDisplayCellImpl

    • Field Detail

      • _text

        protected java.lang.String _text
        Deprecated.

      • _itemsAddedToContextMenu

        protected boolean _itemsAddedToContextMenu
        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.

    • Constructor Detail

      • ReportGridDisplayCellImpl

        public ReportGridDisplayCellImpl()
        Deprecated.
        Constructor used for creating a generic display cell.
        Since:
        MicroStrategy Web 7.5.1

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

      • init

        public void init​(FormalParameters formalParas)
        Deprecated.
        Init method used for creating a generic display cell.
        Specified by:
        init in interface ReportGridDisplayCell
        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​(WebComponent wc,
                 FormalParameters formalParas)
        Deprecated.
        Init method used for creating a generic display cell.
        Specified by:
        init in interface ReportGridDisplayCell
        Parameters:
        wc - associated web component
        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.2

      • init

        @Deprecated
public void init​(WebComponent wc,
                 java.util.HashMap cachedObjects)
        Deprecated.
        please use the interface that takes Context object instances as parameter
        Init method used for creating a generic display cell.
        Specified by:
        init in interface ReportGridDisplayCell
        Parameters:
        wc - associated web component
        cachedObjects - 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 interface ReportGridDisplayCell
        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 interface ReportGridDisplayCell
        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 interface ReportGridDisplayCell
        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 interface ReportGridDisplayCell
        Parameters:
        attributeName - String value with the name of the attribute to add
        attributeValue - 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 interface ReportGridDisplayCell
        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 interface ReportGridDisplayCell
        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 interface ReportGridDisplayCell
        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 interface ReportGridDisplayCell
        Returns:
        boolean value indicating if the manipulation should be enabled
        Since:
        MicroStrategy Web 8.0.1

      • 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 interface ReportGridDisplayCell
        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 interface ReportGridDisplayCell
        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 interface ReportGridDisplayCell
        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 interface ReportGridDisplayCell
        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 interface ReportGridDisplayCell
        Returns:
        WebDrillPath instance initialized, with the drill path with high importance information if available, otherwise returns null
        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 interface ReportGridDisplayCell
        Parameters:
        dp - The drill path to use for drilling.
        elementKey - The key for the element to drill to
        title - The WebTitle to drill from.
        Since:
        MicroStrategy Web 8.0.1

      • 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 interface ReportGridDisplayCell
        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 interface ReportGridDisplayCell
        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 interface ReportGridDisplayCell
        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 interface ReportGridDisplayCell
        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 interface ReportGridDisplayCell
        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 interface ReportGridDisplayCell
        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 interface ReportGridDisplayCell
        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 interface ReportGridDisplayCell
        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 the STYLE attribute of the TD 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 interface ReportGridDisplayCell
        Parameters:
        extraStyle - The text to add
        append - 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 interface ReportGridDisplayCell
        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 interface ReportGridDisplayCell
        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 interface ReportGridDisplayCell
        Parameters:
        extraInfo - the extra info for this cell

      • getAccessibilityInfo

        @Deprecated
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 interface ReportGridDisplayCell
        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 interface ReportGridDisplayCell
        Returns:
        the extra info for this cell

      • getText

        public java.lang.String getText()
        Deprecated.
        Returns the text for this cell
        Specified by:
        getText in interface ReportGridDisplayCell
        Returns:
        text for this cell

      • setText

        public void setText​(java.lang.String text)
        Deprecated.
        Sets the text for this cell
        Specified by:
        setText in interface ReportGridDisplayCell
        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 of in HTML
        Specified by:
        getCellID in interface ReportGridDisplayCell
        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 of in HTML
        Specified by:
        setCellID in interface ReportGridDisplayCell
        Parameters:
        cellID - the id for this cell

      • getWidth

        public java.lang.String getWidth()
        Deprecated.
        Returns the width for this cell
        Specified by:
        getWidth in interface ReportGridDisplayCell
        Returns:
        width for the cell

      • setWidth

        public void setWidth​(java.lang.String width)
        Deprecated.
        Sets the width for this cell
        Specified by:
        setWidth in interface ReportGridDisplayCell
        Parameters:
        width - text for this cell

      • getTooltip

        public java.lang.String getTooltip()
        Deprecated.
        Returns the tooltip text for this cell
        Specified by:
        getTooltip in interface ReportGridDisplayCell
        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 interface ReportGridDisplayCell
        Parameters:
        tooltip - the tooltip to display when the cursor goes over the cell

      • setInnerHTML

        public void setInnerHTML​(java.lang.String innerHTML)
        Deprecated.
        Sets the inner HTML for this cell. Inner HTML is the html code between and .
        Specified by:
        setInnerHTML in interface ReportGridDisplayCell
        Parameters:
        innerHTML - inner HTML for this cell

      • getRowSpan

        public int getRowSpan()
        Deprecated.
        Returns the row span for this cell
        Specified by:
        getRowSpan in interface ReportGridDisplayCell
        Returns:
        row span

      • setRowSpan

        public void setRowSpan​(int rowSpan)
        Deprecated.
        Sets the row span for this cell
        Specified by:
        setRowSpan in interface ReportGridDisplayCell
        Parameters:
        rowSpan - the row span for this cell

      • getColSpan

        public int getColSpan()
        Deprecated.
        Returns the col span for this cell
        Specified by:
        getColSpan in interface ReportGridDisplayCell
        Returns:
        col span

      • setColSpan

        public void setColSpan​(int colSpan)
        Deprecated.
        Sets the col span for this cell
        Specified by:
        setColSpan in interface ReportGridDisplayCell
        Parameters:
        colSpan - col span for this cell

      • getCellType

        public int getCellType()
        Deprecated.
        Returns the cell type
        Specified by:
        getCellType in interface ReportGridDisplayCell
        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

        @Deprecated
public int getReportDesignMode()
        Deprecated.
        Please check the reportDesignMode 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 class java.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 with and ending with .
        Specified by:
        setHTML in interface ReportGridDisplayCell
        Parameters:
        html - the HTML string

      • 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 object
        rb - the ReportBean object
        url - the url for the link
        title - the WebTitle object
        javascriptUsedForDrill - whether use javascript for drilling
        sElementID - 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 interface ReportGridDisplayCell
        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

        @Deprecated
protected boolean useBuiltInFormat()
        Deprecated.
        Please check the useBuiltInFormat 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

        @Deprecated
protected boolean showPivot()
        Deprecated.
        Please check the showPivot formal parameter value instead.
        whether display pivot buttons
        Returns:
        whether display pivot buttons

      • showRemove

        @Deprecated
protected boolean showRemove()
        Deprecated.
        Please check the showRemove formal parameter value instead.
        whether display remove buttons
        Returns:
        whether display remove buttons

      • showBanding

        @Deprecated
protected boolean showBanding()
        Deprecated.
        Please check the showBanding formal parameter value instead.
        whether display banding for the report
        Returns:
        whether display banding for the report

      • showDrillRMC

        @Deprecated
protected boolean showDrillRMC()
        Deprecated.
        Please check the showDrillRMC formal parameter value instead.
        whether display drill RMC (right mouse click context menu)
        Returns:
        whether display drill RMC (right mouse click context menu)

      • showDrillRMCMetric

        @Deprecated
protected boolean showDrillRMCMetric()
        Deprecated.
        Please check the showDrillRMCMetric 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

        @Deprecated
protected boolean showDrillHyperlink()
        Deprecated.
        Please check the showDrillHyperlink formal parameter value instead.
        whether display drill link
        Returns:
        whether display drill link

      • showDrillHyperlinkMetric

        @Deprecated
protected boolean showDrillHyperlinkMetric()
        Deprecated.
        Please check the showDrillHyperlinkMetric formal parameter value instead.
        whether display drill link for metric
        Returns:
        whether display drill link for metric

      • showDrillAdvanced

        @Deprecated
protected boolean showDrillAdvanced()
        Deprecated.
        Please check the showDrillAdvanced formal parameter value instead.
        whether display advanced drilling
        Returns:
        whether display advanced drilling

      • showDrillDownOnly

        @Deprecated
protected boolean showDrillDownOnly()
        Deprecated.
        Please check the showDrillDownOnly formal parameter value instead.
        whether only display drill down paths
        Returns:
        whether only display drill down paths

      • showDrillMetric

        @Deprecated
protected boolean showDrillMetric()
        Deprecated.
        Please check the showDrillMetric formal parameter value instead.
        whether display drill on metric
        Returns:
        whether display drill on metric

      • showDrillCheckBox

        @Deprecated
protected boolean showDrillCheckBox()
        Deprecated.
        Please check the showDrillCheckBox formal parameter value instead.
        whether display checkbox for drill
        Returns:
        whether display checkbox for drill

      • showFilterOnSelectionCheckBox

        @Deprecated
protected boolean showFilterOnSelectionCheckBox()
        Deprecated.
        Please check the showFilterOnSelectionCheckBox formal parameter value instead.
        whether display checkbox for filter on selection
        Returns:
        whether display checkbox for filter on selection

      • showSortButtonsForAttributes

        @Deprecated
protected boolean showSortButtonsForAttributes()
        Deprecated.
        Please check the showSortButtonsForAttributes formal parameter value instead.
        whether display sort buttons for attributes
        Returns:
        whether display sort buttons for attributes

      • showSortRMCForAttributes

        @Deprecated
protected boolean showSortRMCForAttributes()
        Deprecated.
        Please check the showSortRMCForAttributes formal parameter value instead.
        whether display sort RMC for attributes
        Returns:
        whether display sort RMC for attributes

      • showSortButtonsForMetrics

        @Deprecated
protected boolean showSortButtonsForMetrics()
        Deprecated.
        Please check the showSortButtonsForMetrics formal parameter value instead.
        whether display sort buttons for metrics
        Returns:
        whether display sort buttons for metrics

      • showSortRMCForMetrics

        @Deprecated
protected boolean showSortRMCForMetrics()
        Deprecated.
        Please check the showSortRMCForMetrics formal parameter value instead.
        whether display sort RMC for metrics
        Returns:
        whether display sort RMC for metrics

      • getMaxSortAllowed

        @Deprecated
protected int getMaxSortAllowed()
        Deprecated.
        Please check the maxSortAllowed formal parameter value instead.
        get the max number of sorts
        Returns:
        max number of sorts

      • isDragAndDropEnabled

        @Deprecated
protected boolean isDragAndDropEnabled()
        Deprecated.
        Please check the isDragAndDropEnabled formal parameter value instead.
        is drag and drop feature enabled
        Returns:
        drag and drop feature enabled

      • isContextMenuEnabled

        @Deprecated
protected boolean isContextMenuEnabled()
        Deprecated.
        Please check the isContextMenuEnabled 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

        @Deprecated
protected java.lang.String getCssPrefix()
        Deprecated.
        Please check the cssPrefix formal parameter value instead.
        get the prefix for the css class name
        Returns:
        the prefix for the css class name

      • getPreTextForMetricValue

        @Deprecated
protected java.lang.String getPreTextForMetricValue()
        Deprecated.
        Please check the preTextForMetricValue formal parameter value instead.
        the text before displaying the metric value itself
        Returns:
        the text before displaying the metric value itself

      • getPostTextForMetricValue

        @Deprecated
protected java.lang.String getPostTextForMetricValue()
        Deprecated.
        Please check the postTextForMetricValue formal parameter value instead.
        the text after displaying the metric value itself
        Returns:
        the text after displaying the metric value itself

      • getPreTextForNonMetricValue

        @Deprecated
protected java.lang.String getPreTextForNonMetricValue()
        Deprecated.
        Please check the preTextForNonMetricValue formal parameter value instead.
        the text before displaying the non-metric value itself
        Returns:
        the text before displaying the non-metric value itself

      • getPostTextForNonMetricValue

        @Deprecated
protected java.lang.String getPostTextForNonMetricValue()
        Deprecated.
        Please check the postTextForNonMetricValue 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 name
        rowOrdinal - 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 object
        rb - the ReportBean object
        header - the WebHeader object
        sHeaderURL - the header's url
        rhMenu - 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 object
        rb - the ReportBean object
        rowValue - the WebRowValue object
        sHeaderURL - the header's url
        rhMenu - 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 object
        dp - 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 object
        rb - the ReportBean object
        title - the WebTitle object
        sTitleURL - the title's url
        rhMenu - 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 object
        rb - the ReportBean object
        header - the WebHeader object
        rhMenu - 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 object
        rb - the ReportBean object
        title - the WebTitle object
        rhMenu - 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 object
        dp - the drill path
        header - 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 object
        dp - the drill path
        rowValue - 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 object
        dp - the drill path
        title - 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 object
        dp - the drill path
        header - 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 object
        dp - the drill path
        title - 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 object
        header - 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 object
        rowValue - 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 object
        rb - the ReportBean object
        header - 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 object
        rb - the ReportBean object
        header - 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 - sortID
        appliedSorts - 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 id
        appliedSorts - 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

      • isMetricDrillable

        protected boolean isMetricDrillable​(WebHeader header,
                                    WebDrillPath drillPath)
        Deprecated.
        return whether the header has a drillable metric
        Parameters:
        header - the header object
        drillPath - the drill path
        Returns:
        whether the header has a drillable metric

      • showPivotRMC

        @Deprecated
protected boolean showPivotRMC()
        Deprecated.
        Please check the showPivotRMC formal parameter value instead.
        whether display pivot RMC (right mouse click context menu)
        Returns:
        display pivot RMC (right mouse click context menu)

      • showRemoveRMC

        @Deprecated
protected boolean showRemoveRMC()
        Deprecated.
        Please check the showRemoveRMC formal parameter value instead.
        whether display remove RMC (right mouse click context menu)
        Returns:
        display remove RMC (right mouse click context menu)

      • showFormattingRMC

        @Deprecated
protected boolean showFormattingRMC()
        Deprecated.
        Please check the showFormattingRMC formal parameter value instead.
        whether display formatting RMC (right mouse click context menu)
        Returns:
        display formatting RMC (right mouse click context menu)

      • showRenameRMC

        @Deprecated
protected boolean showRenameRMC()
        Deprecated.
        Please check the showRenameRMC formal parameter value instead.
        whether display rename RMC (right mouse click context menu)
        Returns:
        display rename RMC (right mouse click context menu)

      • decodeEuro

        @Deprecated
protected boolean decodeEuro()
        Deprecated.
        This method as well as the decodeEuro 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

        @Deprecated
protected boolean encodeMV()
        Deprecated.
        This method is only required at the metric value cell, please use ReportGridCellMetricValueImpl.encodeMetricValue().
        Whether to HTML-encode metric values.
        Returns:
        Whether to HTML-encode metric values.
        Since:
        MicroStrategy Web 7.5.1

      • convertNonbreakingSpaceOnMV

        @Deprecated
protected boolean convertNonbreakingSpaceOnMV()
        Deprecated.
        This functionality has been moved to the excel-only related classes such as ReportGridExcelCellMetricValueImpl and ReportGridExcelTransform. 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

      • 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 interface ReportGridDisplayCell
        Returns:
        boolean value indicating if the manipulation should be enabled
        Since:
        MicroStrategy Web 8.1.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 interface ReportGridDisplayCell
        Returns:
        WebEvent instance initialized for setting the target of the format editor to be the current cell instance.
        Since:
        MicroStrategy Web 9.0.0

      • getKey

        public int getKey()
        Deprecated.
        Specified by:
        getKey in interface ReportGridDisplayCell
        Returns:
        int value with the key information about the cell being analyzed.
        Since:
        MicroStrategy Web 9.0.0