org.jpedal.examples.viewer.gui.popups

Interface WizardPanelModel

public interface WizardPanelModel

In order to use the Wizard class you need to implement this interface. The implemented class will contain the contents of the user defined panels and add listeners to components that effect the ability to go to the next panel. See SignWizardModel.java for an example.

Method Summary

Modifier and Type	Method and Description
boolean	canAdvance()
void	close() This method can contain any housekeeping you require when the Wizard is exited.
Map<String,JPanel>	getJPanels() In order to use the Card Layout in the wizard class each JPanel must have a unique String identifier.
String	getStartPanelID()
boolean	hasPrevious()
boolean	isFinishPanel()
String	next()
String	previous()
void	registerNextChangeListeners(ChangeListener e) A component that is registered will alert the Wizard class that it should check whether the advance button should be enabled.
void	registerNextKeyListeners(KeyListener e) The same effect as registerNextChangeListeners(ChangeListener e) except applied to keys.

Method Detail

isFinishPanel

boolean isFinishPanel()

Returns:

true if the currently displayed panel requires a Finish box instead of a next box.

getStartPanelID

String getStartPanelID()

Returns:

The unique ID String of the first JPanel to be shown

next

String next()

Returns:

The ID of the JPanel that should be displayed if next is clicked.

previous

String previous()

Returns:

The ID of the JPanel that should be displayed if previous is clicked.

close

void close()

This method can contain any housekeeping you require when the Wizard is exited.

hasPrevious

boolean hasPrevious()

Returns:

true if the current panel has a previous panel

canAdvance

boolean canAdvance()

Returns:

true if the current panel is able to advance.

getJPanels

Map<String,JPanel> getJPanels()

In order to use the Card Layout in the wizard class each JPanel must have a unique String identifier. ie HashMap (String, JPanel)

Returns:

A mapping of ID Strings to JPanels.

registerNextChangeListeners

void registerNextChangeListeners(ChangeListener e)

A component that is registered will alert the Wizard class that it should check whether the advance button should be enabled.

Parameters:

e - Alerts Wizard that the registered component effects the Next button enable/disable status

registerNextKeyListeners

void registerNextKeyListeners(KeyListener e)

The same effect as registerNextChangeListeners(ChangeListener e) except applied to keys.

Parameters:

e - Alerts Wizard that the registered component effects the Next button enable/disable status