Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

javatools.swing
Class AbstractWizard  view AbstractWizard download AbstractWizard.java

java.lang.Object
  extended byjava.awt.Component
      extended byjava.awt.Container
          extended byjava.awt.Window
              extended byjava.awt.Dialog
                  extended byjavax.swing.JDialog
                      extended byjavatools.swing.AbstractWizard
All Implemented Interfaces:
javax.accessibility.Accessible, java.awt.image.ImageObserver, java.awt.MenuContainer, javax.swing.RootPaneContainer, java.io.Serializable, javax.swing.WindowConstants
Direct Known Subclasses:
ConnectionWizard, DatabaseInitWizard, ScriptExecutorWizard, TestWizard

public abstract class AbstractWizard
extends javax.swing.JDialog

Class to represent a generic wizard, with much code written and ready to use.

Version:
0.1.10

Nested Class Summary
 
Nested classes inherited from class javax.swing.JDialog
javax.swing.JDialog.AccessibleJDialog
 
Nested classes inherited from class java.awt.Dialog
java.awt.Dialog.AccessibleAWTDialog
 
Nested classes inherited from class java.awt.Window
java.awt.Window.AccessibleAWTWindow
 
Nested classes inherited from class java.awt.Container
java.awt.Container.AccessibleAWTContainer
 
Nested classes inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
 
Field Summary
private  java.lang.String backgroundFile
           
private  javax.swing.JButton butBack
           
private  javax.swing.JButton butCancel
           
private  javax.swing.JButton butFinish
           
private  javax.swing.JButton butHelp
           
private  javax.swing.JButton butNext
           
static int CANCEL_OPTION
           
private  boolean exitOnClose
           
static int FINISH_OPTION
           
private  javax.swing.JFrame helpForm
           
private  java.awt.Dimension initialFakeDims
           
private  java.awt.Dimension initialFormDims
           
private  java.awt.Dimension initialPanelDims
           
private  java.util.ResourceBundle javatoolsBundle
           
private  javax.swing.JLabel lblDescription
           
private  javax.swing.JPanel panButWizard
           
private  javax.swing.JPanel panInButWizard
           
private  javax.swing.JPanel panLabelContainer
           
private  javax.swing.JPanel panWizPanel
           
protected static int selectedOption
           
protected  int visiblePane
          It contains the number of the visible pane in a certain moment.
protected  InputPanel[] wizPanels
          The panels of this wizards.
 
Fields inherited from class javax.swing.JDialog
accessibleContext, rootPane, rootPaneCheckingEnabled
 
Fields inherited from class java.awt.Dialog
 
Fields inherited from class java.awt.Window
 
Fields inherited from class java.awt.Container
 
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
 
Fields inherited from interface javax.swing.WindowConstants
DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE
 
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
AbstractWizard()
           
AbstractWizard(java.awt.Frame parent, boolean modal)
          Creates new form AbstractWizard
 
Method Summary
protected  java.util.Properties buildProperties()
          Returns all the inserted values into the wizard as a properties object.
private  void butBackActionPerformed(java.awt.event.ActionEvent evt)
           
private  void butCancelActionPerformed(java.awt.event.ActionEvent evt)
           
private  void butFinishActionPerformed(java.awt.event.ActionEvent evt)
           
private  void butHelpActionPerformed(java.awt.event.ActionEvent evt)
           
private  void butNextActionPerformed(java.awt.event.ActionEvent evt)
           
private  void closeDialog(java.awt.event.WindowEvent evt)
          Closes the dialog
abstract  void execute()
          Executes after collecting all necessary information.
 java.lang.String getBackgroundFile()
          Returns the filename of the image file used as a background.
 java.lang.String getValue(int numValue)
          Gets a wizard value.
 java.lang.String getValue(java.lang.String name)
          Gets a wizard value.
 int getValuePos(java.lang.String name)
          Searches the position of a value whose name is the one passed as a parameter.
private  void initComponents()
          This method is called from within the constructor to initialize the form.
private  void initDescription()
           
protected  void initPanels()
          Initialized all the panes, with correct dimensions.
private  void resizePanels(java.awt.Dimension panelDims)
           
 void setBackgroundFile(java.lang.String fileName)
          Sets a filename that represents an image file, to be displayed as a background on the left.
protected  void setEnabledFinishButton(boolean value)
          It should be used to disable finishing if all the needed information has not yet been collected.
 void setExitOnClose(boolean value)
          Sets if it should exit the program on closing the window.
 void setHelpForm(javax.swing.JFrame pHelpForm)
          Sets a reference to the form which will be displayed by pressing the "Help" button.
 void setValue(int numValue, java.lang.String value)
          Sets a wizard value.
 void setValue(java.lang.String name, java.lang.String value)
          Sets a wizard value.
protected  void showNextPane()
          Shows the next pane.
protected  void showPreviousPane()
          Shows the previous pane.
 
Methods inherited from class javax.swing.JDialog
addImpl, createRootPane, dialogInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getJMenuBar, getLayeredPane, getPreferredSize, getRootPane, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, update
 
