net.truelicense.swing.wizard

Class SwingWizardController<S extends Enum<S>,V extends Component & WizardView<S>>

java.lang.Object

net.truelicense.ui.wizard.BasicWizardController<S,V>

net.truelicense.swing.wizard.SwingWizardController<S,V>

Type Parameters:

S - the type of the wizard's states.

V - the type of the wizard's views.

All Implemented Interfaces:

WizardController

public abstract class SwingWizardController<S extends Enum<S>,V extends Component & WizardView<S>>
extends BasicWizardController<S,V>

A generic wizard which uses a JDialog.

Since:

TrueLicense 2.3

Author:

Christian Schlichtherle

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SwingWizardController.ReturnCode Indicates which button was pressed to close the wizard dialog.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SwingWizardController(Dialog nullableOwner) Constructs a wizard controller for the given owner dialog.
protected	SwingWizardController(EnhancedDialog dialog) Constructs a wizard controller which uses the given dialog.
protected	SwingWizardController(Frame nullableOwner) Constructs a wizard controller for the given owner frame.

Method Summary

Modifier and Type	Method and Description
protected void	cancel() Closes the modal wizard dialog and sets the return code to cancel().
protected void	finish() Closes the modal wizard dialog and sets the return code to finish().
SwingWizardController.ReturnCode	lastReturnCode() Returns the last return code from the wizard dialog.
protected ComponentEnabler	nextButtonProxy() Returns an enabler for the next-button.
protected void	onAfterStateSwitch()
SwingWizardController.ReturnCode	showModalDialog() Packs and displays the modal wizard dialog.
protected void	view(S state, V view)

Methods inherited from class net.truelicense.ui.wizard.BasicWizardController

backState, create, currentState, currentView, fireAfterStateSwitch, fireBeforeStateSwitch, model, nextState, onBeforeStateSwitch, switchBack, switchBackEnabled, switchNext, switchNextEnabled, view

Methods inherited from class java.lang.Object

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

Constructor Detail

SwingWizardController

protected SwingWizardController(Dialog nullableOwner)

Constructs a wizard controller for the given owner dialog.

Parameters:

nullableOwner - the nullable owner dialog.

SwingWizardController

protected SwingWizardController(EnhancedDialog dialog)

Constructs a wizard controller which uses the given dialog.

Parameters:

dialog - the dialog to use.

SwingWizardController

protected SwingWizardController(Frame nullableOwner)

Constructs a wizard controller for the given owner frame.

Parameters:

nullableOwner - the nullable owner frame.

Method Detail

cancel

protected void cancel()

Closes the modal wizard dialog and sets the return code to cancel().

finish

protected void finish()

Closes the modal wizard dialog and sets the return code to finish().

lastReturnCode

public SwingWizardController.ReturnCode lastReturnCode()

Returns the last return code from the wizard dialog.

nextButtonProxy

protected ComponentEnabler nextButtonProxy()

Returns an enabler for the next-button.

onAfterStateSwitch

protected void onAfterStateSwitch()

Overrides:

onAfterStateSwitch in class BasicWizardController<S extends Enum<S>,V extends Component & WizardView<S>>

showModalDialog

public SwingWizardController.ReturnCode showModalDialog()

Packs and displays the modal wizard dialog.

view

protected void view(S state,
                    V view)

Overrides:

view in class BasicWizardController<S extends Enum<S>,V extends Component & WizardView<S>>