com.bws42.wizard
Class AbstractWizardPanel

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  com.bws42.wizard.AbstractWizardPanel

All Implemented Interfaces:

Accessible, ImageObserver, MenuContainer, Multilingual, Serializable, WizardPanel

Direct Known Subclasses:

ExampleWizardPanel

public abstract class AbstractWizardPanel

extends JPanel

implements WizardPanel

Extend this class to create a panel for a Wizard.

Version:

1.0, October 4, 2006

Author:

William P. Roberts, IV

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class javax.swing.JPanel

JPanel.AccessibleJPanel

Nested classes inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields inherited from class javax.swing.JComponent

accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

AbstractWizardPanel()
Creates a new AbstractWizardPanel.

Method Summary

JComponent	getComponent() Returns this panel.
protected String	getString(String key) Gets the string for the given key if it exists.
protected String	getString(String key, String[] values) Gets the string for the given key if it exists and returns it with any variables replaced by the appropriate string in the String[].
boolean	isNextAvailable() Returns true, the user can proceed forward from this panel.
boolean	isPrevAvailable() Returns true, the user can proceed backwards from this panel.
void	panelInstalled() Called after a panel has been displayed to the user.
protected abstract void	setLanguage() Called to notify the subclass that a new LanguageLoader is installed and that it should update any strings it has to the new language.
void	setLanguageLoader(LanguageLoader lang) Sets the new language loader and tells the subclass that a new LanguageLoader has been installed.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setLayout, 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, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.bws42.wizard.WizardPanel

getWizardObject, setWizardObject, validateContents

Constructor Detail

AbstractWizardPanel

public AbstractWizardPanel()

Creates a new AbstractWizardPanel.

Method Detail

isPrevAvailable

public boolean isPrevAvailable()

Returns true, the user can proceed backwards from this panel. This is the default value, subclasses can override this to provide different logic.

Specified by:

isPrevAvailable in interface WizardPanel

Returns:

true

isNextAvailable

public boolean isNextAvailable()

Returns true, the user can proceed forward from this panel. This is the default value, subclasses can override this to provide different logic.

Specified by:

isNextAvailable in interface WizardPanel

Returns:

true

panelInstalled

public void panelInstalled()

Called after a panel has been displayed to the user. Allows you to do any final graphical configuration. This method should not be used to do any significant work as it will appear that your wizard has frozen.

Specified by:

panelInstalled in interface WizardPanel

getString

protected final String getString(String key)

Gets the string for the given key if it exists.

Parameters:

key - the key to search for.

Returns:

the string corresponding to the key.

Throws:

MissingResourceException - if the key does not exist

getString

protected final String getString(String key,
                                 String[] values)

Gets the string for the given key if it exists and returns it with any variables replaced by the appropriate string in the String[]. Variables are denoted by {#} in the text file, and the count starts at 0.

Parameters:

key - the key to search for

values - the strings to replace the variables with

Returns:

the string corresponding to the key with the replacements.

Throws:

MissingResourceException - if the key does not exist

setLanguage

protected abstract void setLanguage()

Called to notify the subclass that a new LanguageLoader is installed and that it should update any strings it has to the new language.

setLanguageLoader

public final void setLanguageLoader(LanguageLoader lang)

Sets the new language loader and tells the subclass that a new LanguageLoader has been installed.

Specified by:

setLanguageLoader in interface WizardPanel

Parameters:

lang - the new LanguageLoader.

getComponent

public final JComponent getComponent()

Returns this panel.

Specified by:

getComponent in interface WizardPanel

Returns:

this panel