Package com.vividsolutions.jump.workbench.ui.wizard

Class AbstractWizardPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

com.vividsolutions.jump.workbench.ui.wizard.AbstractWizardPanel

All Implemented Interfaces:

WizardPanel, WizardPanelV2, ImageObserver, MenuContainer, Serializable, Accessible

Direct Known Subclasses:

AddDataStoreLayerWizardPanel, AddWritableDataStoreLayerWizardPanel, ChooseProjectPanel, SaveToDataStorePanel

public class AbstractWizardPanel
extends JPanel
implements WizardPanelV2

See Also:

Serialized Form

Nested Class Summary

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

JPanel.AccessibleJPanel

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

JComponent.AccessibleJComponent

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

Container.AccessibleAWTContainer

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

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields inherited from class javax.swing.JComponent

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

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

Constructors

Constructor	Description
AbstractWizardPanel()
AbstractWizardPanel(String id, String title, String instructions)
AbstractWizardPanel(String id, String nextId, String title, String instructions)

Method Summary

Modifier and Type	Method	Description
void	add(InputChangedListener listener)	Tip: Delegate to an InputChangedFirer.
void	enteredFromLeft(Map data)	Called when the user presses Next on this panel's previous panel
void	enteredFromRight()	Called in WizardDialog when the user presses Previous on this panel's next panel to (re)initialize this panel, see e.g.
void	exitingToLeft()	Called in WizardDialog when the user leaves this panel without taking action
void	exitingToRight()	Called when the user presses Next on this panel
protected void	fireInputChanged()
Map	getData()
String	getID()
String	getInstructions()
String	getNextID()
String	getTitle()
boolean	isInputValid()
void	remove(InputChangedListener listener)
protected void	setNextID(String nextId)

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, getBaseline, getBaselineResizeBehavior, 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, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, 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, 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, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, 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, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractWizardPanel

public AbstractWizardPanel()

AbstractWizardPanel

public AbstractWizardPanel(String id,
                           String title,
                           String instructions)

AbstractWizardPanel

public AbstractWizardPanel(String id,
                           String nextId,
                           String title,
                           String instructions)

Method Detail

add

public void add(InputChangedListener listener)

Description copied from interface: WizardPanel

Tip: Delegate to an InputChangedFirer.

Specified by:

add in interface WizardPanel

Parameters:

listener - a party to notify when the input changes (usually the WizardDialog, which needs to know when to update the enabled state of the buttons.

remove

public void remove(InputChangedListener listener)

Specified by:

remove in interface WizardPanel

fireInputChanged

protected void fireInputChanged()

enteredFromLeft

public void enteredFromLeft(Map data)

Description copied from interface: WizardPanel

Called when the user presses Next on this panel's previous panel

Specified by:

enteredFromLeft in interface WizardPanel

Parameters:

data - the dataMap containing all parameters

enteredFromRight

public void enteredFromRight()
                      throws Exception

Description copied from interface: WizardPanelV2

Called in WizardDialog when the user presses Previous on this panel's next panel to (re)initialize this panel, see e.g. SelectFilesPanel

Specified by:

enteredFromRight in interface WizardPanelV2

Throws:

Exception - if an Exception occurs

getData

public Map getData()

exitingToRight

public void exitingToRight()
                    throws Exception

Description copied from interface: WizardPanel

Called when the user presses Next on this panel

Specified by:

exitingToRight in interface WizardPanel

Throws:

Exception - if an Exception occurs

exitingToLeft

public void exitingToLeft()

Description copied from interface: WizardPanelV2

Called in WizardDialog when the user leaves this panel without taking action

Specified by:

exitingToLeft in interface WizardPanelV2

getID

public String getID()

Specified by:

getID in interface WizardPanel

getInstructions

public String getInstructions()

Specified by:

getInstructions in interface WizardPanel

getNextID

public String getNextID()

Specified by:

getNextID in interface WizardPanel

Returns:

null to turn the Next button into a Finish button

setNextID

protected void setNextID(String nextId)

getTitle

public String getTitle()

Specified by:

getTitle in interface WizardPanel

isInputValid

public boolean isInputValid()

Specified by:

isInputValid in interface WizardPanel