edu.ucsb.nceas.morpho.plugins.datapackagewizard
Class WizardContainerFrame

java.lang.Object
  extended byjava.awt.Component
      extended byjava.awt.Container
          extended byjava.awt.Window
              extended byjava.awt.Frame
                  extended byjavax.swing.JFrame
                      extended byedu.ucsb.nceas.morpho.plugins.datapackagewizard.WizardContainerFrame
All Implemented Interfaces:
javax.accessibility.Accessible, java.awt.image.ImageObserver, java.awt.MenuContainer, javax.swing.RootPaneContainer, java.io.Serializable, javax.swing.WindowConstants

public class WizardContainerFrame
extends javax.swing.JFrame

provides a top-level container for AbstractUIPage objects. The top (title) panel and bottom button panel (including the navigation buttons) are all part of this class, with the AbstractUIPage content being nested inside a central area

See Also:
Serialized Form

Nested Class Summary
 
Nested classes inherited from class javax.swing.JFrame
javax.swing.JFrame.AccessibleJFrame
 
Nested classes inherited from class java.awt.Frame
java.awt.Frame.AccessibleAWTFrame
 
Nested classes inherited from class java.awt.Window
java.awt.Window.AccessibleAWTWindow
 
Nested classes inherited from class java.awt.Container
java.awt.Container.AccessibleAWTContainer
 
Nested classes inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
 
Field Summary
static javax.swing.JFrame frame
           
 
Fields inherited from class javax.swing.JFrame
accessibleContext, EXIT_ON_CLOSE, rootPane, rootPaneCheckingEnabled
 
Fields inherited from class java.awt.Frame
CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR
 
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, HIDE_ON_CLOSE
 
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
WizardContainerFrame()
          Constructor
 
Method Summary
 void addAttributeForImport(java.lang.String entityName, java.lang.String attributeName, java.lang.String scale, OrderedMap omap, java.lang.String xPath, boolean newTable)
           
 void cancelAction()
          The action to be executed when the "Cancel" button is pressed
 org.w3c.dom.Node collectDataFromPages()
           
 void finishAction()
          The action to be executed when the "Finish" button is pressed.
 int getAttributeImportCount()
           
 java.lang.String getCurrentImportAttributeName()
           
 java.lang.String getCurrentImportEntityName()
           
 OrderedMap getCurrentImportMap()
           
 java.lang.String getCurrentImportScale()
           
 java.lang.String getCurrentImportXPath()
           
 AbstractUIPage getCurrentPage()
          gets the wizard content from the center pane
static javax.swing.JFrame getDialogParent()
          gets the JFrame to be used as the owner by a popup dialog.
 java.lang.String getFirstPageID()
          returns the String ID of the first page that was displayed in the current wizard sequence.
 java.util.List getLastImportedAttributes()
           
 java.util.Vector getLastImportedDataSet()
           
 java.lang.String getLastImportedEntity()
           
 AbstractUIPage getPreviousPage()
          returns the AbstractUIPage object representing the previous page that was displayed in the current wizard sequence.
 java.lang.String getPreviousPageID()
          returns the String ID of the previous page that was displayed in the current wizard sequence.
 OrderedMap getSecondImportMap()
           
 boolean isCurrentImportNewTable()
           
 void nextAction()
          The action to be executed when the "Next" button (pages 1 to last-but-one) is pressed.
 void previousAction()
          The action to be executed when the "Prev" button is pressed
 void reInitializePageStack()
          Function to clear the current page stack
 void removeAttributeForImport()
           
 void setButtonsStatus(boolean prevStatus, boolean nextStatus, boolean finishStatus)
          Method to set the enabled/disabled state of the three buttons in the WizardContainerFrame.
 void setCurrentPage(AbstractUIPage newPage)
          sets the wizard content for the center pane
 void setCurrentPage(java.lang.String pageID)
          sets the wizard content for the center pane
 void setDataPackageWizardListener(DataPackageWizardListener listener)
          sets the DataPackageWizardListener to be called back when the Wizard has finished
 void setDOMToReturn(org.w3c.dom.Node dom)
           
 void setLastImportedAttributes(java.util.List attr)
           
 void setLastImportedDataSet(java.util.Vector data)
           
 void setLastImportedEntity(java.lang.String name)
           
protected  void setShowPageCountdown(boolean show)
          if true is passed, the "page # of ##" counter will be shown in the footer
 
Methods inherited from class javax.swing.JFrame
addImpl, createRootPane, frameInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getJMenuBar, getLayeredPane, getRootPane, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, update
 
Methods inherited from class java.awt.Frame
addNotify, finalize, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setCursor, setExtendedState, setIconImage, setMaximizedBounds, setMenuBar, setResizable, setState, setTitle, setUndecorated
 
Methods inherited from class java.awt.Window
addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getMostRecentFocusOwner, getOwnedWindows, getOwner, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindowStateListeners, hide, isActive, isFocusableWindow, isFocusCycleRoot, isFocused, isShowing, pack, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setCursor, setFocusableWindowState, setFocusCycleRoot, setLocationRelativeTo, show, toBack, 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, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setFocusTraversalKeys, setFocusTraversalPolicy, setFont, 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, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, 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, isOpaque, 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, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, setVisible, show, size, toString, transferFocus, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface java.awt.MenuContainer
getFont, postEvent
 

