org.openstreetmap.josm.actions.mapmode

Class MapMode

java.lang.Object

javax.swing.AbstractAction

org.openstreetmap.josm.actions.JosmAction

org.openstreetmap.josm.actions.mapmode.MapMode

All Implemented Interfaces:

java.awt.event.ActionListener, java.awt.event.MouseListener, java.awt.event.MouseMotionListener, java.io.Serializable, java.lang.Cloneable, java.util.EventListener, javax.swing.Action, Preferences.PreferenceChangedListener, Destroyable

Direct Known Subclasses:

AddNoteAction, DeleteAction, DrawAction, ExtrudeAction, ImageryAdjustAction, ImproveWayAccuracyAction, LassoModeAction, ParallelWayAction, PlayHeadDragMode, SelectAction, ZoomAction

public abstract class MapMode
extends JosmAction
implements java.awt.event.MouseListener, java.awt.event.MouseMotionListener, Preferences.PreferenceChangedListener

A class implementing MapMode is able to be selected as an mode for map editing. As example scrolling the map is a MapMode, connecting Nodes to new Ways is another. MapModes should register/deregister all necessary listeners on the map's view control.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.openstreetmap.josm.actions.JosmAction

JosmAction.ActiveLayerChangeAdapter, JosmAction.LayerChangeAdapter, JosmAction.SelectionChangeAdapter

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	alt
protected boolean	ctrl
protected java.awt.Cursor	cursor
protected boolean	shift

Fields inherited from class org.openstreetmap.josm.actions.JosmAction

sc

Fields inherited from class javax.swing.AbstractAction

changeSupport, enabled

Fields inherited from interface javax.swing.Action

ACCELERATOR_KEY, ACTION_COMMAND_KEY, DEFAULT, DISPLAYED_MNEMONIC_INDEX_KEY, LARGE_ICON_KEY, LONG_DESCRIPTION, MNEMONIC_KEY, NAME, SELECTED_KEY, SHORT_DESCRIPTION, SMALL_ICON

Constructor Summary

Constructors

Constructor and Description
MapMode(java.lang.String name, java.lang.String iconName, java.lang.String tooltip, MapFrame mapFrame, java.awt.Cursor cursor) Constructor for mapmodes with a menu (no shortcut will be registered)
MapMode(java.lang.String name, java.lang.String iconName, java.lang.String tooltip, Shortcut shortcut, MapFrame mapFrame, java.awt.Cursor cursor) Constructor for mapmodes without a menu

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(java.awt.event.ActionEvent e) Call selectMapMode(this) on the parent mapFrame.
void	enterMode() Makes this map mode active.
void	exitMode() Makes this map mode inactive.
java.lang.String	getModeHelpText()
boolean	layerIsSupported(Layer l) Determines if layer l is supported by this map mode.
void	mouseClicked(java.awt.event.MouseEvent e)
void	mouseDragged(java.awt.event.MouseEvent e)
void	mouseEntered(java.awt.event.MouseEvent e)
void	mouseExited(java.awt.event.MouseEvent e)
void	mouseMoved(java.awt.event.MouseEvent e)
void	mousePressed(java.awt.event.MouseEvent e)
void	mouseReleased(java.awt.event.MouseEvent e)
void	preferenceChanged(Preferences.PreferenceChangeEvent e) Trigerred when a preference entry value changes.
protected void	readPreferences()
protected void	requestFocusInMapView()
protected void	updateKeyModifiers(java.awt.event.InputEvent e)
protected void	updateKeyModifiers(int modifiers)
protected void	updateKeyModifiers(java.awt.event.MouseEvent e)
protected void	updateStatusLine()

Methods inherited from class org.openstreetmap.josm.actions.JosmAction

destroy, getCurrentDataSet, getEditLayer, getLayerManager, getShortcut, initEnabledState, installAdapters, listenToLayerChange, listenToSelectionChange, setTooltip, updateEnabledState, updateEnabledState, updateEnabledStateOnCurrentSelection, waitFuture

