Class WizardSupport.InitialWelcomeSteps

java.lang.Object

org.netbeans.spi.wizard.WizardPanelProvider

VASSAL.build.module.WizardSupport.InitialWelcomeSteps

Enclosing class:

WizardSupport

public class WizardSupport.InitialWelcomeSteps
extends org.netbeans.spi.wizard.WizardPanelProvider

Wizard pages for the welcome wizard (initial module load). Prompts for username/password if not yet specified, and prompts to load a saved game or start a new one

Author:

rkinney

Field Summary

Fields

Modifier and Type	Field	Description
protected JComponent	actionControls
static final String	NAME_STEP
protected JComponent	nameControls
protected Tutorial	tutorial

Constructor Summary

Constructors

Constructor	Description
InitialWelcomeSteps(String[] steps, String[] stepDescriptions)

Method Summary

Modifier and Type	Method	Description
protected JComponent	createPanel(org.netbeans.spi.wizard.WizardController controller, String id, Map settings)	Create a panel that represents a named step in the wizard.
protected JComponent	getNameControls(org.netbeans.spi.wizard.WizardController controller, Map<String,Object> settings)
protected void	recycleExistingPanel(String id, org.netbeans.spi.wizard.WizardController controller, Map wizardData, JComponent panel)	The method provides a chance to call setProblem() or setCanFinish() when the user re-navigates to a panel they've already seen - in the case that the user pressed the Previous button and then the Next button.
void	setTutorial(Tutorial tutorial)

Methods inherited from class org.netbeans.spi.wizard.WizardPanelProvider

cancel, createWizard, finish, getLongDescription, indexOfStep, toString

Methods inherited from class java.lang.Object

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

Field Details

NAME_STEP

public static final String NAME_STEP

See Also:

• Constant Field Values

nameControls

protected JComponent nameControls

actionControls

protected JComponent actionControls

tutorial

protected Tutorial tutorial

Constructor Details

InitialWelcomeSteps

public InitialWelcomeSteps(String[] steps,
 String[] stepDescriptions)

Method Details

recycleExistingPanel

protected void recycleExistingPanel(String id,
 org.netbeans.spi.wizard.WizardController controller,
 Map wizardData,
 JComponent panel)

Description copied from class: org.netbeans.spi.wizard.WizardPanelProvider

The method provides a chance to call setProblem() or setCanFinish() when the user re-navigates to a panel they've already seen - in the case that the user pressed the Previous button and then the Next button.

The default implementation does nothing, which is sufficient for most cases. If whether this panel is valid or not could have changed because of changed data from a previous panel, or it displays data entered on previous panes which may have changed, you may want to override this method to ensure validity and canFinish are set correctly, and that the components have the correct text.

This method will not be called when a panel is first instantiated - createPanel() is expected to set validity and canFinish appropriately.

The settings Map passed to this method will always be the same Settings map instance that was passed to createPanel() when the panel was created.

If you are implementing WizardPanelProvider and some of the pages are WizardPages, you should call the super implementation if you override this method.

Overrides:

recycleExistingPanel in class org.netbeans.spi.wizard.WizardPanelProvider

createPanel

protected JComponent createPanel(org.netbeans.spi.wizard.WizardController controller,
 String id,
 Map settings)

Description copied from class: org.netbeans.spi.wizard.WizardPanelProvider

Create a panel that represents a named step in the wizard. This method will be called exactly once in the life of a wizard. The panel should retain the passed settings Map, and add/remove values from it as the user enters information, calling setProblem() and setCanFinish() as appropriate in response to user input.

Specified by:

createPanel in class org.netbeans.spi.wizard.WizardPanelProvider

Parameters:

controller - - the object which controls whether the Next/Finish buttons in the wizard are enabled, and what instructions are displayed to the user if they are not

id - The name of the step, one of the array of steps passed in the constructor

settings - A Map containing settings from earlier steps in the wizard. It is safe to retain a reference to this map and put values in it as the user manipulates the UI; the reference should be refreshed whenever this method is called again.

Returns:

A JComponent that should be displayed in the center of the wizard

getNameControls

protected JComponent getNameControls(org.netbeans.spi.wizard.WizardController controller,
 Map<String,Object> settings)

setTutorial

public void setTutorial(Tutorial tutorial)