public class

PreferencesToolbarTransform

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

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
PreferencesToolbarTransform()
Default no-argument constructor.
Public Methods
String getDescription()
String getStyleShellDiv()
Returns the style (that is, the style attribute used for css formatting) of the shell's div.
Class getSupportedBeanType()
Get the class of objects this transform is able to handle.
void initializeTransform(Transformable data)

This method initialize the private and protected fields of the transform, such as width and height.

void renderPulldownButton(MarkupOutput out)
void transformForRequestSuccessful(MarkupOutput out)
Generates the output when the bean's status is WebBeanRequestSuccessful.
void transformForRequestWaitingForUserInput(MarkupOutput out)
Generates the output when the bean's status is WebBeanRequestWaitingForUserInput, that is when the bean needs to answer prompts.
Protected Methods
boolean isAdminLevel()
[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

Public Constructors

public PreferencesToolbarTransform ()

Default no-argument constructor.

Public Methods

public String getDescription ()

public String getStyleShellDiv ()

Returns the style (that is, the style attribute used for css formatting) of the shell's div.

public Class getSupportedBeanType ()

Get the class of objects this transform is able to handle.

Returns
  • a Class instance with the information about the beans this transform is able to manipulate.

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

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

public void transformForRequestWaitingForUserInput (MarkupOutput out)

Generates the output when the bean's status is WebBeanRequestWaitingForUserInput, that is when the bean needs to answer prompts. By default it just generates an error message.
Usually prompts are handled by a Prompts transform, the bean is responsible to delegate execution to this transform when prompts are open so reaching this method is actually considered an error.
Transforms that would like to generate customized error message for this scenario should extend this method.

Parameters
out output by this transform

Protected Methods

protected boolean isAdminLevel ()