01: /*
02: * uDig - User Friendly Desktop Internet GIS client
03: * http://udig.refractions.net
04: * (C) 2004, Refractions Research Inc.
05: *
06: * This library is free software; you can redistribute it and/or
07: * modify it under the terms of the GNU Lesser General Public
08: * License as published by the Free Software Foundation;
09: * version 2.1 of the License.
10: *
11: * This library is distributed in the hope that it will be useful,
12: * but WITHOUT ANY WARRANTY; without even the implied warranty of
13: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14: * Lesser General Public License for more details.
15: *
16: */
17: package net.refractions.udig.project.ui.tool;
18:
19: /**
20: * A tool that performs an action when the tool button is pressed.
21: * <p>
22: * An example is a zoom to extent button. An action button is not modal. Like other tools an action
23: * tool should not be instantiated.
24: * </p>
25: * <p>
26: * Must have a public default constructor.
27: * </p>
28: *
29: * @see net.refractions.udig.project.ui.tool.AbstractTool
30: * @author jeichar
31: * @since 0.3
32: * @see Tool
33: */
34: public interface ActionTool extends Tool {
35:
36: /**
37: * Called when tool button is pressed. If false the tool is set as inactive and deregistered
38: * with the component.
39: */
40: public void run();
41:
42: }
|