public interface MapMouseMode extends java.awt.event.MouseListener, java.awt.event.MouseMotionListener, java.awt.event.MouseWheelListener, PaintListener
AbstractMouseMode
,
NavMouseMode
,
SelectMouseMode
,
NullMouseMode
Modifier and Type | Method and Description |
---|---|
boolean |
actAsProxyFor(MapMouseMode mmm)
Request to have the MapMouseMode act as a proxy for a MapMouseMode that
wants to remain hidden.
|
boolean |
actAsProxyFor(MapMouseMode mmm,
int pdm)
Request to have the MapMouseMode act as a proxy for a MapMouseMode that
wants to remain hidden.
|
void |
addMapMouseListener(MapMouseListener l)
Add a MapMouseListener to the MouseMode.
|
void |
addPropertyChangeListener(java.beans.PropertyChangeListener pcl)
The MapMouseMode should send out notifications when a proxy is added or
removed.
|
javax.swing.Icon |
getGUIIcon()
Gets the Icon to represent the Mouse Mode in a GUI.
|
java.lang.String |
getID()
Returns the id (MapMouseMode name).
|
java.awt.Cursor |
getModeCursor()
Gets the mouse cursor recommended for use when this mouse mode is active.
|
java.lang.String |
getPrettyName()
Return a pretty name, suitable for the GUI.
|
MapMouseMode |
getProxied() |
int |
getProxyDistributionMask()
Get the mask that dictates which events get sent to this support object's
targets even if the parent mouse mode is acting as a proxy.
|
boolean |
isProxyFor(MapMouseMode mmm)
Can check if the MapMouseMode is acting as a proxy for a MapMouseMode.
|
boolean |
isVisible()
Lets the MouseDelegator know if the MapMouseMode should be visible in the
GUI, in order to create certain mouse modes that may be controlled by
other tools.
|
void |
releaseProxy()
Release the proxy lock on the MapMouseMode.
|
void |
removeAllMapMouseListeners()
Remove all MapMouseListeners from the mode.
|
void |
removeMapMouseListener(MapMouseListener l)
Remove a MapMouseListener from the MouseMode.
|
void |
removePropertyChangeListener(java.beans.PropertyChangeListener pcl) |
void |
setActive(boolean active)
Let the MapMouseMode know if it is active or not.
|
void |
setProxyDistributionMask(int mask)
Set the mask that dictates which events get sent to this support object's
targets even if the parent mouse mode is acting as a proxy.
|
mouseClicked, mouseEntered, mouseExited, mousePressed, mouseReleased
listenerPaint
java.lang.String getID()
java.lang.String getPrettyName()
java.awt.Cursor getModeCursor()
javax.swing.Icon getGUIIcon()
void addMapMouseListener(MapMouseListener l)
l
- the MapMouseListener to add.void removeMapMouseListener(MapMouseListener l)
l
- the MapMouseListener to remove.void removeAllMapMouseListeners()
void setActive(boolean active)
active
- true if the MapMouseMode has been made the active one, false
if it has been set inactive.boolean isVisible()
boolean actAsProxyFor(MapMouseMode mmm)
mmm
- the hidden MapMouseMode for this MapMouseMode to send events
to.boolean actAsProxyFor(MapMouseMode mmm, int pdm)
mmm
- the hidden MapMouseMode for this MapMouseMode to send events
to.pdm
- the proxy distribution mask to use, which lets this proxy
notify its targets of events.boolean isProxyFor(MapMouseMode mmm)
void releaseProxy()
MapMouseMode getProxied()
void setProxyDistributionMask(int mask)
for definitions of mask bits.
int getProxyDistributionMask()
for definitions of mask bits.
void addPropertyChangeListener(java.beans.PropertyChangeListener pcl)
pcl
- listener to notify.void removePropertyChangeListener(java.beans.PropertyChangeListener pcl)
Copyright (C) BBNT Solutions LLC; See http://openmap.bbn.com/ for details