jwizardcomponent
Class DefaultJWizardComponents

java.lang.Object
  |
  +--jwizardcomponent.DefaultJWizardComponents
All Implemented Interfaces:
JWizard, JWizardComponents

public class DefaultJWizardComponents
extends java.lang.Object
implements JWizardComponents

Title: DefaultJWizardComponents

Description: Swing-Based Wizard Framework for Wizards

Copyright (C) 2003 William Ready
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the GNU Lesser General Public License for more details.
To receive a copy of the GNU Lesser General Public License
write to: The Free Software Foundation, Inc.,
59 Temple Place, Suite 330
Boston, MA 02111-1307 USA

Version:
1.1 Localization and Property Change Listening implemented by Piotr Kamiński.
Author:
William Ready

Field Summary
(package private)  javax.swing.JButton backButton
           
(package private)  CancelAction cancelAction
           
(package private)  javax.swing.JButton cancelButton
           
(package private)  int currentIndex
           
(package private)  FinishAction finishAction
           
(package private)  javax.swing.JButton finishButton
           
(package private)  javax.swing.JButton nextButton
           
(package private)  java.util.List panelList
           
(package private)  java.beans.PropertyChangeSupport propertyChangeListeners
           
(package private)  javax.swing.JPanel wizardPanelsContainer
           
 
Fields inherited from interface jwizardcomponent.JWizardComponents
CURRENT_PANEL_PROPERTY
 
Constructor Summary
DefaultJWizardComponents()
          This class is the "bread and butter" of this framework.
 
Method Summary
 void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
           
 void addWizardPanel(int index, JWizardPanel panel)
           
 void addWizardPanel(JWizardPanel panel)
           
 void addWizardPanelAfter(JWizardPanel panelToBePlacedAfter, JWizardPanel panel)
           
 void addWizardPanelAfterCurrent(JWizardPanel panel)
           
 void addWizardPanelBefore(JWizardPanel panelToBePlacedBefore, JWizardPanel panel)
           
(package private)  void backButton_actionPerformed(java.awt.event.ActionEvent e)
           
(package private)  void cancelButton_actionPerformed(java.awt.event.ActionEvent e)
           
(package private)  void finishButton_actionPerformed(java.awt.event.ActionEvent e)
           
 javax.swing.JButton getBackButton()
           
 CancelAction getCancelAction()
           
 javax.swing.JButton getCancelButton()
           
 int getCurrentIndex()
           
 JWizardPanel getCurrentPanel()
           
 FinishAction getFinishAction()
           
 javax.swing.JButton getFinishButton()
           
 int getIndexOfPanel(JWizardPanel panel)
           
 javax.swing.JButton getNextButton()
           
 java.util.ResourceBundle getResourceBundle()
           
 JWizardPanel getWizardPanel(int index)
           
 java.util.List getWizardPanelList()
           
 javax.swing.JPanel getWizardPanelsContainer()
           
(package private)  void nextButton_actionPerformed(java.awt.event.ActionEvent e)
           
 boolean onLastPanel()
           
 void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
           
 JWizardPanel removeWizardPanel(int index)
           
 JWizardPanel removeWizardPanel(JWizardPanel panel)
           
 JWizardPanel removeWizardPanelAfter(JWizardPanel panel)
           
 JWizardPanel removeWizardPanelBefore(JWizardPanel panel)
           
 void setBackButton(javax.swing.JButton aBackButton)
           
 void setCancelAction(CancelAction aCancelAction)
           
 void setCancelButton(javax.swing.JButton aCancelButton)
           
 void setCurrentIndex(int aCurrentIndex)
           
 void setFinishAction(FinishAction aFinishAction)
           
 void setFinishButton(javax.swing.JButton button)
           
 void setNextButton(javax.swing.JButton aNextButton)
           
 void setResourceBundle(java.util.ResourceBundle resourceBundle)
           
 void setWizardPanelList(java.util.ArrayList panelList)
           
 void setWizardPanelList(java.util.List panelList)
           
 void setWizardPanelsContainer(javax.swing.JPanel aWizardPanelsContainer)
           
 void updateComponents()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

backButton

javax.swing.JButton backButton

nextButton

javax.swing.JButton nextButton

finishButton

javax.swing.JButton finishButton

cancelButton

javax.swing.JButton cancelButton

finishAction

FinishAction finishAction

cancelAction

CancelAction cancelAction

panelList

java.util.List panelList

currentIndex

int currentIndex

wizardPanelsContainer

javax.swing.JPanel wizardPanelsContainer

propertyChangeListeners

java.beans.PropertyChangeSupport propertyChangeListeners
Constructor Detail

DefaultJWizardComponents

public DefaultJWizardComponents()
This class is the "bread and butter" of this framework. All of these components can be used visually however you want, as shown in the frame and example packages, but all a developer really needs is this, and they can even instead implement JWizard and choose to do this portion any way they wish.

Method Detail

addWizardPanel

public void addWizardPanel(JWizardPanel panel)
Specified by:
addWizardPanel in interface JWizardComponents

addWizardPanel

public void addWizardPanel(int index,
                           JWizardPanel panel)
Specified by:
addWizardPanel in interface JWizardComponents

