org.jboss.hal.ballroom.wizard

Class Wizard<C,S extends Enum<S>>

java.lang.Object

org.jboss.hal.ballroom.wizard.Wizard<C,S>

Type Parameters:

C - The context

S - The state enum

public class Wizard<C,S extends Enum<S>>
extends Object

General purpose wizard relying on a context for the common data and an enum representing the states of the different steps.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Wizard.BackFunction<C,S extends Enum<S>>
static class	Wizard.Builder<C,S extends Enum<S>>
static interface	Wizard.CancelCallback<C> A callback executed whenever the user cancels the wizard.
static interface	Wizard.CloseAction<C> An action executed when the user clicks on the close button of the success page.
static interface	Wizard.FinishCallback<C,S extends Enum<S>> A callback executed when the user finishes last step.
static interface	Wizard.NextFunction<C,S extends Enum<S>>
static interface	Wizard.SuccessAction<C> An action executed when the user clicks on the success button of the success page.

Method Summary

Modifier and Type	Method and Description
C	getContext()
static boolean	isOpen()
void	show() Opens the wizard and reset the state, context and UI.
void	showError(String title, com.google.gwt.safehtml.shared.SafeHtml text)
void	showError(String title, com.google.gwt.safehtml.shared.SafeHtml text, boolean lastStep)
void	showError(String title, com.google.gwt.safehtml.shared.SafeHtml text, String error)
void	showError(String title, com.google.gwt.safehtml.shared.SafeHtml text, String error, boolean lastStep)
void	showProgress(String title, com.google.gwt.safehtml.shared.SafeHtml text)
void	showSuccess(String title, com.google.gwt.safehtml.shared.SafeHtml text)
void	showSuccess(String title, com.google.gwt.safehtml.shared.SafeHtml text, boolean lastStep)
void	showSuccess(String title, com.google.gwt.safehtml.shared.SafeHtml text, String successButton, Wizard.SuccessAction<C> successAction)
void	showSuccess(String title, com.google.gwt.safehtml.shared.SafeHtml text, String successButton, Wizard.SuccessAction<C> successAction, boolean lastStep)
void	showSuccess(String title, com.google.gwt.safehtml.shared.SafeHtml text, String successButton, Wizard.SuccessAction<C> successAction, Wizard.CloseAction<C> closeAction, boolean lastStep)
void	showSuccess(String title, com.google.gwt.safehtml.shared.SafeHtml text, Wizard.CloseAction<C> closeAction, boolean lastStep)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

isOpen

public static boolean isOpen()

show

public void show()

Opens the wizard and reset the state, context and UI. If you override this method please make sure to call super.show() before you access or modify the context.

showProgress

public void showProgress(String title,
                         com.google.gwt.safehtml.shared.SafeHtml text)

showSuccess

public void showSuccess(String title,
                        com.google.gwt.safehtml.shared.SafeHtml text)

showSuccess

public void showSuccess(String title,
                        com.google.gwt.safehtml.shared.SafeHtml text,
                        boolean lastStep)

showSuccess

public void showSuccess(String title,
                        com.google.gwt.safehtml.shared.SafeHtml text,
                        Wizard.CloseAction<C> closeAction,
                        boolean lastStep)

showSuccess

public void showSuccess(String title,
                        com.google.gwt.safehtml.shared.SafeHtml text,
                        String successButton,
                        Wizard.SuccessAction<C> successAction)

showSuccess

public void showSuccess(String title,
                        com.google.gwt.safehtml.shared.SafeHtml text,
                        String successButton,
                        Wizard.SuccessAction<C> successAction,
                        boolean lastStep)

showSuccess

public void showSuccess(String title,
                        com.google.gwt.safehtml.shared.SafeHtml text,
                        String successButton,
                        Wizard.SuccessAction<C> successAction,
                        Wizard.CloseAction<C> closeAction,
                        boolean lastStep)

showError

public void showError(String title,
                      com.google.gwt.safehtml.shared.SafeHtml text)

showError

public void showError(String title,
                      com.google.gwt.safehtml.shared.SafeHtml text,
                      boolean lastStep)

showError

public void showError(String title,
                      com.google.gwt.safehtml.shared.SafeHtml text,
                      String error)

showError

public void showError(String title,
                      com.google.gwt.safehtml.shared.SafeHtml text,
                      String error,
                      boolean lastStep)

getContext

public C getContext()