org.openstreetmap.josm.gui

Class MapStatus

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.openstreetmap.josm.gui.MapStatus

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, Helpful, Destroyable

public class MapStatus
extends JPanel
implements Helpful, Destroyable

A component that manages some status information display about the map. It keeps a status line below the map up to date and displays some tooltip information if the user hold the mouse long enough at some point. All this is done in background to not disturb other processes. The background thread does not alter any data of the map (read only thread). Also it is rather fail safe. In case of some error in the data, it just does nothing instead of whining and complaining.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	MapStatus.BackgroundProgressMonitor
private class	MapStatus.Collector The collector class that waits for notification and then update the display objects.
(package private) static class	MapStatus.MouseState Everything, the collector is interested of.
private static class	MapStatus.StatusTextHistory

Nested classes/interfaces inherited from class javax.swing.JPanel

JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

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

Fields

Modifier and Type	Field and Description
(package private) ImageLabel	angleText
private AWTEventListener	awtListener
(package private) MapStatus.Collector	collector
(package private) ImageLabel	distText
private double	distValue
(package private) ImageLabel	headingText
(package private) JosmTextField	helpText
private KeyAdapter	keyAdapter
(package private) ImageLabel	latText
(package private) ImageLabel	lonText
private MouseMotionListener	mouseMotionListener
(package private) MapStatus.MouseState	mouseState The last sent mouse movement event.
(package private) MapView	mv The MapView this status belongs to.
(package private) ImageLabel	nameText
(package private) JProgressBar	progressBar
MapStatus.BackgroundProgressMonitor	progressMonitor
private NavigatableComponent.SoMChangeListener	somListener
private List<MapStatus.StatusTextHistory>	statusText
private Thread	thread This is the thread that runs in the background and collects the information displayed.

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_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, 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

Constructors

Constructor and Description
MapStatus(MapFrame mapFrame) Construct a new MapStatus and attach it to the map view.

Method Summary

Modifier and Type	Method and Description
void	activateAnglePanel(boolean activeFlag)
void	addMouseListener(MouseListener ml)
void	destroy() Called when the object has been destroyed.
JPanel	getAnglePanel()
String	helpTopic()
private void	registerListeners()
void	resetHelpText(Object id)
void	setAngle(double a)
void	setDist(Collection<Way> ways) Sets the distance text to the total sum of given ways length
void	setDist(double dist) Sets the distance text to the given value
void	setHeading(double h)
void	setHelpText(Object id, String text)
void	setHelpText(String t)
private void	unregisterListeners()

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods 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, update

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, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, 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, 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, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

mv

final MapView mv

The MapView this status belongs to.

collector

final MapStatus.Collector collector

lonText

final ImageLabel lonText

nameText

final ImageLabel nameText

helpText

final JosmTextField helpText

latText

final ImageLabel latText

angleText

final ImageLabel angleText

headingText

final ImageLabel headingText

distText

final ImageLabel distText

progressBar

final JProgressBar progressBar

progressMonitor

public final MapStatus.BackgroundProgressMonitor progressMonitor

somListener

private final NavigatableComponent.SoMChangeListener somListener

distValue

private double distValue

thread

private Thread thread

This is the thread that runs in the background and collects the information displayed. It gets destroyed by destroy() when the MapFrame itself is destroyed.

statusText

private final List<MapStatus.StatusTextHistory> statusText

mouseState

MapStatus.MouseState mouseState

The last sent mouse movement event.

awtListener

private AWTEventListener awtListener

mouseMotionListener

private MouseMotionListener mouseMotionListener

keyAdapter

private KeyAdapter keyAdapter

Constructor Detail

MapStatus

public MapStatus(MapFrame mapFrame)

Construct a new MapStatus and attach it to the map view.

Parameters:

mapFrame - The MapFrame the status line is part of.

Method Detail

registerListeners

private void registerListeners()

unregisterListeners

private void unregisterListeners()

getAnglePanel

public JPanel getAnglePanel()

helpTopic

public String helpTopic()

Specified by:

helpTopic in interface Helpful

addMouseListener

public void addMouseListener(MouseListener ml)

Overrides:

addMouseListener in class Component

setHelpText

public void setHelpText(String t)

setHelpText

public void setHelpText(Object id,
                        String text)

resetHelpText

public void resetHelpText(Object id)

setAngle

public void setAngle(double a)

setHeading

public void setHeading(double h)

setDist

public void setDist(double dist)

Sets the distance text to the given value

Parameters:

dist - The distance value to display, in meters

setDist

public void setDist(Collection<Way> ways)

Sets the distance text to the total sum of given ways length

Parameters:

ways - The ways to consider for the total distance

Since:

5991

activateAnglePanel

public void activateAnglePanel(boolean activeFlag)

destroy

public void destroy()

Description copied from interface: Destroyable

Called when the object has been destroyed.

Specified by:

destroy in interface Destroyable