com.vividsolutions.jump.workbench.ui.cursortool
Interface CursorTool

All Superinterfaces:

java.util.EventListener, java.awt.event.MouseListener, java.awt.event.MouseMotionListener

All Known Implementing Classes:

AbstractCursorTool, CompositeTool, DelegatingTool, DummyTool, LeftClickFilter

public interface CursorTool

extends java.awt.event.MouseListener, java.awt.event.MouseMotionListener

Method Summary

void	activate(LayerViewPanel layerViewPanel)
void	cancelGesture() Notifies the CursorTool that a party is requesting that the gesture currently in progress be aborted.
void	deactivate()
java.awt.Cursor	getCursor()
javax.swing.Icon	getIcon()
java.lang.String	getName() Returns a very brief description of this CursorTool.
boolean	isGestureInProgress()
boolean	isRightMouseButtonUsed()

Methods inherited from interface java.awt.event.MouseListener

mouseClicked, mouseEntered, mouseExited, mousePressed, mouseReleased

Methods inherited from interface java.awt.event.MouseMotionListener

mouseDragged, mouseMoved

Method Detail

getCursor

public java.awt.Cursor getCursor()

getIcon

public javax.swing.Icon getIcon()

Returns:

null to use a default icon

activate

public void activate(LayerViewPanel layerViewPanel)

deactivate

public void deactivate()

isRightMouseButtonUsed

public boolean isRightMouseButtonUsed()

Returns:

true if this CursorTool uses the right mouse button; false to allow the panel to show a popup-menu on right-clicks

isGestureInProgress

public boolean isGestureInProgress()

cancelGesture

public void cancelGesture()

Notifies the CursorTool that a party is requesting that the gesture currently in progress be aborted.

getName

public java.lang.String getName()

Returns a very brief description of this CursorTool.

Returns:

the name of this CursorTool