AbstractReportGridTransform

Note: for the purpose of cell reuse.

The full image name for remove button.
It includeds the image folder path.

The full image name for shift-to-down pivot button.
It includeds the image folder path.

The full image name for shift-to-left pivot button.
It includeds the image folder path.

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.

The full image name for shift-to-right pivot button.
It includeds the image folder path.

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.

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.

The full image name for shift-to-up pivot button.
It includeds the image folder path.

The full image name for shift-to-pageby pivot button.
It includeds the image folder path.

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.

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.

Whether to add the number formatting on metric values.

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

It is used to indicate the name and location of the properties file containing the definition of the grid classes to use.

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.

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.

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.

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.

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.

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.

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.

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.

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.

This is the flag used in the transform to specify whether to enable context menu functionality.
Allowed Values: TRUE/FALSE.

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

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

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

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

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

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.

This is the substring that when found in the cell will be replaced by a break (<br>) tag.
Allowed Values: String values.

It is used in the transform to specify whether to enable context menu functionality.
Allowed Values: TRUE/FALSE.

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.

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.

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

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.

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

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

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

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

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

default no-args constructor.

initialize the images for the transform.

Extends initializeProperties by invoking initializeTranformContext

Extends initializeTransform by initiliazing the grid cell classes by calling initializeCellClasses

Generates the javascript used to initialize the drilling when using incremental fetch.

Get the prefix for the css class name.

get the design mode of the report.

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.

Reads the configuration with the cell classes and caches its content, then it calls setGridCellClass for each different cell type.

whether context menu feature is enabled.

whether drag and drop feature is enabled.

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");
 

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
 

whether to display the formatting RMC (right mouse click context menu).

whether to display the pivot buttons.

whether to display the pivot RMC (right mouse click context menu).

whether to display the remove buttons.

whether to display the remove RMC (right mouse click context menu).

whether to display the rename RMC (right mouse click context menu).