public class

ToolbarSetTransform

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

Class Overview

This transforms handles ToolbarSetBean instances for rendering its different ToolbarBean instances defined as children one after the other.

Summary

[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
protected FormalParameter toolbarStyle Indicates the name of the style to use to render toolbars
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
ToolbarSetTransform()
Default constructor.
Public Methods
String getDescription()
Returns the textual description of the transform
Class getSupportedBeanType()
Returns the supported bean type.
void initializeCss()
Initializes the Css classes to use on this transform.
void renderToolbar(MarkupOutput out, ToolbarBean tb)
Render a single ToolbarBean instance.
void transformForRequestSuccessful(MarkupOutput out)
Generates the graphical output for a ToolbarSetBean when its state is WebBeanRequestSuccessful.
Protected Methods
ToolbarSetBean getToolbarSetBean()
Get the ToolbarSetBean instance being transformed
[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

Fields

protected FormalParameter toolbarStyle

Indicates the name of the style to use to render toolbars

Public Constructors

public ToolbarSetTransform ()

Default constructor. Initializes formal parameters.

Public Methods

public String getDescription ()

Returns the textual description of the transform

Returns
  • the description of the transform

public Class getSupportedBeanType ()

Returns the supported bean type. This transform supports ToolbarSetBean instances

Returns

public void initializeCss ()

Initializes the Css classes to use on this transform.

public void renderToolbar (MarkupOutput out, ToolbarBean tb)

Render a single ToolbarBean instance. The style to use for it will be the one specified on the toolbarStyle formal parameter, or the one already linked to the ToolbarBean instance if the formal parameter was not defined.

Parameters
out MarkupOutput instance where to save the HTML contents to render.
tb ToolbarBean to render

public void transformForRequestSuccessful (MarkupOutput out)

Generates the graphical output for a ToolbarSetBean when its state is WebBeanRequestSuccessful. If no layout has been defined for the transform, then it will render each one of the ToolbarBean children one after the other.

Parameters
out MarkupOutput instance where to create the HTML output

Protected Methods

protected ToolbarSetBean getToolbarSetBean ()

Get the ToolbarSetBean instance being transformed

Returns