Interface ReportGridDisplayCell

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int PIVOT_DECREASE_POSITION
      Identifier for the pivot button that will decrease the position of the object in the collection, for example, move it to the left in case of row title, or move it up if a column title
      static int PIVOT_INCREASE_POSITION
      Identifier for the pivot button that will increase the position of the object in the collection, for example, move it to the right in case of row title, or move it down if a column title
      static int PIVOT_REMOVE
      Identifier for the pivot button that will remove the object from the template
      static int PIVOT_SWITCH_AXIS
      Identifier for the pivot button that will change of axis the object in the template, for example, move it to columns in case of row title, or move it to rows if a column title
      static int PIVOT_TO_PAGE_BY
      Identifier for the pivot button that will move the object to the page by section
    • Method Summary

      All Methods Instance Methods Abstract Methods Deprecated Methods 
      Modifier and Type Method Description
      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
      boolean canAddThresholds()
      Utility method for determining if the cell object is enabled for displaying the user the option to add advanced thresholds
      boolean canDrill()
      Utility methood for determining if the cell object is enabled for displaying the user the option to drill on it
      boolean canDrillAdvanced()
      Utility methood for determining if the cell object is enabled for displaying the user the option for advanced drilling on it
      boolean canEditControl()
      Utility methood for determining if the cell object is enabled for displaying the user the option to edit control
      boolean canEditMetricFilter()
      Utility method for determining if the cell object is enabled editing a metric filter
      boolean canFilterOn()
      Utility methood for determining if the cell object is enabled for displaying the user the option to filter on it
      boolean canFilterOnSelection()  
      boolean canFormat()
      Utility methood for determining if the cell object is enabled for displaying the user the option to format it
      boolean canHaveDerivedElements()  
      boolean canHyperLink()
      Utility method for determining if the cell object is enabled for displaying the user the option to navigate to custom hyperlinks
      boolean canInsertShortcutMetric()
      Utility methood for determining if the cell object is enabled for displaying the user the option to insert shortcut metrics based on it
      boolean canMetricFilterOn()
      Utility method for determining if the cell object is enabled for displaying the user the option to modify the attribute forms on it
      boolean canModifyAttributeForm()
      Utility methood for determining if the cell object is enabled for displaying the user the option to modify the attribute forms on it
      boolean canOpenAlerts()  
      boolean canPivot()
      Utility methood for determining if the cell object is enabled for displaying the user the option to pivot it
      boolean canPivot​(int type)
      Utility methood for determining if the cell object is enabled for displaying the user the option to pivot it according to the type specified
      boolean canQuickGroup()  
      boolean canRemoveFromGrid()
      Utility methood for determining if the cell object is enabled for displaying the user the option to remove it from the grid.
      boolean canRemoveFromReport()
      Utility methood for determining if the cell object is enabled for displaying the user the option to remove it from the report
      boolean canRename()
      Utility methood for determining if the cell object is enabled for displaying the user the option to rename it
      boolean canSort()
      Utility methood for determining if the cell object is enabled for displaying the user the option to sort it
      void generateOutput​(MarkupOutput mo)
      This is the main entry point to generate the output of the cell.
      java.lang.String getAccessibilityInfo()
      Deprecated.
      addExtraAttribute(java.lang.String, java.lang.String) is used instead for specifying the accessibility information, for example, addExtraAttribute("scope", "row");
      java.lang.String getCellID()
      Returns the id for this cell, this should be the one used as the ID attribute of TD tag.
      int getCellType()
      Deprecated.
      The cell type is not significant anymore for the application.
      int getColSpan()
      Returns the column span for this cell, this should be the one used as the COLSPAN attribute of TD tag.
      WebEvent getControlElementSelectorEvent​(RWControl control, java.lang.String elementList)  
      WebEvent getDerivedElementsEvent()  
      WebEvent getDrillEvent​(WebDrillPath dp, java.lang.String elementKey, WebTitle title)
      Returns the WebEvent to drill from the cell to the given drill path.
      WebDrillPath getDrillPathWithHighImportance()
      Obtain the Drill path with high importance information for the current cell being analyzed.
      java.lang.String getExtraInfo()
      Returns the text assigned as extra information of the cell.
      java.lang.String getExtraStyle()
      Returns the extra style information required for the formatting of the cell.
      WebEvent getFilterOnEvent()
      Get the event for filter on the cell header instance
      java.lang.String getHeaderContent​(WebHeader header)
      Deprecated.
      The Transform doesn't call this method.
      int getKey()  
      WebEvent getOpenFormatEditorEvent()
      Get the event for opening the format editor
      WebEvent getRenameEvent()
      Get the event for renaming the current cell
      int getRowSpan()
      Returns the row span for this cell, this should be the one used as the ROWSPAN attribute of TD tag.
      WebEvent getSetFormatEditorTargetEvent()
      Get the event for setting the current target of the format editor to be this cell instance
      java.lang.String getStyle()
      Returns the css class name associated with the cell.
      java.lang.String getText()
      Returns the text content of this cell.
      java.lang.String getTooltip()
      Returns the tooltip text for this cell.
      java.lang.String getWidth()
      Returns the width for this cell, this should be the one used as the WIDTH attribute of TD tag.
      void init​(TransformContext context)
      Initializes the instance.
      void init​(WebComponent wc, FormalParameters formalParas)
      Deprecated.
      This method is not used by the Transform anymore.
      void init​(WebComponent wc, java.util.HashMap cachedObjects)
      Deprecated.
      use the init interface that receives a ReportGridTransformImpl.Context object
      void init​(FormalParameters formalParas)
      Deprecated.
      This method is not used by the Transform anymore.
      boolean isRW()
      Utility methood for determining whether it is a RW execution.
      void reset()
      Reset all of the instance variables.
      void setAccessibilityInfo​(java.lang.String accessibilityInfo)
      Deprecated.
      please use addExtraAttribute(java.lang.String, java.lang.String) instead, for example, addExtraAttribute("scope", "row");
      void setCellID​(java.lang.String cellID)
      Registers the id for this cell, this should be used as the ID attribute of TD tag.
      void setColSpan​(int colSpan)
      Registers the column span for this cell, this should be used as the COLSPAN attribute of TD tag.
      void setContent​(java.lang.String content)
      Deprecated.
      The Transform doesn't call this method.
      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.
      void setExtraInfo​(java.lang.String extraInfo)
      Registers any extra information that should be appended as part of the TD's open tag.
      void setExtraStyle​(java.lang.String extraStyle)
      Deprecated.
      void setExtraStyle​(java.lang.String value, boolean append)
      Updates values to the STYLE attribute of the TD tag.
      void setHTML​(java.lang.String html)
      Deprecated.
      The Transform doesn't call this method.
      void setInnerHTML​(java.lang.String innerHTML)
      Deprecated.
      The Transform doesn't call this method.
      void setPostContent​(java.lang.String content)
      Deprecated.
      The Transform doesn't call this method.
      void setPreContent​(java.lang.String content)
      Deprecated.
      The Transform doesn't call this method.
      void setRowSpan​(int rowSpan)
      Registers the row span for this cell, this should be used as the ROWSPAN attribute of TD tag.
      void setStyle​(java.lang.String style)
      Registers the css style name associated with the cell.
      void setText​(java.lang.String text)
      Registers the text content of this cell.
      void setTooltip​(java.lang.String tooltip)
      Registers the text for the tooltop of this cell.
      void setWidth​(java.lang.String width)
      Registers the width for this cell, this should be used as WIDTH attribute of TD tag.
    • Field Detail

      • PIVOT_INCREASE_POSITION

        static final int PIVOT_INCREASE_POSITION
        Identifier for the pivot button that will increase the position of the object in the collection, for example, move it to the right in case of row title, or move it down if a column title
        Since:
        MicroStrategy Web 8.0.1
        See Also:
        Constant Field Values
      • PIVOT_DECREASE_POSITION

        static final int PIVOT_DECREASE_POSITION
        Identifier for the pivot button that will decrease the position of the object in the collection, for example, move it to the left in case of row title, or move it up if a column title
        Since:
        MicroStrategy Web 8.0.1
        See Also:
        Constant Field Values
      • PIVOT_SWITCH_AXIS

        static final int PIVOT_SWITCH_AXIS
        Identifier for the pivot button that will change of axis the object in the template, for example, move it to columns in case of row title, or move it to rows if a column title
        Since:
        MicroStrategy Web 8.0.1
        See Also:
        Constant Field Values
      • PIVOT_TO_PAGE_BY

        static final int PIVOT_TO_PAGE_BY
        Identifier for the pivot button that will move the object to the page by section
        Since:
        MicroStrategy Web 8.0.1
        See Also:
        Constant Field Values
      • PIVOT_REMOVE

        static final int PIVOT_REMOVE
        Identifier for the pivot button that will remove the object from the template
        Since:
        MicroStrategy Web 8.0.1
        See Also:
        Constant Field Values
    • Method Detail

      • reset

        void reset()
        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.
        Since:
        MicroStrategy Web 9.0.1
      • getText

        java.lang.String getText()

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

        Returns:
        Text for the cell
      • setText

        void setText​(java.lang.String text)

        Registers the text content of this cell. When a non-null text is registered, this should be used as the core content of the cell; otherwise the alias of the underlying WebObject should be used.

        Parameters:
        text - text for this cell
      • getStyle

        java.lang.String getStyle()
        Returns the css class name associated with the cell.
        This should be the one assigned to the CLASS attribute of the TD tag to control its formatting.
        Returns:
        The css class name
      • setStyle

        void setStyle​(java.lang.String style)
        Registers the css style name associated with the cell.
        This text should be assigned as the CLASS attribute of the TD tag to control the format of the cells that share the same CLASS.
        Parameters:
        style - The css class name
      • getExtraStyle

        java.lang.String getExtraStyle()
        Returns the extra style information required for the formatting of the cell. This text should be the one assigned to the STYLE attribute of the TD tag.
        Returns:
        The extra style info for this cell
      • setExtraStyle

        void setExtraStyle​(java.lang.String extraStyle)
        Deprecated.
        Registers any extra information required for the formatting of the cell.
        This text should be assigned to the STYLE attribute of the TD tag. The style assigned this way will only apply to this cell.
        Parameters:
        extraStyle - The text to use
      • setExtraStyle

        void setExtraStyle​(java.lang.String value,
                           boolean append)
        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.
        Parameters:
        value - 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
      • getExtraInfo

        java.lang.String getExtraInfo()
        Returns the text assigned as extra information of the cell. This text should be the one appended to the TD's open tag.
        Returns:
        The extra info for this cell
      • setExtraInfo

        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.
        Parameters:
        extraInfo - the text to be appended as part of the open tag.
      • getCellID

        java.lang.String getCellID()
        Returns the id for this cell, this should be the one used as the ID attribute of TD tag.
        Returns:
        the id for this cell
      • setCellID

        void setCellID​(java.lang.String cellID)
        Registers the id for this cell, this should be used as the ID attribute of TD tag.
        Parameters:
        cellID - The cell's ID
      • getTooltip

        java.lang.String getTooltip()
        Returns the tooltip text for this cell. This is the text displayed by the browser when the cursor goes over the cell.
        Returns:
        The cell's Tooltip text.
      • setTooltip

        void setTooltip​(java.lang.String tooltip)
        Registers the text for the tooltop of this cell. This should be used as the TITLE attribute of TD tag.
        Parameters:
        tooltip - the tooltip to display when the cursor goes over the cell
      • addExtraAttribute

        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
        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
      • getRowSpan

        int getRowSpan()
        Returns the row span for this cell, this should be the one used as the ROWSPAN attribute of TD tag.
        Returns:
        The cell's row span
      • setRowSpan

        void setRowSpan​(int rowSpan)
        Registers the row span for this cell, this should be used as the ROWSPAN attribute of TD tag.
        Parameters:
        rowSpan - row span
      • getColSpan

        int getColSpan()
        Returns the column span for this cell, this should be the one used as the COLSPAN attribute of TD tag.
        Returns:
        The cell's col span
      • setColSpan

        void setColSpan​(int colSpan)
        Registers the column span for this cell, this should be used as the COLSPAN attribute of TD tag.
        Parameters:
        colSpan - col span
      • getWidth

        java.lang.String getWidth()
        Returns the width for this cell, this should be the one used as the WIDTH attribute of TD tag.
        Returns:
        The cell's width
      • setWidth

        void setWidth​(java.lang.String width)
        Registers the width for this cell, this should be used as WIDTH attribute of TD tag.
        Parameters:
        width - text for this cell
      • init

        void init​(TransformContext context)
        Initializes the instance.
        Parameters:
        context - TransformContext instance that contains a reference to the transform being used to render the overall grid information
        Since:
        MicroStrategy Web 8.0.1
      • canRemoveFromGrid

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

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

        boolean canRename()
        Utility methood for determining if the cell object is enabled for displaying the user the option to rename it
        Returns:
        boolean value indicating if the manipulation should be enabled
        Since:
        MicroStrategy Web 8.0.1
      • canFilterOn

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

        boolean canFormat()
        Utility methood for determining if the cell object is enabled for displaying the user the option to format it
        Returns:
        boolean value indicating if the manipulation should be enabled
        Since:
        MicroStrategy Web 8.0.1
      • canSort

        boolean canSort()
        Utility methood for determining if the cell object is enabled for displaying the user the option to sort it
        Returns:
        boolean value indicating if the manipulation should be enabled
        Since:
        MicroStrategy Web 8.0.1
      • canDrill

        boolean canDrill()
        Utility methood for determining if the cell object is enabled for displaying the user the option to drill on it
        Returns:
        boolean value indicating if the manipulation should be enabled
        Since:
        MicroStrategy Web 8.0.1
      • canDrillAdvanced

        boolean canDrillAdvanced()
        Utility methood for determining if the cell object is enabled for displaying the user the option for advanced drilling on it
        Returns:
        boolean value indicating if the manipulation should be enabled
        Since:
        MicroStrategy Web 8.0.1
      • canInsertShortcutMetric

        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
        Returns:
        boolean value indicating if the manipulation should be enabled
        Since:
        MicroStrategy Web 8.0.1
      • canEditControl

        boolean canEditControl()
        Utility methood for determining if the cell object is enabled for displaying the user the option to edit control
        Returns:
        boolean value indicating if the manipulation should be enabled
        Since:
        MicroStrategy Web 8.1.0
      • isRW

        boolean isRW()
        Utility methood for determining whether it is a RW execution.
        Returns:
        boolean value indicating if it is a RW execution.
        Since:
        MicroStrategy Web 8.1.0
      • canPivot

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

        boolean canPivot​(int type)
        Utility methood for determining if the cell object is enabled for displaying the user the option to pivot it according to the type specified
        Parameters:
        type - value indicating which type of pivot manipulation is being tested. Values come from the PIVOT_INCREASE_POSITION, PIVOT_DECREASE_POSITION, PIVOT_SWITCH_AXIS, PIVOT_TO_PAGE_BY and PIVOT_REMOVE constants.
        Returns:
        boolean value indicating if the manipulation should be enabled
        Since:
        MicroStrategy Web 8.0.1
      • canModifyAttributeForm

        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
        Returns:
        boolean value indicating if the manipulation should be enabled
        Since:
        MicroStrategy Web 8.0.1
      • canHyperLink

        boolean canHyperLink()
        Utility method for determining if the cell object is enabled for displaying the user the option to navigate to custom hyperlinks
        Returns:
        boolean value indicating if the manipulation should be enabled
        Since:
        MicroStrategy Web 8.1.2
      • canMetricFilterOn

        boolean canMetricFilterOn()
        Utility method for determining if the cell object is enabled for displaying the user the option to modify the attribute forms on it
        Returns:
        boolean value indicating if the manipulation should be enabled
        Since:
        MicroStrategy Web 9.0.0
      • canEditMetricFilter

        boolean canEditMetricFilter()
        Utility method for determining if the cell object is enabled editing a metric filter
        Returns:
        boolean value indicating if the manipulation should be enabled
        Since:
        MicroStrategy Web 9.0.0
      • canHaveDerivedElements

        boolean canHaveDerivedElements()
        Since:
        MicroStrategy Web 9.0.0
      • canQuickGroup

        boolean canQuickGroup()
        Since:
        MicroStrategy Web 9.0.0
      • canOpenAlerts

        boolean canOpenAlerts()
        Since:
        MicroStrategy Web 9.0.0
      • canAddThresholds

        boolean canAddThresholds()
        Utility method for determining if the cell object is enabled for displaying the user the option to add advanced thresholds
        Returns:
        boolean value indicating if the manipulation should be enabled
        Since:
        MicroStrategy Web 9.0.0
      • getDrillPathWithHighImportance

        WebDrillPath getDrillPathWithHighImportance()
        Obtain the Drill path with high importance information for the current cell being analyzed. This drill-path will be the one used to generate the drilling link for the cell.
        Returns:
        WebDrillPath instance initialized, with the drill path with high importance information to use if available, otherwise returns null
        Since:
        MicroStrategy Web 8.0.1
      • getDrillEvent

        WebEvent getDrillEvent​(WebDrillPath dp,
                               java.lang.String elementKey,
                               WebTitle title)
        Returns the WebEvent to drill from the cell to the given drill path.
        Parameters:
        dp - The drill path to use for drilling.
        elementKey - The key for the element to drill to
        title - The WebTitle to drill from.
        Since:
        MicroStrategy Web 8.0.1
      • getControlElementSelectorEvent

        WebEvent getControlElementSelectorEvent​(RWControl control,
                                                java.lang.String elementList)
        Since:
        MicroStrategy Web 8.1.0
      • getAccessibilityInfo

        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 to be appended as part of the TD's open tag only when the cell will be rendered in Accessibility Mode (508).
        Returns:
        The extra accessibility info for this cell
      • setAccessibilityInfo

        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.
        Parameters:
        accessibilityInfo - the text to be appended as part of the open tag.
      • setContextMenu

        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 should be appended to the TD's open tag.
        Parameters:
        contextMenu - The trigger for the context-menu of this cell
      • setHTML

        void setHTML​(java.lang.String html)
        Deprecated.
        The Transform doesn't call this method. Users who require to customize the HTML should override AbstractReportGridDisplayCell.generateOutput(com.microstrategy.web.beans.MarkupOutput)
        Registers the HTML for this cell. When a non-null html is registered, the whole output of the cell should be replaced with this text.
        Parameters:
        html - The complete HTML string for this cell
      • setInnerHTML

        void setInnerHTML​(java.lang.String innerHTML)
        Deprecated.
        The Transform doesn't call this method. Users who require to customize the inner HTML should override AbstractReportGridDisplayCell.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 should be replaced by this text.

        Notice that the ReportGridDisplayCell divides the innerHTML into three parts:
        1. content: generates the main portion of the HTML, it shall include the cell's text and its corresponding HTML.
        2. pre-content: generates the HTML that goes before the content. In the application this is used to generate the checkboxes for drilling.
        3. post-content: generates the HTML that goes after the content. In the application this is used to generate sorting and pivoting buttons.
        Parameters:
        innerHTML - The inner HTML string to use for this cell.
      • getCellType

        int getCellType()
        Deprecated.
        The cell type is not significant anymore for the application.
        Returns the cell type, should be a value from the EnumReportGridDisplayCellTypes enumeration.
      • getHeaderContent

        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 AbstractReportGridDisplayCell.getText()
        For those cells that uses a WebHeader as their underlying WebObject, this method should returns the cell's text content.
        Parameters:
        header - the WebHeader object
        Returns:
        Header Content as a String
        Since:
        MicroStrategy Web 7.5.1
      • init

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

        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).
        Initializes an ReportGridDisplayCell. This is used to initialize empty cells that have no underlying WebObject.
        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

        void init​(WebComponent wc,
                  java.util.HashMap cachedObjects)
        Deprecated.
        use the init interface that receives a ReportGridTransformImpl.Context object
        Initializes an ReportGridDisplayCell. This is used to initialize empty cells that have no underlying WebObject.
        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
      • getFilterOnEvent

        WebEvent getFilterOnEvent()
        Get the event for filter on the cell header instance
        Returns:
        WebEvent instance initialized for filtering on the information of this cell
        Since:
        MicroStrategy Web 9.0.0
      • getOpenFormatEditorEvent

        WebEvent getOpenFormatEditorEvent()
        Get the event for opening the format editor
        Returns:
        WebEvent instance initialized for opening the format editor
        Since:
        MicroStrategy Web 9.0.0
      • getSetFormatEditorTargetEvent

        WebEvent getSetFormatEditorTargetEvent()
        Get the event for setting the current target of the format editor to be this cell instance
        Returns:
        WebEvent instance initialized for setting the target of the format editor to be the current cell instance.
        Since:
        MicroStrategy Web 9.0.0
      • getRenameEvent

        WebEvent getRenameEvent()
        Get the event for renaming the current cell
        Returns:
        WebEvent instance initialized with the information for renaming the current cell.
        Since:
        MicroStrategy Web 9.0.0
      • getDerivedElementsEvent

        WebEvent getDerivedElementsEvent()
        Since:
        MicroStrategy Web 9.0.0
      • getKey

        int getKey()
        Returns:
        int value with the key information about the cell being analyzed.
        Since:
        MicroStrategy Web 9.0.0
      • canFilterOnSelection

        boolean canFilterOnSelection()
        Since:
        MicroStrategy Web 9.0.0