public class

PromptEditorJavaScriptBoneTransform

extends AbstractAppTransform
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.PromptEditorJavaScriptBoneTransform

Summary

[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
protected FormalParameter boneID
protected FormalParameter filterBeanPath
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
PromptEditorJavaScriptBoneTransform()
Public Methods
String getDescription()
Returns a textual description of the transform.
Class getSupportedBeanType()
Returns the supported bean type.
void transformForRequestSuccessful(MarkupOutput out)
Generates the output when the bean's status is WebBeanRequestSuccessful.
Protected Methods
String getBoneId()
Returns the id to be used for the JavaScript bone.
void renderJavascript(MarkupOutput out)
Generate the JavaScript code required by prompt editor for the proper behavior on the client.
[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.LayoutTransform
From interface com.microstrategy.web.transform.Transform

Fields

protected FormalParameter boneID

protected FormalParameter filterBeanPath

Public Constructors

public PromptEditorJavaScriptBoneTransform ()

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

Returns the id to be used for the JavaScript bone.
This method is used by the renderRegisterBone method to indicate the id of the bone html element.

Returns
  • String

protected void renderJavascript (MarkupOutput out)

Generate the JavaScript code required by prompt editor for the proper behavior on the client. Extends the parent method by adding extra property values as well as the required library for it to work properly.

Parameters
out MarkupOutput instance where the HTML output will be saved.