Methods inherited from class javax.swing.AbstractAction

addPropertyChangeListener, clone, firePropertyChange, getKeys, getPropertyChangeListeners, getValue, isEnabled, putValue, removePropertyChangeListener, setEnabled

Methods inherited from class java.lang.Object

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

Field Detail

cursor

protected final java.awt.Cursor cursor

ctrl

protected boolean ctrl

alt

protected boolean alt

shift

protected boolean shift

Constructor Detail

MapMode

public MapMode(java.lang.String name,
               java.lang.String iconName,
               java.lang.String tooltip,
               Shortcut shortcut,
               MapFrame mapFrame,
               java.awt.Cursor cursor)

Constructor for mapmodes without a menu

Parameters:

name - the action's text

iconName - icon filename in mapmode directory

tooltip - a longer description of the action that will be displayed in the tooltip.

shortcut - a ready-created shortcut object or null if you don't want a shortcut.

mapFrame - unused but kept for plugin compatibility. Can be null

cursor - cursor displayed when map mode is active

MapMode

public MapMode(java.lang.String name,
               java.lang.String iconName,
               java.lang.String tooltip,
               MapFrame mapFrame,
               java.awt.Cursor cursor)

Constructor for mapmodes with a menu (no shortcut will be registered)

Parameters:

name - the action's text

iconName - icon filename in mapmode directory

tooltip - a longer description of the action that will be displayed in the tooltip.

mapFrame - unused but kept for plugin compatibility. Can be null

cursor - cursor displayed when map mode is active

Method Detail

enterMode

public void enterMode()

Makes this map mode active.

exitMode

public void exitMode()

Makes this map mode inactive.

updateStatusLine

protected void updateStatusLine()

getModeHelpText

public java.lang.String getModeHelpText()

readPreferences

protected void readPreferences()

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent e)

Call selectMapMode(this) on the parent mapFrame.

Specified by:

actionPerformed in interface java.awt.event.ActionListener

layerIsSupported

public boolean layerIsSupported(Layer l)

Determines if layer l is supported by this map mode. By default, all tools will work with all layers. Can be overwritten to require a special type of layer

Parameters:

l - layer

Returns:

true if the layer is supported by this map mode

updateKeyModifiers

protected void updateKeyModifiers(java.awt.event.InputEvent e)

updateKeyModifiers

protected void updateKeyModifiers(java.awt.event.MouseEvent e)

updateKeyModifiers

protected void updateKeyModifiers(int modifiers)

requestFocusInMapView

protected void requestFocusInMapView()

mouseReleased

public void mouseReleased(java.awt.event.MouseEvent e)

Specified by:

mouseReleased in interface java.awt.event.MouseListener

mouseExited

public void mouseExited(java.awt.event.MouseEvent e)

Specified by:

mouseExited in interface java.awt.event.MouseListener

mousePressed

public void mousePressed(java.awt.event.MouseEvent e)

Specified by:

mousePressed in interface java.awt.event.MouseListener

mouseClicked

public void mouseClicked(java.awt.event.MouseEvent e)

Specified by:

mouseClicked in interface java.awt.event.MouseListener

mouseEntered

public void mouseEntered(java.awt.event.MouseEvent e)

Specified by:

mouseEntered in interface java.awt.event.MouseListener

mouseMoved

public void mouseMoved(java.awt.event.MouseEvent e)

Specified by:

mouseMoved in interface java.awt.event.MouseMotionListener

mouseDragged

public void mouseDragged(java.awt.event.MouseEvent e)

Specified by:

mouseDragged in interface java.awt.event.MouseMotionListener

preferenceChanged

public void preferenceChanged(Preferences.PreferenceChangeEvent e)

Description copied from interface: Preferences.PreferenceChangedListener

Trigerred when a preference entry value changes.

Specified by:

preferenceChanged in interface Preferences.PreferenceChangedListener

Parameters:

e - the preference change event