Package com.microstrategy.web.app.transforms

Class AbstractReportGridDisplayCell

    • Field Detail

      • _isWrapHeaderText

        protected boolean _isWrapHeaderText

      • _blankDrillAnchorTag

        protected AnchorTag _blankDrillAnchorTag
        Since:
        MicroStrategy Web 9.0.0

      • _sharedCellProperties

        protected com.microstrategy.web.app.transforms.SharedCellProperties _sharedCellProperties
        Since:
        MicroStrategy Web 8.1.0

      • _appliedSorts

        protected java.lang.String[][] _appliedSorts

      • _appliedColSorts

        protected java.lang.String[][] _appliedColSorts
        Since:
        MicroStrategy Web 8.0.2

      • _sortSubtotalPostion

        protected java.lang.String _sortSubtotalPostion

      • _sortSubtotalPosition

        protected java.lang.String _sortSubtotalPosition
        Since:
        MicroStrategy Web 8.1.0

      • _sortSubtotalColPosition

        protected java.lang.String _sortSubtotalColPosition
        Since:
        MicroStrategy Web 8.0.2

      • _typicalURLBeanState

        protected java.lang.String _typicalURLBeanState
        Since:
        MicroStrategy Web 8.0.0

      • _maxColHeaderDepth

        protected int _maxColHeaderDepth
        Deprecated.
        please use getMaxColHeaderDepth() method instead

      • _imgBasePath

        protected java.lang.String _imgBasePath

      • _isNetscape

        protected boolean _isNetscape

      • _specifyWidthForCell

        protected boolean _specifyWidthForCell

      • _itemsAddedToContextMenu

        protected boolean _itemsAddedToContextMenu
        Deprecated.
        Context menus should be added by modifying the xml definition associated through the AbstractAppTransform's contextMenus formal parameter. Please see the MSDL context menu scenarios for the new approach.
        See Also:
        AbstractAppTransform.contextMenus

      • _advDrillEditorProcessEvent

        protected WebEvent _advDrillEditorProcessEvent
        Deprecated.
        Please use the get event methods defined on this class, its children, or on the transform that uses this class.

      • formalParas

        protected FormalParameters formalParas
        Deprecated.
        Please access the formal parameter information via the transform defined on the Context object of this instance.

      • _drillEditorName

        protected java.lang.String _drillEditorName
        Deprecated.
        This property is no longer used in the logic of this class

      • _sortEvent

        protected WebEvent _sortEvent
        Deprecated.
        Please use the get event methods defined on this class, its children, or on the transform that uses this class.

      • _advdrillEvent

        protected WebEvent _advdrillEvent
        Deprecated.
        Please use the get event methods defined on this class, its children, or on the transform that uses this class.

      • _specifyIDForCell

        protected boolean _specifyIDForCell
        Deprecated.
        This property is no longer used in the logic of this class

      • _cachedObjects

        protected java.util.Map _cachedObjects
        Deprecated.
        The cached objects approach has been replaced with the TransformContext object. Please obtain the required information from the context object.

      • _isIFrameRequest

        protected java.lang.Boolean _isIFrameRequest
        Deprecated.
        please use the isIFrameRequest() method instead.

      • _pivotImgHeight

        protected int _pivotImgHeight
        Since:
        MicroStrategy Web 8.0.0

      • _pivotImgWidth

        protected int _pivotImgWidth
        Since:
        MicroStrategy Web 8.0.0

      • _sortImgHeight

        protected int _sortImgHeight
        Since:
        MicroStrategy Web 8.0.0

      • _sortImgWidth

        protected int _sortImgWidth
        Since:
        MicroStrategy Web 8.0.0

      • RETAIN_THRESHOLDS_FORMAL_PARAMETER

        protected static final java.lang.String RETAIN_THRESHOLDS_FORMAL_PARAMETER
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values

      • RETAIN_PARENT_FORMAL_PARAMETER

        protected static final java.lang.String RETAIN_PARENT_FORMAL_PARAMETER
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values

      • NO

        protected static final java.lang.String NO
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values

      • YES

        protected static final java.lang.String YES
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values

      • DISPLAY_CELL_CLASS

        protected final java.lang.String DISPLAY_CELL_CLASS
        Since:
        MicroStrategy Web 7.5.2
        See Also:
        Constant Field Values

    • Constructor Detail

      • AbstractReportGridDisplayCell

        public AbstractReportGridDisplayCell()
        Constructor used for creating a generic display cell.

    • Method Detail

      • reset

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

      • getMaxColHeaderDepth

        public int getMaxColHeaderDepth()
        Since:
        MicroStrategy Web 8.0.1

      • initCell

        protected void initCell()
        Initialize the cell title information
        Since:
        MicroStrategy Web 8.0.1

      • clone

        public java.lang.Object clone()
        Utility method to clone this object.
        Overrides:
        clone in class java.lang.Object
        Returns:
        the cloned object

      • isContextMenusEnabled

        protected boolean isContextMenusEnabled()
        Since:
        MicroStrategy Web 8.0.1

      • generateOutput

        public void generateOutput​(MarkupOutput mo)

        This is the main entry point to generate the output of the cell.

        This method is the one used by the Transform to delegate execution. It is responsible for generating the complete HTML output for the cell.

        Developers can overwrite the generateOutput(com.microstrategy.web.beans.MarkupOutput) method to set any text they want to display for the cell.

        Specified by:
        generateOutput in interface ReportGridDisplayCell
        Parameters:
        mo - the output object

      • getCellAttributes

        protected void getCellAttributes​(java.util.Map attributes)
        Since:
        MicroStrategy Web 9.0.0

      • addTooltipAttributes

        protected void addTooltipAttributes​(java.util.Map attributes)

      • getViewBean

        public ViewBean getViewBean()
        Returns the view bean associated with this display cell
        Returns:
        the view bean
        Since:
        MicroStrategy Web 8.0.0

      • getBaseBean

        public WebComponent getBaseBean()
        Returns the base bean associated with this display cell. The base bean should be used to calculate features and other general functionality from the underlying WebComponent.
        Returns:
        the base bean
        Since:
        MicroStrategy Web 8.0.0

      • generateInnerHTML

        protected void generateInnerHTML​(MarkupOutput mo)

        This method generates the HTML that goes inside of the <TD> tag. It divides the output by calling three methods:

        1. generateContent: generates the core portion of the HTML, it include the cell's text and its corresponding HTML.
        2. generatePreContent: generates the HTML that goes before the content. This is used to generate the checkboxes for drilling.
        3. generatePostContent: generates the HTML that goes after the content. This is used to generate sorting and pivoting buttons.

        Developers can either use the setInnerHTML(java.lang.String) method to set any text they want for the inner HTML or override this method to inherit its functionality and build on top of it.

        The following is an example of the code that is executed by this method: 
         protected void generateInnerHTML(MarkupOutput mo) {
     generatePreContent(mo);
     generateContent(mo);
     generatePostContent(mo);
 }
        Parameters:
        mo - the output object

      • generatePreContent

        protected void generatePreContent​(MarkupOutput mo)

        Generates the preContent of the cell. The pre-Content means the html content before the core content of the cell. An example would be a checkbox before the text.
        By default, this method generates images for grids in outline mode, drilling checkboxes and filter on selection checkboxes.

        Developers can either use the setPreContent(java.lang.String) method to set any text they want to display before the contents of the cell or override this method to inherit its functionality and build on top of it.

        For example, the following code could be used to extend this method to add a <LI> tag before the cell content in any of the classes that extend AbstractReportGridDisplayCell:
         public void generatePreContent(MarkupOutput mo) {
     super.generatePreContent(mo);

     mo.append("<LI>");
 }
        Parameters:
        mo - the output object

      • generateContent

        protected void generateContent​(MarkupOutput mo)
        Generates the core HTML for this cell. By default, this method just calls the generateText to include the cell's text.

        Developers can either use the setContent(java.lang.String) method to set any text they want to display for the contents of the cell or override this method to inherit its functionality and build on top of it.

        The following is an example of the code that is executed by this method: 

         public void generateContent(MarkupOutput mo) {
     generateText(mo);
 }

        As an example, the following code could be used to extend this method to add a <BR> tag after content in any of the classes that extend AbstractReportGridDisplayCell:

         public void generateContent(MarkupOutput mo) {
     super.generateContent(mo);

     mo.append("<br>");
 }

        Parameters:
        mo - the output object

      • generateText

        protected void generateText​(MarkupOutput mo)

        Generates the text of the cell. This is the the text that gets displayed by the browser.

        Developers can either use the setText(java.lang.String) method to set any text they want to display for the cell or override this method to inherit its functionality and build on top of it.

        For example, the following code could be used to extend this method to render a hyphen if the cell content is empty:
         public void generateText(MarkupOutput mo) {
     String text = getText();

     if ("".equals(text) || "&nbsp;".equals(text)) {
         mo.append("-");
     } else {
         super.generateText(mo);
     }

 }
        Parameters:
        mo - the output object
        Since:
        MicroStrategy Web 8.0.0

      • generatePostContent

        protected void generatePostContent​(MarkupOutput mo)

        Generates the postContent of the cell. The post-Content means the html content after the core content of the cell. Usually this method generates sort and pivot buttons as well as subtotals for outline mode.

        Developers can either use the setPostContent(java.lang.String) method to set any text they want to display after the contents of the cell or override this method to inherit its functionality and build on top of it.

        For example, the following code could be used to extend this method to add a submit button after the cell content in any of the classes that extend AbstractReportGridDisplayCell:
         public void generatePostContent(MarkupOutput mo) {
     super.generatePostContent(mo);

     mo.append("<INPUT TYPE=\"SUBMIT\" NAME=\"Submit request\" />");
 }
        Parameters:
        mo - the output object

      • getContextMenu

        protected ContextMenu getContextMenu​(java.lang.String menuName)
        Returns the corresponding context-menu. If a valid ContextMenu has been provided, the transform will use it to populate the context-menu, otherwise it will return an empty ContextMenu instance.
        Parameters:
        menuName - Name of the context-menu
        Returns:
        ContextMenu instance related with the name requested. If not found, it will be an empty instance returned.
        Since:
        MicroStrategy Web 8.0.1

      • addContextMenuAttributes

        protected void addContextMenuAttributes​(java.util.Map atts)
        Adds into the Map instance the tag attributes required for processing context menus.
        Parameters:
        atts - Map where attributes will be appended.
        Since:
        MicroStrategy Web 8.1.0

      • addContextMenuAttributes

        protected void addContextMenuAttributes​(java.util.Map atts,
                                        java.lang.String menuName,
                                        int flag)
        Adds into the Map instance the tag attributes required for processing context menus.
        Parameters:
        atts - Map where attributes will be appended.
        menuName - The context-menu name, the name should correspond to a valid <shortcut-list> from the context-menus' xml definition, otherwise "default" is used.
        flag - The infoFlag attribute of the ContextMenu.addTagAttributes(java.util.Map<java.lang.String, java.lang.String>) method.
        Since:
        MicroStrategy Web 8.1.0

      • addToHeaderMetricValueJsonMap

        protected void addToHeaderMetricValueJsonMap​(java.lang.String key,
                                             java.lang.String value)

      • isHeaderMVJsonMovable

        protected boolean isHeaderMVJsonMovable()

      • getContextMenuAttributes

        protected java.util.Map getContextMenuAttributes​(java.lang.String menuName,
                                                 int flag)
        Deprecated.
        Use addContextMenuAttributes(Map atts)
        Returns a Map with the tag attributes that should be added to the cell's definition for processing context menus.

        Notice this method has been deprecated for performance reasons. If it's necessary to include extra attributes related to context-menus override the addContextMenuAttributes(Map atts) method. Although this method is still invoked under normal cell execution, it now returns null. If a subclass overrides this method and returns a Map instance, the members of the Map are appended to the cell's tag attributes.
        Since:
        MicroStrategy Web 8.0.1

      • getContextMenuAttributes

        protected java.util.Map getContextMenuAttributes()
        Deprecated.
        Use addContextMenuAttributes(Map atts)
        Returns a Map with the tag attributes that should be added to the cell's definition for processing context menus.
        Notice this method has been deprecated for performance reasons. If it's necessary to include extra attributes related to context-menus override the addContextMenuAttributes(Map atts) method. Although this method is still invoked under normal cell execution, it now returns null. If a subclass overrides this method and returns a Map instance, the members of the Map are appended to the cell's tag attributes.
        Since:
        MicroStrategy Web 8.0.1

      • getCellLevelAttributes

        protected void getCellLevelAttributes​(java.util.Map cell)
        Obtains the type of cell and the grid title index that it belongs to
        Parameters:
        cell -
        Since:
        MicroStrategy Web 9.0.0

      • appendContextMenuItems

        protected void appendContextMenuItems​(ContextMenu menu)
        Deprecated.
        Context menus should be added by modifying the xml definition associated through the AbstractAppTransform's contextMenus formal parameter.Please see the MSDL context menu scenarios for the new approach.
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        AbstractAppTransform.contextMenus

      • generateTooltipContent

        protected java.lang.String generateTooltipContent()
        Generates the string with the tooltip information to be assigned to the TITLE attribute of the cell tag for this instance
        Returns:
        String with the information about the tooltip to render for the current cell.
        Since:
        MicroStrategy Web 8.0.1

      • generateDrillCheckBox

        protected void generateDrillCheckBox​(MarkupOutput mo)
        Generate the drill check box HTML information for this cell.
        Parameters:
        mo - the output object

      • generateAnchor

        protected AnchorTag generateAnchor​(WebEvent event)
        Creates an <a> tag from the EventManager with the Iframe information required if supported.
        Parameters:
        event - the WebEvent to generate the link with the request
        Returns:
        AnchorTag instance initialized with the information from the event
        Since:
        MicroStrategy Web 8.0.1

      • generateFilterOnSelectionCheckBox

        protected void generateFilterOnSelectionCheckBox​(MarkupOutput mo)
        Generate the filter on selections check box HTML information
        Parameters:
        mo - the output object

      • generateOutlineModeImage

        protected void generateOutlineModeImage​(MarkupOutput mo)
        Generate the javascript images for collapse and expand for outline mode.
        Parameters:
        mo - the output object

      • generateOutlineSubTotalName

        protected void generateOutlineSubTotalName​(MarkupOutput mo)
        Generate the name of the subtotal type next to the header element for outline mode.
        Parameters:
        mo - the output object

      • generateSortButton

        protected Tag generateSortButton()
        Generate the sort button tag information for this object
        Returns:
        Tag instance initialized if sort is supported.
        Since:
        MicroStrategy Web 8.0.1

      • generatePivotButtons

        protected void generatePivotButtons​(MarkupOutput mo)
        Generate pivot buttons.
        Parameters:
        mo - the output object

      • generatePivotButton

        protected abstract Tag generatePivotButton​(int type)

      • renderPivotButtons

        protected void renderPivotButtons​(MarkupOutput mo)

      • buildGenericTooltipInformation

        protected java.lang.String buildGenericTooltipInformation()
        Generate generic tooltip information for the current cell being rendered. Might include description, drill and generic hints as enabled and available.
        Returns:
        String value with the tooltip information that can be added to the cell HTML output.
        Since:
        MicroStrategy Web 8.0.1

      • isMetric

        public boolean isMetric()
        Indicates if the underlying object of a cell is a metric header.
        Returns:
        whether the cell is containing a metric

      • hasMetricFilterCondition

        protected boolean hasMetricFilterCondition()
        Since:
        MicroStrategy Web 9.0.0

      • generateDragAndDropAttributes

        protected java.util.Map generateDragAndDropAttributes()
        Deprecated.
        Use addDragAndDropAttributes(Map atts)
        Returns a Map with the tag attributes that should be added to the cell's definition to enable drag and drop operations.
        Notice this method has been deprecated for performance reasons. If it's necessary to include extra attributes related to context-menus override the addDragAndDropAttributes(Map atts) method. Although this method is still invoked under normal cell execution, it now returns null. If a subclass overrides this method and returns a Map instance, the members of the Map are appended to the cell's tag attributes.
        Since:
        MicroStrategy Web 8.0.1

      • addDragAndDropAttributes

        protected void addDragAndDropAttributes​(java.util.Map atts)
        Adds into the Map instance the tag attributes required to enable drag and drop operations.
        Parameters:
        atts - Map where attributes will be appended.
        Since:
        MicroStrategy Web 8.1.0

      • generateDragAndDrop

        protected void generateDragAndDrop​(MarkupOutput mo)
        Generate drag and drop properties used in javascript.
        Parameters:
        mo - the output object

      • initDragAndDrop

        protected void initDragAndDrop​(DragAndDropItem item)
        This method initializes properties used in javascript for drag and drop.
        Parameters:
        item - DragAndDropItem

      • initDNDForDesignMode

        protected void initDNDForDesignMode​(DragAndDropItem item)
        This method initializes properties used in javascript for drag and drop in design mode.
        Parameters:
        item - DragAndDropItem

      • initDNDForExecuteMode

        protected void initDNDForExecuteMode​(DragAndDropItem item)
        This method initializes properties used in javascript for drag and drop in view mode.
        Parameters:
        item - DragAndDropItem

      • getDescriptor

        protected java.lang.String getDescriptor​(int key)
        Get descriptor for this key
        Parameters:
        key - input key as an int
        Returns:
        descriptor as a String
        Since:
        MicroStrategy Web 8.0.0

      • hasWebObject

        protected abstract boolean hasWebObject()
        This method allows the abstract class to identify whether the cell has been initialized with a valid WebObject. Some cells are created empty (with no underlying web object), they usually represent empty cells (like the ones used in design mode for metric values or row headers); in these cases some functionality needs to be disabled (liek context-menus or dnd), this method allow us to identify these cells.
        Returns:
        true if the cell has underlying WebObject.
        Since:
        MicroStrategy Web 8.0.0

      • isOutlineModeEnabled

        protected boolean isOutlineModeEnabled()
        Indicates whether outline more is enabled for this transform
        Returns:
        true if outline mode is enabled

      • showSubtitle

        protected boolean showSubtitle()
        Indicates whether to display sub titles (attribute forms).
        Returns:
        true if the transform is displaying sub title

      • isDesignMode

        protected boolean isDesignMode()
        Indicates if the Transform is rendering data in design mode
        Returns:
        true if in design mode.

      • isAccessibilityMode

        protected boolean isAccessibilityMode()
        Indicates if the Transform is rendering data in accessibility (508) mode
        Returns:
        true if in 508 mode.
        Since:
        MicroStrategy Web 8.0.0

      • isDhtml

        protected boolean isDhtml()
        Indicates if DHTML (javascript) is enabled
        Returns:
        true if using DHTML.
        Since:
        MicroStrategy Web 7.5.4

      • isFeatureAvailable

        protected boolean isFeatureAvailable​(java.lang.String name)
        Checks if the given feature is available. It calls getBaseBean().isFeatureAvailable(name).
        Parameters:
        name - Feature name
        Returns:
        false if the feature should be disabled.
        Since:
        MicroStrategy Web 7.5.4

      • isRW

        public boolean isRW()
        Indicates if the cell is being rendered in the context of report writing (documents).
        Specified by:
        isRW in interface ReportGridDisplayCell
        Returns:
        true if parent of the base bean is a RWBean
        Since:
        MicroStrategy Web 8.0.0

      • getImgName

        protected java.lang.String getImgName​(java.lang.String fpName)
        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)
        Returns tha value of a formal parameter which has a string value
        Parameters:
        fpName - formal parameter name
        Returns:
        formal parameter value

      • getFPIntValue

        protected int getFPIntValue​(java.lang.String fpName)
        Returns tha value of a formal parameter which has an integer value
        Parameters:
        fpName - formal parameter name
        Returns:
        formal parameter value

      • isFPTrue

        protected boolean isFPTrue​(java.lang.String fpName,
                           boolean defValue)
        Returns tha value of a formal parameter which has a boolean value.
        Parameters:
        fpName - formal parameter name
        defValue - value to use if the formal parameter doesn't exist or if its value is null.
        Returns:
        formal parameter value

      • isFPTrue

        protected boolean isFPTrue​(java.lang.String fpName)
        Returns tha value of a formal parameter which has a boolean value.
        Parameters:
        fpName - formal parameter name
        Returns:
        formal parameter value

      • setStyleForNonBuiltInFormat

        protected void setStyleForNonBuiltInFormat​(java.lang.String style,
                                           int rowOrdinal)
        set the style for the cell when not using the built in report formatting
        Parameters:
        style - style name
        rowOrdinal - row ordial

      • getStyleForNonBuiltInFormat

        protected java.lang.String getStyleForNonBuiltInFormat​(java.lang.String style,
                                                       int rowOrdinal)

      • getDrillParametersForDHTML

        protected java.lang.String getDrillParametersForDHTML​(WebDrillPath dp,
                                                      WebTitle title)
        Returns parameters required for drilling when using javascript for WebTitle cells.
        Parameters:
        dp - the drill path
        title - the WebTitle object
        Returns:
        the url string
        Since:
        MicroStrategy Web 8.0.0

      • getDrillPathWithHighImportance

        public WebDrillPath getDrillPathWithHighImportance()
        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

      • generateDrillCheckBoxTag

        protected Tag generateDrillCheckBoxTag()
        Generates the tag information for a check box for drilling, if all privileges and conditions required are met
        Returns:
        Tag instance initialized with the information of a check box for requesting drill manipulations. If not enabled or available, returns null
        Since:
        MicroStrategy Web 8.0.1

      • generateFilterOnSelectionCheckBoxTag

        protected Tag generateFilterOnSelectionCheckBoxTag()
        Generates the tag information for a check box for filter on selection, if all privileges and conditions required are met
        Returns:
        Tag instance initialized with the information of a check box for requesting a filter on selection manipulations. If not enabled or available, returns null
        Since:
        MicroStrategy Web 8.0.1

      • hasDrillPathsWithHighImportanceAvailable

        protected boolean hasDrillPathsWithHighImportanceAvailable​(WebDrillMap wdm)
        Helper method to determine if there are drill paths with high importance available for the current cell being rendered
        Parameters:
        wdm - WebDrillMap instance associated with the cell being rendered
        Returns:
        boolean value indicating if there are drill paths with high importance available
        Since:
        MicroStrategy Web 8.0.1

      • cellNeedsLink

        protected boolean cellNeedsLink()
        Utility method for determining if the current cell being displayed needs to be a link or not, for example, in case of drilling available.
        Returns:
        boolean value indicating if the current cell should be displayed as a link.
        Since:
        MicroStrategy Web 8.0.1

      • getSortStatus

        protected boolean getSortStatus​(java.lang.String sSortID,
                                java.lang.String[][] appliedSorts)
        get the sort status
        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)
        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()
        return whether there is any item added to the context menu
        Returns:
        whether there is any item added to the context menu

      • setExtraUrl

        public void setExtraUrl​(java.lang.String value)
        set extra url for the cell
        Parameters:
        value - extra url for the cell

      • getExtraUrl

        public java.lang.String getExtraUrl()
        get extra url for the cell
        Returns:
        extra url for the cell

      • isIframeEnabled

        protected boolean isIframeEnabled()
        whether ifram is enabled
        Returns:
        whether ifram is enabled

      • isMetricDrillable

        protected boolean isMetricDrillable​(WebHeader header,
                                    WebDrillPath drillPath)
        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

      • showRemoveFromReport

        protected boolean showRemoveFromReport()
        Determine whether to show the 'Remove from Report' option according to the objects already defined on the template.
        Returns:
        true if should display the 'Remove from Report' option.
        Since:
        MicroStrategy Web 8.0.0

      • showRemoveFromReport

        protected boolean showRemoveFromReport​(int metricSize,
                                       int wkSetSize)
        Determine if we should show the 'Remove from Report' option depending on the number of metrics and the working set size
        Parameters:
        metricSize - number of metrics
        wkSetSize - working set size
        Returns:
        true if working set is not empty or if the working set size is greater than the metrics size.
        Since:
        MicroStrategy Web 8.0.0

      • encodeMV

        protected boolean encodeMV()
        Deprecated.
        This method is only required at the metric value cell, please use ReportGridCellMetricValueImpl.encodeMetricValue().
        Whether to HTML-encode metric values (based on the preference value)
        Returns:
        Whether to HTML-encode metric values.

      • isIframeRequest

        protected boolean isIframeRequest()
        whether it's an iframe request
        Returns:
        whether it's an iframe request

      • getNearestNonMetricRowHeader

        protected WebHeader getNearestNonMetricRowHeader​(WebRowValue rowValue)

      • getRowValueDrillElements

        protected java.lang.String getRowValueDrillElements​(WebRowValue rowValue)

      • newNamespaceEncoder

        protected NamespaceEncoder newNamespaceEncoder()
        Convenience method to retrieve a new Namespace Encoder object from the stored AppContext.
        Returns:
        A new instance of a NamespaceEncoder object that encode names.
        Since:
        MicroStrategy Web 8.0.0

      • setArgumentFromFormalParameter

        protected void setArgumentFromFormalParameter​(WebEvent event,
                                              int argumentID,
                                              java.lang.String paramName)
        Since:
        MicroStrategy Web 8.0.0

      • getFilterOnEvent

        protected WebEvent getFilterOnEvent​(WebObjectInfo targetObject,
                                    java.lang.String alias)
        Since:
        MicroStrategy Web 8.0.1

      • getRenameEvent

        protected WebEvent getRenameEvent​(int key)
        Get the event for renaming the current cell
        Returns:
        WebEvent instance initialized with the information for renaming the current cell.
        Since:
        MicroStrategy Web 8.0.1

      • getDerivedElementsEvent

        protected WebEvent getDerivedElementsEvent​(int key)
        Since:
        MicroStrategy Web 9.0.0

      • getDrillEvent

        public WebEvent getDrillEvent​(WebDrillPath dp,
                              java.lang.String elementId,
                              WebTitle title)
        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.
        elementId - The key for the element to drill to
        title - The WebTitle to drill from.
        Since:
        MicroStrategy Web 8.0.0

      • getDrillKey

        public java.lang.String getDrillKey​(WebDrillPath dp,
                                    WebTitle title)
        Deprecated.
        9.0.1 use getDrillpathKeyInOldFormat
        Since:
        MicroStrategy Web 8.0.0

      • getDrillpathKey

        public static java.lang.String getDrillpathKey​(WebDrillPath dp,
                                               WebTitle title)
        Deprecated.
        9.0.1 use getDrillpathKeyInOldFormat
        Since:
        MicroStrategy Web 9.0.0

      • getDrillpathKeyInOldFormat

        public static java.lang.String getDrillpathKeyInOldFormat​(WebDrillPath dp,
                                                          WebTitle title)

      • getSortID

        protected abstract java.lang.String getSortID()
        This method return the ID to use for sorting this cell.
        Returns:
        The ID to use for sorting this cell.
        Since:
        MicroStrategy Web 8.0.0

      • getSortEvent

        protected WebEvent getSortEvent()
        Deprecated.
        Please use getSortEvent(int axis EnumViewBeanEvents)
        Since:
        MicroStrategy Web 8.0.0

      • getSortEventByAxis

        protected WebEvent getSortEventByAxis​(int axis)
        Parameters:
        axis - specifies the axis EnumViewBeanEvents on which the sort is defined
        Since:
        MicroStrategy Web 8.0.2

      • getSortAscendingEvent

        protected WebEvent getSortAscendingEvent()
        Since:
        MicroStrategy Web 8.0.0

      • getSortEventByAxisBySortOrder

        protected WebEvent getSortEventByAxisBySortOrder​(int axis,
                                                 int sortOrder)
        Since:
        MicroStrategy Web 8.0.2

      • getSortDescendingEvent

        protected WebEvent getSortDescendingEvent()
        Since:
        MicroStrategy Web 8.0.0

      • getGridCell

        protected ReportGridDisplayCell getGridCell​(java.lang.String className)
        Creates a new instance of a ReportGridDisplayCell
        Parameters:
        className - a fully qualified class name.
        Returns:
        a new instance of a ReportGridDisplayCell
        Since:
        MicroStrategy Web 7.5.2

      • getReportGridTransform

        protected ReportGridTransformImpl getReportGridTransform()
        Utility method for returning the ReportGridTransformImpl instance associated with the context of this object
        Returns:
        ReportGridTransformImpl instance as defined on the context object of this instance. If not available, it will return null
        Since:
        MicroStrategy Web 8.0.1

      • canRemoveFromGrid

        public boolean canRemoveFromGrid()
        Utility methood for determining if the cell object is enabled for displaying the user the option to remove it from the grid.
        Specified by:
        canRemoveFromGrid in interface ReportGridDisplayCell
        Returns:
        boolean value indicating if the manipulation should be enabled
        Since:
        MicroStrategy Web 8.0.1

      • canRemoveFromReport

        public boolean canRemoveFromReport()
        Utility methood for determining if the cell object is enabled for displaying the user the option to remove it from the report
        Specified by:
        canRemoveFromReport in interface ReportGridDisplayCell
        Returns:
        boolean value indicating if the manipulation should be enabled
        Since:
        MicroStrategy Web 8.0.1

      • canRename

        public boolean canRename()
        Utility methood for determining if the cell object is enabled for displaying the user the option to rename it
        Specified by:
        canRename in interface ReportGridDisplayCell
        Returns:
        boolean value indicating if the manipulation should be enabled
        Since:
        MicroStrategy Web 8.0.1

      • canFilterOn

        public boolean canFilterOn()
        Utility methood for determining if the cell object is enabled for displaying the user the option to filter on it
        Specified by:
        canFilterOn in interface ReportGridDisplayCell
        Returns:
        boolean value indicating if the manipulation should be enabled
        Since:
        MicroStrategy Web 8.0.1

      • canFormat

        public boolean canFormat()
        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()
        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()
        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()
        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()
        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

      • canInsertShortcutMetric

        public boolean canInsertShortcutMetric()
        Utility methood for determining if the cell object is enabled for displaying the user the option to insert shortcut metrics based on it
        Specified by:
        canInsertShortcutMetric in interface ReportGridDisplayCell
        Returns:
        boolean value indicating if the manipulation should be enabled
        Since:
        MicroStrategy Web 8.0.1

      • canEditControl

        public boolean canEditControl()
        Description copied from interface: ReportGridDisplayCell
        Utility methood for determining if the cell object is enabled for displaying the user the option to edit control
        Specified by:
        canEditControl in interface ReportGridDisplayCell
        Returns:
        boolean value indicating if the manipulation should be enabled
        Since:
        MicroStrategy Web 8.1.0

      • canPivot

        public boolean canPivot()
        Utility methood for determining if the cell object is enabled for displaying the user the option to pivot it
        Specified by:
        canPivot in interface ReportGridDisplayCell
        Returns:
        boolean value indicating if the manipulation should be enabled
        Since:
        MicroStrategy Web 8.0.1

      • canModifyAttributeForm

        public boolean canModifyAttributeForm()
        Utility methood for determining if the cell object is enabled for displaying the user the option to modify the attribute forms on it
        Specified by:
        canModifyAttributeForm in interface ReportGridDisplayCell
        Returns:
        boolean value indicating if the manipulation should be enabled
        Since:
        MicroStrategy Web 8.0.1

      • canMetricFilterOn

        public boolean canMetricFilterOn()
        Utility method for determining if the cell object is enabled for displaying the user the option to apply a metric filter on it
        Specified by:
        canMetricFilterOn in interface ReportGridDisplayCell
        Returns:
        boolean value indicating if the manipulation should be enabled
        Since:
        MicroStrategy Web 9.0.0

      • canUse

        protected boolean canUse​(WebMetric m)
        Since:
        MicroStrategy Web 9.0.0

      • isDerivedMetric

        protected boolean isDerivedMetric​(WebMetric m)
        Since:
        MicroStrategy Web 9.0.0

      • canEditMetricFilter

        public boolean canEditMetricFilter()
        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

      • canAddThresholds

        public boolean canAddThresholds()
        Utility methood for determining if the cell object is enabled for displaying the user the option to add threshold to it
        Specified by:
        canAddThresholds in interface ReportGridDisplayCell
        Returns:
        boolean value indicating if the manipulation should be enabled
        Since:
        MicroStrategy Web 9.0.0

      • newContext

        protected TransformContext newContext​(TransformContext transformContext)
        Creates a new instance of a TransformContext. It's used by the getContext method the first time is invoked. Transforms who require to include extra information in the context should create their own TransformContext implementation (possibly a subclass of AppTransformContext) and returns a new instance in this method.
        Since:
        MicroStrategy Web 8.0.1

      • getStyle

        public java.lang.String getStyle()
        Returns the css class name associated with the cell as registered by the Transform.
        If set, this is the one assigned to the CLASS attribute of the TD tag to control its formatting.
        Specified by:
        getStyle in interface ReportGridDisplayCell
        Returns:
        The css class name as registered by the Transform.

      • setStyle

        public void setStyle​(java.lang.String style)
        Registers the css style name associated with the cell.
        This text will be assigned as the CLASS attribute of the TD tag to control the format of the cells that share the same CLASS.
        Specified by:
        setStyle in interface ReportGridDisplayCell
        Parameters:
        style - The css class name

      • setSubTitle

        public void setSubTitle​(WebSubTitle subtitle)
        Registers the underlying SDK object associated with this cell. If the report is in execute mode and attribute forms are displayed, the Transform calls this method to associate a WebSubTitle with the cell.
        Parameters:
        subtitle - The corresponding WebSubTitle to associate with the cell.

      • getSubTitle

        public WebSubTitle getSubTitle()
        Returns the underlying SDK object associated with this cell. If the report is in execute mode and attribute forms are displayed, it returns the corresponding WebSubTitle; when in design mode, this returns null.
        It always returns null if the instance represents an empty cell.
        Returns:
        The underlying SDK object.

      • setSubTitleIndex

        public void setSubTitleIndex​(int subtitleIndex)
        Registers the position of the underlying WebSubTitle within the subtitles collection.
        Parameters:
        subtitleIndex - the position of the corresponding WebSubTitle

      • getSubtitleIndex

        public int getSubtitleIndex()
        If attribute forms are displayed, returns the position of the WebSubTitle within the subtitles collection.
        Returns:
        The WebSubTitle position

      • addToStyle

        public void addToStyle​(java.lang.String value)
        Adds values to the STYLE attribute of the TD tag. The style assigned this way will only apply to this cell. Information added through this method is appended to other information currently assigned to this attribute.
        Parameters:
        value - The text to add
        Since:
        MicroStrategy Web 8.1.0

      • setExtraStyle

        public void setExtraStyle​(java.lang.String extraStyle)
        Registers any extra information required for the formatting of the cell.
        This text is assigned to the STYLE attribute of the TD tag. The style assigned this way will only apply to this cell. Notice this method actually replaces the value of the style attribute with the provided parameter. If you actually require to add more information to the style attribute, you should use the addToStyle(java.lang.String) method instead.
        Specified by:
        setExtraStyle in interface ReportGridDisplayCell
        Parameters:
        extraStyle - The text to use

      • setExtraStyle

        public void setExtraStyle​(java.lang.String extraStyle,
                          boolean append)
        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()
        Returns the extra style information required for the formatting of the cell as registered by the Transform. This text is assigned to the STYLE attribute of the TD tag.
        Specified by:
        getExtraStyle in interface ReportGridDisplayCell
        Returns:
        The extra style info as registered by the Transform.

      • addExtraAttribute

        public void addExtraAttribute​(java.lang.String attributeName,
                              java.lang.String attributeValue)
        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

      • setExtraInfo

        public void setExtraInfo​(java.lang.String extraInfo)
        Registers any extra information that should be appended as part of the TD's open tag. This can be used, for example, to include extra attributes into the cell.
        Specified by:
        setExtraInfo in interface ReportGridDisplayCell
        Parameters:
        extraInfo - the text to be appended as part of the open tag.

      • getExtraInfo

        public java.lang.String getExtraInfo()
        Returns the text assigned by the Transform as extra information of the cell. This text is appended to the TD's open tag.
        Specified by:
        getExtraInfo in interface ReportGridDisplayCell
        Returns:
        The extra info for this cell

      • getText

        public java.lang.String getText()

        Returns the text content of this cell. This represents the actual text displayed by the web browser.

        Specified by:
        getText in interface ReportGridDisplayCell
        Returns:
        Text for the cell

      • setText

        public void setText​(java.lang.String text)

        Registers the text content of this cell. When a non-null text is registered, this text is used as the core content of the cell.

        Specified by:
        setText in interface ReportGridDisplayCell
        Parameters:
        text - text for this cell

      • setCellColor

        protected void setCellColor​(java.lang.String value)

      • getCellColor

        protected java.lang.String getCellColor()

      • getDescription

        protected java.lang.String getDescription()
        Returns the text registered as the description of the underlying web object associated with this cell.
        Returns:
        description for the cell.

      • setDescription

        protected void setDescription​(java.lang.String description)

        Registers the description of the underlying web object associated with this cell. Based on a formal parameter, this text might be used as the tooltip of the cell.

        Parameters:
        description - description for this cell.

      • setDrillPath

        public void setDrillPath​(java.lang.String drillPath)
        Sets the drillPath for this cell. This is used to generate the drill link of the cell.
        Parameters:
        drillPath - String

      • getDrillPath

        protected java.lang.String getDrillPath()
        Returns the drillPath associated with this cell.
        Returns:
        String drill path registered fro this cell.

      • getCellID

        public java.lang.String getCellID()
        Returns the id for this cell, this will be used as the ID attribute of TD tag.
        Specified by:
        getCellID in interface ReportGridDisplayCell
        Returns:
        the id for this cell

      • setCellID

        public void setCellID​(java.lang.String cellID)
        Registers the id for this cell, this is used as the ID attribute of TD tag.
        Specified by:
        setCellID in interface ReportGridDisplayCell
        Parameters:
        cellID - The cell's ID

      • getWidth

        public java.lang.String getWidth()
        Returns the width for this cell as registered by the Transform, this is used as the WIDTH attribute of TD tag.
        Specified by:
        getWidth in interface ReportGridDisplayCell
        Returns:
        The cell's width

      • setWidth

        public void setWidth​(java.lang.String width)
        Registers the width for this cell, this is used as WIDTH attribute of TD tag.
        Specified by:
        setWidth in interface ReportGridDisplayCell
        Parameters:
        width - text for this cell

      • getTooltip

        public java.lang.String getTooltip()
        Returns the tooltip text for this cell as registered by the Transform. This is the text displayed by the browser when the cursor goes over the cell.
        Specified by:
        getTooltip in interface ReportGridDisplayCell
        Returns:
        The cell's Tooltip text.

      • setTooltip

        public void setTooltip​(java.lang.String tooltip)
        Registers the text for the tooltop of this cell. This is used as the TITLE attribute of TD tag.
        Specified by:
        setTooltip in interface ReportGridDisplayCell
        Parameters:
        tooltip - the tooltip to display when the cursor goes over the cell

      • getContextMenu

        protected ContextMenu getContextMenu()
        Returns the context menu instance for this cell. The cell should add menu items to this ContextMenu, this will be displayed to the end user when the it clicks over a cell with the mouse's right button.
        Returns:
        The ContextMenu for this cell.
        Since:
        MicroStrategy Web 8.0.0

      • getRowSpan

        public int getRowSpan()
        Returns the row span for this cell as registered by the Transform, this is used as the ROWSPAN attribute of TD tag.
        Specified by:
        getRowSpan in interface ReportGridDisplayCell
        Returns:
        The cell's row span

      • setRowSpan

        public void setRowSpan​(int rowSpan)
        Registers the row span for this cell, this is used as the ROWSPAN attribute of TD tag.
        Specified by:
        setRowSpan in interface ReportGridDisplayCell
        Parameters:
        rowSpan - row span

      • getColSpan

        public int getColSpan()
        Returns the column span for this cell as registered by the Transform. This is used as the COLSPAN attribute of TD tag.
        Specified by:
        getColSpan in interface ReportGridDisplayCell
        Returns:
        The cell's col span

      • setColSpan

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

      • setHTML

        public void setHTML​(java.lang.String html)
        Registers the HTML for this cell. When a non-null html is registered, the whole output of the cell is replaced with this text by the generateOutput method.
        Specified by:
        setHTML in interface ReportGridDisplayCell
        Parameters:
        html - The complete HTML string for this cell

      • setContent

        public void setContent​(java.lang.String content)
        Registers the main content of the cell. When a non-null content is registered, the content of the cell is replaced by this text and the cell does not call the generateContent method.

        Specified by:
        setContent in interface ReportGridDisplayCell
        Parameters:
        content - content for this cell.
        See Also:
        ReportGridDisplayCell.setInnerHTML(java.lang.String)

      • setPreContent

        public void setPreContent​(java.lang.String preContent)
        Registers the pre-content of the cell. When a non-null content is registered, the pre-content of the cell is replaced by this text and the cell does not call the generatePreContent method.

        Specified by:
        setPreContent in interface ReportGridDisplayCell
        Parameters:
        preContent - pre-content for this cell
        See Also:
        ReportGridDisplayCell.setInnerHTML(java.lang.String)

      • setPostContent

        public void setPostContent​(java.lang.String postContent)
        Registers the post-content of the cell. When a non-null content is registered, the post-content of the cell is replaced by this text and the cell does not call the generatePostContent method.

        Specified by:
        setPostContent in interface ReportGridDisplayCell
        Parameters:
        postContent - post-content for this cell
        See Also:
        ReportGridDisplayCell.setInnerHTML(java.lang.String)

      • setContextMenu

        public void setContextMenu​(java.lang.String contextMenu)
        Deprecated.
        use the context menu infrastructure for defining this information, or the addExtraAttribute(java.lang.String, java.lang.String) method for adding tag attributes.
        Registers the text used to enabled context menus for this cell. This text is appended to the TD's open tag.
        Specified by:
        setContextMenu in interface ReportGridDisplayCell
        Parameters:
        contextMenu - The trigger for the context-menu of this cell

      • setAccessibilityInfo

        public void setAccessibilityInfo​(java.lang.String accessibilityInfo)
        Deprecated.
        please use addExtraAttribute(java.lang.String, java.lang.String) instead, for example, addExtraAttribute("scope", "row");
        Registers any extra information that should be appended as part of the TD's open tag only when the cell will be rendered in Accessibility Mode (508). This can be used, for example, to include extra attributes used by screen-reader browsers.
        Specified by:
        setAccessibilityInfo in interface ReportGridDisplayCell
        Parameters:
        accessibilityInfo - the text to be appended as part of the open tag.

      • 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");
        Returns any extra information registered by the Transform to be appended as part of the TD's open tag only when the cell will be rendered in Accessibility Mode (508).
        Specified by:
        getAccessibilityInfo in interface ReportGridDisplayCell
        Returns:
        The extra accessibility info for this cell

      • generateTooltip

        protected void generateTooltip​(MarkupOutput mo)
        Deprecated.
        use generateTooltipContent() instead
        Generate the tooltip HTML attribute information for this cell.
        Parameters:
        mo - the output object

      • generateHeaderDrillContextMenu

        protected void generateHeaderDrillContextMenu​(WebHeader header,
                                              java.lang.StringBuffer sHeaderURL,
                                              ContextMenu rhMenu)
        Deprecated.
        please use the new approach for generating context menu options. See ReportCellDrill
        Generate the drilling context menus for cells that use WebHeader as their underlying SDK object.
        Parameters:
        header - the WebHeader object
        sHeaderURL - the header's url
        rhMenu - the context menu object
        Since:
        MicroStrategy Web 8.0.0

      • generateRowValueDrillContextMenu

        protected void generateRowValueDrillContextMenu​(WebRowValue rowValue,
                                                java.lang.StringBuffer sHeaderURL,
                                                ContextMenu rhMenu)
        Deprecated.
        please use the new approach for generating context menu options. See ReportCellDrill
        Generate the drilling context menus for cells that use WebRowValue as their underlying SDK object.
        Parameters:
        rowValue - the WebRowValue object
        sHeaderURL - the header's url
        rhMenu - the context menu object
        Since:
        MicroStrategy Web 8.0.0

      • generateTitleDrillContextMenu

        protected void generateTitleDrillContextMenu​(WebTitle title,
                                             java.lang.StringBuffer sTitleURL,
                                             ContextMenu rhMenu)
        Deprecated.
        please use the new approach for generating context menu options. See ReportCellDrill
        Generate the drilling context menus for cells that use WebTitle as their underlying SDK object.
        Parameters:
        title - the WebTitle object
        sTitleURL - the title's url
        rhMenu - the context menu object
        Since:
        MicroStrategy Web 8.0.0

      • generateDrillContextMenu

        protected void generateDrillContextMenu​(WebHeader header,
                                        WebTitle title,
                                        WebRowValue rowValue,
                                        java.lang.StringBuffer sHeaderURL,
                                        ContextMenu rhMenu)
        Deprecated.
        please use the new approach for generating context menu options. See ReportCellDrill
        Since:
        MicroStrategy Web 8.0.0

      • generateSortContextMenu

        protected void generateSortContextMenu​(ContextMenu rhMenu)
        Deprecated.
        please use the new approach for generating context menu options. See ReportCellSort
        Since:
        MicroStrategy Web 8.0.0

      • generateContextMenu

        protected void generateContextMenu​(MarkupOutput out)
        Deprecated.
        please use getContextMenu(java.lang.String) instead
        Generate the context menu for this cell.
        Parameters:
        out - the output object

      • isRemoveAvailable

        protected boolean isRemoveAvailable()
        Deprecated.
        please use canRemoveFromGrid() or canRemoveFromReport()
        Validate if the remove option should be made available to the user or not
        Returns:
        boolean value indicating if remove should be available or not.
        Since:
        MicroStrategy Web 8.0.0

      • getShowDescriptionAsTooltip

        protected int getShowDescriptionAsTooltip​(java.lang.String fpName)
        Deprecated.
        Please check the showDescriptionAsTooltip formal parameter value instead.
        get formal parameter value as an int value
        Parameters:
        fpName - formal parameter name
        Returns:
        formal parameter value

      • convertNonbreakingSpaceOnMV

        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.

      • decodeEuro

        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

      • showAdvancedDrillingOptionsInContextMenu

        protected boolean showAdvancedDrillingOptionsInContextMenu()
        Deprecated.
        Please check the advancedDrillingContextMenuDisplay formal parameter value instead.
        whether to show the set names submenu at the root level in the Drilling RMC or one level lower.
        Returns:
        whether to show the set names submenu at the root level in the Drilling RMC or one level lower.
        Since:
        MicroStrategy Web 8.0.0

      • groupContextMenuDrillPathsByType

        protected boolean groupContextMenuDrillPathsByType()
        Deprecated.
        Please check the groupContextMenuDrillPathsByType formal parameter value instead.
        whether to group the drill paths by types in the Drilling RMC.
        Returns:
        whether to group the drill paths by types in the Drilling RMC.
        Since:
        MicroStrategy Web 8.0.0

      • sortSetNamesAndDrillPaths

        protected boolean sortSetNamesAndDrillPaths()
        Deprecated.
        Please check the sortSetNamesAndDrillPaths formal parameter value instead.
        whether to sort the set names and drill paths in the drilling context menu.
        Returns:
        whether to sort the set names and drill paths in the drilling context menu.
        Since:
        MicroStrategy Web 8.0.0

      • showRenameRMC

        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)

      • showRemoveRMC

        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)

      • showPivotRMC

        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)

      • showFormattingRMC

        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)

      • showExtraRemoveRMC

        protected boolean showExtraRemoveRMC()
        Deprecated.
        Please check the showExtraRemoveRMC formal parameter value instead.
        whether display the extra remove RMC (right mouse click context menu)
        Returns:
        display the extra remove RMC (right mouse click context menu)
        Since:
        MicroStrategy Web 8.0.0

      • showDrillPathSetNamesSubMenuAtTopLevel

        protected boolean showDrillPathSetNamesSubMenuAtTopLevel()
        Deprecated.
        Please check the showDrillPathSetNamesSubMenuAtTopLevel formal parameter value instead.
        whether to show the set names submenu at the root level in the Drilling RMC or one level lower.
        Returns:
        whether to show the set names submenu at the root level in the Drilling RMC or one level lower.
        Since:
        MicroStrategy Web 8.0.0

      • getReportDesignMode

        public int getReportDesignMode()
        Deprecated.
        Please check the reportDesignMode formal parameter value instead.
        Returns the mode from EnumReportDesignMode
        Returns:
        cell type - EnumReportGridDisplayCellTypes.EnumReportGridDisplayCellTypeGeneric. The cell type is read-only.

      • getPreTextForNonMetricValue

        protected java.lang.String getPreTextForNonMetricValue()
        Deprecated.
        Please check the preTextForNonMetricValue formal parameter value instead.
        Returns the text to use before displaying the content of a non-metric value cell
        Returns:
        the text before displaying the non-metric value itself

      • getPostTextForNonMetricValue

        protected java.lang.String getPostTextForNonMetricValue()
        Deprecated.
        Please check the postTextForNonMetricValue formal parameter value instead.
        Returns the text to use after displaying the content of a non-metric value cell
        Returns:
        the text after displaying the non-metric value itself

      • getCssPrefix

        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

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

      • getPostTextForMetricValue

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

      • showBanding

        protected boolean showBanding()
        Deprecated.
        Please check the showBanding formal parameter value instead.
        s * Indicates whether to display banding for the report
        Returns:
        true if banding need to be displayed

      • showDrillRMC

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

      • showDrillRMCMetric

        protected boolean showDrillRMCMetric()
        Deprecated.
        Please check the showDrillRMCMetric formal parameter value instead.
        Indicates whether to display drill right mouse click context menu for metrics
        Returns:
        whether display drill RMC (right mouse click context menu) for metric

      • showDrillHyperlink

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

      • showDrillHyperlinkMetric

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

      • showDrillAdvanced

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

      • showDrillDownOnly

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

      • showDrillMetric

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

      • showDrillCheckBox

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

      • showFilterOnSelectionCheckBox

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

      • showSortButtonsForAttributes

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

      • showSortRMCForAttributes

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

      • showSortButtonsForMetrics

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

      • showSortRMCForMetrics

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

      • getMaxSortAllowed

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

      • isDragAndDropEnabled

        protected boolean isDragAndDropEnabled()
        Deprecated.
        Please check the isDragAndDropEnabled formal parameter value instead.
        Indicates whether to drag and drop feature is enabled
        Returns:
        true if drag and drop is enabled

      • isContextMenuEnabled

        protected boolean isContextMenuEnabled()
        Deprecated.
        Please check the isContextMenuEnabled formal parameter value instead.
        Indicates whether to is the context menu featuer enabled
        Returns:
        true if context menus are enabled

      • useBuiltInFormat

        protected boolean useBuiltInFormat()
        Deprecated.
        Please check the useBuiltInFormat formal parameter value instead.
        Indicates whether to use report's built-in formatting, that is the formatting specified in the report definition
        Returns:
        true if should use report's built-in formatting

      • showPivot

        protected boolean showPivot()
        Deprecated.
        Please check the showPivot formal parameter value instead.
        Indicates whether display pivot buttons
        Returns:
        true if pivot buttons need to be displayed

      • showRemove

        protected boolean showRemove()
        Deprecated.
        Please check the showRemove formal parameter value instead.
        Indicates whether display remove buttons
        Returns:
        true if remove buttons needs to be displayed

      • init

        public void init​(WebComponent wc,
                 java.util.HashMap cachedObjects)
        Deprecated.
        use the init interface that receives a ReportGridTransformImpl.Context object
        Description copied from interface: ReportGridDisplayCell
        Initializes an ReportGridDisplayCell. This is used to initialize empty cells that have no underlying WebObject.
        Specified by:
        init in interface ReportGridDisplayCell
        Parameters:
        wc - associated web component.
        cachedObjects - a HashMap populated by the transform and used to store information shared across multiple cells.
        Since:
        MicroStrategy Web 7.5.2

      • init

        public void init​(WebComponent wc,
                 FormalParameters formalParas)
        Deprecated.
        This method is not used by the Transform anymore. To initialize empty cells it now uses init(TransformContext).
        Description copied from interface: ReportGridDisplayCell
        Initializes an ReportGridDisplayCell. This is used to initialize empty cells that have no underlying WebObject.
        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.
        Since:
        MicroStrategy Web 7.5.2

      • init

        public void init​(FormalParameters formalParas)
        Deprecated.
        This method is not used by the Transform anymore. To initialize empty cells it now uses init(TransformContext).
        Description copied from interface: ReportGridDisplayCell
        Initializes an ReportGridDisplayCell. This is used to initialize empty cells that have no underlying WebObject.
        Specified by:
        init in interface ReportGridDisplayCell
        Parameters:
        formalParas - all the formal parameters from the report transform. Used to control some output generation.

      • setInnerHTML

        public void setInnerHTML​(java.lang.String innerHTML)
        Deprecated.
        The Transform doesn't call this method. Users who require to customize the inner HTML should override generateInnerHTML(com.microstrategy.web.beans.MarkupOutput)

        Registers the inner HTML for this cell. When a non-null innerHTML is registered, all the HTML within the TD tag is replaced by this text and the cell does not call the generateInnerHTML method.

        Specified by:
        setInnerHTML in interface ReportGridDisplayCell
        Parameters:
        innerHTML - The inner HTML string to use for this cell.

      • setCellType

        public void setCellType​(int cellType)
        Deprecated.
        The cell type is not significant anymore for the application.
        Sets the type for this cell, the value should be from the EnumReportGridDisplayCellTypes enumeration.
        Parameters:
        cellType - the type for this cell

      • generateDrillOpenLink

        protected void generateDrillOpenLink​(MarkupOutput mo,
                                     ReportBean rb,
                                     java.lang.String url,
                                     java.lang.String title,
                                     boolean javascriptUsedForDrill,
                                     java.lang.String sElementID)
        Deprecated.
        Use method that doesn't receive the ReportBean as an argument.
        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

      • generateDrillOpenLink

        protected void generateDrillOpenLink​(MarkupOutput mo,
                                     java.lang.String url,
                                     java.lang.String title,
                                     boolean javascriptUsedForDrill,
                                     java.lang.String sElementID)
        Deprecated.
        use generateAnchor(com.microstrategy.web.beans.WebEvent) instead
        Generate open anchor for drill link for header elements
        Parameters:
        mo - the MarkupOutput 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
        Since:
        MicroStrategy Web 8.0.0

      • generateSortButton

        protected void generateSortButton​(MarkupOutput mo)
        Deprecated.
        use generateSortButton() instead
        Generate sort button for this cell.
        Parameters:
        mo - the output object

      • getDescriptor

        protected java.lang.String getDescriptor​(ReportBean rb,
                                         int key)
        Deprecated.
        Use method that doesn't receive the ReportBean as an argument.
        Get descriptor for this key
        Parameters:
        rb - the ReportBean object
        key - input key as an int
        Returns:
        descriptor as a String

      • showSubTitle

        protected boolean showSubTitle()
        Deprecated.
        Use showSubtitle instead.
        Indicates whether to display sub titles (attribute forms).
        Returns:
        true if the transform is displaying sub title

      • generateHeaderDrillContextMenu

        protected void generateHeaderDrillContextMenu​(MarkupOutput mo,
                                              ReportBean rb,
                                              WebHeader header,
                                              java.lang.StringBuffer sHeaderURL,
                                              ContextMenu rhMenu)
        Deprecated.
        Use method that doesn't receive the ReportBean as an argument.
        Generate the drilling context menus for cells that use WebHeader as their underlying SDK object.
        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.
        Use method that doesn't receive the ReportBean as an argument.
        Generate the drilling context menus for cells that use WebRowValue as their underlying SDK object.
        Parameters:
        mo - the MarkupOutput object
        rb - the ReportBean object
        rowValue - the WebRowValue object
        sHeaderURL - the header's url
        rhMenu - the context menu object

      • getRowValueDrillParametersForDHTML

        protected java.lang.String getRowValueDrillParametersForDHTML​(ReportBean rb,
                                                              WebDrillPath dp)
        Deprecated.
        Use method that doesn't receive the ReportBean as an argument.
        Returns parameters required for drilling when using javascript for cells that use WebRowValue as their underlying SDK object.
        Parameters:
        rb - the ReportBean object
        dp - the drill path
        Returns:
        the url string

      • generateTitleDrillContextMenu

        protected void generateTitleDrillContextMenu​(MarkupOutput mo,
                                             ReportBean rb,
                                             WebTitle title,
                                             java.lang.StringBuffer sTitleURL,
                                             ContextMenu rhMenu)
        Deprecated.
        Use method that doesn't receive the ReportBean as an argument.
        Generate the drilling context menus for cells that use WebTitle as their underlying SDK object.
        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.
        Use method that doesn't receive the ReportBean as an argument.
        Generate the sort context menus for cells that use WebHeader as their underlying SDK object.
        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.
        Use method that doesn't receive the ReportBean as an argument.
        Generate the sort context menus for cells that use WebTitle as their underlying SDK object.
        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.
        Use method that doesn't receive the ReportBean as an argument.
        Returns the URL use for drilling cells that use a WebHeader as their underlying SDK object.
        Parameters:
        rb - the ReportBean object
        dp - the drill path
        header - the WebHeader object
        Returns:
        String with the URL link for a header

      • getHeaderDrillURL

        protected java.lang.String getHeaderDrillURL​(WebDrillPath dp,
                                             WebHeader header)
        Deprecated.
        use generateAnchor(com.microstrategy.web.beans.WebEvent) instead
        Returns the URL use for drilling cells that use a WebHeader as their underlying SDK object.
        Parameters:
        dp - the drill path
        header - the WebHeader object
        Returns:
        String with the URL link for a header
        Since:
        MicroStrategy Web 8.0.0

      • getRowValueDrillURL

        protected java.lang.String getRowValueDrillURL​(ReportBean rb,
                                               WebDrillPath dp,
                                               WebRowValue rowValue)
        Deprecated.
        Use method that doesn't receive the ReportBean as an argument.
        Returns the URL use for drilling cells that use a WebRowValue as their underlying SDK object.
        Parameters:
        rb - the ReportBean object
        dp - the drill path
        rowValue - the WebRowValue object
        Returns:
        the URL Link for a row value

      • getRowValueDrillURL

        protected java.lang.String getRowValueDrillURL​(WebDrillPath dp,
                                               WebRowValue rowValue)
        Deprecated.
        use generateAnchor(com.microstrategy.web.beans.WebEvent) instead
        Returns the URL use for drilling cells that use a WebRowValue as their underlying SDK object.
        Parameters:
        dp - the drill path
        rowValue - the WebRowValue object
        Returns:
        the URL Link for a row value
        Since:
        MicroStrategy Web 8.0.0

      • getTitleDrillURL

        protected java.lang.String getTitleDrillURL​(ReportBean rb,
                                            WebDrillPath dp,
                                            WebTitle title)
        Deprecated.
        Use method that doesn't receive the ReportBean as an argument.
        Returns the URL use for drilling cells that use a WebTitle as their underlying SDK object.
        Parameters:
        rb - the ReportBean object
        dp - the drill path
        title - the WebTitle object
        Returns:
        the URL Link for a title cell

      • getTitleDrillURL

        protected java.lang.String getTitleDrillURL​(WebDrillPath dp,
                                            WebTitle title)
        Deprecated.
        use generateAnchor(com.microstrategy.web.beans.WebEvent) instead
        Returns the URL use for drilling cells that use a WebTitle as their underlying SDK object.
        Parameters:
        dp - the drill path
        title - the WebTitle object
        Returns:
        the URL Link for a title cell
        Since:
        MicroStrategy Web 8.0.0

      • getHeaderDrillParametersForDHTML

        protected java.lang.String getHeaderDrillParametersForDHTML​(ReportBean rb,
                                                            WebDrillPath dp,
                                                            WebHeader header)
        Deprecated.
        Use method that doesn't receive the ReportBean as an argument.
        Returns parameters required for drilling when using javascript for cells that use WebHeader as their underlying SDK object.
        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.
        Use method that doesn't receive the ReportBean as an argument.
        Returns parameters required for drilling when using javascript for cells that use WebTitle as their underlying SDK object.
        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.
        Use method that doesn't receive the ReportBean as an argument.
        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.
        Use method that doesn't receive the ReportBean as an argument.
        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

      • generateDrillCheckBox

        protected boolean generateDrillCheckBox​(MarkupOutput mo,
                                        ReportBean rb,
                                        WebHeader header)
        Deprecated.
        Use method that doesn't receive the ReportBean as an argument.
        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.
        Use method that doesn't receive the ReportBean as an argument.
        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

      • isIFrameEnabled

        protected boolean isIFrameEnabled()
        Deprecated.
        use isIframeEnabled()
        whether ifram is enabled
        Returns:
        whether ifram is enabled

      • isIFrameRequest

        protected boolean isIFrameRequest()
        Deprecated.
        use isIframeRequest
        whether it's an iframe request
        Returns:
        whether it's an iframe request

      • getReportBean

        public ReportBean getReportBean()
        Deprecated.
        use getViewBean() instead
        Returns the report bean associated with this display cell
        Returns:
        the report bean

      • getHeaderContent

        public java.lang.String getHeaderContent​(WebHeader header)
        Deprecated.
        The Transform doesn't call this method. Users who require to customize the text-content of a header should override getText()
        For those cells that uses a WebHeader as their underlying WebObject, this method returns the cell's text content.
        Specified by:
        getHeaderContent in interface ReportGridDisplayCell
        Parameters:
        header - the WebHeader object.
        Returns:
        Header Content as a String

      • getHeaderDrillPathWithHighImportance

        protected WebDrillPath getHeaderDrillPathWithHighImportance​(WebHeader header)
        Deprecated.
        please use getDrillPathWithHighImportance() instead
        generate drilling url parameters for DHTML mode
        Parameters:
        header - the WebHeader object
        Returns:
        The drill path with high importance
        Since:
        MicroStrategy Web 8.0.0

      • getRowValueDrillPathWithHighImportance

        protected WebDrillPath getRowValueDrillPathWithHighImportance​(WebRowValue rowValue)
        Deprecated.
        please use getDrillPathWithHighImportance() instead
        generate drilling url parameters for row value in DHTML mode
        Parameters:
        rowValue - the WebRowValue object
        Returns:
        The drill path with high importance
        Since:
        MicroStrategy Web 8.0.0

      • generateDrillCheckBox

        protected boolean generateDrillCheckBox​(MarkupOutput mo,
                                        WebHeader header)
        Deprecated.
        please use generateDrillCheckBoxTag() instead
        generate output for checkboxes for drill
        Parameters:
        mo - the MarkupOutput object
        header - the WebHeader object
        Returns:
        if any checkbox is rendered
        Since:
        MicroStrategy Web 8.0.0

      • generateFilterOnSelectionCheckBox

        protected boolean generateFilterOnSelectionCheckBox​(MarkupOutput mo,
                                                    WebHeader header)
        Deprecated.
        please use generateFilterOnSelectionCheckBoxTag() instead
        generate output for the checkbox for Filter on Selections
        Parameters:
        mo - the MarkupOutput object
        header - the WebHeader object
        Returns:
        if any checkbox is rendered
        Since:
        MicroStrategy Web 8.0.0

      • isHeaderNeedLink

        protected boolean isHeaderNeedLink​(WebHeader header)
        Deprecated.
        please use cellNeedsLink()
        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.
        please use cellNeedsLink()
        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.
        please use cellNeedsLink()
        return whether to display link for drill
        Parameters:
        rowValue - the WebRowValue object
        Returns:
        whether to display link for drill

      • getColHeaderWebMetric

        protected WebMetric getColHeaderWebMetric​(WebHeader header)
        Deprecated.
        please refer to the getWebMetric method on the ReportGridCellColHeaderImpl class.
        get the metric object for the column header
        Parameters:
        header - the column header
        Returns:
        the corresponding WebMetric object

      • getOpenFormatEditorEvent

        public WebEvent getOpenFormatEditorEvent()
        Get the event for opening the format editor for the requested target.
        Specified by:
        getOpenFormatEditorEvent in interface ReportGridDisplayCell
        Returns:
        WebEvent initialized instance. If it could not be generated, it will return null
        Since:
        MicroStrategy Web 8.0.1

      • getSetFormatEditorTargetEvent

        public WebEvent getSetFormatEditorTargetEvent()
        Description copied from interface: ReportGridDisplayCell
        Get the event for setting the current target of the format editor to be this cell instance
        Specified by:
        getSetFormatEditorTargetEvent in interface ReportGridDisplayCell
        Returns:
        WebEvent instance initialized for setting the target of the format editor to be the current cell instance.
        Since:
        MicroStrategy Web 8.0.1

      • getDefaultDrillEvent

        protected WebEvent getDefaultDrillEvent​(WebDrillPath dp)
        Since:
        MicroStrategy Web 9.0.0

      • getDefaultDrillEvent

        protected WebEvent getDefaultDrillEvent()
        Since:
        MicroStrategy Web 8.0.1

      • getRWDDrillOutEvent

        protected WebEvent getRWDDrillOutEvent()
        Since:
        MicroStrategy Web 9.0.0

      • getDefaultAdvancedDrillEvent

        protected WebEvent getDefaultAdvancedDrillEvent()
        Since:
        MicroStrategy Web 8.0.1

      • getDefaultDrillEditorProcessEvent

        protected WebEvent getDefaultDrillEditorProcessEvent()
        Since:
        MicroStrategy Web 8.0.1

      • getDefaultAdvancedDrillProcessEvent

        protected WebEvent getDefaultAdvancedDrillProcessEvent()
        Since:
        MicroStrategy Web 8.0.1

      • getDefaultDrillFilterOnSelectionEvent

        protected WebEvent getDefaultDrillFilterOnSelectionEvent()
        Since:
        MicroStrategy Web 8.0.1

      • getDefaultSortEvent

        protected WebEvent getDefaultSortEvent()
        Since:
        MicroStrategy Web 8.0.1

      • getTargetKeys

        protected java.lang.String getTargetKeys​(RWControl ctl,
                                         boolean[] usePartialDisplay)
        Since:
        MicroStrategy Web 8.1.0

      • generateThresholdSymbol

        protected java.lang.String generateThresholdSymbol​(int thresholdValue)
        Generates the HTML when the metric value is a "quick symbol" threshold.
        Parameters:
        out - the output object
        thresholdValue - the threshold id. A value from EnumDSSXMLSymbol.

      • getSelectorEvent

        protected WebEvent getSelectorEvent()
        get the selector Event to gnereate the anchor in HTML mode
        Returns:

      • shouldHiliteOnServer

        protected boolean shouldHiliteOnServer()
        Indicate if it's necessary to hilight the selected element on server side.
        Returns:

      • canDefineDerivedElements

        protected boolean canDefineDerivedElements()