public class

ReportDetailsPanelTransform

extends AbstractAppTransform
java.lang.Object
   ↳ com.microstrategy.web.transform.AbstractTransform
     ↳ com.microstrategy.web.transform.AbstractLayoutTransform
       ↳ com.microstrategy.web.app.transforms.AbstractAppTransform
         ↳ com.microstrategy.web.app.transforms.ReportDetailsPanelTransform

Class Overview

This transform renders the report details panel contents on the report page.
It uses an Editor to display the contents of the report details.

Summary

[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
public final String FP_PANEL_HEIGHT Constant defining the formal parameter name - height.
public final String FP_PANE_TITLE_ID Constant defining the formal parameter name - pane title.
public FormalParameter helpTopic Indicates the help topic for the help page of the editor.
public FormalParameter helpType Indicates the type of help topic this editor uses.
public FormalParameter paneTitleId The title to be used for the pane.
public FormalParameter panelHeight The title to be used for the pane.
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
ReportDetailsPanelTransform()
Default constructor no args
Public Methods
boolean canTransform(Transformable data)
Checks that the transform supports specified data object and that object is in the state supported by this transform.
String getDescription()
Class getSupportedBeanType()
Returns the supported bean type.
void initializeTransform(Transformable data)

This method initialize the private and protected fields of the transform, such as width and height.

void renderReportDetails(MarkupOutput out)
Method that will render the content of the report details to a MarkupOutput object
void transformForRequestSuccessful(MarkupOutput out)
Generates the output when the bean's status is WebBeanRequestSuccessful.
Protected Methods
WebEvent getCloseEvent()
Returns the event to be used for the close button.
Editor getEditor()
Returns the instance of the editor used by this transform.
void initEditor()
Initializes the editor with the global settings.
void renderJavascript(MarkupOutput out)
Render the Javascript required for the editor.
[Expand]
Inherited Methods
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

Fields

public final String FP_PANEL_HEIGHT

Constant defining the formal parameter name - height.

Constant Value: "panelHeight"

public final String FP_PANE_TITLE_ID

Constant defining the formal parameter name - pane title.

Constant Value: "paneTitleId"

public FormalParameter helpTopic

Indicates the help topic for the help page of the editor.

public FormalParameter helpType

Indicates the type of help topic this editor uses.

public FormalParameter paneTitleId

The title to be used for the pane.

public FormalParameter panelHeight

The title to be used for the pane.

Public Constructors

public ReportDetailsPanelTransform ()

Default constructor no args

Public Methods

public boolean canTransform (Transformable data)

Checks that the transform supports specified data object and that object is in the state supported by this transform.

Returns
  • true if the transform supports specified data object and the object is in the state supported by this transform.

public String getDescription ()

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 initialize the private and protected fields of the transform, such as width and height. It also invokes the initializeWebComponent, initializeImages and initializeCss methods.

This method is automatically called from the transform method. Transforms which would like to invoke other methods in this instance directly (for example, to invoke some render methods), need first to call this method to guarantee that the Transform is ready to generate output.

Parameters
data the bean to transform.

public void renderReportDetails (MarkupOutput out)

Method that will render the content of the report details to a MarkupOutput object

Parameters
out MarkupOutput that will be used to append the report details

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 WebEvent getCloseEvent ()

Returns the event to be used for the close button. This returns the EnumPageEvents.WebEventShowBean

Returns
  • The close event.

protected Editor getEditor ()

Returns the instance of the editor used by this transform.

Returns
  • the instance of the Editor.

protected void initEditor ()

Initializes the editor with the global settings.

protected void renderJavascript (MarkupOutput out)

Render the Javascript required for the editor. Calls renderRegisterBone.

Parameters
out - MarkupOutput to render