public class

RWFlashTransform

extends AbstractRWDataVisualizationTransform
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.RWLayoutTransform
               ↳ com.microstrategy.web.app.transforms.AbstractRWDataVisualizationTransform
                 ↳ com.microstrategy.web.app.transforms.RWFlashTransform

Class Overview

This Transform generates an embeded flash object tag. It can include the report XML for the Flash to use or a URL that can be used to obtain the report XML.

Summary

[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.RWLayoutTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
protected FormalParameter containerHeight Specifies the height (in any measure accepted by the web-browser) of the element rendered by this transform.
protected FormalParameter containerWidth Specifies the width (in any measure accepted by the web-browser) of the element rendered by this transform.
protected FormalParameter extraFlashVars This field is deprecated. to add extra flashvars please extend Transform and overwrite getFlashVars()
public FormalParameter flashFile The name of the flash SWF file to include.
protected FormalParameter includeBaseURL Adds a FlashVar named "baseURL" that contains a URL that can be used to access MicroStrategy Web from Flash.
protected FormalParameter useJS Whether to use Javascript to render the embeded Flash Object.
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractRWDataVisualizationTransform
From class com.microstrategy.web.app.transforms.RWLayoutTransform
From class com.microstrategy.web.app.transforms.AbstractRWTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
RWFlashTransform()
Default no-args constructor, initializes formal parameters.
Public Methods
void initializeTransform(Transformable data)
Extends initializeTransform(com.microstrategy.web.beans.Transformable) by obtaining a reference to the data
void renderVisualization(MarkupOutput out)
Renders an embeded Flash object tag.
Protected Methods
HashList<String, String> getFlashVars()
Returns the collection of flashVars to be added to the embedded Flash object.
void renderEmbededFlashObjectTag(MarkupOutput out)
Renders an embeded object flash file based on the values set on the formal parameters.
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.AbstractRWDataVisualizationTransform
From class com.microstrategy.web.app.transforms.RWLayoutTransform
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.beans.RWBeanVisitor
From interface com.microstrategy.web.beans.RWBeanVisitor2
From interface com.microstrategy.web.transform.Transform

Fields

protected FormalParameter containerHeight

Specifies the height (in any measure accepted by the web-browser) of the element rendered by this transform. Its value can be specified on the request as "containerHeight" and this will overwrite the existing value.

protected FormalParameter containerWidth

Specifies the width (in any measure accepted by the web-browser) of the element rendered by this transform. Its value can be specified on the request as "containerWidth" and this will overwrite the existing value.

protected FormalParameter extraFlashVars

This field is deprecated.
to add extra flashvars please extend Transform and overwrite getFlashVars()

The value of this parameter specifies a collection of extra flashVar variables that will be passed to the embedded flash object. These variables consist of name/value pairs in the following format:
"name1=value1&name2=value2&name3=value3"
If set through the styleCatalog.xml, the '&' must be encoded, so it should be "name1=value1&amp;name2=value2&amp;name3=value3"

public FormalParameter flashFile

The name of the flash SWF file to include. Allowed values: String values

protected FormalParameter includeBaseURL

Adds a FlashVar named "baseURL" that contains a URL that can be used to access MicroStrategy Web from Flash.
This link includes the session manager state which is used to restore the session

protected FormalParameter useJS

Whether to use Javascript to render the embeded Flash Object.
Javascript is used validate that the proper version of Flash is installed on the client.
Its value can be specified on the request as "useJS" and this will overwrite the existing value.

Public Constructors

public RWFlashTransform ()

Default no-args constructor, initializes formal parameters.

Public Methods

public void initializeTransform (Transformable data)

Extends initializeTransform(com.microstrategy.web.beans.Transformable) by obtaining a reference to the data

Parameters
data The bean to transform.

public void renderVisualization (MarkupOutput out)

Renders an embeded Flash object tag.

Parameters
out The markup output

Protected Methods

protected HashList<String, String> getFlashVars ()

Returns the collection of flashVars to be added to the embedded Flash object. Based on the value of WebPreferenceVisualizationsXMLAccessMethod, it adds "customURL" or "customXML" with their corresponding values.
It may also add a baseURL if specified in the formal parameter.
This method can be overritten to add more flashVars.

Returns
  • the collection of flashVars to be added to the embedded Flash object

protected void renderEmbededFlashObjectTag (MarkupOutput out)

Renders an embeded object flash file based on the values set on the formal parameters.

Parameters
out the Markup output