Methods inherited from class java.awt.Dialog
addNotify, dispose, getTitle, hide, isModal, isResizable, isUndecorated, setModal, setResizable, setTitle, setUndecorated, show
 
Methods inherited from class java.awt.Window
addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getGraphicsConfiguration, getListeners, getLocale, getMostRecentFocusOwner, getOwnedWindows, getOwner, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindowStateListeners, isActive, isFocusableWindow, isFocusCycleRoot, isFocused, isShowing, pack, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setCursor, setFocusableWindowState, setFocusCycleRoot, setLocationRelativeTo, toBack, toFront
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, removeNotify, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFont, transferFocusDownCycle, validate, validateTree
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isOpaque, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, setVisible, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

FINISH_OPTION

public static final int FINISH_OPTION
See Also:
Constant Field Values

CANCEL_OPTION

public static final int CANCEL_OPTION
See Also:
Constant Field Values

wizPanels

protected InputPanel[] wizPanels
The panels of this wizards. They must be of InputPanel class.


visiblePane

protected int visiblePane
It contains the number of the visible pane in a certain moment.


panInButWizard

private javax.swing.JPanel panInButWizard

butFinish

private javax.swing.JButton butFinish

butCancel

private javax.swing.JButton butCancel

butBack

private javax.swing.JButton butBack

panLabelContainer

private javax.swing.JPanel panLabelContainer

butHelp

private javax.swing.JButton butHelp

lblDescription

private javax.swing.JLabel lblDescription

panWizPanel

private javax.swing.JPanel panWizPanel

butNext

private javax.swing.JButton butNext

panButWizard

private javax.swing.JPanel panButWizard

selectedOption

protected static int selectedOption

backgroundFile

private java.lang.String backgroundFile

initialFormDims

private java.awt.Dimension initialFormDims

initialFakeDims

private java.awt.Dimension initialFakeDims

initialPanelDims

private java.awt.Dimension initialPanelDims

helpForm

private javax.swing.JFrame helpForm

exitOnClose

private boolean exitOnClose

javatoolsBundle

private java.util.ResourceBundle javatoolsBundle
Constructor Detail

AbstractWizard

public AbstractWizard()

AbstractWizard

public AbstractWizard(java.awt.Frame parent,
                      boolean modal)
Creates new form AbstractWizard

Method Detail

execute

public abstract void execute()
                      throws WizardException
Executes after collecting all necessary information.


setExitOnClose

public void setExitOnClose(boolean value)
Sets if it should exit the program on closing the window.


setValue

public void setValue(int numValue,
                     java.lang.String value)
              throws java.lang.IndexOutOfBoundsException
Sets a wizard value. It will be searched between all the assigned panes.


setValue

public void setValue(java.lang.String name,
                     java.lang.String value)
Sets a wizard value. It will be searched between all the assigned panes.


getValue

public java.lang.String getValue(int numValue)
                          throws java.lang.IndexOutOfBoundsException
Gets a wizard value. It will be searched between all the assigned panes.


getValue

public java.lang.String getValue(java.lang.String name)
Gets a wizard value. It will be searched between all the assigned panes.


getValuePos

public int getValuePos(java.lang.String name)
Searches the position of a value whose name is the one passed as a parameter.


setBackgroundFile

public void setBackgroundFile(java.lang.String fileName)
                       throws WizardException
Sets a filename that represents an image file, to be displayed as a background on the left.


getBackgroundFile

public java.lang.String getBackgroundFile()
Returns the filename of the image file used as a background.


setHelpForm

public void setHelpForm(javax.swing.JFrame pHelpForm)
Sets a reference to the form which will be displayed by pressing the "Help" button.


showNextPane

protected void showNextPane()
Shows the next pane.


showPreviousPane

protected void showPreviousPane()
Shows the previous pane.


initPanels

protected void initPanels()
Initialized all the panes, with correct dimensions.


buildProperties

protected java.util.Properties buildProperties()
Returns all the inserted values into the wizard as a properties object.


setEnabledFinishButton

protected void setEnabledFinishButton(boolean value)
It should be used to disable finishing if all the needed information has not yet been collected.


initComponents

private void initComponents()
This method is called from within the constructor to initialize the form. WARNING: Do NOT modify this code. The content of this method is always regenerated by the Form Editor.


butHelpActionPerformed

private void butHelpActionPerformed(java.awt.event.ActionEvent evt)

butCancelActionPerformed

private void butCancelActionPerformed(java.awt.event.ActionEvent evt)

butFinishActionPerformed

private void butFinishActionPerformed(java.awt.event.ActionEvent evt)

butNextActionPerformed

private void butNextActionPerformed(java.awt.event.ActionEvent evt)

butBackActionPerformed

private void butBackActionPerformed(java.awt.event.ActionEvent evt)

closeDialog

private void closeDialog(java.awt.event.WindowEvent evt)
Closes the dialog


initDescription

private void initDescription()

resizePanels

private void resizePanels(java.awt.Dimension panelDims)