public class

ReportFlashTransform

extends AbstractReportDataVisualizationTransform
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.AbstractReportDataTransform
               ↳ com.microstrategy.web.app.transforms.AbstractReportDataVisualizationTransform
                 ↳ com.microstrategy.web.app.transforms.ReportFlashTransform

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

Constants
int BROWSER_FIREFOX
int BROWSER_INTERNET_EXPLORER
String HIDE_RESIZING_JS
String VISUALIZATIONS_DEFAULT_LOCATION
String VISUALIZATION_XML_ACCESS_METHOD_TASK_URL URL to get the XML using the tasks infrastructure - "CustomURL" flashVar
String VISUALIZATION_XML_ACCESS_METHOD_URL URL to get the XML - "CustomURL" flashVar
String VISUALIZATION_XML_ACCESS_METHOD_XML XML directly - "CustomXML" flashVar
[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractReportDataTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
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 hideResizingJs In this Transform's output we have some bone-based JavaScript Strings.
protected FormalParameter includeBaseURL Adds a FlashVar named "baseURL" that contains a URL that can be used to access MicroStrategy Web from Flash.
protected FormalParameter nodeKeys A list of grid keys to be requested by the Flash code when the visualization is applied to a grid in a document.
protected FormalParameter useJS Whether to use Javascript to render the embeded Flash Object.
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractReportDataVisualizationTransform
From class com.microstrategy.web.app.transforms.AbstractReportDataTransform
From class com.microstrategy.web.app.transforms.AbstractReportTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
ReportFlashTransform()
Default no-args constructor, initializes formal parameters.
Public Methods
static String getVersion(AppContext appContext)
Generate a web version.
void initializeProperties()
Extends initializeProperties by invoking initializeTranformContext
void renderVisualization(MarkupOutput out)
Renders an embeded Flash object tag.
void transformForRequestSuccessful(MarkupOutput out)
Transform when the status is "Successful".
Protected Methods
HashList getFlashVars()
Returns the collection of flashVars to be added to the embedded Flash object.
static void renderEmbededFlashObjectTag(MarkupOutput out, String movie, HashList flashVarsList, String extraFlashVars, String width, String height, AppContext appContext, String beanPath)
Renders an embeded object flash file.
static void renderEmbededFlashObjectTag(MarkupOutput out, String movie, HashList flashVarsList, String extraFlashVars, String width, String height, AppContext appContext, String beanPath, String containerID, boolean useJS, boolean hideResizingJS)
Renders an embeded object flash file.
static void renderEmbededFlashObjectTag(MarkupOutput out, String movie, HashList flashVarsList, String extraFlashVars, String width, String height, AppContext appContext, String beanPath, String containerID, boolean useJS)
static void renderEmbededFlashObjectTag(MarkupOutput out, String movie, HashList flashVarsList, String extraFlashVars, String imgWidth, String imgHeight, int browserType)
This method is deprecated. use renderEmbededFlashObjectTag(MarkupOutput out, String movie, HashList flashVarsList, String extraFlashVars, String width, String height, AppContext appContext, String beanPath)
static void renderEmbededFlashObjectTag(MarkupOutput out, String movie, HashList flashVarsList, String extraFlashVars, String width, String height, AppContext appContext, String beanPath, String containerID)
Renders an embeded object flash file.
void renderEmbededFlashObjectTag(MarkupOutput out)
Renders an embeded object flash file based on the values set on the formal parameters.
void renderJavascript(MarkupOutput out)
This method renders the javascript code that needs to be generated on the server side because its content is dynamic.
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.AbstractReportDataVisualizationTransform
From class com.microstrategy.web.app.transforms.AbstractReportDataTransform
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.app.transforms.ReportDataTransform
From interface com.microstrategy.web.transform.LayoutTransform
From interface com.microstrategy.web.transform.Transform

Constants

public static final int BROWSER_FIREFOX

Constant Value: 2 (0x00000002)

public static final int BROWSER_INTERNET_EXPLORER

Constant Value: 1 (0x00000001)

public static final String HIDE_RESIZING_JS

Constant Value: "hideResizingJs"

public static final String VISUALIZATIONS_DEFAULT_LOCATION

Constant Value: "../VisFramework"

public static final String VISUALIZATION_XML_ACCESS_METHOD_TASK_URL

URL to get the XML using the tasks infrastructure - "CustomURL" flashVar

Constant Value: "2"

public static final String VISUALIZATION_XML_ACCESS_METHOD_URL

URL to get the XML - "CustomURL" flashVar

Constant Value: "1"

public static final String VISUALIZATION_XML_ACCESS_METHOD_XML

XML directly - "CustomXML" flashVar

Constant Value: "0"

Fields

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&name2=value2&name3=value3"

public FormalParameter flashFile

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

protected FormalParameter hideResizingJs

In this Transform's output we have some bone-based JavaScript Strings. These JavaScript are not used for Mojo Modes. So we use this boolean-typed FormalParameter to control whether we show the JavaScript or not.

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 nodeKeys

A list of grid keys to be requested by the Flash code when the visualization is applied to a grid in a document.
This list may have multiple elements if Secondary Data Providers are enabled.
The list is a comma separated list of keys and sliceIDs: "K44:0,W45:1,W46:2"

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 ReportFlashTransform ()

Default no-args constructor, initializes formal parameters.

Public Methods

public static String getVersion (AppContext appContext)

Generate a web version.

Parameters
appContext used to get the active session used to identify web version
Returns
  • web version

public void initializeProperties ()

Extends initializeProperties by invoking initializeTranformContext

public void renderVisualization (MarkupOutput out)

Renders an embeded Flash object tag.

Parameters
out The Markup output

public void transformForRequestSuccessful (MarkupOutput out)

Transform when the status is "Successful". This is the main entry point of the Transform. It will check if a layout-xml has been specified and use it, otherwise it calls renderContent.
After the content has been generated it calls renderJavascript to generate any necessary client-side information.

Parameters
out MarkupOutput to generate the HTML.

Protected Methods

protected HashList 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 static void renderEmbededFlashObjectTag (MarkupOutput out, String movie, HashList flashVarsList, String extraFlashVars, String width, String height, AppContext appContext, String beanPath)

Renders an embeded object flash file.
This can be used when extending this class to embed a flash file different from the one specified by the formal parameter values.

Parameters
out the Markup output
movie the flash movie path
flashVarsList the collection (value-name pair) of flashVars to include
width the width of the movie
height the height of the movie (if "-1", the flash will be resized when loaded on the browser)
appContext the AppContext object (only used when height is set to -1)

protected static void renderEmbededFlashObjectTag (MarkupOutput out, String movie, HashList flashVarsList, String extraFlashVars, String width, String height, AppContext appContext, String beanPath, String containerID, boolean useJS, boolean hideResizingJS)

Renders an embeded object flash file.
This can be used when extending this class to embed a flash file different from the one specified by the formal parameter values.

Parameters
out the Markup output
movie the flash movie path
flashVarsList the collection (value-name pair) of flashVars to include
width the width of the movie
height the height of the movie (if "-1", the flash will be resized when loaded on the browser)
appContext the AppContext object (only used when height is set to -1)
containerID a unique identifier to use for the Div that will contain the FlashPlayer
useJS Whether to use Javascript to render the embeded Flash Object.
hideResizingJS Whether to hide bone-based Javascript to render the embeded Flash Object.

protected static void renderEmbededFlashObjectTag (MarkupOutput out, String movie, HashList flashVarsList, String extraFlashVars, String width, String height, AppContext appContext, String beanPath, String containerID, boolean useJS)

protected static void renderEmbededFlashObjectTag (MarkupOutput out, String movie, HashList flashVarsList, String extraFlashVars, String imgWidth, String imgHeight, int browserType)

This method is deprecated.
use renderEmbededFlashObjectTag(MarkupOutput out, String movie, HashList flashVarsList, String extraFlashVars, String width, String height, AppContext appContext, String beanPath)

Renders an embeded object flash file.
This can be used when extending this class to embed a flash file different from the one specified by the formal parameter values.

Parameters
out the Markup output
movie the flash movie path
flashVarsList the collection (value-name pair) of flashVars to include
imgWidth the width of the movie
imgHeight the height of the movie
browserType for which browser to optimize the output: 1 means InternetExplorer (only <object> tag is generated), 2 means Firefox (only <embed> tag is generated). Any other value generates both tags.

protected static void renderEmbededFlashObjectTag (MarkupOutput out, String movie, HashList flashVarsList, String extraFlashVars, String width, String height, AppContext appContext, String beanPath, String containerID)

Renders an embeded object flash file.
This can be used when extending this class to embed a flash file different from the one specified by the formal parameter values.

Parameters
out the Markup output
movie the flash movie path
flashVarsList the collection (value-name pair) of flashVars to include
width the width of the movie
height the height of the movie (if "-1", the flash will be resized when loaded on the browser)
appContext the AppContext object (only used when height is set to -1)
containerID a unique identifier to use for the Div that will contain the FlashPlayer

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

protected void renderJavascript (MarkupOutput out)

This method renders the javascript code that needs to be generated on the server side because its content is dynamic. In particular this method invokes renderRegisterBone which initializes and registers a grid's bone..

Parameters
out MarkupOutput to generate the HTML.