| javax.swing.JDialog
 org.jfree.ui.WizardDialog
| WizardDialog | | public class WizardDialog extends JDialog implements ActionListener(Code) | | 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.
author:
David Gilbert |
| Method Summary | |
| public void | actionPerformed(ActionEvent event)
Handles events. | | public boolean | canDoNextPanel()
Returns true if there is a 'next' panel, and false otherwise. | | public boolean | canDoPreviousPanel()
Returns true if it is possible to back up to the previous panel, and false otherwise. | | public boolean | canFinish()
Returns true if it is possible to finish the sequence at this point (possibly with defaults
for the remaining entries). | | public JPanel | createContent()
Creates a panel containing the user interface for the dialog. | | public void | finish()
Finishes the wizard. | | public Object | getResult()
Returns the result of the wizard sequence. | | public int | getStepCount()
Returns the total number of steps in the wizard sequence, if this number is known. | | public WizardPanel | getWizardPanel(int step)
Returns the panel for the specified step (steps are numbered from zero).
Parameters:
step - the current step. | | public boolean | isCancelled()
Checks, whether the user cancelled the dialog. | | public void | next()
Displays the next step in the wizard sequence. | | public 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)(Code) | | Standard constructor - builds and returns a new WizardDialog.
Parameters:
owner - the owner.
Parameters:
modal - modal?
Parameters:
title - the title.
Parameters:
firstPanel - the first panel. |
| WizardDialog | | public WizardDialog(JFrame owner, boolean modal, String title, WizardPanel firstPanel)(Code) | | Standard constructor - builds a new WizardDialog owned by the specified JFrame.
Parameters:
owner - the owner.
Parameters:
modal - modal?
Parameters:
title - the title.
Parameters:
firstPanel - the first panel. |
| actionPerformed | | public void actionPerformed(ActionEvent event)(Code) | | Handles events.
Parameters:
event - the event. |
| canDoNextPanel | | public boolean canDoNextPanel()(Code) | | Returns true if there is a 'next' panel, and false otherwise.
boolean. |
| canDoPreviousPanel | | public boolean canDoPreviousPanel()(Code) | | Returns true if it is possible to back up to the previous panel, and false otherwise.
boolean. |
| canFinish | | public boolean canFinish()(Code) | | Returns true if it is possible to finish the sequence at this point (possibly with defaults
for the remaining entries).
boolean. |
| createContent | | public JPanel createContent()(Code) | | Creates a panel containing the user interface for the dialog.
the panel. |
| finish | | public void finish()(Code) | | Finishes the wizard.
|
| getResult | | public Object getResult()(Code) | | Returns the result of the wizard sequence.
the result. |
| getStepCount | | public int getStepCount()(Code) | | 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.
the number of steps. |
| getWizardPanel | | public WizardPanel getWizardPanel(int step)(Code) | | Returns the panel for the specified step (steps are numbered from zero).
Parameters:
step - the current step. the panel. |
| isCancelled | | public boolean isCancelled()(Code) | | Checks, whether the user cancelled the dialog.
false. |
| next | | public void next()(Code) | | Displays the next step in the wizard sequence.
|
| previous | | public void previous()(Code) | | Handles a click on the "previous" button, by displaying the previous panel in the sequence.
|
|
|