org.jfree.ui
Class WizardDialog
JDialog
org.jfree.ui.WizardDialog
- ActionListener
extends JDialog
implements ActionListener
A dialog that presents the user with a sequence of steps for completing a task. The dialog
contains "Next" and "Previous" buttons, allowing the user to navigate through the task.
When the user backs up by one or more steps, the dialog keeps the completed steps so that
they can be reused if the user doesn't change anything - this handles the cases where the user
backs up a few steps just to review what has been completed.
But if the user changes some options in an earlier step, then the dialog may have to discard
the later steps and have them repeated.
THIS CLASS IS NOT WORKING CORRECTLY YET.
WizardDialog(JDialog owner, boolean modal, String title, WizardPanel firstPanel) - Standard constructor - builds and returns a new WizardDialog.
|
WizardDialog(JFrame owner, boolean modal, String title, WizardPanel firstPanel) - Standard constructor - builds a new WizardDialog owned by the specified JFrame.
|
void | actionPerformed(ActionEvent event) - Handles events.
|
boolean | canDoNextPanel() - Returns true if there is a 'next' panel, and false otherwise.
|
boolean | canDoPreviousPanel() - Returns true if it is possible to back up to the previous panel, and false otherwise.
|
boolean | canFinish() - Returns true if it is possible to finish the sequence at this point (possibly with defaults
for the remaining entries).
|
JPanel | createContent() - Creates a panel containing the user interface for the dialog.
|
void | finish() - Finishes the wizard.
|
Object | getResult() - Returns the result of the wizard sequence.
|
int | getStepCount() - Returns the total number of steps in the wizard sequence, if this number is known.
|
WizardPanel | getWizardPanel(int step) - Returns the panel for the specified step (steps are numbered from zero).
|
boolean | isCancelled() - Checks, whether the user cancelled the dialog.
|
void | next() - Displays the next step in the wizard sequence.
|
void | previous() - Handles a click on the "previous" button, by displaying the previous panel in the sequence.
|
WizardDialog
public WizardDialog(JDialog owner,
boolean modal,
String title,
WizardPanel firstPanel)
Standard constructor - builds and returns a new WizardDialog.
owner
- the owner.modal
- modal?title
- the title.firstPanel
- the first panel.
WizardDialog
public WizardDialog(JFrame owner,
boolean modal,
String title,
WizardPanel firstPanel)
Standard constructor - builds a new WizardDialog owned by the specified JFrame.
owner
- the owner.modal
- modal?title
- the title.firstPanel
- the first panel.
actionPerformed
public void actionPerformed(ActionEvent event)
Handles events.
canDoNextPanel
public boolean canDoNextPanel()
Returns true if there is a 'next' panel, and false otherwise.
canDoPreviousPanel
public boolean canDoPreviousPanel()
Returns true if it is possible to back up to the previous panel, and false otherwise.
canFinish
public boolean canFinish()
Returns true if it is possible to finish the sequence at this point (possibly with defaults
for the remaining entries).
createContent
public JPanel createContent()
Creates a panel containing the user interface for the dialog.
finish
public void finish()
Finishes the wizard.
getResult
public Object getResult()
Returns the result of the wizard sequence.
getStepCount
public int getStepCount()
Returns the total number of steps in the wizard sequence, if this number is known. Otherwise
this method returns zero. Subclasses should override this method unless the number of steps
is not known.
getWizardPanel
public WizardPanel getWizardPanel(int step)
Returns the panel for the specified step (steps are numbered from zero).
isCancelled
public boolean isCancelled()
Checks, whether the user cancelled the dialog.
next
public void next()
Displays the next step in the wizard sequence.
previous
public void previous()
Handles a click on the "previous" button, by displaying the previous panel in the sequence.