edu.ucsb.nceas.morpho.plugins.datapackagewizard.pages
Class PartyPage

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
                      extended byedu.ucsb.nceas.morpho.plugins.datapackagewizard.pages.PartyPage
All Implemented Interfaces:
javax.accessibility.Accessible, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable

public class PartyPage
extends 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
protected  boolean editingOriginalRef
           
 javax.swing.JPanel listPanel
           
 javax.swing.JLabel pageDescriptionLabel
           
 
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
PartyPage(java.lang.String role)
          Constructor - determines what type of dialog (what role):
 
Method Summary
 java.lang.String getNextPageID()
          Returns the ID of the page that the user will see next, after the "Next" button is pressed.
 OrderedMap getPageData()
          gets the Map object that contains all the key/value paired settings for this particular UI page
 OrderedMap getPageData(java.lang.String rootXPath)
          gets the Map object that contains all the key/value paired
 java.lang.String getPageID()
          gets the Page ID for this wizard page
 java.lang.String getPageNumber()
          Returns the serial number of the page
protected  java.lang.String getReferencesNodeIDString()
          gets the referencesNodeIDString - ie if this party is a reference to another party, this method returns the reference id value it is using to "point to" that other party
protected  java.lang.String getRefID()
          gets the referenceID for this wizard page
 java.lang.String getSubtitle()
          gets the subtitle for this wizard page
 java.util.List getSurrogate()
           
 java.lang.String getTitle()
          gets the title for this wizard page
 boolean onAdvanceAction()
          The action to be executed when the "OK" button is pressed.
 void onLoadAction()
          The action to be executed when the page is loaded Here, it does nothing because this is just a Panel and not the outer container
 void onRewindAction()
          /** The action to be executed when the "Prev" button is pressed.
 void setEditable(boolean editable)
          The action sets all the fields in 'this' page editable or non-editable based on boolean arguement passed
 boolean setPageData(OrderedMap map, 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
 

Field Detail

pageDescriptionLabel

public javax.swing.JLabel pageDescriptionLabel

listPanel

public javax.swing.JPanel listPanel

editingOriginalRef

protected boolean editingOriginalRef
Constructor Detail

PartyPage

public PartyPage(java.lang.String role)
Constructor - determines what type of dialog (what role):

Parameters:
role - short - CREATOR, CONTACT, ASSOCIATED, PERSONNEL, CITATION_AUTHOR or UNDEFINED
Method Detail

setEditable

public void setEditable(boolean editable)
The action sets all the fields in 'this' page editable or non-editable based on boolean arguement passed

Parameters:
editable - boolean

onAdvanceAction

public boolean onAdvanceAction()
The action to be executed when the "OK" button is pressed. If no onAdvance processing is required, implementation must return boolean true.

Specified by:
onAdvanceAction in class AbstractUIPage
Returns:
boolean true if dialog should close and return to wizard, false if not (e.g. if a required field hasn't been filled in)

onRewindAction

public void onRewindAction()
/** The action to be executed when the "Prev" button is pressed. May be empty Here, it does nothing because this is just a Panel and not the outer container

Specified by:
onRewindAction in class AbstractUIPage

onLoadAction

public void onLoadAction()
The action to be executed when the page is loaded Here, it does nothing because this is just a Panel and not the outer container

Specified by:
onLoadAction in class AbstractUIPage

getRefID

protected java.lang.String getRefID()
gets the referenceID for this wizard page

Returns:
String refID

getReferencesNodeIDString

protected java.lang.String getReferencesNodeIDString()
gets the referencesNodeIDString - ie if this party is a reference to another party, this method returns the reference id value it is using to "point to" that other party

Returns:
String referencesNodeIDString

getPageID

public java.lang.String getPageID()
gets the Page ID for this wizard page

Specified by:
getPageID in class AbstractUIPage
Returns:
the Page ID String for this wizard page

getTitle

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

Specified by:
getTitle in class AbstractUIPage
Returns:
the String title for this wizard page

getSubtitle

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

Specified by:
getSubtitle in class AbstractUIPage
Returns:
the String subtitle for this wizard page

getNextPageID

public 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

Specified by:
getNextPageID in class AbstractUIPage
Returns:
the String ID of the page that the user will see next, or null if this is te last page

getPageNumber

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

Specified by:
getPageNumber in class AbstractUIPage
Returns:
the serial number of the page

getSurrogate

public java.util.List getSurrogate()
Returns:
a List contaiing 3 String elements - one for each column of the 3-col list in which this surrogate is displayed

getPageData

public OrderedMap getPageData()
Description copied from class: AbstractUIPage
gets the Map object that contains all the key/value paired settings for this particular UI page

Specified by:
getPageData in class AbstractUIPage
Returns:
data the Map object that contains all the key/value paired settings for this particular UI page

getPageData

public OrderedMap getPageData(java.lang.String rootXPath)
gets the Map object that contains all the key/value paired

Specified by:
getPageData in class AbstractUIPage
Parameters:
rootXPath - the string xpath to which this dialog's xpaths will be appended when making name/value pairs. For example, in the xpath: /eml:eml/dataset/creator[2]/individualName/surName, the root would be /eml:eml/dataset/creator[2]. NOTE - MUST NOT END WITH A SLASH, BUT MAY END WITH AN INDEX IN SQUARE BRACKETS []
Returns:
data the Map object that contains all the key/value paired settings for this particular wizard page

setPageData

public boolean setPageData(OrderedMap map,
                           java.lang.String rootXPath)
Description copied from class: AbstractUIPage
sets the fields in the UI page using the Map object that contains all the key/value paired

Specified by:
setPageData in class AbstractUIPage
Parameters:
map - 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.