HiRISE

HiRISE.HiPlan.HOGG
Class Observation_ID_Dialog

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by java.awt.Window
              extended by java.awt.Dialog
                  extended by javax.swing.JDialog
                      extended by HiRISE.HiPlan.HOGG.Observation_ID_Dialog
All Implemented Interfaces:
ActionListener, FocusListener, ImageObserver, MenuContainer, PropertyChangeListener, Serializable, EventListener, Accessible, ChangeListener, RootPaneContainer, WindowConstants

public class Observation_ID_Dialog
extends JDialog
implements ActionListener, ChangeListener, FocusListener, PropertyChangeListener

A dialog for setting a HiRISE Observation_ID.

To use this, first instantiate it. Then use the showDialog methods to display it. Their return value will indicate how it was dismissed.

Version:
1.24
Author:
Christian Schaller - UA/PIRL
See Also:
Observation_ID, Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class javax.swing.JDialog
JDialog.AccessibleJDialog
 
Nested classes/interfaces inherited from class java.awt.Dialog
Dialog.AccessibleAWTDialog, Dialog.ModalExclusionType, Dialog.ModalityType
 
Nested classes/interfaces inherited from class java.awt.Window
Window.AccessibleAWTWindow
 
Nested classes/interfaces inherited from class java.awt.Container
Container.AccessibleAWTContainer
 
Nested classes/interfaces inherited from class java.awt.Component
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy
 
Field Summary
static String DEFAULT_TITLE
          The default title for the dialog window.
static String ID
          Class identification name with source code version and date.
 
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
Observation_ID_Dialog()
          Creates a modal Observation_ID_Dialog.
Observation_ID_Dialog(Component component)
          Creates a modal Observation_ID_Dialog with an owner frame derived from the indicated component.
 
Method Summary
 void actionPerformed(ActionEvent event)
          Receives ActionEvents.
 void focusGained(FocusEvent event)
          Receives FocusEvents.
 void focusLost(FocusEvent event)
          Receives FocusEvents.
static void main(String[] args)
          Invokes a standalone test stub of the observation ID dialog in its own thread.
 void propertyChange(PropertyChangeEvent event)
           
 String showDialog(Component location_component, String observation_id)
          Displays the Observation_ID_Dialog with the specified location component and initial observation ID.
 String showDialog(Component location_component, String title, String observation_id)
          Displays the Observation_ID_Dialog with the specified location component, title, and initial observation ID.
 String showDialog(String observation_id)
          Displays the Observation_ID_Dialog with the specified initial observation ID.
 String showDialog(String title, String observation_id)
          Displays the Observation_ID_Dialog with the specified title and initial observation ID.
 void stateChanged(ChangeEvent event)
          Receives ChangeEvents.
 
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, paint, 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, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, 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, 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, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

ID

public static final String ID
Class identification name with source code version and date.

See Also:
Constant Field Values

DEFAULT_TITLE

public static final String DEFAULT_TITLE
The default title for the dialog window.

See Also:
Constant Field Values
Constructor Detail

Observation_ID_Dialog

public Observation_ID_Dialog(Component component)
Creates a modal Observation_ID_Dialog with an owner frame derived from the indicated component. The dialog is not displayed; to do so, use one of the showDialog methods.

If component is null, a shared, hidden frame is set as the owner of the dialog.

Parameters:
component - the component that identifies the owner frame of this Observation_ID_Dialog.

Observation_ID_Dialog

public Observation_ID_Dialog()
Creates a modal Observation_ID_Dialog. A shared, hidden frame is set as the owner of the dialog. The dialog is not displayed; to do so, use one of the showDialog methods.

Method Detail

actionPerformed

public void actionPerformed(ActionEvent event)
Receives ActionEvents. This method is invoked when an action occurs within this Observation_ID_Dialog object. This method invokes additional methods appropriate to the source of the action event.

Specified by:
actionPerformed in interface ActionListener
Parameters:
event - the action event that invoked this method.

stateChanged

public void stateChanged(ChangeEvent event)
Receives ChangeEvents. This method is invoked when an interface component's state is changed. If the component whose state changed is the time setting spinner text field, the observation ID value is updated with the new information contained in that field. If the component is the tabbed pane, the value of the observation ID is updated.

Specified by:
stateChanged in interface ChangeListener
Parameters:
event - the change event that invoked this method.

focusGained

public void focusGained(FocusEvent event)
Receives FocusEvents. This method is invoked when an interface component gains the focus. This method is a do-nothing method, in that the Observation_ID_Dialog is not interested in components gaining focus. It is required by the FocusListener interface, however, regardless.

Specified by:
focusGained in interface FocusListener
Parameters:
event - the focus event that invoked this method.

focusLost

public void focusLost(FocusEvent event)
Receives FocusEvents. This method is invoked when an interface component loses the focus. If the component that loses focus is the orbit number text field or the target text field, the observation ID value is updated with the new information contained in the field that lost focus.

Specified by:
focusLost in interface FocusListener
Parameters:
event - the focus event that invoked this method.

propertyChange

public void propertyChange(PropertyChangeEvent event)
Specified by:
propertyChange in interface PropertyChangeListener

showDialog

public String showDialog(Component location_component,
                         String title,
                         String observation_id)
Displays the Observation_ID_Dialog with the specified location component, title, and initial observation ID.

If location_component is null, the dialog is centered on the screen. If title is null, DEFAULT_TITLE is used. If observation_id is null, the empty string ("") is used.

Parameters:
location_component - the component in relation to which the dialog's location is determined.
title - the dialog's title.
observation_id - the initial observation ID.
Returns:
an observation ID in text form if the "OK" button was clicked, null otherwise.

showDialog

public String showDialog(Component location_component,
                         String observation_id)
Displays the Observation_ID_Dialog with the specified location component and initial observation ID. DEFAULT_TITLE is used for the dialog's title.

If location_component is null, the dialog is centered on the screen. If observation_id is null, the empty string ("") is used.

Parameters:
location_component - the component in relation to which the dialog's location is determined.
observation_id - the initial observation ID.
Returns:
an observation ID in text form if the "OK" button was clicked, null otherwise.

showDialog

public String showDialog(String title,
                         String observation_id)
Displays the Observation_ID_Dialog with the specified title and initial observation ID. The dialog is centered on the screen.

If title is null, DEFAULT_TITLE is used. If observation_id is null, the empty string ("") is used.

Parameters:
title - the dialog's title.
observation_id - the initial observation ID.
Returns:
an observation ID in text form if the "OK" button was clicked, null otherwise.

showDialog

public String showDialog(String observation_id)
Displays the Observation_ID_Dialog with the specified initial observation ID. The dialog is centered on the screen, and DEFAULT_TITLE is used for the dialog's title.

If observation_id is null, the empty string ("") is used.

Parameters:
observation_id - the initial observation ID.
Returns:
an observation ID in text form if the "OK" button was clicked, null otherwise.

main

public static void main(String[] args)
Invokes a standalone test stub of the observation ID dialog in its own thread.

Usage

Observation_ID_Dialog

Parameters:
args - the command-line arguments, which are unused.

HiRISE

Copyright (C) Arizona Board of Regents on behalf of the Planetary Image Research Laboratory, Lunar and Planetary Laboratory at the University of Arizona