edu.ucsb.nceas.morpho.framework
Class AbstractUIPage

java.lang.Object
  extended byjava.awt.Component
      extended byjava.awt.Container
          extended byjavax.swing.JComponent
              extended byjavax.swing.JPanel
                  extended byedu.ucsb.nceas.morpho.framework.AbstractUIPage
All Implemented Interfaces:
javax.accessibility.Accessible, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable
Direct Known Subclasses:
Access, AccessPage, AttributePage, CitationPage, CodeDefinition, CodeImportPage, CodeImportSummary, CustomUnitPage, DataFormat, DataLocation, Entity, ExternalRefsPage, General, Geographic, GeographicPage, ImportWizard, Introduction, Keywords, KeywordsPage, Methods, MethodsPage, PartyIntro, PartyMainPage, PartyPage, Project, Summary, Taxonomic, Temporal, TemporalPage, UsageRights

public abstract class AbstractUIPage
extends javax.swing.JPanel

Class AbstractUIPage

See Also:
Serialized Form

Nested Class Summary
 
Nested classes inherited from class javax.swing.JPanel
javax.swing.JPanel.AccessibleJPanel
 
Nested classes inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
 
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
 
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
AbstractUIPage()
           
 
Method Summary
abstract  java.lang.String getNextPageID()
          Returns the ID of the page that the user will see next, after the "Next" button is pressed.
abstract  OrderedMap getPageData()
          gets the Map object that contains all the key/value paired settings for this particular UI page
abstract  OrderedMap getPageData(java.lang.String rootXPath)
          gets the Map object that contains all the key/value paired settings for this particular UI page
abstract  java.lang.String getPageID()
          gets the unique ID for this UI page
abstract  java.lang.String getPageNumber()
          Returns the serial number of the page
abstract  java.lang.String getSubtitle()
          gets the subtitle for this UI page
abstract  java.lang.String getTitle()
          gets the title for this UI page
abstract  boolean onAdvanceAction()
          The action to be executed when the "Next" button (pages 1 to last-but-one) or "Finish" button(last page) is pressed.
abstract  void onLoadAction()
          The action to be executed when the page is displayed.
abstract  void onRewindAction()
          The action to be executed when the "Prev" button is pressed.
abstract  boolean setPageData(OrderedMap data, java.lang.String rootXPath)
          sets the fields in the UI page using the Map object that contains all the key/value paired
 
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFont, setForeground, 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, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, 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, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, 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, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, 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

AbstractUIPage

public AbstractUIPage()
Method Detail

getPageID

public abstract java.lang.String getPageID()
gets the unique ID for this UI page

Returns:
the unique ID String for this UI page

getTitle

public abstract java.lang.String getTitle()
gets the title for this UI page

Returns:
the String title for this UI page

getSubtitle

public abstract java.lang.String getSubtitle()
gets the subtitle for this UI page

Returns:
the String subtitle for this UI page

getNextPageID

public abstract java.lang.String getNextPageID()
Returns the ID of the page that the user will see next, after the "Next" button is pressed. If this is the last page, return value must be null

Returns:
the String ID of the page that the user will see next, or null if this is te last page

getPageNumber

public abstract java.lang.String getPageNumber()
Returns the serial number of the page

Returns:
the serial number of the page

onLoadAction

public abstract void onLoadAction()
The action to be executed when the page is displayed. May be empty


onRewindAction

public abstract void onRewindAction()
The action to be executed when the "Prev" button is pressed. May be empty


onAdvanceAction

public abstract boolean onAdvanceAction()
The action to be executed when the "Next" button (pages 1 to last-but-one) or "Finish" button(last page) is pressed. May be empty

Returns:
boolean true if wizard should advance, false if not (e.g. if a required field hasn't been filled in)

getPageData

public abstract OrderedMap getPageData()
gets the Map object that contains all the key/value paired settings for this particular UI page

Returns:
data the Map object that contains all the key/value paired settings for this particular UI page

getPageData

public abstract OrderedMap getPageData(java.lang.String rootXPath)
gets the Map object that contains all the key/value paired settings for this particular UI page

Parameters:
rootXPath - the root xpath to prepend to all the xpaths returned by this method
Returns:
data the Map object that contains all the key/value paired settings for this particular UI page

setPageData

public abstract boolean setPageData(OrderedMap data,
                                    java.lang.String rootXPath)
sets the fields in the UI page using the Map object that contains all the key/value paired

Parameters:
data - the Map object that contains all the key/value paired settings for this particular UI page
rootXPath - the String that represents the "root" of the XPath to the content of this widget, INCLUDING PREDICATES. example - if this is a "Party" widget, being used for the second "Creator" entry in a list, then xPathRoot = "/eml:eml/dataset[1]/creator[2]
Returns:
boolean true if this page can handle all the data passed in the OrderedMap, false if not. NOTE that the setPageData() method should still complete its work and fill out all the UI values, even if it is returning false


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