|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface MapMouseMode
Interface for handling mouse behavior while the mouse is operating over the MapBean. A "MouseMode" object exists to interpret the meaning of mouse events. For instance, you could have a mode where mouse events (click, drag-select) are interpreted as navigation commands, (recenter, zoom-and-recenter). There may be other modes depending on how your application wants to interpret MouseEvents.
AbstractMouseMode
,
NavMouseMode
,
SelectMouseMode
,
NullMouseMode
Method Summary | |
---|---|
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. |
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. |
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 |
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. |
Methods inherited from interface java.awt.event.MouseListener |
---|
mouseClicked, mouseEntered, mouseExited, mousePressed, mouseReleased |
Methods inherited from interface java.awt.event.MouseMotionListener |
---|
mouseDragged, mouseMoved |
Methods inherited from interface java.awt.event.MouseWheelListener |
---|
mouseWheelMoved |
Methods inherited from interface com.bbn.openmap.event.PaintListener |
---|
listenerPaint |
Method Detail |
---|
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()
void setProxyDistributionMask(int mask)
for definitions of mask bits.
int getProxyDistributionMask()
for definitions of mask bits.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |