Class WizardSupport

java.lang.Object

VASSAL.build.module.WizardSupport

public class WizardSupport
extends Object

Provides support for two different wizards. The WelcomeWizard is the initial screen shown to the user when loading a module in play mode. The GameSetupWizard is shown whenever the user starts a new game on- or off-line.

Author:

rkinney

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WizardSupport.BranchingWizard	Branches the wizard by forwarding to the Wizard stored in the wizard settings under a specified key
static class	WizardSupport.GameSetupPanels	Wizard pages for starting a new game.
class	WizardSupport.InitialWelcomeSteps	Wizard pages for the welcome wizard (initial module load).
static class	WizardSupport.LoadSavedGamePanels	Wizard pages for loading a saved game
static class	WizardSupport.PlayOfflinePanels	Wizard pages for starting a new game offline
static class	WizardSupport.SavedGameLoader	Loads a saved game in the background.
static class	WizardSupport.SetupStepPage	Wizard page for an unfinished GameSetupStep
static class	WizardSupport.TutorialLoader

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ACTION_KEY
static final String	LOAD_GAME_ACTION
static final String	LOAD_TUTORIAL_ACTION
protected Dimension	logoSize
static final String	PLAY_OFFLINE_ACTION
static final String	PLAY_ONLINE_ACTION
static final String	POST_INITIAL_STEPS_WIZARD
static final String	POST_LOAD_GAME_WIZARD
static final String	POST_PLAY_OFFLINE_WIZARD
static final String	SETUP_KEY
protected List<PredefinedSetup>	setups
protected Tutorial	tutorial
static final String	WELCOME_WIZARD_ENABLED
static final String	WELCOME_WIZARD_KEY

Constructor Summary

Constructors

Constructor	Description
WizardSupport()

Method Summary

Modifier and Type	Method	Description
void	addPredefinedSetup(PredefinedSetup setup)	Add a PredefinedSetup to the wizard page for starting a new game offline.
WizardSupport.InitialWelcomeSteps	createInitialWelcomeSteps()
org.netbeans.spi.wizard.WizardPanelProvider	createPlayOfflinePanels()
protected WizardSupport.BranchingWizard	createWelcomeWizard()
void	removePredefinedSetup(PredefinedSetup setup)
void	setBackgroundImage(Image image)
void	setTutorial(Tutorial tutorial)	Specify a Tutorial that the user may load from the WizardSupport.InitialWelcomeSteps
void	showGameSetupWizard()	Show a wizard that prompts the user to specify information for unfinished GameSetupSteps
void	showWelcomeWizard()	Show the "Welcome" wizard, shown when loading a module in play mode

Methods inherited from class java.lang.Object

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

Field Details

POST_INITIAL_STEPS_WIZARD

public static final String POST_INITIAL_STEPS_WIZARD

See Also:

• Constant Field Values

POST_LOAD_GAME_WIZARD

public static final String POST_LOAD_GAME_WIZARD

See Also:

• Constant Field Values

POST_PLAY_OFFLINE_WIZARD

public static final String POST_PLAY_OFFLINE_WIZARD

See Also:

• Constant Field Values

WELCOME_WIZARD_KEY

public static final String WELCOME_WIZARD_KEY

See Also:

• Constant Field Values

SETUP_KEY

public static final String SETUP_KEY

See Also:

• Constant Field Values

ACTION_KEY

public static final String ACTION_KEY

See Also:

• Constant Field Values

LOAD_TUTORIAL_ACTION

public static final String LOAD_TUTORIAL_ACTION

See Also:

• Constant Field Values

PLAY_ONLINE_ACTION

public static final String PLAY_ONLINE_ACTION

See Also:

• Constant Field Values

PLAY_OFFLINE_ACTION

public static final String PLAY_OFFLINE_ACTION

See Also:

• Constant Field Values

LOAD_GAME_ACTION

public static final String LOAD_GAME_ACTION

See Also:

• Constant Field Values

WELCOME_WIZARD_ENABLED

public static final String WELCOME_WIZARD_ENABLED

See Also:

• Constant Field Values

logoSize

protected Dimension logoSize

setups

protected List<PredefinedSetup> setups

tutorial

protected Tutorial tutorial

Constructor Details

WizardSupport

public WizardSupport()

Method Details

addPredefinedSetup

public void addPredefinedSetup(PredefinedSetup setup)

Add a PredefinedSetup to the wizard page for starting a new game offline. Only adds setups that are not menus.

Parameters:

setup - Predefined Setup

removePredefinedSetup

public void removePredefinedSetup(PredefinedSetup setup)

setTutorial

public void setTutorial(Tutorial tutorial)

Specify a Tutorial that the user may load from the WizardSupport.InitialWelcomeSteps

Parameters:

tutorial - Tutorial

showWelcomeWizard

public void showWelcomeWizard()

Show the "Welcome" wizard, shown when loading a module in play mode

createWelcomeWizard

protected WizardSupport.BranchingWizard createWelcomeWizard()

createPlayOfflinePanels

public org.netbeans.spi.wizard.WizardPanelProvider createPlayOfflinePanels()

showGameSetupWizard

public void showGameSetupWizard()

Show a wizard that prompts the user to specify information for unfinished GameSetupSteps

createInitialWelcomeSteps

public WizardSupport.InitialWelcomeSteps createInitialWelcomeSteps()

setBackgroundImage

public void setBackgroundImage(Image image)