org.browsecode.helpers.wizard
Class WizardCard

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  org.browsecode.helpers.wizard.WizardCard

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

Direct Known Subclasses:

EmailWizardCard1List, EmailWizardCard3, EmailWizardCard4, EmailWizardCard4HalfPreSending, EmailWizardCard6LogResults, ExportWizardCard3, HTMLTextCard, ImportWizardCard1Open, ImportWizardCard2List, LoadDictionary, LoadTable, OpenDatabaseWizardCard, Options, PageCard, PickDataFromTable, ProgressCard, SaveResults, StyledDocumentCard

public abstract class WizardCard
extends javax.swing.JPanel

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JPanel

javax.swing.JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

static WizardCard

unknownCard this card should be used to indicate that the next step is not yet known since this indicates the user needs to make a decision both the next and finished buttons will be disabled if this is the next card in sequence.

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

WizardCard()

WizardCard(java.awt.LayoutManager layout)

Method Summary

void	display() Called right before showing the card, before adding it to its parent.
void	fireNextChanged() call this if the next card has changed (which might occur at a decision junction)
boolean	getHasHelp()
java.net.URL	getHelpURL()
WizardCard	getNext() return the next card in the series or null if this is the last card return an unknownCard to indicate that the next card is not yet available, but this is not the last card the general contract with a Wizard is that this function will only be called once per instance, unless fireNextChanged is invoked.
java.lang.Object	getProperty(java.lang.String key) use this method to retrieve the named property
abstract java.lang.String	getTitle() return the title of this card to be displayed to the user
Wizard	getWizard()
void	helpClicked()
void	initialize() this method is invoked on the first transition from the previous slide to this slide, before the component is shown (display is called afterwards) this method is *not* invoked on the return trip, nor on any repeated trips -- it is only invoked once!
boolean	nextClicked() this is a vetoable event that will be called when the user clicks the next button return true to proceed to the next card; return false to force the user to remain on this slide any time-sensitive mutation of the next slide should be performed here since there is no notification on returning from the next slide, this operation should be safe to execute multiple times in succession (with possibly varying configuration settings for this card).
void	postDisplay() Called right after showing the card and adding it to the right place.
void	previousClicked() this method is called when returning from the following slide by the user clicking the "previous" button to emphasize that clicking previous is always a safe user option, this method is not vetoable this is the appropriate place to do any clean-up to restore the state
void	setHelpURL(java.net.URL helpURL)
void	setNext(WizardCard card)
void	setProperty(java.lang.String key, java.lang.Object value) use this method to set a property for other cards to access the key must be unique in this wizard's set of slides
void	setWizard(Wizard wizard) will be automatically called when first added to a Wizard

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, 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, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, 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, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, 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, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, 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

Field Detail

unknownCard

public static WizardCard unknownCard

this card should be used to indicate that the next step is not yet known since this indicates the user needs to make a decision both the next and finished buttons will be disabled if this is the next card in sequence.

Constructor Detail

WizardCard

public WizardCard()

WizardCard

public WizardCard(java.awt.LayoutManager layout)

Method Detail

setWizard

public void setWizard(Wizard wizard)

will be automatically called when first added to a Wizard

getWizard

public Wizard getWizard()

getTitle

public abstract java.lang.String getTitle()

return the title of this card to be displayed to the user

Returns:

fireNextChanged

public void fireNextChanged()

call this if the next card has changed (which might occur at a decision junction)

getProperty

public java.lang.Object getProperty(java.lang.String key)

use this method to retrieve the named property

setProperty

public void setProperty(java.lang.String key,
                        java.lang.Object value)

use this method to set a property for other cards to access the key must be unique in this wizard's set of slides

getNext

public WizardCard getNext()

return the next card in the series or null if this is the last card return an unknownCard to indicate that the next card is not yet available, but this is not the last card the general contract with a Wizard is that this function will only be called once per instance, unless fireNextChanged is invoked. therefore, no caching is required (unless of course you wish to mutate the next card based on this wizard's settings)

setNext

public void setNext(WizardCard card)

nextClicked

public boolean nextClicked()

this is a vetoable event that will be called when the user clicks the next button return true to proceed to the next card; return false to force the user to remain on this slide any time-sensitive mutation of the next slide should be performed here since there is no notification on returning from the next slide, this operation should be safe to execute multiple times in succession (with possibly varying configuration settings for this card).

previousClicked

public void previousClicked()

this method is called when returning from the following slide by the user clicking the "previous" button to emphasize that clicking previous is always a safe user option, this method is not vetoable this is the appropriate place to do any clean-up to restore the state

display

public void display()

Called right before showing the card, before adding it to its parent. any time-sensitive initialization should be performed here rather than in the constructor this method is invoked on every transition from the previous slide to this slide this method is *not* invoked on the return trip

postDisplay

public void postDisplay()

Called right after showing the card and adding it to the right place.

initialize

public void initialize()

this method is invoked on the first transition from the previous slide to this slide, before the component is shown (display is called afterwards) this method is *not* invoked on the return trip, nor on any repeated trips -- it is only invoked once!

getHasHelp

public boolean getHasHelp()

Returns:

Whether or not the page has an HTML help file and we should show the button.

helpClicked

public void helpClicked()

getHelpURL

public java.net.URL getHelpURL()

Returns:

the URL for the help file to show

setHelpURL

public void setHelpURL(java.net.URL helpURL)