public class

RWFlashDashboardTransform

extends AbstractWebBeanTransform
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.RWFlashDashboardTransform

Summary

Constants
String FP_CUSTOM_JS_FEATURES Constant specifying any extra features that will be send down to the client.
String FP_EXTRA_FLASH_VARS
String FP_FLASH_SOURCE Constant for the name of the flash source file Formal Parameter.
String FP_FLASH_SOURCE_DB Constant for the name of the flash source file Formal Parameter for double byte locales.
String FP_IS_OVI Constant specifying flag indicating this is OVI page.
[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
protected FormalParameter customJavaScriptFeatures Indicates a comma separated list of the extra features that will be send down to the client
public FormalParameter extraFlashVars
public FormalParameter flashSource Indicates the name of the flash source file.
public FormalParameter flashSourceDB Indicates the name of the flash source file for double byte locales.
protected FormalParameter isOVI
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
RWFlashDashboardTransform()
Public Methods
String getDescription()
Returns the textual description of the transform
Class getSupportedBeanType()
Returns the BeanType supported by this bean.
void initializeTransform(Transformable data)
This method initialize the private and protected fields of the transform.
void renderFlashObject(MarkupOutput out)
void transformForRequestSuccessful(MarkupOutput out)
Generates the output when the bean's status is WebBeanRequestSuccessful.
Protected Methods
JsonGenerator getFeatures()
HashList getFlashVars()
String getScriptClass()

Returns the name of the javaScript class (if any) to be associated with the component.

void renderRegisterBone(MarkupOutput out)
If a scriptClass is specified, this method registers the corresponding javascript bone for this component.
void setBoneProperties(JsonGenerator bonePropertiesGenerator)
Sets the necessary properties to the bone assigned to this transform (based on the scriptClass formal parameter)
Usually called by renderRegisterBone(MarkupOutput)
Can be overwritten to add or modify bone properties.
[Expand]
Inherited Methods
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

Constants

public static final String FP_CUSTOM_JS_FEATURES

Constant specifying any extra features that will be send down to the client.

Constant Value: "customJavaScriptFeatures"

public static final String FP_EXTRA_FLASH_VARS

Constant Value: "extraFlashVars"

public static final String FP_FLASH_SOURCE

Constant for the name of the flash source file Formal Parameter.

Constant Value: "flashSource"

public static final String FP_FLASH_SOURCE_DB

Constant for the name of the flash source file Formal Parameter for double byte locales.

Constant Value: "flashSourceDB"

public static final String FP_IS_OVI

Constant specifying flag indicating this is OVI page.

Constant Value: "isOVI"

Fields

protected FormalParameter customJavaScriptFeatures

Indicates a comma separated list of the extra features that will be send down to the client

public FormalParameter extraFlashVars

public FormalParameter flashSource

Indicates the name of the flash source file.

public FormalParameter flashSourceDB

Indicates the name of the flash source file for double byte locales.

protected FormalParameter isOVI

Public Constructors

public RWFlashDashboardTransform ()

Public Methods

public String getDescription ()

Returns the textual description of the transform

Returns
  • the description of the transform

public Class getSupportedBeanType ()

Returns the BeanType supported by this bean. (non-Javadoc)

Returns
  • RWBean.class

public void initializeTransform (Transformable data)

This method initialize the private and protected fields of the transform.

Parameters
data bean that will be transformed

public void renderFlashObject (MarkupOutput out)

public void transformForRequestSuccessful (MarkupOutput out)

Generates the output when the bean's status is WebBeanRequestSuccessful. This is the main entry point to generate the output for those Transforms that just want to render the "regular" bean case.
This is an abstract method. All classes need to implement it.

Parameters
out output by this transform

Protected Methods

protected JsonGenerator getFeatures ()

protected HashList getFlashVars ()

protected String getScriptClass ()

Returns the name of the javaScript class (if any) to be associated with the component. When the scriptClass is specified, a bone is registered on the page for this component.

A bone is the corresponding concept of a bean in Microstrategy's javascript environment.
By default, thie methods returns an empty string. Transform which does have an associated bone needs to override this method.

Returns
  • String representing the name of a javaScript class

protected void renderRegisterBone (MarkupOutput out)

If a scriptClass is specified, this method registers the corresponding javascript bone for this component.

Parameters
out MarkupOutput whether the output should be rendered.
See Also

protected void setBoneProperties (JsonGenerator bonePropertiesGenerator)

Sets the necessary properties to the bone assigned to this transform (based on the scriptClass formal parameter)
Usually called by renderRegisterBone(MarkupOutput)
Can be overwritten to add or modify bone properties.

Parameters
bonePropertiesGenerator the JsonGenerator object that contains the collection of bone properties.