public class

ObjectSelectorTransform

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

Summary

[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractAppTransform
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
ObjectSelectorTransform()
Public Methods
String getDescription()
Returns a textual description of the transform.
Class getSupportedBeanType()
Returns the supported bean type.
void initializeWebComponent(Transformable data)
Initialize the web component to be used by the transform.
boolean isSingleObjectSelectionMode()
Returns whether the bean supports selection of only a single object.
void transformForRequestSuccessful(MarkupOutput out)
Generates the output when the bean's status is WebBeanRequestSuccessful.
Protected Methods
boolean isDialog()
Defines whether this Transform should behave as a dialog (for example, a pop-up window).
boolean isModal()
Defines whether this Transform should behave as a modal component (that is, it's displayed on top of the page and while open nothing else can be used).
[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

Public Constructors

public ObjectSelectorTransform ()

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 initializeWebComponent (Transformable data)

Initialize the web component to be used by the transform.

Parameters
data the bean to transform.

public boolean isSingleObjectSelectionMode ()

Returns whether the bean supports selection of only a single object.

Returns
  • boolean True if the size restriction on the bean is set to 1.

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 boolean isDialog ()

Defines whether this Transform should behave as a dialog (for example, a pop-up window).

Returns
  • true if it's transforming a dialog

protected boolean isModal ()

Defines whether this Transform should behave as a modal component (that is, it's displayed on top of the page and while open nothing else can be used).

Returns
  • true if it's transforming a modal dialog