addWizardPanelAfter

public void addWizardPanelAfter(JWizardPanel panelToBePlacedAfter,
                                JWizardPanel panel)
Specified by:
addWizardPanelAfter in interface JWizardComponents

addWizardPanelBefore

public void addWizardPanelBefore(JWizardPanel panelToBePlacedBefore,
                                 JWizardPanel panel)
Specified by:
addWizardPanelBefore in interface JWizardComponents

addWizardPanelAfterCurrent

public void addWizardPanelAfterCurrent(JWizardPanel panel)
Specified by:
addWizardPanelAfterCurrent in interface JWizardComponents

removeWizardPanel

public JWizardPanel removeWizardPanel(JWizardPanel panel)
Specified by:
removeWizardPanel in interface JWizardComponents

removeWizardPanel

public JWizardPanel removeWizardPanel(int index)
Specified by:
removeWizardPanel in interface JWizardComponents

removeWizardPanelAfter

public JWizardPanel removeWizardPanelAfter(JWizardPanel panel)
Specified by:
removeWizardPanelAfter in interface JWizardComponents

removeWizardPanelBefore

public JWizardPanel removeWizardPanelBefore(JWizardPanel panel)
Specified by:
removeWizardPanelBefore in interface JWizardComponents

getWizardPanel

public JWizardPanel getWizardPanel(int index)
Specified by:
getWizardPanel in interface JWizardComponents

getIndexOfPanel

public int getIndexOfPanel(JWizardPanel panel)
Specified by:
getIndexOfPanel in interface JWizardComponents

onLastPanel

public boolean onLastPanel()
Specified by:
onLastPanel in interface JWizardComponents

cancelButton_actionPerformed

void cancelButton_actionPerformed(java.awt.event.ActionEvent e)

finishButton_actionPerformed

void finishButton_actionPerformed(java.awt.event.ActionEvent e)

nextButton_actionPerformed

void nextButton_actionPerformed(java.awt.event.ActionEvent e)

backButton_actionPerformed

void backButton_actionPerformed(java.awt.event.ActionEvent e)

getCurrentPanel

public JWizardPanel getCurrentPanel()
                             throws java.lang.Exception
Specified by:
getCurrentPanel in interface JWizardComponents
java.lang.Exception

updateComponents

public void updateComponents()
Specified by:
updateComponents in interface JWizardComponents

getWizardPanelList

public java.util.List getWizardPanelList()
Specified by:
getWizardPanelList in interface JWizardComponents

setWizardPanelList

public void setWizardPanelList(java.util.ArrayList panelList)

getFinishAction

public FinishAction getFinishAction()
Specified by:
getFinishAction in interface JWizardComponents

setFinishAction

public void setFinishAction(FinishAction aFinishAction)
Specified by:
setFinishAction in interface JWizardComponents

getCancelAction

public CancelAction getCancelAction()
Specified by:
getCancelAction in interface JWizardComponents

setCancelAction

public void setCancelAction(CancelAction aCancelAction)
Specified by:
setCancelAction in interface JWizardComponents

getCurrentIndex

public int getCurrentIndex()
Specified by:
getCurrentIndex in interface JWizardComponents

setCurrentIndex

public void setCurrentIndex(int aCurrentIndex)
Specified by:
setCurrentIndex in interface JWizardComponents

getWizardPanelsContainer

public javax.swing.JPanel getWizardPanelsContainer()
Specified by:
getWizardPanelsContainer in interface JWizardComponents

setWizardPanelsContainer

public void setWizardPanelsContainer(javax.swing.JPanel aWizardPanelsContainer)
Specified by:
setWizardPanelsContainer in interface JWizardComponents

getBackButton

public javax.swing.JButton getBackButton()
Specified by:
getBackButton in interface JWizardComponents

setBackButton

public void setBackButton(javax.swing.JButton aBackButton)
Specified by:
setBackButton in interface JWizardComponents

getNextButton

public javax.swing.JButton getNextButton()
Specified by:
getNextButton in interface JWizardComponents

setNextButton

public void setNextButton(javax.swing.JButton aNextButton)
Specified by:
setNextButton in interface JWizardComponents

getCancelButton

public javax.swing.JButton getCancelButton()
Specified by:
getCancelButton in interface JWizardComponents

setCancelButton

public void setCancelButton(javax.swing.JButton aCancelButton)
Specified by:
setCancelButton in interface JWizardComponents

getFinishButton

public javax.swing.JButton getFinishButton()
Specified by:
getFinishButton in interface JWizardComponents

setFinishButton

public void setFinishButton(javax.swing.JButton button)
Specified by:
setFinishButton in interface JWizardComponents

setWizardPanelList

public void setWizardPanelList(java.util.List panelList)
Specified by:
setWizardPanelList in interface JWizardComponents

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
Specified by:
addPropertyChangeListener in interface JWizardComponents

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
Specified by:
removePropertyChangeListener in interface JWizardComponents

getResourceBundle

public java.util.ResourceBundle getResourceBundle()
Returns:
Returns the resourceBundle.

setResourceBundle

public void setResourceBundle(java.util.ResourceBundle resourceBundle)
Parameters:
resourceBundle - The resourceBundle to set.