Package ucar.unidata.ui
Class LatLonWidget
java.lang.Object
java.awt.Component
java.awt.Container
javax.swing.JComponent
javax.swing.JPanel
ucar.unidata.ui.LatLonWidget
- All Implemented Interfaces:
ImageObserver,MenuContainer,Serializable,Accessible
A widget that provides a Lat/Lon entry box.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class javax.swing.JPanel
JPanel.AccessibleJPanelNested classes/interfaces inherited from class javax.swing.JComponent
JComponent.AccessibleJComponentNested classes/interfaces inherited from class java.awt.Container
Container.AccessibleAWTContainerNested classes/interfaces inherited from class java.awt.Component
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy -
Field Summary
Fields inherited from class javax.swing.JComponent
listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOWFields inherited from class java.awt.Component
accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENTFields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH -
Constructor Summary
ConstructorsConstructorDescriptionCreate a widget with the blank values for latitude and longitude and with the default field labels.LatLonWidget(double lat, double lon) Create a widget with the given initial values for latitude and longitude.LatLonWidget(ActionListener actionListener) Create a widget with blank values for latitude and longitude and with the default field labels.LatLonWidget(String latLabel, String lonLabel, ActionListener actionListener) Create a widget with the blank values for latitude and longitude and with the given Strings for the field labels.LatLonWidget(String latLabel, String lonLabel, String altLabel, ActionListener actionListener) Create a widget with the blank values for latitude and longitude and with the given Strings for the field labels. -
Method Summary
Modifier and TypeMethodDescriptionvoidclear()Clear the contents of the lat/lon text fields.protected StringformatLatLonString(String latOrLon) Format the lat or lon stringdoublegetAlt()Get the altitudeGet the text field for the alt.booleanGet the DoFormat property.doublegetLat()Get a latitudeGet the text field for the latitude.doublegetLon()Get a longitudeGet the text field for the longitude.booleanIs there any text entered in the alt field and is it enabled.booleanSee if the value is definedbooleanIs there any text entered in the lat field and is it enabled.booleanIs there any text entered in both the lat and the lon field.booleanIs there any text entered in the lon field and is it enabled.Check if the current field values are valid.voidsetAlt(double alt) Set the value of the alt field.voidSet the value of the alt field with the given String value.voidsetDoFormat(boolean value) Set the DoFormat property.voidsetLat(double lat) Set the value of the latitude field.voidSet the value of the lat field with the given String value.voidsetLatLon(double lat, double lon) Set the value of the lat and lon fields.voidSet the value of the lat and lon fields.voidsetLon(double lon) Set the value of the longitude field.voidSet the value of the lon field with the given String value.Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUIMethods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, 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, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, 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, updateMethods 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, transferFocusDownCycle, validate, validateTreeMethods 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, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, 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, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
-
Constructor Details
-
LatLonWidget
Create a widget with blank values for latitude and longitude and with the default field labels. Add the given ActionListener to the text fields.- Parameters:
actionListener-
-
LatLonWidget
public LatLonWidget()Create a widget with the blank values for latitude and longitude and with the default field labels. -
LatLonWidget
Create a widget with the blank values for latitude and longitude and with the given Strings for the field labels. If the given ActionListener is non-null then add it to the text fields.- Parameters:
latLabel-lonLabel-actionListener-
-
LatLonWidget
public LatLonWidget(String latLabel, String lonLabel, String altLabel, ActionListener actionListener) Create a widget with the blank values for latitude and longitude and with the given Strings for the field labels. If the given ActionListener is non-null then add it to the text fields.- Parameters:
latLabel-lonLabel-altLabel- If non-null then add an alt fieldactionListener-
-
LatLonWidget
public LatLonWidget(double lat, double lon) Create a widget with the given initial values for latitude and longitude.- Parameters:
lat-lon-
-
-
Method Details
-
setLatLon
public void setLatLon(double lat, double lon) Set the value of the lat and lon fields.- Parameters:
lat-lon-
-
setLatLon
Set the value of the lat and lon fields.- Parameters:
lat-lon-
-
setLat
Set the value of the lat field with the given String value.- Parameters:
latString-
-
setLon
Set the value of the lon field with the given String value.- Parameters:
lonString-
-
setAlt
Set the value of the alt field with the given String value.- Parameters:
altString-
-
setLat
public void setLat(double lat) Set the value of the latitude field.- Parameters:
lat-
-
setLon
public void setLon(double lon) Set the value of the longitude field.- Parameters:
lon-
-
setAlt
public void setAlt(double alt) Set the value of the alt field.- Parameters:
alt-
-
clear
public void clear()Clear the contents of the lat/lon text fields. -
isDefined
See if the value is defined- Parameters:
s- the value- Returns:
- true if it is defined
-
isLatDefined
public boolean isLatDefined()Is there any text entered in the lat field and is it enabled.- Returns:
- do we have a lat
-
isLonDefined
public boolean isLonDefined()Is there any text entered in the lon field and is it enabled.- Returns:
- do we have a lon
-
isAltDefined
public boolean isAltDefined()Is there any text entered in the alt field and is it enabled.- Returns:
- do we have alt
-
isLatLonDefined
public boolean isLatLonDefined()Is there any text entered in both the lat and the lon field.- Returns:
- true if defined
-
isValidValues
Check if the current field values are valid. If invalid then return a String error message. If the values are valid then return null. The fields are invalid if there is non-whitespace text entered in both fields and the text does not convert to a double or the values are outside the range (for lat) -90,90 and (for lon) -180,180.- Returns:
- error message
-
getLat
Get a latitude- Returns:
- the latitude
- Throws:
NumberFormatException- illegal number
-
getLon
Get a longitude- Returns:
- the longitude
- Throws:
NumberFormatException- illegal number
-
getAlt
Get the altitude- Returns:
- the altitude
- Throws:
NumberFormatException- illegal number
-
getLatField
Get the text field for the latitude.- Returns:
- The Lat field.
-
getLonField
Get the text field for the longitude.- Returns:
- The Lon field.
-
getAltField
Get the text field for the alt.- Returns:
- The alt field.
-
formatLatLonString
Format the lat or lon string- Parameters:
latOrLon- lat or lon value as a string in decimal notation- Returns:
- value in regional formatting
-
setDoFormat
public void setDoFormat(boolean value) Set the DoFormat property.- Parameters:
value- The new value for DoFormat
-
getDoFormat
public boolean getDoFormat()Get the DoFormat property.- Returns:
- The DoFormat
-