gov.nih.nci.cagrid.data.ui.wizard
Class AbstractWizardPanel

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  gov.nih.nci.cagrid.data.ui.wizard.AbstractWizardPanel

All Implemented Interfaces:

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

Direct Known Subclasses:

AppserviceConfigPanel, AppserviceConfigPanel, CoreDsIntroPanel, DomainModelPanel, QueryProcessorConfigurationPanel, QueryProcessorSecurityPanel, SchemaMappingPanel, SchemaTypesPanel, SDKClientSelectionPanel, SDKClientSelectionPanel

public abstract class AbstractWizardPanel
extends javax.swing.JPanel

AbstractWizardPanel Base class for panels to be used by a service creation wizard

Version:

$Id: AbstractWizardPanel.java,v 1.4 2008/01/02 19:32:08 dervin Exp $

Author:

David W. Ervin

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

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(ServiceExtensionDescriptionType extensionDescription, ServiceInformation info)

Method Summary

protected java.util.Map<java.lang.Object,java.lang.Object>	getBitBucket() Gets a Map into which data can be stored for communicating with other panels in a sequence in a wizard.
protected ExtensionTypeExtensionData	getExtensionData()
protected ServiceExtensionDescriptionType	getExtensionDescription()
abstract java.lang.String	getPanelShortName() Gets the short name for this panel.
abstract java.lang.String	getPanelTitle() Gets the descriptive title for this panel.
protected ServiceInformation	getServiceInformation()
void	movingNext() Called when the user clicks the button to travel to the next panel in the wizard.
protected void	setNextEnabled(boolean enable) Enable or disable the wizard button which allows moving to the next panel in the sequence.
protected void	setPrevEnabled(boolean enable) Enable or disable the wizard button which allows moving to the previous panel in the sequence.
protected void	setWizardComplete(boolean done)
abstract void	update() Called when the panel is shown in the 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

Constructor Detail

AbstractWizardPanel

public AbstractWizardPanel(ServiceExtensionDescriptionType extensionDescription,
                           ServiceInformation info)

Method Detail

getExtensionDescription

protected ServiceExtensionDescriptionType getExtensionDescription()

getServiceInformation

protected ServiceInformation getServiceInformation()

getExtensionData

protected ExtensionTypeExtensionData getExtensionData()

getBitBucket

protected java.util.Map<java.lang.Object,java.lang.Object> getBitBucket()

Gets a Map into which data can be stored for communicating with other panels in a sequence in a wizard. This bit bucket is not persistant, so only use it for data which doesn't really belong in the service information or extension description.

Returns:

A map for storing arbitrary data

setNextEnabled

protected void setNextEnabled(boolean enable)

Enable or disable the wizard button which allows moving to the next panel in the sequence. When the panel is shown, the previous and next buttons will be enabled / disabled according to the panel's order in the panel sequence. If the buttons state needs to be changed, do so in the update() method.

Parameters:

enable -

setPrevEnabled

protected void setPrevEnabled(boolean enable)

Enable or disable the wizard button which allows moving to the previous panel in the sequence. When the panel is shown, the previous and next buttons will be enabled / disabled according to the panel's order in the panel sequence. If the buttons state needs to be changed, do so in the update() method.

Parameters:

enable -

setWizardComplete

protected void setWizardComplete(boolean done)

update

public abstract void update()

Called when the panel is shown in the wizard. Use this call to perform any updates to the GUI needed by data changed in the extension data / bit bucket

movingNext

public void movingNext()

Called when the user clicks the button to travel to the next panel in the wizard. Use this call to perform any changes to the underlying service model.

getPanelTitle

public abstract java.lang.String getPanelTitle()

Gets the descriptive title for this panel.

Returns:

The long title for the panel

getPanelShortName

public abstract java.lang.String getPanelShortName()

Gets the short name for this panel. This name will be shown in the next / back buttons of the wizard

Returns:

The short title for the panel