public class

PDFTransform

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.PDFTransform

Class Overview

PDFTransform is the class that generates the PDF output for a PDFBean. It expects the PDFBean to contain a report bean.

Summary

[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
protected FormalParameter imageNotFoundImage This field is deprecated. This formal parameter is not used anymore. The PDF is now generated by the Intelligence Server.
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
PDFTransform()
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 by invoking checkDesignMode() and initializeProperties()
void renderShell(MarkupOutput out)

Generates the shell for this Transform.

void transformForRequestInError(MarkupOutput mo)
Generates the output when the bean's status is WebBeanRequestEndsInError.
void transformForRequestProcessing(MarkupOutput out)
Transform when the status is Processing.
void transformForRequestSuccessful(MarkupOutput mo)
Transform when the status is "Successful".
Protected Methods
void setContentDisposition()
Sets the content Disposition Header as: "Content-Disposition: report.pdf"
[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 imageNotFoundImage

This field is deprecated.
This formal parameter is not used anymore. The PDF is now generated by the Intelligence Server.

Specifies the image used as a place holder when an image is not found. By default it is a red cross.
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.

Public Constructors

public PDFTransform ()

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 PDFBean

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

public void initializeTransform (Transformable data)

Extends initializeTransform by invoking checkDesignMode() and initializeProperties()

Parameters
data the bean to transform.

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 transformForRequestInError (MarkupOutput mo)

Generates the output when the bean's status is WebBeanRequestEndsInError. This method just calls displayError(MarkupOutput, String, String, Exception) with the title and message based on the error code from the bean's ErrorInfo, as provided by the the getErrorTitle and getErrorMessage methods accordingly.
Transforms that would like to generate customized output based on the error should extend this method.

Parameters
mo output by this transform

public void transformForRequestProcessing (MarkupOutput out)

Transform when the status is Processing.

Parameters
out output by this transform

public void transformForRequestSuccessful (MarkupOutput mo)

Transform when the status is "Successful".

Parameters
mo output by this transform

Protected Methods

protected void setContentDisposition ()

Sets the content Disposition Header as: "Content-Disposition: report.pdf"