A C D E G I L M P S V W

A

AbstractWizardPanel - class com.bws42.wizard.AbstractWizardPanel.

Extend this class to create a panel for a Wizard.

AbstractWizardPanel() - Constructor for class com.bws42.wizard.AbstractWizardPanel

Creates a new AbstractWizardPanel.

actionPerformed(ActionEvent) - Method in class com.bws42.wizard.Wizard

Listens for clicks on the next/previous buttons and acts accordingly.

C

com.bws42.wizard - package com.bws42.wizard

This package contains all the source files for the Wizard.

com.bws42.wizard.example - package com.bws42.wizard.example

This package contains an example Wizard implementation using the Wizard framework.

D

DEFAULT_HEIGHT - Static variable in class com.bws42.wizard.Wizard

Holds the default wizard height.

DEFAULT_WIDTH - Static variable in class com.bws42.wizard.Wizard

Holds the default wizard width.

displayWizard() - Method in class com.bws42.wizard.Wizard

Creates and displays the wizard.

displayWizard(WizardObject) - Method in class com.bws42.wizard.Wizard

Creates and displays the wizard using the info stored in the WizardObject.

E

ExampleWizard - class com.bws42.wizard.example.ExampleWizard.

Example main class for a Wizard.

ExampleWizardFactory - class com.bws42.wizard.example.ExampleWizardFactory.

An example WizardFactory that supplies only one panel.

ExampleWizardFactory() - Constructor for class com.bws42.wizard.example.ExampleWizardFactory

Creates a new ExampleWizardFactory.

ExampleWizardPanel - class com.bws42.wizard.example.ExampleWizardPanel.

An example WizardPanel that demonstrates some of the possible uses of a panel within a wizard.

ExampleWizardPanel() - Constructor for class com.bws42.wizard.example.ExampleWizardPanel

Creates and lays out the components, but you'll notice no text is set or any default values.

G

getComponent() - Method in class com.bws42.wizard.AbstractWizardPanel

Returns this panel.

getComponent() - Method in interface com.bws42.wizard.WizardPanel

Returns the component to display for this panel.

getFrame() - Method in class com.bws42.wizard.Wizard

Returns a pointer to the JFrame of the wizard.

getNextButton() - Method in class com.bws42.wizard.Wizard

Returns a pointer to the next button.

getPanel(WizardObject) - Method in interface com.bws42.wizard.WizardFactory

Returns a panel in the sequence.

getPanel(WizardObject) - Method in class com.bws42.wizard.example.ExampleWizardFactory

Returns the appropriate panel given the Wizard's current position.

getPosition() - Method in class com.bws42.wizard.WizardObject

Returns the current position.

getPrevButton() - Method in class com.bws42.wizard.Wizard

Returns a pointer to the previous button.

getStartPanel() - Method in interface com.bws42.wizard.WizardFactory

Returns the starting panel for the wizard.

getStartPanel() - Method in class com.bws42.wizard.example.ExampleWizardFactory

Returns the start panel for this wizard.

getString(String) - Method in class com.bws42.wizard.AbstractWizardPanel

Gets the string for the given key if it exists.

getString(String, String[]) - Method in class com.bws42.wizard.AbstractWizardPanel

Gets the string for the given key if it exists and returns it with any variables replaced by the appropriate string in the String[].

getString(String) - Method in class com.bws42.wizard.LanguageLoader

Gets the string for the given key if it exists.

getString(String, Object[]) - Method in class com.bws42.wizard.LanguageLoader

Gets the string for the given key if it exists and returns it with any variables replaced by the appropriate string in the Object[].

getWizardObject() - Method in interface com.bws42.wizard.WizardPanel

Gets the wizard data object from the panel.

getWizardObject() - Method in class com.bws42.wizard.example.ExampleWizardPanel

Returns the WizardObject in use by the Wizard.

I

isNextAvailable() - Method in class com.bws42.wizard.AbstractWizardPanel

Returns true, the user can proceed forward from this panel.

isNextAvailable() - Method in interface com.bws42.wizard.WizardPanel

Returns whether or not the user should be able to click next.

isNextAvailable() - Method in class com.bws42.wizard.example.ExampleWizardPanel

Returns whether the Next button should be activated.

isPrevAvailable() - Method in class com.bws42.wizard.AbstractWizardPanel

