public class

WizardTransform

extends AbstractEditorTransform
java.lang.Object
   ↳ com.microstrategy.web.transform.AbstractTransform
     ↳ com.microstrategy.web.transform.AbstractLayoutTransform
       ↳ com.microstrategy.web.app.transforms.AbstractAppTransform
         ↳ com.microstrategy.web.app.transforms.AbstractEditorTransform
           ↳ com.microstrategy.web.app.transforms.WizardTransform
Known Direct Subclasses

Class Overview

This transform will act as HTML container for a Wizard. It'll provide of space Wizard step pages will be displayed. It divides rendering process into the following sections:

The execution bar information is divided into the following sections:

  • Navigation Bar renderNavigationButtons(MarkupOutput)
  • Execution Bar renderExecutionButtons(MarkupOutput)

    • Summary

    Constants
    String FP_LEVEL_FLAG String value with the name of the formal parameter for levelFlag
    int LEVEL_SHOW_ALL Value associated with the levelFlag formal parameter for indicating the all sections should be shown
    int LEVEL_SHOW_CONTENT Value associated with the levelFlag formal parameter for indicating the content section should be shown
    int LEVEL_SHOW_ERROR Value associated with the levelFlag formal parameter for indicating the error section should be shown
    int LEVEL_SHOW_EXECUTION_BAR Value associated with the levelFlag formal parameter for indicating the execution bar section should be shown
    int LEVEL_SHOW_NAVIGATION_INDEX Value associated with the levelFlag formal parameter for indicating the navigation index section should be shown
    int LEVEL_SHOW_POST_CONTENT Value associated with the levelFlag formal parameter for indicating the post-content section should be shown
    int LEVEL_SHOW_PRE_CONTENT Value associated with the levelFlag formal parameter for indicating the pre-content section should be shown
    [Expand]
    Inherited Constants
    From class com.microstrategy.web.app.transforms.AbstractEditorTransform
    From class com.microstrategy.web.app.transforms.AbstractAppTransform
    Fields
    protected String _cancelButtonImage Local property for holding the cancelButtonImage value
    protected WebEvent _cancelWizardEvent WebEvent instance with the information for cancelling the wizard
    protected String _finishButtonImage Local property for holding the finishButtonImage value
    protected WebEvent _finishWizardEvent WebEvent instance with the information for finishing the wizard
    protected int _levelFlag Local property for holding the levelFlag value
    protected String _nextButtonImage Local property for holding the nextButtonImage value
    protected WebEvent _nextStepEvent WebEvent instance with the information for going forward a step on the wizard
    protected String _previousButtonImage Local property for holding the previousButtonImage value
    protected WebEvent _previousStepEvent WebEvent instance with the information for going back a step on the wizard
    protected WizardBean _wizardBean WizardBean being transformed by this class
    protected String _wizardWidth Local property for holding the wizardWidth value
    public FormalParameter cancelButtonImage Formal parameter indicating the image to use for the Cancel button.
    public FormalParameter displayFinish Formal parameter indicating if the Finish button option should be shown on the wizard
    public FormalParameter displayNext Formal parameter indicating if the Next button option should be shown on the wizard
    public FormalParameter displayPrevious Formal parameter indicating if the Previous button option should be shown on the wizard
    public FormalParameter finishButtonImage Formal parameter indicating the image to use for the Finish button.
    public FormalParameter levelFlag Formal parameter indicating which sections of the wizard should be shown
    public FormalParameter nextButtonImage Formal parameter indicating the image to use for the Next button.
    public FormalParameter previousButtonImage Formal parameter indicating the image to use for the Previous button.
    public FormalParameter wizardWidth Formal parameter indicating the width of the wizard
    [Expand]
    Inherited Fields
    From class com.microstrategy.web.app.transforms.AbstractEditorTransform
    From class com.microstrategy.web.app.transforms.AbstractAppTransform
    Public Constructors
    WizardTransform()
    Default no-args constructor.
    Public Methods
    String getDescription()
    Return description for this Transform.
    Class getSupportedBeanType()
    Get the class of objects this transform is able to handle, which is WizardBean.
    WizardBean getWizardBean()
    Returns current instance of WizardBean being transformed.
    void initializeImages()
    Initialize the images to be used by this transform.
    void initializeTransform(Transformable data)
    Initializes transform formal parameters
    void renderBodyMessage(MarkupOutput out)
    Renders the title to show before the body of the wizard's current step.
    void renderContent(MarkupOutput out)
    Renders Wizard content section.
    void renderEditorContents(MarkupOutput out)
    Method that renders the editor contents corresponding to this Wizard.
    void renderExecutionBar(MarkupOutput out)
    Generates the output for the navigation/finish/cancel buttons.
    void renderExecutionButtons(MarkupOutput out)
    Renders buttons for execution in Wizard steps, mainly Finish and Cancel.
    void renderHiddenInputs(MarkupOutput out)
    Renders required hidden input information for the wizard form to be complete for a user request.
    void renderNavigationButtons(MarkupOutput out)
    Renders buttons for navigating through Wizard steps, mainly Next and Previous.
    void renderPostContent(MarkupOutput out)
    Renders Wizard pre content section.
    void renderPreContent(MarkupOutput out)
    Renders Wizard pre content section.
    void transformForRequestInError(MarkupOutput out)
    Transform output when the status is WebBeanRequestEndsInError.
    Protected Methods
    boolean checkLevel(int iLevelConst)
    Check if the levelFlag formal parameter value contains the indicated flag value
    WebEvent getCancelWizardEvent()
    Generate the event required for cancelling the wizard.
    WebEvent getFinishWizardEvent()
    Generate the event required for finishing the wizard.
    WebEvent getNextEvent()
    Generate the event required for accessing the next step of the wizard.
    WebEvent getPreviousEvent()
    Generate the event required for accessing the previous step of the wizard.
    void initEditor(Editor editor)
    Initialize the editor with the global settings.
    [Expand]
    Inherited Methods
    From class com.microstrategy.web.app.transforms.AbstractEditorTransform
    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_LEVEL_FLAG

    String value with the name of the formal parameter for levelFlag

    Constant Value: "levelFlag"

    public static final int LEVEL_SHOW_ALL

    Value associated with the levelFlag formal parameter for indicating the all sections should be shown

    Constant Value: 4095 (0x00000fff)

    public static final int LEVEL_SHOW_CONTENT

    Value associated with the levelFlag formal parameter for indicating the content section should be shown

    Constant Value: 1 (0x00000001)

    public static final int LEVEL_SHOW_ERROR

    Value associated with the levelFlag formal parameter for indicating the error section should be shown

    Constant Value: 2 (0x00000002)

    public static final int LEVEL_SHOW_EXECUTION_BAR

    Value associated with the levelFlag formal parameter for indicating the execution bar section should be shown

    Constant Value: 8 (0x00000008)

    public static final int LEVEL_SHOW_NAVIGATION_INDEX

    Value associated with the levelFlag formal parameter for indicating the navigation index section should be shown

    Constant Value: 2 (0x00000002)

    public static final int LEVEL_SHOW_POST_CONTENT

    Value associated with the levelFlag formal parameter for indicating the post-content section should be shown

    Constant Value: 32 (0x00000020)

    public static final int LEVEL_SHOW_PRE_CONTENT

    Value associated with the levelFlag formal parameter for indicating the pre-content section should be shown

    Constant Value: 16 (0x00000010)

    Fields

    protected String _cancelButtonImage

    Local property for holding the cancelButtonImage value

    protected WebEvent _cancelWizardEvent

    WebEvent instance with the information for cancelling the wizard

    protected String _finishButtonImage

    Local property for holding the finishButtonImage value

    protected WebEvent _finishWizardEvent

    WebEvent instance with the information for finishing the wizard

    protected int _levelFlag

    Local property for holding the levelFlag value

    protected String _nextButtonImage

    Local property for holding the nextButtonImage value

    protected WebEvent _nextStepEvent

    WebEvent instance with the information for going forward a step on the wizard

    protected String _previousButtonImage

    Local property for holding the previousButtonImage value

    protected WebEvent _previousStepEvent

    WebEvent instance with the information for going back a step on the wizard

    protected WizardBean _wizardBean

    WizardBean being transformed by this class

    protected String _wizardWidth

    Local property for holding the wizardWidth value

    public FormalParameter cancelButtonImage

    Formal parameter indicating the image to use for the Cancel button.

    public FormalParameter displayFinish

    Formal parameter indicating if the Finish button option should be shown on the wizard

    public FormalParameter displayNext

    Formal parameter indicating if the Next button option should be shown on the wizard

    public FormalParameter displayPrevious

    Formal parameter indicating if the Previous button option should be shown on the wizard

    public FormalParameter finishButtonImage

    Formal parameter indicating the image to use for the Finish button.

    public FormalParameter levelFlag

    Formal parameter indicating which sections of the wizard should be shown

    public FormalParameter nextButtonImage

    Formal parameter indicating the image to use for the Next button.

    public FormalParameter previousButtonImage

    Formal parameter indicating the image to use for the Previous button.

    public FormalParameter wizardWidth

    Formal parameter indicating the width of the wizard

    Public Constructors

    public WizardTransform ()

    Default no-args constructor. Initialize all Formal Parameters.

    Public Methods

    public String getDescription ()

    Return description for this Transform.

    Returns
    • description text.

    public Class getSupportedBeanType ()

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

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

    public WizardBean getWizardBean ()

    Returns current instance of WizardBean being transformed.

    Returns

    public void initializeImages ()

    Initialize the images to be used by this transform.

    public void initializeTransform (Transformable data)

    Initializes transform formal parameters

    Parameters
    data Transformable instance to be associated with this transform.

    public void renderBodyMessage (MarkupOutput out)

    Renders the title to show before the body of the wizard's current step.

    Parameters
    out the MarkupOutput instance to write to

    public void renderContent (MarkupOutput out)

    Renders Wizard content section.
    This function will need to access WizardBean for selecting what transform to call. Here, the transform will have to redirect transform output to step-specific transform.

    Parameters
    out where to write the output of the method.

    public void renderEditorContents (MarkupOutput out)

    Method that renders the editor contents corresponding to this Wizard.

    Parameters
    out MarkupOutput instance where the HTML contents to render are to be saved.

    public void renderExecutionBar (MarkupOutput out)

    Generates the output for the navigation/finish/cancel buttons.

    Parameters
    out where to write the output of the method.

    public void renderExecutionButtons (MarkupOutput out)

    Renders buttons for execution in Wizard steps, mainly Finish and Cancel.

    Parameters
    out where to write output

    public void renderHiddenInputs (MarkupOutput out)

    Renders required hidden input information for the wizard form to be complete for a user request.

    Parameters
    out where to write the output of the method.

    public void renderNavigationButtons (MarkupOutput out)

    Renders buttons for navigating through Wizard steps, mainly Next and Previous.

    Parameters
    out where to write output

    public void renderPostContent (MarkupOutput out)

    Renders Wizard pre content section.

    Parameters
    out where to write the output of the method.

    public void renderPreContent (MarkupOutput out)

    Renders Wizard pre content section.

    Parameters
    out where to write the output of the method.

    public void transformForRequestInError (MarkupOutput out)

    Transform output when the status is WebBeanRequestEndsInError.

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

    Protected Methods

    protected boolean checkLevel (int iLevelConst)

    Check if the levelFlag formal parameter value contains the indicated flag value

    Parameters
    iLevelConst level flag value to check for
    Returns
    • true means the level flag is included in the level parameter value

    protected WebEvent getCancelWizardEvent ()

    Generate the event required for cancelling the wizard.

    Returns
    • WebEvent instance initialized with the information required for closing the wizard without submitting any of the changes.

    protected WebEvent getFinishWizardEvent ()

    Generate the event required for finishing the wizard.

    Returns
    • WebEvent instance initialized with the information required for submitting all the wizard information.

    protected WebEvent getNextEvent ()

    Generate the event required for accessing the next step of the wizard.

    Returns
    • WebEvent instance initialized with the information required for going a step forward on the wizard.

    protected WebEvent getPreviousEvent ()

    Generate the event required for accessing the previous step of the wizard.

    Returns
    • WebEvent instance initialized with the information required for going back a step on the wizard.

    protected void initEditor (Editor editor)

    Initialize the editor with the global settings.

    Parameters
    editor Editor instance, abstraction of the container where output is rendered.