jsky.util.gui
Class CoordinatesPanel

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by javax.swing.JComponent
              extended by jsky.util.gui.CoordinatesPanel
All Implemented Interfaces:
java.awt.event.ActionListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.beans.PropertyChangeListener, java.io.Serializable, java.util.EventListener

public class CoordinatesPanel
extends javax.swing.JComponent
implements java.awt.event.ActionListener, java.beans.PropertyChangeListener

A component that contains entry fields for astronomical coordinates. It includes entry fields for an RA and DEC, provides validation, and includes methods for getting and setting a Coordinates object.

This code was orginally developed by NASA, Goddard Space Flight Center, Code 588 for the Scientist's Expert Assistant (SEA) project. Subsequently adapted by STScI as part of the APT project

Version:
06.29.2000
Author:
J. Jones / 588
See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
 
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.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
 
Field Summary
static java.lang.String COORDINATES_PROPERTY
          Bound property name.
protected static java.lang.String DEC_NOTIFY
           
protected static java.lang.String EQUINOX_NOTIFY
           
static java.lang.String EQUINOX_PROPERTY
          Bound property name.
static java.lang.String EQUINOX_SHOWN_PROPERTY
          Bound property name.
static int HORIZONTAL
          Orientation where RA and DEC are side by side
static java.lang.String ORIENTATION_PROPERTY
          Bound property name.
protected static java.lang.String RA_NOTIFY
           
static java.lang.String READ_ONLY_PROPERTY
          Bound property name.
static int VERTICAL
          Orientation where RA is on top of DEC
 
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
CoordinatesPanel()
           
 
Method Summary
 void actionPerformed(java.awt.event.ActionEvent e)
           
 Coordinates getCoordinates()
           
 int getOrientation()
           
 boolean isEquinoxShown()
           
 boolean isReadOnly()
           
static void main(java.lang.String[] args)
           
 void propertyChange(java.beans.PropertyChangeEvent event)
           
 void setCoordinates(Coordinates position)
           
 void setCoordinates(java.lang.String ra, java.lang.String dec)
           
 void setEquinoxShown(boolean show)
           
 void setOrientation(int orient)
           
 void setPostActionEventOnFocusLost(boolean postFlag)
          Registers weather the RA and DEC fields of the CoordinatesPanel should postActionEvents when they lose focus.
 void setReadOnly(boolean readOnly)
          Sets the fields on this panel as read-only depending on the value of readOnly.
 void showErrorDialog()
          Shows an error dialog to the user which informs them that the current input is not a valid set of coordinates.
protected  void updateFromFormatChange()
           
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getAccessibleContext, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, 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, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, 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, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, 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

RA_NOTIFY

protected static final java.lang.String RA_NOTIFY

DEC_NOTIFY

protected static final java.lang.String DEC_NOTIFY

EQUINOX_NOTIFY

protected static final java.lang.String EQUINOX_NOTIFY

HORIZONTAL

public static final int HORIZONTAL
Orientation where RA and DEC are side by side

See Also:
Constant Field Values

VERTICAL

public static final int VERTICAL
Orientation where RA is on top of DEC

See Also:
Constant Field Values

COORDINATES_PROPERTY

public static final java.lang.String COORDINATES_PROPERTY
Bound property name.


READ_ONLY_PROPERTY

public static final java.lang.String READ_ONLY_PROPERTY
Bound property name.


ORIENTATION_PROPERTY

public static final java.lang.String ORIENTATION_PROPERTY
Bound property name.


EQUINOX_SHOWN_PROPERTY

public static final java.lang.String EQUINOX_SHOWN_PROPERTY
Bound property name.


EQUINOX_PROPERTY

public static final java.lang.String EQUINOX_PROPERTY
Bound property name.

Constructor Detail

CoordinatesPanel

public CoordinatesPanel()
Method Detail

getCoordinates

public Coordinates getCoordinates()

setCoordinates

public void setCoordinates(Coordinates position)

setCoordinates

public void setCoordinates(java.lang.String ra,
                           java.lang.String dec)

setPostActionEventOnFocusLost

public void setPostActionEventOnFocusLost(boolean postFlag)
Registers weather the RA and DEC fields of the CoordinatesPanel should postActionEvents when they lose focus. This method is in place so that the user will not have to press "Enter" when going from one of the text fields to another in order for both modifications to take effect.

Parameters:
postFlag - Determines if the RA and DEC fields should post ActionEvents when losing focus.

isReadOnly

public boolean isReadOnly()

setReadOnly

public void setReadOnly(boolean readOnly)
Sets the fields on this panel as read-only depending on the value of readOnly. The equinox ComboBox is also enabled/disabled along with this.

Parameters:
readOnly - If true then the input widgets of this class are set as readonly. If false then the input widgets of this class are editable.

isEquinoxShown

public boolean isEquinoxShown()

setEquinoxShown

public void setEquinoxShown(boolean show)

getOrientation

public int getOrientation()

setOrientation

public void setOrientation(int orient)

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent e)
Specified by:
actionPerformed in interface java.awt.event.ActionListener

propertyChange

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

showErrorDialog

public void showErrorDialog()
Shows an error dialog to the user which informs them that the current input is not a valid set of coordinates.


updateFromFormatChange

protected void updateFromFormatChange()

main

public static void main(java.lang.String[] args)