Field Detail

frame

public static javax.swing.JFrame frame
Constructor Detail

WizardContainerFrame

public WizardContainerFrame()
Constructor

Method Detail

setDataPackageWizardListener

public void setDataPackageWizardListener(DataPackageWizardListener listener)
sets the DataPackageWizardListener to be called back when the Wizard has finished

Parameters:
listener - the DataPackageWizardListener to be called back when the Wizard has finished

setCurrentPage

public void setCurrentPage(java.lang.String pageID)
sets the wizard content for the center pane

Parameters:
pageID - the String pageID of the wizard content to be loaded into the center pane

setCurrentPage

public void setCurrentPage(AbstractUIPage newPage)
sets the wizard content for the center pane

Parameters:
newPage - the wizard content for the center pane

getCurrentPage

public AbstractUIPage getCurrentPage()
gets the wizard content from the center pane

Returns:
the wizard content from the center pane

setButtonsStatus

public void setButtonsStatus(boolean prevStatus,
                             boolean nextStatus,
                             boolean finishStatus)
Method to set the enabled/disabled state of the three buttons in the WizardContainerFrame. The Cancel button is always enabled.

Parameters:
prevStatus - - the state of the 'prev' Button. If true, it enables the button, else it disables the button
nextStatus - - the state of the 'next' Button. If true, it enables the button, else it disables the button
finishStatus - - the state of the 'finish' Button. If true, it enables the button, else it disables the button

setShowPageCountdown

protected void setShowPageCountdown(boolean show)
if true is passed, the "page # of ##" counter will be shown in the footer

Parameters:
show - boolean

getFirstPageID

public java.lang.String getFirstPageID()
returns the String ID of the first page that was displayed in the current wizard sequence. Used, for example, by Summary page to determine which wizard sequence it is summarizing

Returns:
String ID of the first page that was displayed in the current wizard sequence (@see DataPackageWizardInterface for values)

getPreviousPageID

public java.lang.String getPreviousPageID()
returns the String ID of the previous page that was displayed in the current wizard sequence.

Returns:
String ID of the previous page that was displayed in the current wizard sequence (@see DataPackageWizardInterface for values)

getPreviousPage

public AbstractUIPage getPreviousPage()
returns the AbstractUIPage object representing the previous page that was displayed in the current wizard sequence.

Returns:
AbstractUIPage object representing the previous page that was displayed in the current wizard sequence. DOES NOT REMOVE IT FROM THE STACK, so multiple calls will all return the same value

nextAction

public void nextAction()
The action to be executed when the "Next" button (pages 1 to last-but-one) is pressed. It's up to the content to know whether it's the last page or not


finishAction

public void finishAction()
The action to be executed when the "Finish" button is pressed.


collectDataFromPages

public org.w3c.dom.Node collectDataFromPages()

setDOMToReturn

public void setDOMToReturn(org.w3c.dom.Node dom)

previousAction

public void previousAction()
The action to be executed when the "Prev" button is pressed


reInitializePageStack

public void reInitializePageStack()
Function to clear the current page stack


cancelAction

public void cancelAction()
The action to be executed when the "Cancel" button is pressed


getDialogParent

public static javax.swing.JFrame getDialogParent()
gets the JFrame to be used as the owner by a popup dialog. Basically, if the wizard is showing, the wizard container frame is returned. If not, the current morpho frame is returned.

Returns:
JFrame

addAttributeForImport

public void addAttributeForImport(java.lang.String entityName,
                                  java.lang.String attributeName,
                                  java.lang.String scale,
                                  OrderedMap omap,
                                  java.lang.String xPath,
                                  boolean newTable)

getCurrentImportEntityName

public java.lang.String getCurrentImportEntityName()

getCurrentImportAttributeName

public java.lang.String getCurrentImportAttributeName()

getCurrentImportScale

public java.lang.String getCurrentImportScale()

getCurrentImportMap

public OrderedMap getCurrentImportMap()

getSecondImportMap

public OrderedMap getSecondImportMap()

getCurrentImportXPath

public java.lang.String getCurrentImportXPath()

isCurrentImportNewTable

public boolean isCurrentImportNewTable()

getAttributeImportCount

public int getAttributeImportCount()

removeAttributeForImport

public void removeAttributeForImport()

setLastImportedEntity

public void setLastImportedEntity(java.lang.String name)

setLastImportedDataSet

public void setLastImportedDataSet(java.util.Vector data)

setLastImportedAttributes

public void setLastImportedAttributes(java.util.List attr)

getLastImportedEntity

public java.lang.String getLastImportedEntity()

getLastImportedAttributes

public java.util.List getLastImportedAttributes()

getLastImportedDataSet

public java.util.Vector getLastImportedDataSet()


Copyright © 2000 National Center for Ecological Analysis and Synthesis. All Rights Reserved.