Package com.microstrategy.web.app.transforms

Class AbstractReportGridTransform

    • Field Detail

      • reportDesignModePara

        protected FormalParameter reportDesignModePara
        This is the report mode flag used in the transform.
        not needed any more because we have two seperate transforms for execute mode and design mode: ReportGridTransformImpl and ReportDesignModeTransformImpl
        Allowed Values: integer values from enumeration EnumReportViewModes.

      • isDragAndDropEnabled

        protected FormalParameter isDragAndDropEnabled
        This is the flag used in the transform to specify whether to enable drag and drop functionality.
        Allowed Values: TRUE/FALSE.

      • isContextMenuEnabled

        protected FormalParameter isContextMenuEnabled
        Deprecated.
        To customize context-menus use the xml-definition specified by AbstractAppTransform.contextMenus
        This is the flag used in the transform to specify whether to enable context menu functionality.
        Allowed Values: TRUE/FALSE.

      • showPivotPara

        protected FormalParameter showPivotPara
        This is the flag used in the transform to specify whether to show pivot buttons.
        Allowed Values: TRUE/FALSE.

      • showRemovePara

        protected FormalParameter showRemovePara
        This is the flag used in the transform to specify whether to show remove buttons.
        Allowed Values: TRUE/FALSE.

      • showPivotRMC

        protected FormalParameter showPivotRMC
        This is the flag used in the transform to specify whether to show Right Mouse Click menu for pivoting.
        Allowed Values: TRUE/FALSE.

      • showRemoveRMC

        protected FormalParameter showRemoveRMC
        This is the flag used in the transform to specify whether to show Right Mouse Click menu for removing.
        Allowed Values: TRUE/FALSE.

      • showExtraRemoveRMC

        protected FormalParameter showExtraRemoveRMC
        This is the flag used in the transform to specify whether to show a second Right Mouse Click menu for removing option.
        This second option will allow the Remove From Report manipulation only if Remove From Grid is granted to the user and showRemoveRMC is enabled. Allowed Values: TRUE/FALSE.
        Since:
        MicroStrategy Web 8.0.0

      • showFormattingRMC

        protected FormalParameter showFormattingRMC
        This is the flag used in the transform to specify whether to show Right Mouse Click menu for formatting.
        Allowed Values: TRUE/FALSE.

      • showRenameRMC

        protected FormalParameter showRenameRMC
        This is the flag used in the transform to specify whether to show Right Mouse Click menu for renaming.
        Allowed Values: TRUE/FALSE.

      • contextMenuName

        protected FormalParameter contextMenuName
        This is the parameter to define the name of the context menu to use.
        Allowed Values: String values.

      • showContextMenus

        protected FormalParameter showContextMenus
        Deprecated.
        use isContextMenuEnabled instead.
        It is used in the transform to specify whether to enable context menu functionality.
        Allowed Values: TRUE/FALSE.

      • preTextForMetricValue

        protected FormalParameter preTextForMetricValue
        This is the pre text for the metric value cell content. Most likely used with exporting feature.
        Allowed Values: String values.

      • returnReplacement

        protected FormalParameter returnReplacement
        This is the substring that when found in the cell will be replaced by a break (<br>) tag.
        Allowed Values: String values.
        Since:
        MicroStrategy Web 8.0.0

      • postTextForMetricValue

        protected FormalParameter postTextForMetricValue
        This is the post text for the metric value cell content. Most likely used with exporting feature.
        Allowed Values: String values.

      • preTextForNonMetricValue

        protected FormalParameter preTextForNonMetricValue
        This is the pre text for the non-metric value cell content. Most likely used with exporting feature.
        Allowed Values: String values.

      • postTextForNonMetricValue

        protected FormalParameter postTextForNonMetricValue
        This is the post text for the non-metric value cell content. Most likely used with exporting feature.
        Allowed Values: String values.

      • showDescriptionAsTooltip

        protected FormalParameter showDescriptionAsTooltip
        It is used in the transform to specify whether to show the descriptions in the tooltip for the row or column titles.
        It should be of BOOLEAN type.
        Allowed Values: "1" means TRUE, "0" means FALSE.

      • imgShiftLeft

        protected FormalParameter imgShiftLeft
        This is the image name for shift left arrow used in the transform.
        Allowed Values: The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.

      • imgShiftRight

        protected FormalParameter imgShiftRight
        This is the image name for shift right arrow used in the transform.
        Allowed Values: The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.

      • imgShiftUp

        protected FormalParameter imgShiftUp
        This is the image name for shift up arrow used in the transform.
        Allowed Values: The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.

      • imgShiftDown

        protected FormalParameter imgShiftDown
        This is the image name for shift down arrow used in the transform.
        Allowed Values: The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.

      • imgShiftRightUp

        protected FormalParameter imgShiftRightUp
        This is the image name for shift right up arrow (pivot to column) used in the transform.
        Allowed Values: The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.

      • imgShiftLeftDown

        protected FormalParameter imgShiftLeftDown
        This is the image name for shift left down arrow (pivot to row) used in the transform.
        Allowed Values: The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.

      • imgShiftRightDown

        protected FormalParameter imgShiftRightDown
        Deprecated.
        This parameter has been deprecated as it was only used by the ReportPageByTransform.
        This is the image name for pivot-to-cols image used in the transform.
        Allowed values: a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.

      • imgToPageBy

        protected FormalParameter imgToPageBy
        This is the image name for to-page-by image used in the transform.
        Allowed Values: The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.

      • imgRemove

        protected FormalParameter imgRemove
        This is the image name for remove image used in the transform.
        Allowed Values: The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.

      • showGridInFullWidth

        protected FormalParameter showGridInFullWidth
        Deprecated.
        Previously used only in design mode of the report. Deprecated because now the layout of the grid will be dictated by the column width setting, i.e. whether it is set to Fit to Contents or Fit to Window.
        It is used in the transform to specify whether to show the grid in full width.
        If TRUE, the grid will expand to the complete browser window; If FALSE, the grid will fit to the content in each cell. Allowed Values: TRUE/FALSE.

      • gridClassesConfFile

        protected FormalParameter gridClassesConfFile
        It is used to indicate the name and location of the properties file containing the definition of the grid classes to use.
        Since:
        MicroStrategy Web 7.5.1

      • addNumberFormatting

        protected FormalParameter addNumberFormatting
        Whether to add the number formatting on metric values.
        Since:
        MicroStrategy Web 8.0.2

      • _imgShiftLeft

        protected java.lang.String _imgShiftLeft
        The full image name for shift-to-left pivot button.
        It includeds the image folder path.

      • _imgShiftRight

        protected java.lang.String _imgShiftRight
        The full image name for shift-to-right pivot button.
        It includeds the image folder path.

      • _imgShiftUp

        protected java.lang.String _imgShiftUp
        The full image name for shift-to-up pivot button.
        It includeds the image folder path.

      • _imgShiftDown

        protected java.lang.String _imgShiftDown
        The full image name for shift-to-down pivot button.
        It includeds the image folder path.

      • _imgShiftRightUp

        protected java.lang.String _imgShiftRightUp
        The full image name for shift-right-up pivot button.
        It's for pivot from row axis to column axis.
        It includeds the image folder path.

      • _imgShiftLeftDown

        protected java.lang.String _imgShiftLeftDown
        The full image name for shift-left-down pivot button.
        It's for pivot from column axis to row axis, and for pivot from page axis to row axis.
        It includeds the image folder path.

      • _imgShiftRightDown

        protected java.lang.String _imgShiftRightDown
        Deprecated.
        This parameter has been deprecated as it was only used by the ReportPageByTransform.
        The full image name for shift-to-left pivot button.
        It's for pivot from page axis to row axis.
        It includeds the image folder path.

      • _imgToPageBy

        protected java.lang.String _imgToPageBy
        The full image name for shift-to-pageby pivot button.
        It includeds the image folder path.

      • _imgRemove

        protected java.lang.String _imgRemove
        The full image name for remove button.
        It includeds the image folder path.

      • _gridCellClasses

        protected java.util.HashMap _gridCellClasses
        Since:
        MicroStrategy Web 7.5.1

      • COL_HEADER

        protected final java.lang.String COL_HEADER
        Since:
        MicroStrategy Web 7.5.1
        See Also:
        Constant Field Values

      • ROW_HEADER

        protected final java.lang.String ROW_HEADER
        Since:
        MicroStrategy Web 7.5.1
        See Also:
        Constant Field Values

      • COL_TITLE

        protected final java.lang.String COL_TITLE
        Since:
        MicroStrategy Web 7.5.1
        See Also:
        Constant Field Values

      • ROW_TITLE

        protected final java.lang.String ROW_TITLE
        Since:
        MicroStrategy Web 7.5.1
        See Also:
        Constant Field Values

      • METRIC_VALUE

        protected final java.lang.String METRIC_VALUE
        Since:
        MicroStrategy Web 7.5.1
        See Also:
        Constant Field Values

      • DISPLAY_CELL

        protected final java.lang.String DISPLAY_CELL
        Since:
        MicroStrategy Web 7.5.1
        See Also:
        Constant Field Values

      • COL_HEADER_CLASS

        protected final java.lang.String COL_HEADER_CLASS
        Since:
        MicroStrategy Web 7.5.1
        See Also:
        Constant Field Values

      • ROW_HEADER_CLASS

        protected final java.lang.String ROW_HEADER_CLASS
        Since:
        MicroStrategy Web 7.5.1
        See Also:
        Constant Field Values

      • COL_TITLE_CLASS

        protected final java.lang.String COL_TITLE_CLASS
        Since:
        MicroStrategy Web 7.5.1
        See Also:
        Constant Field Values

      • ROW_TITLE_CLASS

        protected final java.lang.String ROW_TITLE_CLASS
        Since:
        MicroStrategy Web 7.5.1
        See Also:
        Constant Field Values

      • METRIC_VALUE_CLASS

        protected final java.lang.String METRIC_VALUE_CLASS
        Since:
        MicroStrategy Web 7.5.1
        See Also:
        Constant Field Values

      • DISPLAY_CELL_CLASS

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

      • REUSE_FLAG

        protected final java.lang.String REUSE_FLAG
        Note: for the purpose of cell reuse.
        Since:
        MicroStrategy Web 9.0.1
        See Also:
        Constant Field Values

      • _rdcFactory

        protected ReportDisplayCellsFactory _rdcFactory
        This factory object is used to generate a cell instance for a particular type if necessary. One cell class has only one cell instance. Note: for the purpose of cell reuse.
        Since:
        MicroStrategy Web 9.0.1

      • _reuseFlag

        protected boolean _reuseFlag
        This flag is used to indicate reuse the cell instances from the above cell factory or not. By default, it is set to true. Or, it can be read from the property file defined by #gridClassesConfFile. NOte: for the purpose of cell reuse.
        Since:
        MicroStrategy Web 9.0.1

    • Constructor Detail

      • AbstractReportGridTransform

        public AbstractReportGridTransform()
        default no-args constructor.

    • Method Detail

      • setGridCellClass

        protected void setGridCellClass​(java.util.Properties properties,
                                java.lang.String classKey,
                                java.lang.String defaultClassName)
        This method initializes the classes used to render headers, titles and metric values by using a property file. These classes are defined under WEB-INF\classes\resources\gridClasses.properties By default, this file contains the following values: 
            colHeader=com.microstrategy.web.app.transforms.ReportGridCellColHeaderImpl
    rowHeader=com.microstrategy.web.app.transforms.ReportGridCellRowHeaderImpl
    colTitle=com.microstrategy.web.app.transforms.ReportGridCellColTitleImpl
    rowTitle=com.microstrategy.web.app.transforms.ReportGridCellRowTitleImpl
    metricValue=com.microstrategy.web.app.transforms.ReportGridCellMetricValueImpl
    displayCell=com.microstrategy.web.app.transforms.ReportGridDisplayCellImpl
        Since:
        MicroStrategy Web 7.5.1

      • setGridCellClass

        protected void setGridCellClass​(java.lang.String classKey,
                                java.lang.String className)
        This method initializes the classes used to render headers, titles and metric values.
        These classes are defined under WEB-INF\classes\resources\gridClasses.properties By default, this file contains the following values: 
            colHeader=com.microstrategy.web.app.transforms.ReportGridCellColHeaderImpl
    rowHeader=com.microstrategy.web.app.transforms.ReportGridCellRowHeaderImpl
    colTitle=com.microstrategy.web.app.transforms.ReportGridCellColTitleImpl
    rowTitle=com.microstrategy.web.app.transforms.ReportGridCellRowTitleImpl
    metricValue=com.microstrategy.web.app.transforms.ReportGridCellMetricValueImpl
    displayCell=com.microstrategy.web.app.transforms.ReportGridDisplayCellImpl
 
         
        

 This method is used as shown below:
 
            setGridCellClass(properties, COL_HEADER, COL_HEADER_CLASS);
 
        
 where COL_HEADER is a constant that defines a column header and
 COL_HEADER_CLASS defines the actual name of the implementation class
 (com.microstrategy.web.app.transforms.ReportGridCellColHeaderImpl)

 Developers can use this method to set their own implementation classes.
 For example:
 
            //Initialize the HashMap with the name of the classes.
    initGridCellClasses();
    //Set the class to be used for the different elements of a grid
    setGridCellClass(COL_HEADER, "com.microstrategy.web.app.transforms.MyReportGridCellColHeaderImpl");
    setGridCellClass(ROW_HEADER, "com.microstrategy.web.app.transforms.MyReportGridCellRowHeaderImpl");
    setGridCellClass(COL_TITLE, "com.microstrategy.web.app.transforms.MyReportGridCellColTitleImpl");
    setGridCellClass(ROW_TITLE, "com.microstrategy.web.app.transforms.MyReportGridCellRowTitleImpl");
    setGridCellClass(METRIC_VALUE, "com.microstrategy.web.app.transforms.MyReportGridCellMetricValueImpl");
    setGridCellClass(DISPLAY_CELL, "com.microstrategy.web.app.transforms.MyReportGridCellDisplayCellImpl");
        Parameters:
        classKey - one of the following:
        • COL_HEADER
        • ROW_HEADER
        • COL_TITLE
        • ROW_TITLE
        • METRIC_VALUE
        • DISPLAY_CELL
        className - a fully qualified class name.
        Since:
        MicroStrategy Web 7.5.1

      • initGridCellClasses

        protected void initGridCellClasses()
        Deprecated.
        This method is deprecated and will be removed in future versions of the product.
        It's not invoked anymore by the Transform, and calling it has no effect.
        Since:
        MicroStrategy Web 7.5.1

      • initializeCellClasses

        protected void initializeCellClasses()
        Reads the configuration with the cell classes and caches its content, then it calls setGridCellClass for each different cell type.
        Since:
        MicroStrategy Web 7.5.1

      • isDragAndDropEnabled

        protected boolean isDragAndDropEnabled()
        Deprecated.
        Please query directly the isDragAndDropEnabled formal parameter instead
        whether drag and drop feature is enabled.
        Returns:
        whether drag and drop feature is enabled

      • isContextMenuEnabled

        protected boolean isContextMenuEnabled()
        Deprecated.
        Please query directly the isContextMenuEnabled formal parameter instead
        whether context menu feature is enabled.
        Returns:
        whether context menu feature is enabled

      • showPivot

        protected boolean showPivot()
        Deprecated.
        Please query directly the showPivotPara formal parameter instead
        whether to display the pivot buttons.
        Returns:
        whether to display the pivot buttons

      • getDesignMode

        protected int getDesignMode()
        Deprecated.
        - use isDesignMode instead
        get the design mode of the report.
        Returns:
        EnumReportViewModes value

      • showRemove

        protected boolean showRemove()
        Deprecated.
        Please query directly the showRemovePara formal parameter instead
        whether to display the remove buttons.
        Returns:
        whether to display the remove buttons

      • showRemoveRMC

        protected boolean showRemoveRMC()
        Deprecated.
        Please query directly the showRemoveRMC formal parameter instead
        whether to display the remove RMC (right mouse click context menu).
        Returns:
        whether to display the remove RMC (right mouse click context menu)

      • showRenameRMC

        protected boolean showRenameRMC()
        Deprecated.
        Please query directly the showRenameRMC formal parameter instead
        whether to display the rename RMC (right mouse click context menu).
        Returns:
        whether to display the rename RMC (right mouse click context menu)

      • showFormattingRMC

        protected boolean showFormattingRMC()
        Deprecated.
        Please query directly the showFormattingRMC formal parameter instead
        whether to display the formatting RMC (right mouse click context menu).
        Returns:
        whether to display the formatting RMC (right mouse click context menu)

      • showPivotRMC

        protected boolean showPivotRMC()
        Deprecated.
        Please query directly the showPivotRMC formal parameter instead
        whether to display the pivot RMC (right mouse click context menu).
        Returns:
        whether to display the pivot RMC (right mouse click context menu)

      • getCssPrefix

        protected java.lang.String getCssPrefix()
        Get the prefix for the css class name.
        Overrides:
        getCssPrefix in class AbstractAppTransform
        Returns:
        the prefix for the css class name

      • generateJavaScriptForDragAndDrop

        protected void generateJavaScriptForDragAndDrop​(MarkupOutput out,
                                                ReportBean rb)
        Deprecated.
        This method has been deprecated and will be removed in future versions of the product.
        Generates the javascript used to initialize the drilling when using incremental fetch.
        Parameters:
        out - MarkupOutput to generate the HTML.
        rb - ReportBean being transformed (ignored, always uses the bean passed to the initializeTransform method).

      • getGridCell

        protected ReportGridDisplayCell getGridCell​(java.lang.String className)
        Get the cell instance for the given cell class name. Note: This method has been refactored since 9.0.1 for the purpose of cell reuse.
        Since:
        MicroStrategy Web 7.5.1

      • getGridGenericCell

        protected ReportGridCell getGridGenericCell()
        Since:
        MicroStrategy Web 7.5.2