public class

VisualizationsEditorTransform

extends AbstractEditorTransform
implements LayoutTransform
java.lang.Object
   ↳ com.microstrategy.web.transform.AbstractTransform
     ↳ com.microstrategy.web.transform.AbstractLayoutTransform
       ↳ com.microstrategy.web.app.transforms.AbstractAppTransform
         ↳ com.microstrategy.web.app.transforms.AbstractEditorTransform
           ↳ com.microstrategy.web.app.transforms.VisualizationsEditorTransform

Class Overview

This transform used by the visualizations editor bean.
Allows the user to enable visualizations and specify a list of visualizations for reports and report writer documents.

Summary

Constants
String FP_SHOW_LIST_NAME_ON_CART Name of the showListNameOnCart formal parameter
[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractEditorTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
public FormalParameter showListNameOnCart Indicates whether to show the visualizations list name ('FLASH') as a title on the shopping cart
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractEditorTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
VisualizationsEditorTransform()
Public Methods
String getDescription()
Returns a textual description of the transform.
Class getSupportedBeanType()
Returns the supported bean type.
void initializeTransform(Transformable data)
This method initializes the private and protected fields of the transform.
void renderCart(MarkupOutput out)
Renders the Shopping Cart with the available and selected visualizations.
void renderEditorContents(MarkupOutput out)
Generates the graphical output for the Editor
void renderIPhoneIPadOptions(MarkupOutput out)
This method is deprecated. use renderMobileOptions(MarkupOutput)
void renderMobileOptions(MarkupOutput out)
Renders the mobile options (iPhone, iPad and Android)
void renderSecondaryDataSources(MarkupOutput out)
void renderSetVisualizationMode(MarkupOutput out)
Renders the visualization set option
void renderVisPropsEditorButton(MarkupOutput out)
void renderVisualizationsEnabled(MarkupOutput out)
Renders the visualizations enabled checkbox
Protected Methods
Cart getCart()
Creates and initializes the Cart instance used by this Transform.
String getScriptClass()
Returns the name of the javaScript class to be associated with the component
void initHelp(Editor editor)
void initializeCart(Cart cart)
Initializes the Cart instance used by this Transform.
void setBoneProperties(JsonGenerator boneProps)
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.AbstractEditorTransform
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.LayoutTransform
From interface com.microstrategy.web.transform.Transform

Constants

public static final String FP_SHOW_LIST_NAME_ON_CART

Name of the showListNameOnCart formal parameter

Constant Value: "showListNameOnCart"

Fields

public FormalParameter showListNameOnCart

Indicates whether to show the visualizations list name ('FLASH') as a title on the shopping cart

Public Constructors

public VisualizationsEditorTransform ()

Public Methods

public String getDescription ()

Returns a textual description of the transform.

Returns
  • The textual description of the transform.

public Class getSupportedBeanType ()

Returns the supported bean type. This abstract Transform supports all WebComponents so every sub-class should override this method to return the class of the Bean the Transform is expecting, for example:

 public class CustomReportClass extends AbstractAppTransform {

    public Class getSupportedBeanType() {
        //This Transform is expected to work only with a ReportBean,
        //therefore this method needs to return this class:
        return ReportBean.class;
    }

 }
 

Returns
  • a root class/interface supported by this transform.

public void initializeTransform (Transformable data)

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

Parameters
data bean that will be transformed

public void renderCart (MarkupOutput out)

Renders the Shopping Cart with the available and selected visualizations.

Parameters
out MarkupOutput to generate the HTML.

public void renderEditorContents (MarkupOutput out)

Generates the graphical output for the Editor

Parameters
out MarkupOutput instance where to create the HTML output

public void renderIPhoneIPadOptions (MarkupOutput out)

This method is deprecated.
use renderMobileOptions(MarkupOutput)

public void renderMobileOptions (MarkupOutput out)

Renders the mobile options (iPhone, iPad and Android)

Parameters
out MarkupOutput to generate the HTML.

public void renderSecondaryDataSources (MarkupOutput out)

public void renderSetVisualizationMode (MarkupOutput out)

Renders the visualization set option

Parameters
out MarkupOutput to generate the HTML.

public void renderVisPropsEditorButton (MarkupOutput out)

public void renderVisualizationsEnabled (MarkupOutput out)

Renders the visualizations enabled checkbox

Parameters
out MarkupOutput to generate the HTML.

Protected Methods

protected Cart getCart ()

Creates and initializes the Cart instance used by this Transform.

Returns
  • The Cart object used to render the available and selected visualizations.

protected String getScriptClass ()

Returns the name of the javaScript class to be associated with the component

Returns
  • mstrVisualizationsEditorImpl, the default bone for editors.

protected void initHelp (Editor editor)

protected void initializeCart (Cart cart)

Initializes the Cart instance used by this Transform.

Parameters
cart Cart to be initialized.

protected void setBoneProperties (JsonGenerator boneProps)

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
boneProps the JsonGenerator object that contains the collection of bone properties.