public class

ReportExportHTMLTransform

extends AbstractReportTransform
implements LayoutTransform
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.ReportExportHTMLTransform

This class is deprecated.
Please use ReportExportHTMLFormatTransform or ReportExportExcelFormatTransform

Class Overview

ReportExportHTMLTransform is the class that generates the output for a ReportBean in HTML format for exporting. Used for exporting to HTML and exportining to Excel with formatting.

Summary

[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
protected FormalParameter _enableExcelNumFormat This formal parameter determines whether to enable number formatting for Excel.
protected FormalParameter _enableExcelOutline This formal parameter determines whether to export outline reports as outline in Excel.
protected FormalParameter _isExcel This field is deprecated. we now read this value from getExportFormat() and then ask for isExcel()
protected FormalParameter _renderOldStyleFilterDetails This formal parameter determines whether the filter details section is rendered using the old style
Allowed Values: TRUE/FALSE
protected FormalParameter _renderPageByAfterFilterDetails This formal parameter determines whether the page by information is rendered after the filter details section.
protected FormalParameter _styleGraphs This formal parameter determines the style to be used to transform the report bean on graph mode.
protected FormalParameter _styleGrids This formal parameter determines the style to be used to transform the report bean on grid or grid and graph mode.
protected FormalParameter _styleOutlineGrids This formal parameter determines the style to be used to transform the report bean on grids in Outline mode.
protected FormalParameter _stylePageByInfo This formal parameter determines the style to be used to transform the report bean to display the page by information.
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractReportTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
ReportExportHTMLTransform()
Default empty constructor.
Public Methods
Map getAttributesBody()
Gets the list of html attributes for the body tag
Map getAttributesHTML()
Gets the list of html attributes for the html tag
Map getAttributesMainTable()
Gets the list of html attributes for the main table tag
String getDescription()
Return description for this Transform
void initializeProperties()
Initialize some properties for the transform.
void renderCss(MarkupOutput mo)
Render the necessary CSS files
void renderExcelHeader(MarkupOutput mo)
Renders a header to tell Excel to display the headers on top for outline mode reports
void renderFilterDetails(MarkupOutput mo)
Renders the report's filter details.
void renderFooter(MarkupOutput mo)
Renders a footer section that is added at the end of the exported results.
void renderHeader(MarkupOutput mo)
Renders a header section that is added at the top of the exported results.
void renderMetaContentType(MarkupOutput out)
Renders the META tag with the content type
void renderNewLine(MarkupOutput mo)
Renders a new line (empty row)
void renderPageByInfo(MarkupOutput mo, ReportBean rb)
This method is deprecated. use renderPageByInfo(MarkupOutput)
void renderPageByInfo(MarkupOutput mo)
Renders the page by information
void renderReport(MarkupOutput mo, ReportBean rb, ExportBean eb)
This method is deprecated. use renderReport(MarkupOutput)
void renderReport(MarkupOutput mo)
Renders the report section
void renderReport(MarkupOutput mo, ReportBean rb, ExportBean eb, boolean isOldStyle)
This method is deprecated. use renderReport(MarkupOutput)
void renderReportName(MarkupOutput mo)
Renders the report name
void renderReportName(String reportName, MarkupOutput mo)
This method is deprecated. use renderReportName(MarkupOutput)
void renderReportNameForTitle(MarkupOutput mo)
Renders the report name for the page's title
void renderShell(MarkupOutput out)

Generates the shell for this Transform.

void transformForRequestSuccessful(MarkupOutput mo)
Transform when the status is "Successful".
Protected Methods
String cleanTextForExport(String text)
This methods cleans a string to be displayed in Excel.
TransformInstance getPageByTransform(ReportBean rb)
TransformInstance getReportGraphTransform(ViewBean vb)
TransformInstance getReportGridTransform(ViewBean vb)
TransformInstance getReportOutlineGridTransform(ViewBean vb)
[Expand]
Inherited Methods
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.transform.LayoutTransform
From interface com.microstrategy.web.transform.Transform

Fields

protected FormalParameter _enableExcelNumFormat

This formal parameter determines whether to enable number formatting for Excel. Allowed Values: TRUE/FALSE.

protected FormalParameter _enableExcelOutline

This formal parameter determines whether to export outline reports as outline in Excel. This feature depends on the getRawDataEnabled() property of the ExportBean Allowed Values: TRUE/FALSE.

protected FormalParameter _isExcel

This field is deprecated.
we now read this value from getExportFormat() and then ask for isExcel()

This formal parameter determines whether the application to Export to is Excel.
Allowed Values: TRUE/FALSE.

protected FormalParameter _renderOldStyleFilterDetails

This formal parameter determines whether the filter details section is rendered using the old style
Allowed Values: TRUE/FALSE

protected FormalParameter _renderPageByAfterFilterDetails

This formal parameter determines whether the page by information is rendered after the filter details section.
Allowed Values: TRUE/FALSE

protected FormalParameter _styleGraphs

This formal parameter determines the style to be used to transform the report bean on graph mode.
Allowed Values: any report style name from StyleCatalog.xml file.

protected FormalParameter _styleGrids

This formal parameter determines the style to be used to transform the report bean on grid or grid and graph mode.
Allowed Values: any report style name from StyleCatalog.xml file.

protected FormalParameter _styleOutlineGrids

This formal parameter determines the style to be used to transform the report bean on grids in Outline mode.
Allowed Values: any report style name from StyleCatalog.xml file.

protected FormalParameter _stylePageByInfo

This formal parameter determines the style to be used to transform the report bean to display the page by information.
Allowed Values: any report style name from StyleCatalog.xml file.

Public Constructors

public ReportExportHTMLTransform ()

Default empty constructor.
Initialize formal parameters.

Public Methods

public Map getAttributesBody ()

Gets the list of html attributes for the body tag

public Map getAttributesHTML ()

Gets the list of html attributes for the html tag

public Map getAttributesMainTable ()

Gets the list of html attributes for the main table tag

public String getDescription ()

Return description for this Transform

Returns
  • description for this Transform

public void initializeProperties ()

Initialize some properties for the transform.
For example, it may overwrite some formal parameters' values depending on whether the corresponding feature is available.

public void renderCss (MarkupOutput mo)

Render the necessary CSS files

Parameters
mo MarkupOutput

public void renderExcelHeader (MarkupOutput mo)

Renders a header to tell Excel to display the headers on top for outline mode reports

Parameters
mo MarkupOutput

public void renderFilterDetails (MarkupOutput mo)

Renders the report's filter details.

Parameters
mo MarkupOutput

public void renderFooter (MarkupOutput mo)

Renders a footer section that is added at the end of the exported results.
The value of the header is saved as a project property and can be modified under "Preferences > Project Defaults > Project Footer"

Parameters
mo MarkupOutput

public void renderHeader (MarkupOutput mo)

Renders a header section that is added at the top of the exported results.
The value of the header is saved as a project property and can be modified under "Preferences > Project Defaults > Project Header"

Parameters
mo MarkupOutput

public void renderMetaContentType (MarkupOutput out)

Renders the META tag with the content type

Parameters
out MarkupOutput

public void renderNewLine (MarkupOutput mo)

Renders a new line (empty row)

Parameters
mo the output object

public void renderPageByInfo (MarkupOutput mo, ReportBean rb)

This method is deprecated.
use renderPageByInfo(MarkupOutput)

Renders the page by information

Parameters
mo the output object
rb report bean to export

public void renderPageByInfo (MarkupOutput mo)

Renders the page by information

Parameters
mo the output object

public void renderReport (MarkupOutput mo, ReportBean rb, ExportBean eb)

This method is deprecated.
use renderReport(MarkupOutput)

Renders the report section

Parameters
mo the output object
rb Report bean to export
eb Export bean

public void renderReport (MarkupOutput mo)

Renders the report section

Parameters
mo the output object

public void renderReport (MarkupOutput mo, ReportBean rb, ExportBean eb, boolean isOldStyle)

This method is deprecated.
use renderReport(MarkupOutput)

This function renders the report section

Parameters
mo the output object
rb Report bean to export
eb Export bean
isOldStyle Render the report using Old Style

public void renderReportName (MarkupOutput mo)

Renders the report name

public void renderReportName (String reportName, MarkupOutput mo)

This method is deprecated.
use renderReportName(MarkupOutput)

This method renders the report name

Parameters
reportName name of the report
mo the output object

public void renderReportNameForTitle (MarkupOutput mo)

Renders the report name for the page's title

public void renderShell (MarkupOutput out)

Generates the shell for this Transform.

The shell is a <div> tag that automatically surrounds the content generated by the Transform. It's used among other things by the javascript to identify the HTML associated with a bone, and by the iFrame update technology to identify a component in the page.

The attributes to append to this <div> are obtained from the getAttributesShellDiv method; the style from the getStyleShellDiv method.
This method calls renderCssLink and checkStatus to generate the Transform's content.

Parameters
out output by this transform

public void transformForRequestSuccessful (MarkupOutput mo)

Transform when the status is "Successful".

Parameters
mo the output object

Protected Methods

protected String cleanTextForExport (String text)

This methods cleans a string to be displayed in Excel.
Adds a space if the text starts with "=", "+" and "-"

Parameters
text text to clean
Returns
  • cleaned text

protected TransformInstance getPageByTransform (ReportBean rb)

protected TransformInstance getReportGraphTransform (ViewBean vb)

protected TransformInstance getReportGridTransform (ViewBean vb)

protected TransformInstance getReportOutlineGridTransform (ViewBean vb)