Returns true, the user can proceed backwards from this panel.

isPrevAvailable() - Method in interface com.bws42.wizard.WizardPanel

Returns whether or not the user should be able to click previous.

isPrevAvailable() - Method in class com.bws42.wizard.example.ExampleWizardPanel

Returns whether the Previous button should be activated.

L

LanguageLoader - class com.bws42.wizard.LanguageLoader.

Allows for loading of different languages for the strings of a program.

LanguageLoader(String, String) - Constructor for class com.bws42.wizard.LanguageLoader

Creates a LanguageLoader for the program.

LanguageLoader(String, Locale) - Constructor for class com.bws42.wizard.LanguageLoader

Creates a LanguageLoader for the program.

LanguageLoader(ResourceBundle) - Constructor for class com.bws42.wizard.LanguageLoader

Creates a LanguageLoader for the program.

M

Multilingual - interface com.bws42.wizard.Multilingual.

Allows for programs to be multilingual.

main(String[]) - Static method in class com.bws42.wizard.example.ExampleWizard

Launches the example wizard.

P

panelInstalled() - Method in class com.bws42.wizard.AbstractWizardPanel

Called after a panel has been displayed to the user.

panelInstalled() - Method in interface com.bws42.wizard.WizardPanel

Called after a panel has been displayed to the user.

S

setLanguage() - Method in class com.bws42.wizard.AbstractWizardPanel

Called to notify the subclass that a new LanguageLoader is installed and that it should update any strings it has to the new language.

setLanguage(Locale) - Method in class com.bws42.wizard.Wizard

Changes the language of the Wizard to the language of the given locale if available.

setLanguage() - Method in class com.bws42.wizard.example.ExampleWizardPanel

Sets the text of buttons and dialogs.

setLanguageLoader(LanguageLoader) - Method in class com.bws42.wizard.AbstractWizardPanel

Sets the new language loader and tells the subclass that a new LanguageLoader has been installed.

setLanguageLoader(LanguageLoader) - Method in interface com.bws42.wizard.Multilingual

Sets the LanguageLoader that will be in use.

setLanguageLoader(LanguageLoader) - Method in interface com.bws42.wizard.WizardPanel

Sets the new language loader.

setLanguageLoader(LanguageLoader) - Method in class com.bws42.wizard.example.ExampleWizardFactory

This method allows your program to change the language of all the panels in the wizard.

setPosition(int) - Method in class com.bws42.wizard.WizardObject

Sets the current position.

setWizardFactory(WizardFactory) - Method in class com.bws42.wizard.Wizard

Sets the WizardFactory for the Wizard.

setWizardObject(WizardObject) - Method in interface com.bws42.wizard.WizardPanel

Sets the wizard data object for the panel.

setWizardObject(WizardObject) - Method in class com.bws42.wizard.example.ExampleWizardPanel

Sets the WizardObject in use by the Wizard.

setWizardSize(int, int) - Method in class com.bws42.wizard.Wizard

Sets the size of the wizard window.

setWizardTitle(String) - Method in class com.bws42.wizard.Wizard

Sets the title of the wizard window.

V

validateContents() - Method in interface com.bws42.wizard.WizardPanel

Tells the panel to validate its input options.

validateContents() - Method in class com.bws42.wizard.example.ExampleWizardPanel

Here you should check to make sure that the user input is valid, for example they didn't enter 'A' where you expected a number and things like that.

W

Wizard - class com.bws42.wizard.Wizard.

Central class of the Wizard.

Wizard(Locale) - Constructor for class com.bws42.wizard.Wizard

Creates a new Wizard in the given language if available.

WizardException - exception com.bws42.wizard.WizardException.

Simple exception used by the Wizard.

WizardException() - Constructor for class com.bws42.wizard.WizardException

Creates a new exception.

WizardFactory - interface com.bws42.wizard.WizardFactory.

Classes implementing this interface are responsible for providing the wizard with the correct next/previous panel given the information stored in the WizardObject.

WizardObject - class com.bws42.wizard.WizardObject.

The data object for the Wizard.

WizardObject() - Constructor for class com.bws42.wizard.WizardObject

Creates a new WizardObject.

WizardPanel - interface com.bws42.wizard.WizardPanel.

Implement this class to create a panel for a Wizard.

A C D E G I L M P S V W