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.
-
backButton
- The "Back" button.
-
cancelButton
- The "Cancel" button.
-
images
- The respective images of the WizardDialog's panels.
-
lastPanel
- The last panel selected.
-
listener
- A class implementing WizardListener to call when the finish
button is clicked.
-
nextButton
- The "Next"/"Finish" button.
-
panels
- The WizardDialog's panels.
-
parentFrame
- The Dialog's parent frame.
-
selectedPanel
- The currently selected panel.
-
tabbingPanel
- The WizardDialogs's primary panel.
-
WizardDialog(Frame, String)
- Constructs a new WizardDialog.
-
WizardDialog(String)
- Constructs a new WizardDialog.
-
WizardDialog(WizardListener, Frame, String)
- Constructs a new WizardDialog.
-
WizardDialog(WizardListener, String)
- Constructs a new WizardDialog.
-
addPanel(Panel)
- Adds a panel to the WizardDialog.
-
addPanel(Panel, Image)
- Adds a panel to the WizardDialog.
-
backButtonClick()
- Selects the previous panel.
-
cancelButtonClick()
- Cancels the WizardDialog.
-
canGoBack()
- Tells the WizardDialog it is not on its first page.
-
canGoNext()
- Tells the WizardDialog it is not on its last page.
-
cantGoBack()
- Tells the WizardDialog it is on its first page.
-
cantGoNext()
- Tells the WizardDialog it is on its last page.
-
finishButtonClick()
- Finishes the WizardDialog.
-
getLastPanel()
- Returns the WizardDialog's last panel.
-
getPanels()
- Returns an array of the WizardDialog's panels.
-
getParentFrame()
- Returns the WizardDialog's parent Frame.
-
getSelectedImage()
- Returns the WizardDialog's current image.
-
getSelectedPanel()
- Returns the WizardDialog's current panel.
-
getSelectedPanelIndex()
- Returns the index of the selected panel.
-
handleEvent(Event)
- Handle clicks on the WizardDialog's button bar.
-
isFinishButton()
- Returns true if the WizardDialog is on its last page.
-
isNextButton()
- Returns true if the WizardDialog is not on its last page.
-
nextButtonClick()
- Selects the next panel.
-
setSelectedPanel(int)
- Sets the WizardDialog's current panel.
-
setSelectedPanel(Panel)
- Sets the WizardDialog's current panel.
-
setToFinishButton()
- Set to true if the WizardDialog is on its last page.
-
setToNextButton()
- Set to true if the WizardDialog is not on its last page.
-
show()
- Centers the WizardDialog over its parent Frame.
listener
protected WizardListener listener
- A class implementing WizardListener to call when the finish
button is clicked.
parentFrame
protected Frame parentFrame
- The Dialog's parent frame.
selectedPanel
protected Panel selectedPanel
- The currently selected panel.
lastPanel
protected Panel lastPanel
- The last panel selected.
panels
protected Vector panels
- The WizardDialog's panels.
images
protected Vector images
- The respective images of the WizardDialog's panels.
backButton
protected Button backButton
- The "Back" button.
nextButton
protected Button nextButton
- The "Next"/"Finish" button.
cancelButton
protected Button cancelButton
- The "Cancel" button.
tabbingPanel
protected WizardPanel tabbingPanel
- The WizardDialogs's primary panel.
WizardDialog
public WizardDialog(String title)
- Constructs a new WizardDialog.
WizardDialog
public WizardDialog(Frame parentFrame,
String title)
- Constructs a new WizardDialog.
WizardDialog
public WizardDialog(WizardListener listener,
String title)
- Constructs a new WizardDialog.
WizardDialog
public WizardDialog(WizardListener listener,
Frame parentFrame,
String title)
- Constructs a new WizardDialog.
getParentFrame
protected Frame getParentFrame()
- Returns the WizardDialog's parent Frame.
show
public synchronized void show()
- Centers the WizardDialog over its parent Frame.
- Overrides:
- show in class Window
addPanel
public void addPanel(Panel panel)
- Adds a panel to the WizardDialog.
- Parameters:
- panel - the panel to add as a page of the WizardDialog
getPanels
public Panel[] getPanels()
- Returns an array of the WizardDialog's panels.
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
getSelectedPanel
public Panel getSelectedPanel()
- Returns the WizardDialog's current panel.
getSelectedImage
public Image getSelectedImage()
- Returns the WizardDialog's current image.
getSelectedPanelIndex
protected int getSelectedPanelIndex()
- Returns the index of the selected panel.
setSelectedPanel
public void setSelectedPanel(Panel panel)
- Sets the WizardDialog's current panel.
- Parameters:
- panel - the panel to set as the current page
setSelectedPanel
public void setSelectedPanel(int index)
- Sets the WizardDialog's current panel.
- Parameters:
- index - the zero-based index of the panel to use
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.
isNextButton
protected boolean isNextButton()
- Returns true if the WizardDialog is not on its last page.
setToNextButton
protected void setToNextButton()
- Set to true if the WizardDialog is not on its last page.
isFinishButton
protected boolean isFinishButton()
- Returns true if the WizardDialog is on its last page.
setToFinishButton
protected void setToFinishButton()
- Set to true if the WizardDialog is on its last page.
canGoBack
protected void canGoBack()
- Tells the WizardDialog it is not on its first page.
cantGoBack
protected void cantGoBack()
- Tells the WizardDialog it is on its first page.
canGoNext
protected void canGoNext()
- Tells the WizardDialog it is not on its last page.
cantGoNext
protected void cantGoNext()
- Tells the WizardDialog it is on its last page.
handleEvent
public boolean handleEvent(Event event)
- Handle clicks on the WizardDialog's button bar.
- Overrides:
- handleEvent in class Component
backButtonClick
protected void backButtonClick()
- Selects the previous panel.
nextButtonClick
protected void nextButtonClick()
- Selects the next panel.
finishButtonClick
protected void finishButtonClick()
- Finishes the WizardDialog.
cancelButtonClick
protected void cancelButtonClick()
- Cancels the WizardDialog.
All Packages Class Hierarchy This Package Previous Next Index