forked from scijava/scijava-common
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathTool.java
More file actions
120 lines (101 loc) · 4.58 KB
/
Tool.java
File metadata and controls
120 lines (101 loc) · 4.58 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
/*
* #%L
* SciJava Common shared library for SciJava software.
* %%
* Copyright (C) 2009 - 2014 Board of Regents of the University of
* Wisconsin-Madison, Broad Institute of MIT and Harvard, and Max Planck
* Institute of Molecular Cell Biology and Genetics.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
* #L%
*/
package org.scijava.tool;
import org.scijava.display.event.input.KyPressedEvent;
import org.scijava.display.event.input.KyReleasedEvent;
import org.scijava.display.event.input.MsClickedEvent;
import org.scijava.display.event.input.MsDraggedEvent;
import org.scijava.display.event.input.MsMovedEvent;
import org.scijava.display.event.input.MsPressedEvent;
import org.scijava.display.event.input.MsReleasedEvent;
import org.scijava.display.event.input.MsWheelEvent;
import org.scijava.input.MouseCursor;
import org.scijava.plugin.Plugin;
import org.scijava.plugin.RichPlugin;
import org.scijava.plugin.SingletonPlugin;
/**
* Interface for ImageJ tools. A tool is a collection of rules binding user
* input (e.g., keyboard and mouse events) to display and data manipulation in a
* coherent way.
* <p>
* For example, a {@code PanTool} might pan a display when the mouse is dragged
* or arrow key is pressed, while a {@code PencilTool} could draw hard lines on
* the data within a display.
* </p>
* <p>
* Tools discoverable at runtime must implement this interface and be annotated
* with @{@link Plugin} with {@link Plugin#type()} = {@link Tool}.class. While
* it possible to create a tool merely by implementing this interface, it is
* encouraged to instead extend {@link AbstractTool}, for convenience.
* </p>
*
* @author Rick Lentz
* @author Grant Harris
* @author Curtis Rueden
* @see Plugin
* @see ToolService
*/
public interface Tool extends RichPlugin, SingletonPlugin {
/** When true, tool has no button but rather is active all the time. */
boolean isAlwaysActive();
/**
* When true, tool receives events when the main ImageJ application frame is
* active. When false, tool only receives events when a display window is
* active.
*/
boolean isActiveInAppFrame();
/** The tool's mouse pointer. */
MouseCursor getCursor();
/** Informs the tool that it is now active. */
void activate();
/** Informs the tool that it is no longer active. */
void deactivate();
/** Occurs when a key on the keyboard is pressed while the tool is active. */
void onKeyDown(KyPressedEvent event);
/** Occurs when a key on the keyboard is released while the tool is active. */
void onKeyUp(KyReleasedEvent event);
/** Occurs when a mouse button is pressed while the tool is active. */
void onMouseDown(MsPressedEvent event);
/** Occurs when a mouse button is released while the tool is active. */
void onMouseUp(MsReleasedEvent event);
/** Occurs when a mouse button is double clicked while the tool is active. */
void onMouseClick(MsClickedEvent event);
/** Occurs when the mouse is moved while the tool is active. */
void onMouseMove(MsMovedEvent event);
/** Occurs when the mouse is dragged while the tool is active. */
void onMouseDrag(MsDraggedEvent event);
/** Occurs when the mouse wheel is moved while the tool is active. */
void onMouseWheel(MsWheelEvent event);
/** Occurs when the user right clicks this tool's icon. */
void configure();
/** Returns the text the tool provides when mouse hovers over tool */
String getDescription();
}