Class jrad.util.WizardDialog
All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class jrad.util.WizardDialog

java.lang.Object
   |
   +----java.awt.Component
           |
           +----java.awt.Container
                   |
                   +----java.awt.Window
                           |
                           +----java.awt.Dialog
                                   |
                                   +----jrad.util.WizardDialog

public class WizardDialog
extends Dialog
A class used to create Windows 95-style Wizard dialogs. Implement the WizardListener interface in order to handle the WizardDialog's completion. The WizardDialog may be subclassed if custom page-to-page functionality is required.

Variable Index

 o backButton
The "Back" button.
 o cancelButton
The "Cancel" button.
 o images
The respective images of the WizardDialog's panels.
 o lastPanel
The last panel selected.
 o listener
A class implementing WizardListener to call when the finish button is clicked.
 o nextButton
The "Next"/"Finish" button.
 o panels
The WizardDialog's panels.
 o parentFrame
The Dialog's parent frame.
 o selectedPanel
The currently selected panel.
 o tabbingPanel
The WizardDialogs's primary panel.

Constructor Index

 o WizardDialog(Frame, String)
Constructs a new WizardDialog.
 o WizardDialog(String)
Constructs a new WizardDialog.
 o WizardDialog(WizardListener, Frame, String)
Constructs a new WizardDialog.
 o WizardDialog(WizardListener, String)
Constructs a new WizardDialog.

Method Index

 o addPanel(Panel)
Adds a panel to the WizardDialog.
 o addPanel(Panel, Image)
Adds a panel to the WizardDialog.
 o backButtonClick()
Selects the previous panel.
 o cancelButtonClick()
Cancels the WizardDialog.
 o canGoBack()
Tells the WizardDialog it is not on its first page.
 o canGoNext()
Tells the WizardDialog it is not on its last page.
 o cantGoBack()
Tells the WizardDialog it is on its first page.
 o cantGoNext()
Tells the WizardDialog it is on its last page.
 o finishButtonClick()
Finishes the WizardDialog.
 o getLastPanel()
Returns the WizardDialog's last panel.
 o getPanels()
Returns an array of the WizardDialog's panels.
 o getParentFrame()
Returns the WizardDialog's parent Frame.
 o getSelectedImage()
Returns the WizardDialog's current image.
 o getSelectedPanel()
Returns the WizardDialog's current panel.
 o getSelectedPanelIndex()
Returns the index of the selected panel.
 o handleEvent(Event)
Handle clicks on the WizardDialog's button bar.
 o isFinishButton()
Returns true if the WizardDialog is on its last page.
 o isNextButton()
Returns true if the WizardDialog is not on its last page.
 o nextButtonClick()
Selects the next panel.
 o setSelectedPanel(int)
Sets the WizardDialog's current panel.
 o setSelectedPanel(Panel)
Sets the WizardDialog's current panel.
 o setToFinishButton()
Set to true if the WizardDialog is on its last page.
 o setToNextButton()
Set to true if the WizardDialog is not on its last page.
 o show()
Centers the WizardDialog over its parent Frame.

Variables

 o listener
  protected WizardListener listener
A class implementing WizardListener to call when the finish button is clicked.
 o parentFrame
  protected Frame parentFrame
The Dialog's parent frame.
 o selectedPanel
  protected Panel selectedPanel
The currently selected panel.
 o lastPanel
  protected Panel lastPanel
The last panel selected.
 o panels
  protected Vector panels
The WizardDialog's panels.
 o images
  protected Vector images
The respective images of the WizardDialog's panels.
 o backButton
  protected Button backButton
The "Back" button.
 o nextButton
  protected Button nextButton
The "Next"/"Finish" button.
 o cancelButton
  protected Button cancelButton
The "Cancel" button.
 o tabbingPanel
  protected WizardPanel tabbingPanel
The WizardDialogs's primary panel.

Constructors

 o WizardDialog
  public WizardDialog(String title)
Constructs a new WizardDialog.
 o WizardDialog
  public WizardDialog(Frame parentFrame,
                      String title)
Constructs a new WizardDialog.
 o WizardDialog
  public WizardDialog(WizardListener listener,
                      String title)
Constructs a new WizardDialog.
 o WizardDialog
  public WizardDialog(WizardListener listener,
                      Frame parentFrame,
                      String title)
Constructs a new WizardDialog.

Methods

 o getParentFrame
  protected Frame getParentFrame()
Returns the WizardDialog's parent Frame.
 o show
  public synchronized void show()
Centers the WizardDialog over its parent Frame.
Overrides:
show in class Window
 o addPanel
  public void addPanel(Panel panel)
Adds a panel to the WizardDialog.
Parameters:
panel - the panel to add as a page of the WizardDialog
 o getPanels
  public Panel[] getPanels()
Returns an array of the WizardDialog's panels.
 o addPanel
  public void addPanel(Panel panel,
                       Image image)
Adds a panel to the WizardDialog.
Parameters:
panel - the panel to add as a page of the WizardDialog
image - the image to show to the left of the panel
 o getSelectedPanel
  public Panel getSelectedPanel()
Returns the WizardDialog's current panel.
 o getSelectedImage
  public Image getSelectedImage()
Returns the WizardDialog's current image.
 o getSelectedPanelIndex
  protected int getSelectedPanelIndex()
Returns the index of the selected panel.
 o setSelectedPanel
  public void setSelectedPanel(Panel panel)
Sets the WizardDialog's current panel.
Parameters:
panel - the panel to set as the current page
 o setSelectedPanel
  public void setSelectedPanel(int index)
Sets the WizardDialog's current panel.
Parameters:
index - the zero-based index of the panel to use
 o getLastPanel
  public Panel getLastPanel()
Returns the WizardDialog's last panel. This may be a different panel than the panel in the order if panels have been set procedurally.
 o isNextButton
  protected boolean isNextButton()
Returns true if the WizardDialog is not on its last page.
 o setToNextButton
  protected void setToNextButton()
Set to true if the WizardDialog is not on its last page.
 o isFinishButton
  protected boolean isFinishButton()
Returns true if the WizardDialog is on its last page.
 o setToFinishButton
  protected void setToFinishButton()
Set to true if the WizardDialog is on its last page.
 o canGoBack
  protected void canGoBack()
Tells the WizardDialog it is not on its first page.
 o cantGoBack
  protected void cantGoBack()
Tells the WizardDialog it is on its first page.
 o canGoNext
  protected void canGoNext()
Tells the WizardDialog it is not on its last page.
 o cantGoNext
  protected void cantGoNext()
Tells the WizardDialog it is on its last page.
 o handleEvent
  public boolean handleEvent(Event event)
Handle clicks on the WizardDialog's button bar.
Overrides:
handleEvent in class Component
 o backButtonClick
  protected void backButtonClick()
Selects the previous panel.
 o nextButtonClick
  protected void nextButtonClick()
Selects the next panel.
 o finishButtonClick
  protected void finishButtonClick()
Finishes the WizardDialog.
 o cancelButtonClick
  protected void cancelButtonClick()
Cancels the WizardDialog.

All Packages  Class Hierarchy  This Package  Previous  Next  Index