CursorTool (jump-b3p 6.0 API)

All Superinterfaces:

EventListener, MouseListener, MouseMotionListener

All Known Implementing Classes:

AbstractCursorTool, AbstractDeleteVectorTool, AndCompositeTool, CompositeTool, CreateDelineationTool, DelegatingTool, DeleteIncrementalWarpingVectorTool, DeleteVertexTool, DeleteWarpingVectorTool, DragTool, DrawIncrementalWarpingVectorTool, DrawLineStringTool, DrawPointTool, DrawPolygonFenceTool, DrawPolygonTool, DrawRectangleFenceTool, DrawRectangleTool, DrawWarpingVectorTool, DummyTool, EditDelineationTool, FeatureInfoTool, InsertVertexTool, LeftClickFilter, MeasureTool, MoveSelectedItemsTool, MoveVertexTool, MultiClickTool, NClickTool, NoteTool, OrCompositeTool, PanTool, PolygonTool, QuasimodeTool, RectangleTool, SelectFeaturesTool, SelectLineStringsTool, SelectPartsTool, SelectTool, SnapIndicatorTool, SnapVerticesTool, SnapVerticesToSelectedVertexClickTool, SnapVerticesToSelectedVertexTool, SpecifyFeaturesTool, VectorTool, ZoomTool
```
public interface CursorTool
extends MouseListener, MouseMotionListener
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`activate(LayerViewPanel layerViewPanel)`
`void`	`cancelGesture()`	Notifies the CursorTool that a party is requesting that the gesture currently in progress be aborted.
`void`	`deactivate()`
`Cursor`	`getCursor()`
`Icon`	`getIcon()`
`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
```
Cursor getCursor()
```
  - getIcon
```
Icon getIcon()
```
    Returns:
    
    null to use a default icon
  - activate
```
void activate(LayerViewPanel layerViewPanel)
```
  - deactivate
```
void deactivate()
```
  - isRightMouseButtonUsed
```
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
```
boolean isGestureInProgress()
```
  - cancelGesture
```
void cancelGesture()
```
    Notifies the CursorTool that a party is requesting that the gesture currently in progress be aborted.
  - getName
```
String getName()
```
    Returns a very brief description of this CursorTool.
    
    Returns:
    
    the name of this CursorTool