public class

WizardStepTransform

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

Class Overview

This class is the generic transform of a WizardStepBean. It simply takes all the children of the WizardStepBean, and calls generateOutput on each one of them.

Summary

Constants
String FP_TITLE_LABEL_ID String value with the name of the titleLabelID formal parameter
[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
public FormalParameter titleLabelID Indicates the title id according to the application's resource buldles.
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
WizardStepTransform()
Class Constructor, initialize formal parameters
Public Methods
String getDescription()
Returns the 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.
void renderStepContent(MarkupOutput out)
Renders the content for this step.
void renderTitle(MarkupOutput out)
Renders the title for this step.
void transformForRequestSuccessful(MarkupOutput out)
Transform output when the status is WebBeanRequestSuccessful.
Protected Methods
String getTitle()
Returns the title of this step.
WizardStepBean getWizardStepBean()
[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

Constants

public static final String FP_TITLE_LABEL_ID

String value with the name of the titleLabelID formal parameter

Constant Value: "titleLabelID"

Fields

public FormalParameter titleLabelID

Indicates the title id according to the application's resource buldles.

Public Constructors

public WizardStepTransform ()

Class Constructor, initialize 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 WizardStepBean instances

Returns
  • the class of the bean 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 void renderStepContent (MarkupOutput out)

Renders the content for this step. Here it obtains each one of the children of this WizardStepBean and calls their generateOutput method.

Parameters
out MarkupOutput where the HTML contents to be rendered will be saved.

public void renderTitle (MarkupOutput out)

Renders the title for this step. It simply enclose the title within a div tag.

Parameters
out MarkupOutput where the HTML contents to be rendered will be saved.

public void transformForRequestSuccessful (MarkupOutput out)

Transform output when the status is WebBeanRequestSuccessful. This Transform will try to use first a Layout as defined in the style catalog. If there is no layout associated it will call renderTitle(MarkupOutput) and renderStepContent(MarkupOutput).

Parameters
out MarkupOutput where the HTML contents to be rendered will be saved.

Protected Methods

protected String getTitle ()

Returns the title of this step. It is used by the renderTitle method.
The title can be controled through the titleLabelID formal parameter. If a value is assigned to this, this method will return the descriptor associated with this value.

Returns
  • title to use for this step.

protected WizardStepBean getWizardStepBean ()

Returns