public class

AnnotationsTransform

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

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
AnnotationsTransform()
Public Methods
String getAnnotationsEncoded()
String getDescription()
Returns a textual description of the transform.
String getMode()
int getPrefixLength()
String getPrivilege()
Class getSupportedBeanType()
Returns the supported bean type.
void transformForRequestSuccessful(MarkupOutput out)
Generates the output when the bean's status is WebBeanRequestSuccessful.
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.AbstractAppWidgetTransform
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 AnnotationsTransform ()

Public Methods

public String getAnnotationsEncoded ()

public String getDescription ()

Returns a textual description of the transform.

Returns
  • The textual description of the transform.

public String getMode ()

public int getPrefixLength ()

public String getPrivilege ()

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