public class

ReportDesignModeTransformImpl

extends ReportGridTransformImpl
java.lang.Object
   ↳ com.microstrategy.web.transform.AbstractTransform
     ↳ com.microstrategy.web.transform.AbstractLayoutTransform
       ↳ com.microstrategy.web.app.transforms.AbstractAppTransform
         ↳ com.microstrategy.web.app.transforms.AbstractWebBeanTransform
           ↳ com.microstrategy.web.app.transforms.AbstractReportTransform
             ↳ com.microstrategy.web.app.transforms.AbstractReportDataTransform
               ↳ com.microstrategy.web.app.transforms.AbstractReportGridTransform
                 ↳ com.microstrategy.web.app.transforms.ReportGridTransformImpl
                   ↳ com.microstrategy.web.app.transforms.ReportDesignModeTransformImpl

Class Overview

The ReportDesignModeTransformImpl generates a grid visualization of the Report that allows to modify its definition.

The main difference with the ReportGridTransformImpl is that this transform, instead of reading the report's data, it iterates through the Template definition; but it follows the same customization guidelines as its parent class.

Summary

[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.ReportGridTransformImpl
From class com.microstrategy.web.app.transforms.AbstractReportDataTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
protected FormalParameter designModeDummyRowCount It is used in the transform to specify how many dummy rows are displayed in design mode.
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.ReportGridTransformImpl
From class com.microstrategy.web.app.transforms.AbstractReportGridTransform
From class com.microstrategy.web.app.transforms.AbstractReportDataTransform
From class com.microstrategy.web.app.transforms.AbstractReportTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
ReportDesignModeTransformImpl()
default no-args constructor
Public Methods
String getDescription()
Returns a textual description of this transform to be used in WYSIWYG tools.
void initializeProperties()
Extends initializeProperties by invoking initializeTranformContext
boolean isDatamart()
This method always returns false, as this transform is used only in design mode.
boolean isGridEmpty()
This method always returns true, whenever he template is empty
ReportGridCellColHeader newPreviewColHeader(WebTemplateUnit wtu)
Returns a ReportGridCellColHeader populated with the preview unit.
ReportGridCellColHeader newPreviewColHeader(WebAttributeForm waf)
Returns a ReportGridCellColHeader populated with the preview unit.
ReportGridCellMetricValue newPreviewMetricValue(WebTemplateMetric wtm)
Returns a ReportGridCellMetricValue populated with the preview unit.
ReportGridCellRowHeader newPreviewRowHeader()
Creates and returns a new ReportGridCellRowHeader with a blank text.
ReportGridCellRowHeader newPreviewRowHeader(WebTemplateUnit wtu)
Returns a ReportGridCellRowHeader populated with the preview unit.
ReportGridCellRowHeader newPreviewRowHeader(WebAttributeForm waf)
Returns a ReportGridCellRowHeader populated with the preview unit.
ReportGridCellRowHeader newPreviewRowHeader(WebTemplateUnit wtu, WebAttributeForm waf, boolean showSubTitleOnly)
Returns a ReportGridCellRowHeader populated with the preview unit.
void renderEmptyGrid(MarkupOutput out)
It renders the output when the report grid is empty.
void renderGrid(MarkupOutput out)
Generates the grid.
void renderGridData(MarkupOutput out)
Generates the data content of the grid, this includes both Row headers and metric values.
void renderGridHeaders(MarkupOutput out)
Generates the top part of the report, that is, the row titles, column titles and column headers.
void renderRowAxis(MarkupOutput out, ReportBean rb, WebAxis rowAxis)
Display row axis for the template
void renderRowAxis(MarkupOutput out, ReportBean rb, WebAxis rowAxis, boolean useEmptyRowTitle)
Display row axis for the template
Protected Methods
WebEvent getApplyChangesEvent()
Map getAttributesBoneDiv()
Generates the list of attributes used by a div surrounding the grid.
Map getAttributesForm()
Map getAttributesGridTable()
Generates the list of attributes used by the grid's table.
Map getAttributesMainTable()
String getCssGrid()
Returns the css class to be used by the grid table.
boolean isDesignMode()
This method always returns true, as this transform is used only in design mode.
void setBoneProperties(JsonGenerator boneProps)
Sets the necessary properties to the bone assigned to this transform (based on the scriptClass formal parameter)
Usually called by renderRegisterBone(MarkupOutput)
Can be overwritten to add or modify bone properties.
boolean showEmptyAxis()
boolean showEmptyAxisCssLink()
boolean showEmptyColAxis()
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.ReportGridTransformImpl
From class com.microstrategy.web.app.transforms.AbstractReportGridTransform
From class com.microstrategy.web.app.transforms.AbstractReportDataTransform
From class com.microstrategy.web.app.transforms.AbstractReportTransform
From class com.microstrategy.web.app.transforms.AbstractWebBeanTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
From class com.microstrategy.web.transform.AbstractLayoutTransform
From class com.microstrategy.web.transform.AbstractTransform
From class java.lang.Object
From interface com.microstrategy.web.app.transforms.AppTransform
From interface com.microstrategy.web.app.transforms.ReportDataTransform
From interface com.microstrategy.web.transform.LayoutTransform
From interface com.microstrategy.web.transform.Transform

Fields

protected FormalParameter designModeDummyRowCount

It is used in the transform to specify how many dummy rows are displayed in design mode.
Allowed Values: positive integer values.

Public Constructors

public ReportDesignModeTransformImpl ()

default no-args constructor

Public Methods

public String getDescription ()

Returns a textual description of this transform to be used in WYSIWYG tools.

Returns
  • "The ReportGridTransformImpl generates the grid visualization of the data returned by a Report.";

public void initializeProperties ()

Extends initializeProperties by invoking initializeTranformContext

public boolean isDatamart ()

This method always returns false, as this transform is used only in design mode.

Returns
  • false

public boolean isGridEmpty ()

This method always returns true, whenever he template is empty

Returns
  • true if the template is empty.

public ReportGridCellColHeader newPreviewColHeader (WebTemplateUnit wtu)

Returns a ReportGridCellColHeader populated with the preview unit.

public ReportGridCellColHeader newPreviewColHeader (WebAttributeForm waf)

Returns a ReportGridCellColHeader populated with the preview unit.

public ReportGridCellMetricValue newPreviewMetricValue (WebTemplateMetric wtm)

Returns a ReportGridCellMetricValue populated with the preview unit.

public ReportGridCellRowHeader newPreviewRowHeader ()

Creates and returns a new ReportGridCellRowHeader with a blank text.

public ReportGridCellRowHeader newPreviewRowHeader (WebTemplateUnit wtu)

Returns a ReportGridCellRowHeader populated with the preview unit.

public ReportGridCellRowHeader newPreviewRowHeader (WebAttributeForm waf)

Returns a ReportGridCellRowHeader populated with the preview unit.

public ReportGridCellRowHeader newPreviewRowHeader (WebTemplateUnit wtu, WebAttributeForm waf, boolean showSubTitleOnly)

Returns a ReportGridCellRowHeader populated with the preview unit. For TQMS 569210

public void renderEmptyGrid (MarkupOutput out)

It renders the output when the report grid is empty.
For design mode, we always just call renderGrid

Parameters
out MarkupOutput to generate the HTML.

public void renderGrid (MarkupOutput out)

Generates the grid. In design mode, the grid needs to be enclosed in a form that allows to perform manipulations in HTML mode.

Parameters
out MarkupOutput to generate the HTML.

public void renderGridData (MarkupOutput out)

Generates the data content of the grid, this includes both Row headers and metric values.

Parameters
out MarkupOutput to generate the HTML.

public void renderGridHeaders (MarkupOutput out)

Generates the top part of the report, that is, the row titles, column titles and column headers.

Parameters
out MarkupOutput to generate the HTML.

public void renderRowAxis (MarkupOutput out, ReportBean rb, WebAxis rowAxis)

Display row axis for the template

Parameters
out MarkupOutput to generate the HTML.
rb ReportBean being transformed (ignored, always uses the bean passed to the initializeTransform method).
rowAxis the corresponding WebAxis

public void renderRowAxis (MarkupOutput out, ReportBean rb, WebAxis rowAxis, boolean useEmptyRowTitle)

Display row axis for the template

Parameters
out MarkupOutput to generate the HTML.
rb ReportBean being transformed (ignored, always uses the bean passed to the initializeTransform method).
rowAxis the corresponding WebAxis

Protected Methods

protected WebEvent getApplyChangesEvent ()

Returns
  • apply changes event

protected Map getAttributesBoneDiv ()

Generates the list of attributes used by a div surrounding the grid. This div includes the information used by grid's bone, such as scriptclass and subtype (sty).

Returns
  • Map with the Attributes to use

protected Map getAttributesForm ()

protected Map getAttributesGridTable ()

Generates the list of attributes used by the grid's table. This method may be extended to include extra/custom attributes.

Returns
  • Map with the Attributes to use

protected Map getAttributesMainTable ()

Returns
  • a map with border -> 0, cellspacing -> 0, cellpadding-> 0 and if its fit to contents width -> 100%

protected String getCssGrid ()

Returns the css class to be used by the grid table.

protected boolean isDesignMode ()

This method always returns true, as this transform is used only in design mode.

Returns
  • true

protected void setBoneProperties (JsonGenerator boneProps)

Sets the necessary properties to the bone assigned to this transform (based on the scriptClass formal parameter)
Usually called by renderRegisterBone(MarkupOutput)
Can be overwritten to add or modify bone properties.

Parameters
boneProps the JsonGenerator object that contains the collection of bone properties.

protected boolean showEmptyAxis ()

protected boolean showEmptyAxisCssLink ()

protected boolean showEmptyColAxis ()