public class

ElementPickerTransform

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

Class Overview

This transform renders the element picker used in prompts.

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_TITLE_LABEL_ID Constant defining the formal parameter name - pane title.
public FormalParameter editorLayoutFile Indicates the name of the definition file associated with the editor.
public FormalParameter titleLabelID The title to be used for the pane.
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
ElementPickerTransform()
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 renderEditor(MarkupOutput out)
Main method to render the output of an editor.
void renderOutput(MarkupOutput out)
Creates a CartElementPicker instance and initializes the cart properties and then renders the cart into the MarkupOutput.
void transformForRequestSuccessful(MarkupOutput out)
Generates the output when the bean's status is WebBeanRequestSuccessful.
Protected Methods
void initEditor(Editor editor)
Initializes the editor with the global settings.
void initializeCartProperties(CartElementPicker cartElemPicker)
Initializes the cart properties.
void initializeCartSearchAndIncrementalFetch(CartElementPicker cartElemPicker)
Initialize the Search and incremental fetch properties
void renderHiddenInputs(MarkupOutput out)
Render hidden inputs for EnumPromptsBeanEvents.PROMPTS_EVENT_PROCESS_ANY_PROMPTS
void renderJavascript(MarkupOutput out)
Renders the javascript for the transform.
[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_TITLE_LABEL_ID

Constant defining the formal parameter name - pane title.

Constant Value: "titleLabelID"

public FormalParameter editorLayoutFile

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

public FormalParameter titleLabelID

The title to be used for the pane.

Public Constructors

public ElementPickerTransform ()

Default constructor

Public Methods

public String getDescription ()

See Also

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 renderEditor (MarkupOutput out)

Main method to render the output of an editor. It creates an Editor and initializes the editor and calls renderOutput method to render the contents into the editor's contents.

Parameters
out MarkupOutputinstance where to create the HTML output

public void renderOutput (MarkupOutput out)

Creates a CartElementPicker instance and initializes the cart properties and then renders the cart into the MarkupOutput.

Parameters
out MarkupOutputinstance where to create the HTML output

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 void initEditor (Editor editor)

Initializes the editor with the global settings.

Parameters
editor the Editorto modify.

protected void initializeCartProperties (CartElementPicker cartElemPicker)

Initializes the cart properties.

Parameters
cartElemPicker - the CartElementPicker to be initialized

protected void initializeCartSearchAndIncrementalFetch (CartElementPicker cartElemPicker)

Initialize the Search and incremental fetch properties

Parameters
cartElemPicker - the CartElementPicker to be initialized

protected void renderHiddenInputs (MarkupOutput out)

Render hidden inputs for EnumPromptsBeanEvents.PROMPTS_EVENT_PROCESS_ANY_PROMPTS

Parameters
out MarkupOutputinstance where to create the HTML output

protected void renderJavascript (MarkupOutput out)

Renders the javascript for the transform. Calls renderRegisterBone to register the bone.

Parameters
out MarkupOutputinstance where to create the HTML output