public class

ReportSavePropertiesTransform

extends AbstractReportTransform
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.ReportSavePropertiesTransform

Class Overview

ReportSavePropertiesTransform is the class that generates the output for a Report to be exported.
Please note this transform generates a form which will be submitted automatically after displayed,
therefore it is required the bean is transformed last in the page so any previous HTML/Javascript code
generated by other beans on the page is executed first.

Summary

[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
protected FormalParameter addFileNameToURL Determines whether to add the file name at the end of the URL.
protected FormalParameter allowCloseWindow Formal parameter that displays special HTML to allow users the possiblity to close the window where this transform will be rendered
protected FormalParameter eventToForwardTo This is the name of the event to redirect to after updating the report page state.
protected FormalParameter reloadPageName Defines the name of the Parent Page to reload after saving Properties on the options page (used for HTML mode) Default value is "report" Allowed values - String value.
protected FormalParameter setEventArguments Defines if the arguments of the event to forward to should be set or not.
protected FormalParameter useURLRedirect Determines whether to use a fake URL to avoid a problem with IE having two excel files open at the same time inside the browser.
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractReportTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
ReportSavePropertiesTransform()
Default empty constructor.
Public Methods
String getDescription()
Return description for this Transform
WebEvent getExecuteReportEvent()
This method is deprecated. use getReloadPageEvent() instead.
WebEvent getReloadPageEvent()
Return the event to reload the parent page.
void initializeTransform(Transformable data)
This method initialize the private and protected fields of the transform.
void renderShell(MarkupOutput out)
Generates the shell for this Transform
void transformForRequestProcessing(MarkupOutput mo)
Generates the output when the bean's status is WebBeanRequestProcessing.
void transformForRequestSuccessful(MarkupOutput mo)
Transform when the status is "Successful".
Protected Methods
String getFormActionName()
String getSuggestedFileName()
void renderCloseWindowLink(Tag div)
Renders the anchor that displays the "Close window" message.
[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.Transform

Fields

protected FormalParameter addFileNameToURL

Determines whether to add the file name at the end of the URL.
This is added to aid the browser on choosing a file name when a PDF or Excel file is saved when displayed embeded in the browser.
The file name is added in the form:
...mstrWeb?n=/FileName.pdf

protected FormalParameter allowCloseWindow

Formal parameter that displays special HTML to allow users the possiblity to close the window where this transform will be rendered

protected FormalParameter eventToForwardTo

This is the name of the event to redirect to after updating the report page state.
Allowed Values: integer values representing WebEvent. It shall be defined in appBeanEvents.xml or mdBeanEvents.xml.

protected FormalParameter reloadPageName

Defines the name of the Parent Page to reload after saving Properties on the options page (used for HTML mode) Default value is "report" Allowed values - String value. Should be a page name.

protected FormalParameter setEventArguments

Defines if the arguments of the event to forward to should be set or not.
Default is true, to be set to false when only passing the bean state is required.
Allowed Values: TRUE/FALSE.

protected FormalParameter useURLRedirect

Determines whether to use a fake URL to avoid a problem with IE having two excel files open at the same time inside the browser.
The fake URL has the following format:

  • for aspx:"Microstrategy/asp/number.exp.aspx"
  • for jsp: "Microstrategy/export/number"
    where the number is a unique identifier.
    Internally we will redirect to the appropiate ASP/servlet.

  • Public Constructors

    public ReportSavePropertiesTransform ()

    Default empty constructor.
    Initialize formal parameters.

    Public Methods

    public String getDescription ()

    Return description for this Transform

    Returns
    • description for this Transform

    public WebEvent getExecuteReportEvent ()

    This method is deprecated.
    use getReloadPageEvent() instead.

    Return the event to execute a report.
    Used in HTML to refresh the Report page after printing or exporting to PDF.

    Returns
    • WebEvent the event to execute a report.

    public WebEvent getReloadPageEvent ()

    Return the event to reload the parent page.
    Used in HTML to refresh the parent page after printing or exporting to PDF.

    Returns
    • WebEvent the event to execute a report.

    public void initializeTransform (Transformable data)

    This method initialize the private and protected fields of the transform. After calling the initializeTransform on super, it calls initializeProperties if the XMLStatus of the reportBean is WebBeanRequestSuccessful

    Parameters
    data the bean to transform.

    public void renderShell (MarkupOutput out)

    Generates the shell for this Transform

    Parameters
    out MarkupOutput the markup output

    public void transformForRequestProcessing (MarkupOutput mo)

    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
    mo output by this transform

    public void transformForRequestSuccessful (MarkupOutput mo)

    Transform when the status is "Successful".

    Parameters
    mo output by this transform

    Protected Methods

    protected String getFormActionName ()

    protected String getSuggestedFileName ()

    protected void renderCloseWindowLink (Tag div)

    Renders the anchor that displays the "Close window" message.

    Parameters
    div the DIV tag where the anchor tag is rendered.