public class

PrintTransform

extends AbstractAppTransform
java.lang.Object
   ↳ com.microstrategy.web.transform.AbstractTransform
     ↳ com.microstrategy.web.transform.AbstractLayoutTransform
       ↳ com.microstrategy.web.app.transforms.AbstractAppTransform
         ↳ com.microstrategy.web.app.transforms.PrintTransform

Class Overview

PrintTransform is the class that generates the printable version of the report.

Summary

[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
protected FormalParameter countPreviousBlockPages Determines whether to count the previous block of pages when displaying the page number on the header/footer.
public FormalParameter dpiConversion name for the formal parameter "dpiConversion".
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
PrintTransform()
Default empty constructor.
Public Methods
String getDescription()
Return description for this Transform
Class getSupportedBeanType()
Returns the supported bean type.
void initializeTransform(Transformable data)
Extends initializeTransform.
void renderCoverPage(MarkupOutput mo, ReportBean rb)
Renders the cover page.
void renderFooter(MarkupOutput mo, ReportBean rb)
Renders the page's footer.
void renderGraph(MarkupOutput mo, ReportBean rb)
Renders the report in graph mode by transforming the report bean with the style specified in the styleGraph formal parameter.
void renderGrid(MarkupOutput mo, ReportBean rb)
Renders the report in grid mode by transforming the report bean with the style specified in the styleGrid formal parameter.
void renderHeader(MarkupOutput mo, ReportBean rb)
Renders the page's header.
void renderHtmlBottomDhtmlMode(MarkupOutput mo, ReportBean rb)
Renders the bottom part of the HTML for DHTML mode.
void renderHtmlBottomHtmlMode(MarkupOutput mo)
Renders the bottom part of the HTML for HTML mode.
void renderHtmlTopDhtmlMode(MarkupOutput out, ReportBean rb)
Renders the top section of the HTML for DHTML mode until the definition of the DIV tag that contains the report(s).
void renderHtmlTopHtmlMode(MarkupOutput out, ReportBean rb)
Renders the top section of the HTML on HTML mode until the definition of the BODY tag.
void renderPageHtmlMode(MarkupOutput mo, ReportBean rb, int viewMode)
Renders one HTML page for HTML mode.
void renderShell(MarkupOutput out)

Generates the shell for this Transform.

void renderUserFooter(MarkupOutput mo, ReportBean rb)
Renders the user's footer.
void renderUserHeader(MarkupOutput mo, ReportBean rb)
Renders the user's header.
void transformForRequestSuccessful(MarkupOutput mo)
Transform when the status is "Successful".
[Expand]
Inherited Methods
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.Transform

Fields

protected FormalParameter countPreviousBlockPages

Determines whether to count the previous block of pages when displaying the page number on the header/footer.
If set to false every block of pages will start with page number 1

public FormalParameter dpiConversion

name for the formal parameter "dpiConversion".

Public Constructors

public PrintTransform ()

Default empty constructor.
Initialize formal parameters.

Public Methods

public String getDescription ()

Return description for this Transform

Returns
  • description for this Transform

public Class getSupportedBeanType ()

Returns the supported bean type. This transform supports the PrintBean

Returns
  • the class of the bean supported by this transform.

public void initializeTransform (Transformable data)

Extends initializeTransform. Initializes the print bean.

Parameters
data the bean to transform.

public void renderCoverPage (MarkupOutput mo, ReportBean rb)

Renders the cover page.
The cover page has information like: Total number of rows/columns and filter details. It also includes header and footer.

Parameters
mo the output object
rb ReportBean to print

public void renderFooter (MarkupOutput mo, ReportBean rb)

Renders the page's footer.

Parameters
mo the output object
rb ReportBean to print

public void renderGraph (MarkupOutput mo, ReportBean rb)

Renders the report in graph mode by transforming the report bean with the style specified in the styleGraph formal parameter.

Parameters
mo the output object
rb ReportBean to print

public void renderGrid (MarkupOutput mo, ReportBean rb)

Renders the report in grid mode by transforming the report bean with the style specified in the styleGrid formal parameter.

Parameters
mo the output object
rb ReportBean to print

public void renderHeader (MarkupOutput mo, ReportBean rb)

Renders the page's header.

Parameters
mo the output object
rb ReportBean to print

public void renderHtmlBottomDhtmlMode (MarkupOutput mo, ReportBean rb)

Renders the bottom part of the HTML for DHTML mode.
Closes the DIV tag that contains the report(s) and adds the DIV tags for Header, Footer and Cover Page.
Also adds the Parameters needed for the DHTML printing component.
Finally, closes the BODY and HTML tag.

Parameters
mo the output object
rb ReportBean to print

public void renderHtmlBottomHtmlMode (MarkupOutput mo)

Renders the bottom part of the HTML for HTML mode.
Closes the HTML and BODY tags.

Parameters
mo the output object

public void renderHtmlTopDhtmlMode (MarkupOutput out, ReportBean rb)

Renders the top section of the HTML for DHTML mode until the definition of the DIV tag that contains the report(s).
Adds META tag and CSS/JavaScript includes on the HEAD section.

Parameters
out the output object
rb ReportBean to print

public void renderHtmlTopHtmlMode (MarkupOutput out, ReportBean rb)

Renders the top section of the HTML on HTML mode until the definition of the BODY tag.
Adds META tag and CSS includes on the HEAD section.

Parameters
out the output object
rb ReportBean to print

public void renderPageHtmlMode (MarkupOutput mo, ReportBean rb, int viewMode)

Renders one HTML page for HTML mode.

Parameters
mo the output object
rb ReportBean to print
viewMode a value from EnumWebReportViewMode

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 renderUserFooter (MarkupOutput mo, ReportBean rb)

Renders the user's footer.

Parameters
mo the output object
rb ReportBean to print

public void renderUserHeader (MarkupOutput mo, ReportBean rb)

Renders the user's header.

Parameters
mo the output object
rb ReportBean to print

public void transformForRequestSuccessful (MarkupOutput mo)

Transform when the status is "Successful".

Parameters
mo the output object