public class

SingleObjectSelectorTransform

extends AbstractEditorTransform
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.AbstractEditorTransform
           ↳ com.microstrategy.web.app.transforms.SingleObjectSelectorTransform

Summary

[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractEditorTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractEditorTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
SingleObjectSelectorTransform()
Default no-args constructor, initialize formal parameters.
Public Methods
String getDescription()
Returns the textual Type of current transform class.
String getEditorTitle()
String getObjectTypeName()
Class getSupportedBeanType()
Returns the supported bean type.
int[] getTypeRestriction()
String getTypeString(int type)
void initializeTransform(Transformable data)
This method initialize the private and protected fields of the transform.
void renderEditorContents(MarkupOutput out)
Generates the graphical output for the Projects Bean
void renderHeader(MarkupOutput out)
void renderNameField(MarkupOutput out)
void renderNameLabel(MarkupOutput out)
void renderNameProperty(MarkupOutput out)
void renderProjectBrowser(MarkupOutput out)
void renderTypeField(MarkupOutput out)
Renders the text input for the formula name section
void renderTypeLabel(MarkupOutput out)
Renders the title label that appears before the formula name section
void renderTypeProperty(MarkupOutput out)
boolean supports(Transformable data)
Returns true if the transform supports the specified data object.
Protected Methods
WebEvent getApplyEvent()
Returns an instance of the event responsible for processing the editor's actions
void initEditor(Editor editor)
Initialize the editor with the global settings.
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.AbstractEditorTransform
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

Public Constructors

public SingleObjectSelectorTransform ()

Default no-args constructor, initialize formal parameters.

Public Methods

public String getDescription ()

Returns the textual Type of current transform class.

Returns
  • String the description of the transform.

public String getEditorTitle ()

Throws
IllegalArgumentException

public String getObjectTypeName ()

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 int[] getTypeRestriction ()

public String getTypeString (int type)

public void initializeTransform (Transformable data)

This method initialize the private and protected fields of the transform.

Parameters
data bean that will be transformed

public void renderEditorContents (MarkupOutput out)

Generates the graphical output for the Projects Bean

Parameters
out MarkupOutput instance where to create the HTML output.

public void renderHeader (MarkupOutput out)

public void renderNameField (MarkupOutput out)

public void renderNameLabel (MarkupOutput out)

public void renderNameProperty (MarkupOutput out)

public void renderProjectBrowser (MarkupOutput out)

public void renderTypeField (MarkupOutput out)

Renders the text input for the formula name section

Parameters
out MarkupOutput instance where to create the HTML output.

public void renderTypeLabel (MarkupOutput out)

Renders the title label that appears before the formula name section

Parameters
out MarkupOutput instance where to create the HTML output.

public void renderTypeProperty (MarkupOutput out)

public boolean supports (Transformable data)

Returns true if the transform supports the specified data object. The check is performed only on the object's type, no object state is taken into account.

Parameters
data a transformable object
Returns
  • true if the transform supports the data object, false otherwise.

Protected Methods

protected WebEvent getApplyEvent ()

Returns an instance of the event responsible for processing the editor's actions

Returns
  • a WebEvent instance with the information needed for submitting an apply request.

protected void initEditor (Editor editor)

Initialize the editor with the global settings.

Parameters
editor Editor instance, abstraction of the container where output is rendered.