javatools.swing
Class AbstractWizard

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--java.awt.Window
                    |
                    +--java.awt.Frame
                          |
                          +--javax.swing.JFrame
                                |
                                +--javatools.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, ScriptExecutorWizard, TestWizard, Volume2DbWizard

public abstract class AbstractWizard

extends javax.swing.JFrame

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

See Also:

Serialized Form

Field Summary

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.JFrame

accessibleContext, EXIT_ON_CLOSE, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Frame

CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR

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, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

AbstractWizard()
Creates new form DBScriptWizard

Method Summary

protected java.util.Properties	buildProperties() Returns all the inserted values into the wizard as a properties object.
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.
protected void	initPanels() Initialized all the panes, with correct dimensions.
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.JFrame

addImpl, createRootPane, frameInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getJMenuBar, getLayeredPane, getRootPane, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, update

Methods inherited from class java.awt.Frame

addNotify, finalize, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setCursor, setExtendedState, setIconImage, setMaximizedBounds, setMenuBar, setResizable, setState, setTitle, setUndecorated

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getMostRecentFocusOwner, getOwnedWindows, getOwner, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindowStateListeners, hide, isActive, isFocusableWindow, isFocusCycleRoot, isFocused, isShowing, pack, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setCursor, setFocusableWindowState, setFocusCycleRoot, setLocationRelativeTo, show, toBack, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setFocusTraversalKeys, setFocusTraversalPolicy, setFont, transferFocusBackward, 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, getBackground, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, 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, 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, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.awt.MenuContainer

getFont, postEvent

Field Detail

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.

Constructor Detail

AbstractWizard

public AbstractWizard()

Creates new form DBScriptWizard

Method Detail

execute

public abstract void execute()
                      throws WizardException

Executes after collecting all necessary information.

Throws:

WizardException - If something goes wrong in executing.

setExitOnClose

public void setExitOnClose(boolean value)

Sets if it should exit the program on closing the window.

Parameters:

value - true: when window is closed, exits the program; false: when window is closed, disposes 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.

Parameters:

numValue - The number of the needed value.

value - The value to be assigned.

Throws:

java.lang.IndexOutOfBoundsException - If numValue is not valid.

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.

Parameters:

name - The name of the needed value.

value - The value to be assigned.

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.

Parameters:

numValue - The number of the needed value.

Returns:

The needed value.

Throws:

java.lang.IndexOutOfBoundsException - If numValue is not valid.

getValue

public java.lang.String getValue(java.lang.String name)

Gets a wizard value. It will be searched between all the assigned panes.

Parameters:

name - The name of the value.

Returns:

The needed value.

getValuePos

public int getValuePos(java.lang.String name)

Searches the position of a value whose name is the one passed as a parameter.

Parameters:

name - The name of the needed value.

Returns:

The position of the needed value.

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.

Parameters:

fileName - The filename of the image file.

Throws:

WizardException - If the file does not exist.

getBackgroundFile

public java.lang.String getBackgroundFile()

Returns the filename of the image file used as a background.

Returns:

The filename.

setHelpForm

public void setHelpForm(javax.swing.JFrame pHelpForm)

Sets a reference to the form which will be displayed by pressing the "Help" button.

Parameters:

pHelpForm - The reference to the help form.

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.

Returns:

The properties representing all the inserted values.

setEnabledFinishButton

protected void setEnabledFinishButton(boolean value)

It should be used to disable finishing if all the needed information has not yet been collected.

Parameters:

value - true: the Finish button is enabled. false: the Finish button is disabled.