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:
AbstractClickSelectedLineStringsTool, 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, NodeLineStringsTool, NoteTool, OrCompositeTool, PanTool, PolygonTool, QuasimodeTool, RectangleTool, SelectFeaturesTool, SelectLineStringsTool, SelectPartsTool, SelectTool, SnapIndicatorTool, SnapVerticesTool, SnapVerticesToSelectedVertexClickTool, SnapVerticesToSelectedVertexTool, SpecifyFeaturesTool, SplitLineStringTool, VectorTool, ZoomTool

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

java.awt.Cursor getCursor()

getIcon

javax.swing.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

java.lang.String getName()
Returns a very brief description of this CursorTool.

Returns:
the name of this CursorTool