01: /*
02: * The Unified Mapping Platform (JUMP) is an extensible, interactive GUI
03: * for visualizing and manipulating spatial features with geometry and attributes.
04: *
05: * Copyright (C) 2003 Vivid Solutions
06: *
07: * This program is free software; you can redistribute it and/or
08: * modify it under the terms of the GNU General Public License
09: * as published by the Free Software Foundation; either version 2
10: * of the License, or (at your option) any later version.
11: *
12: * This program is distributed in the hope that it will be useful,
13: * but WITHOUT ANY WARRANTY; without even the implied warranty of
14: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15: * GNU General Public License for more details.
16: *
17: * You should have received a copy of the GNU General Public License
18: * along with this program; if not, write to the Free Software
19: * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
20: *
21: * For more information, contact:
22: *
23: * Vivid Solutions
24: * Suite #1A
25: * 2328 Government Street
26: * Victoria BC V8T 5G5
27: * Canada
28: *
29: * (250)385-6040
30: * www.vividsolutions.com
31: */
32:
33: package com.vividsolutions.jump.workbench.ui.cursortool;
34:
35: import java.awt.Cursor;
36: import java.awt.event.MouseListener;
37: import java.awt.event.MouseMotionListener;
38:
39: import javax.swing.Icon;
40:
41: import com.vividsolutions.jump.workbench.ui.LayerViewPanel;
42:
43: public interface CursorTool extends MouseListener, MouseMotionListener {
44: public Cursor getCursor();
45:
46: /**
47: * @return null to use a default icon
48: */
49: public Icon getIcon();
50:
51: public void activate(LayerViewPanel layerViewPanel);
52:
53: public void deactivate();
54:
55: /**
56: * @return true if this CursorTool uses the right mouse button; false
57: * to allow the panel to show a popup-menu on right-clicks
58: */
59: public boolean isRightMouseButtonUsed();
60:
61: public boolean isGestureInProgress();
62:
63: /**
64: * Notifies the CursorTool that a party is requesting that the gesture
65: * currently in progress be aborted.
66: */
67: public void cancelGesture();
68:
69: /**
70: * Returns a very brief description of this CursorTool.
71: * @return the name of this CursorTool
72: */
73: public String getName();
74: }
|