public class

RWExportTransform

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

Class Overview

The RWExportTransform retrieves the binary data from the RWInstance and appends it to the markup output. Assumes that the execution mode has been set on the RWBean It also sets the content type (i.e. "application/pdf") accordingly, depending on the value of the contentType formal parameter or it obtains it from the ExportFormat that matches the view mode and bean type.

Summary

[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
protected FormalParameter _contentType Defines the content type of the MarkupOutput.
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractExportTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
RWExportTransform()
Default no arguments constructor.
Public Methods
String getDescription()
Class getSupportedBeanType()
Returns the supported bean type.
void initializeTransform(Transformable data)

This method initialize the private and protected fields of the transform, such as width and height.

void renderShell(MarkupOutput out)

Generates the shell for this Transform.

void transformForRequestSuccessful(MarkupOutput out)
Generates the output when the bean's status is WebBeanRequestSuccessful.
Protected Methods
ExportBeanHelper getExportBeanHelper()
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.AbstractExportTransform
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 _contentType

Defines the content type of the MarkupOutput.
This should be a valid browser content type for the PDF Content.
Default value: application/pdf

Public Constructors

public RWExportTransform ()

Default no arguments constructor. Initialize Formal Parameters.

Public Methods

public String getDescription ()

public Class getSupportedBeanType ()

Returns the supported bean type. This abstract Transform supports all WebComponents so every sub-class should override this method to return the class of the Bean the Transform is expecting, for example:

 public class CustomReportClass extends AbstractAppTransform {

    public Class getSupportedBeanType() {
        //This Transform is expected to work only with a ReportBean,
        //therefore this method needs to return this class:
        return ReportBean.class;
    }

 }
 

Returns
  • a root class/interface supported by this transform.

public void initializeTransform (Transformable data)

This method initialize the private and protected fields of the transform, such as width and height. It also invokes the initializeWebComponent, initializeImages and initializeCss methods.

This method is automatically called from the transform method. Transforms which would like to invoke other methods in this instance directly (for example, to invoke some render methods), need first to call this method to guarantee that the Transform is ready to generate output.

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 transformForRequestSuccessful (MarkupOutput out)

Generates the output when the bean's status is WebBeanRequestSuccessful. This is the main entry point to generate the output for those Transforms that just want to render the "regular" bean case.
This is an abstract method. All classes need to implement it.

Parameters
out output by this transform

Protected Methods

protected ExportBeanHelper getExportBeanHelper ()