public class

RWSavePropertiesTransform

extends AbstractRWTransform
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.AbstractRWTransform
             ↳ com.microstrategy.web.app.transforms.RWSavePropertiesTransform

Class Overview

RWSavePropertiesTransform is the class that generates the output for a Report Writing document 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 eventToForwardTo This is the name of the event to redirect to after updating the report page state.
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.AbstractRWTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
RWSavePropertiesTransform()
Default empty constructor.
Public Methods
boolean canTransform(Transformable data)
whether the data is transformable.
WebEvent getCancelEvent()
String getDescription()
Return description for this Transform
void renderShell(MarkupOutput out)

Generates the shell for this Transform.

void transformForRequestInError(MarkupOutput mo)
Transform when the status is "InError".
void transformForRequestSuccessful(MarkupOutput mo)
Transform when the status is "Successful".
Protected Methods
String getDisplayableObjectName()
String getFormActionName()
String getFormMethod()
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.AbstractRWTransform
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 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 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 RWSavePropertiesTransform ()

    Default empty constructor.
    Initialize formal parameters.

    Public Methods

    public boolean canTransform (Transformable data)

    whether the data is transformable.

    Parameters
    data the data
    Returns
    • whether the data is transformable

    public WebEvent getCancelEvent ()

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

    public String getDescription ()

    Return description for this Transform

    Returns
    • description for this 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)

    Transform when the status is "InError".

    Parameters
    mo output by this transform DE47839, if error occures when rendering rwframe bean, rwb will be rendered by this transform and display related error messages

    public void transformForRequestSuccessful (MarkupOutput mo)

    Transform when the status is "Successful".

    Parameters
    mo output by this transform

    Protected Methods

    protected String getDisplayableObjectName ()

    protected String getFormActionName ()

    protected String getFormMethod ()

    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.