public class

ReportAjaxVisualizationTransform

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.ReportAjaxVisualizationTransform
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

This transform serves as the base for a AJAX/DHTML visualization.
It renders an iframe where the AJAX/DHTML visualization will reside. The iframe's SRC attribute will point to a URL that actually renders the visualization. This URL is created by using the formal parameters: _styleName or _iframeSrc

Note: The use of an iframe is recommended, though not enforced, to avoid conflicts with the visualization's CSS styles or javascript code and the ones used by MicroStrategy Web

Summary

[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractReportDataTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
public FormalParameter _forceShowForm The flag to force displaying all the attribute forms.
public FormalParameter _iframeExtraAttrs Extra attributes for the iframe tag.
public FormalParameter _iframeSrc The source for the iframe.
public FormalParameter _styleName The name of the style to use to render the AJAX/DHTML visualization.
public FormalParameter _viewModes The view modes that the visualization allows to be rendered.
public FormalParameter _zoomFactor The zoom factor that the visualization to be rendered.
[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
ReportAjaxVisualizationTransform()
Public Methods
String getDescription()
void renderContainerHeight(MarkupOutput out)
Renders the height of the container
Calls #getContainerheight()
void renderContainerWidth(MarkupOutput out)
Renders the width of the container
Calls getContainerWidth()
void renderGridDataUrl(MarkupOutput out)
Render a URL that can be used to get the report data using the style specified on the "reportXMLStyle" formal parameter
void renderVisualization(MarkupOutput out)
Renders an iframe that contains the visualization.
void transformForRequestSuccessful(MarkupOutput out)
Transform when the status is "Successful".
Protected Methods
String getContainerHeight()
Returns the height of the container.
String getContainerWidth()
Returns the width of the container.
String getGridBoneJson()
This method is deprecated. use getGridDataUrl()
ParameterBuilder getGridDataUrl()
HashList<String, String> getIFrameSrcExtraParameters()
String getIframeSource()
void setBoneProperties(JsonGenerator boneProps)
Add the "selectionData" property on the grid bone.
[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

Fields

public FormalParameter _forceShowForm

The flag to force displaying all the attribute forms. Allowed values: Boolean. True means show all the forms, false means show headers by default.

public FormalParameter _iframeExtraAttrs

Extra attributes for the iframe tag.
Allowed Values: Any string with attributes to be added to the iframe tag. For example frameborder="0"

public FormalParameter _iframeSrc

The source for the iframe. Used if the source is static. Allowed Values: Any URL. For example: ../VisFramework/map/map.html

public FormalParameter _styleName

The name of the style to use to render the AJAX/DHTML visualization.
Ignored is _iframeSrc is set. Allowed Values: String value that corresponds to a style on the styleCatalog.

public FormalParameter _viewModes

The view modes that the visualization allows to be rendered. Allowed values: The OR values from EnumDSSXMLViewMedia

public FormalParameter _zoomFactor

The zoom factor that the visualization to be rendered. Allowed values: Integer. For example: 1 stands for the origin size

Public Constructors

public ReportAjaxVisualizationTransform ()

Public Methods

public String getDescription ()

public void renderContainerHeight (MarkupOutput out)

Renders the height of the container
Calls #getContainerheight()

Parameters
out The Markup output

public void renderContainerWidth (MarkupOutput out)

Renders the width of the container
Calls getContainerWidth()

Parameters
out The Markup output

public void renderGridDataUrl (MarkupOutput out)

Render a URL that can be used to get the report data using the style specified on the "reportXMLStyle" formal parameter

public void renderVisualization (MarkupOutput out)

Renders an iframe that contains the visualization.
Calls getContainerWidth(), getContainerHeight() and getIframeSource()
The iframe's SRC attribute will point to a URL that actually renders the visualization.

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 String getContainerHeight ()

Returns the height of the container.
It first checks for the "containerheight" formal parameter, which is set on the case of grids in documents. If this is empty it checks for the "height" formal parameter

Returns
  • the height of the container.

protected String getContainerWidth ()

Returns the width of the container.
It first checks for the "containerWidth" formal parameter, which is set on the case of grids in documents. If this is empty it checks for the "width" formal parameter

Returns
  • the width of the container.

protected String getGridBoneJson ()

This method is deprecated.
use getGridDataUrl()

protected ParameterBuilder getGridDataUrl ()

Returns
  • A URL that can be used to get the report data using the style specified on the "reportXMLStyle" formal parameter

protected HashList<String, String> getIFrameSrcExtraParameters ()

protected String getIframeSource ()

protected void setBoneProperties (JsonGenerator boneProps)

Add the "selectionData" property on the grid bone.

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