public class

ExportTransform

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

Class Overview

This is the main Transform for Exporting.
It will transform the Report Bean with the style specified on the Export Format (set on the Export Bean).

Summary

[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractAppTransform
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
ExportTransform()
Public Methods
String getDescription()
Return description for this Transform
Class getSupportedBeanType()
return the bean type supported by this transform.
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)
Generates the output when the bean's status is WebBeanRequestProcessing.
void transformForRequestSuccessful(MarkupOutput mo)
Transform when the status is "Successful".
Protected Methods
WebEvent getCancelEvent()
void renderProcessingObjectName(MarkupOutput out)
[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

Public Constructors

public ExportTransform ()

Public Methods

public String getDescription ()

Return description for this Transform

Returns
  • description for this Transform

public Class getSupportedBeanType ()

return the bean type supported by this transform.

Returns
  • the bean type

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)

Generates the output when the bean's status is WebBeanRequestProcessing. This is the case when the iServer is still executing the request and a wait page is displayed to the end user.
This method generates the default wait page contents. It calls renderProcessingInfo and renderProcessingButtons.

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 WebEvent getCancelEvent ()

Returns
  • WebEvent instance initialized with the information for cancelling a request

protected void renderProcessingObjectName (MarkupOutput out)