org.peace_tools.core.dataset
Class DataSetWizard

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Window
              java.awt.Dialog
                  javax.swing.JDialog
                      org.peace_tools.generic.WizardDialog
                          org.peace_tools.core.dataset.DataSetWizard

All Implemented Interfaces:

java.awt.event.ActionListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants

public class DataSetWizard
extends WizardDialog

This class serves as the top-level class for adding a new data set entry to the work space. This top-level class merely creates the various pages and adds them to the wizard. Each page performs a specific task required to create or edit a complete data set.

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.JDialog.AccessibleJDialog

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

java.awt.Dialog.AccessibleAWTDialog, java.awt.Dialog.ModalExclusionType, java.awt.Dialog.ModalityType

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

java.awt.Window.AccessibleAWTWindow

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.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

private DataSet	dataSet This is the server entry that is being currently edited via this wizard.
private ESTList	estList The list of ESTs associated with this data set.
private static java.lang.String	OVERVIEW_MSG A static overview message that is displayed in the first overview page displayed by this wizard to the user.
private static long	serialVersionUID The generated serialization UID (need to keep the compiler happy)

Fields inherited from class javax.swing.JDialog

accessibleContext, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Dialog

DEFAULT_MODALITY_TYPE

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

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

DataSetWizard(java.lang.String title, MainFrame parent)
The constructor for the data set wizard.

Method Summary

protected boolean	cancel() Helper method invoked when user clicks cancel button.
private void	createOverview() Helper method to create the overview page.
void	done(boolean success) This method overrides the final notification method in this wizard to add the new data set (if wizard was successfully completed) to the workspace.
ESTList	getESTList() This method can be used to obtain the ESTs associated with this data set.
void	setESTList(ESTList estList) Set the list of ESTs associated with this data set.

Methods inherited from class org.peace_tools.generic.WizardDialog

actionPerformed, addPage, addThread, changePage, checkChangePage, getCurrentPage, getPage, getPagePane, layoutButtons, layoutSequencePanel, layoutTitlePanel, layoutWizard, removeThread, setButtonStatus, setSequenceBackground, setTitleBackground, showWizard

Methods inherited from class javax.swing.JDialog

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

Methods inherited from class java.awt.Dialog

addNotify, getModalityType, getTitle, hide, isModal, isResizable, isUndecorated, setModal, setModalityType, setResizable, setTitle, setUndecorated, setVisible, show, toBack

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOwnedWindows, getOwner, getOwnerlessWindows, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, pack, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeNotify, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImage, setIconImages, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, 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, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, 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, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, 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, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, 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, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resize, resize, setBackground, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

dataSet

private DataSet dataSet

This is the server entry that is being currently edited via this wizard. This object is accessed by the various pages in this wizard and updated as the user navigates through the wizard pages.

estList

private ESTList estList

The list of ESTs associated with this data set. This object is set whenever one of the pages loads the EST data.

OVERVIEW_MSG

private static final java.lang.String OVERVIEW_MSG

A static overview message that is displayed in the first overview page displayed by this wizard to the user.

See Also:

Constant Field Values

serialVersionUID

private static final long serialVersionUID

The generated serialization UID (need to keep the compiler happy)

See Also:

Constant Field Values

Constructor Detail

DataSetWizard

public DataSetWizard(java.lang.String title,
                     MainFrame parent)

The constructor for the data set wizard. The constructor lays out the wizard and creates all the wizard pages. The wizard pages are created as blank pages and get populated with the necessary information just before the pages get displayed to the user.

Parameters:

title - The title to be set for the main wizard frame.

parent - The main frame that logically owns the dialog

Method Detail

cancel

protected boolean cancel()

Helper method invoked when user clicks cancel button. This is a helper method that is overridden in this class. This method is invoked when the user clicks the cancel button in the wizard. This method is used to display a confirmation dialog to ensure that the user really wants to exit out of the wizard.

Overrides:

cancel in class WizardDialog

Returns:

This method returns true if the user wants to quit out of the wizard dialog.

createOverview

private void createOverview()

Helper method to create the overview page. This method was introduced to keep the code clutter in the constructor to a bare minimum.

done

public void done(boolean success)

This method overrides the final notification method in this wizard to add the new data set (if wizard was successfully completed) to the workspace.

Overrides:

done in class WizardDialog

Parameters:

success - This flag is true if the wizard completed successfully and the user clicks the finish button. Otherwise this flag is set ot false, indicating an premature exit.

getESTList

public ESTList getESTList()

This method can be used to obtain the ESTs associated with this data set.

Returns:

The list of ESTs associated with this data set.

setESTList

public void setESTList(ESTList estList)

Set the list of ESTs associated with this data set.

Parameters:

estList - The list of ESTs associated with this data set.