public class

PromptDetailsTransform

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.PromptDetailsTransform

Class Overview

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

Summary

Constants
String FP_EDITOR_LAYOUT_FILE Constant defining the formal parameter name - Editor Layout file.
[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
public final String FP_PANE_TITLE_ID Constant defining the formal parameter name - pane title.
public final String FP_STYLE_TO_USE Constant defining the formal parameter name - prompt summary style.
public FormalParameter editorLayoutFile Indicates the name of the definition file associated with the editor.
public FormalParameter paneTitleId The title to be used for the pane.
public FormalParameter promptSummaryStyleName The name of the style to be used to render the prompts summary.
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
PromptDetailsTransform()
Default constructor.
Public Methods
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 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.
void renderOutput(MarkupOutput out)
Render the output to 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

Constants

public static final String FP_EDITOR_LAYOUT_FILE

Constant defining the formal parameter name - Editor Layout file.

Constant Value: "editorLayoutFile"

Fields

public final String FP_PANE_TITLE_ID

Constant defining the formal parameter name - pane title.

Constant Value: "paneTitleId"

public final String FP_STYLE_TO_USE

Constant defining the formal parameter name - prompt summary style.

Constant Value: "promptSummaryStyleName"

public FormalParameter editorLayoutFile

Indicates the name of the definition file associated with the editor.

public FormalParameter paneTitleId

The title to be used for the pane.

public FormalParameter promptSummaryStyleName

The name of the style to be used to render the prompts summary.

Public Constructors

public PromptDetailsTransform ()

Default constructor.

Public Methods

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 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

protected void renderOutput (MarkupOutput out)

Render the output to the editor.