org.jboss.hal.ballroom.wizard

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

java.lang.Object

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

Type Parameters:

C - The context

S - The state enum

All Implemented Interfaces:

org.jboss.gwt.elemento.core.IsElement

public abstract class WizardStep<C,S extends Enum<S>>
extends Object
implements org.jboss.gwt.elemento.core.IsElement

A step in a wizard. The UI for the step should not contain a header. The header is part of the wizard and will show this step's title.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	title

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	WizardStep(String title)

Method Summary

Modifier and Type	Method and Description
protected boolean	onBack(C context) Called before the previous step is shown.
protected boolean	onCancel(C context) Called when this step is canceled.
protected boolean	onNext(C context) Called before the next step is shown.
protected void	onShow(C context) Called every time the step is shown.
protected void	registerAttachable(Attachable first, Attachable... rest)
void	reset(C context) Subclasses should reset their state using this method.
protected Wizard<C,S>	wizard() Valid only after the wizard has been created.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jboss.gwt.elemento.core.IsElement

asElement

Field Detail

title

protected String title

Constructor Detail

WizardStep

protected WizardStep(String title)

Method Detail

wizard

protected Wizard<C,S> wizard()

Valid only after the wizard has been created. Must not be used in the step constructor!

Returns:

the wizard instance this step is part of.

reset

public void reset(C context)

Subclasses should reset their state using this method. This method is called just before the wizard is opened. Opposed to onShow(Object) this method should be used to implement one-time initialization.

onShow

protected void onShow(C context)

Called every time the step is shown.

Parameters:

context - the current context

onCancel

protected boolean onCancel(C context)

Called when this step is canceled.

Parameters:

context - the current context

Returns:

true if we can cancel this step, false otherwise.

onBack

protected boolean onBack(C context)

Called before the previous step is shown. The method is called no matter if there's a previous step!

Parameters:

context - the current context

Returns:

true if we can navigate to the previous step, false otherwise.

onNext

protected boolean onNext(C context)

Called before the next step is shown. The method is called no matter if there's a next step!

Parameters:

context - the current context

Returns:

true if we can navigate to the next step, false otherwise.

registerAttachable

protected void registerAttachable(Attachable first,
                                  Attachable... rest)