Tool (SciJava Javadocs 0-SNAPSHOT API)

All Superinterfaces:

Comparable<Prioritized>, Contextual, HasPluginInfo, Identifiable, Locatable, Logged, Prioritized, RichPlugin, SciJavaPlugin, SingletonPlugin, Versioned

All Known Implementing Classes:

AbstractTool, DummyTool
```
public interface Tool
extends RichPlugin, SingletonPlugin
```
Interface for 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.
For example, a PanTool might pan a display when the mouse is dragged or arrow key is pressed, while a PencilTool could draw hard lines on the data within a display.

Tools discoverable at runtime must implement this interface and be annotated with @Plugin with Plugin.type() = Tool.class. While it possible to create a tool merely by implementing this interface, it is encouraged to instead extend AbstractTool, for convenience.

Author:

Rick Lentz, Grant Harris, Curtis Rueden

See Also:

Plugin, ToolService

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default void`	`activate()` Informs the tool that it is now active.
`default void`	`configure()` Occurs when the user right clicks this tool's icon.
`default void`	`deactivate()` Informs the tool that it is no longer active.
`default MouseCursor`	`getCursor()` The tool's mouse pointer.
`default String`	`getDescription()` Returns the text the tool provides when mouse hovers over tool
`default boolean`	`isActiveInAppFrame()` When true, tool receives events when the main application frame is active.
`default boolean`	`isAlwaysActive()` When true, tool has no button but rather is active all the time.
`default void`	`onKeyDown(KyPressedEvent evt)` Occurs when a key on the keyboard is pressed while the tool is active.
`default void`	`onKeyUp(KyReleasedEvent evt)` Occurs when a key on the keyboard is released while the tool is active.
`default void`	`onMouseClick(MsClickedEvent evt)` Occurs when a mouse button is double clicked while the tool is active.
`default void`	`onMouseDown(MsPressedEvent evt)` Occurs when a mouse button is pressed while the tool is active.
`default void`	`onMouseDrag(MsDraggedEvent evt)` Occurs when the mouse is dragged while the tool is active.
`default void`	`onMouseMove(MsMovedEvent evt)` Occurs when the mouse is moved while the tool is active.
`default void`	`onMouseUp(MsReleasedEvent evt)` Occurs when a mouse button is released while the tool is active.
`default void`	`onMouseWheel(MsWheelEvent evt)` Occurs when the mouse wheel is moved while the tool is active.

Methods inherited from interface org.scijava.plugin.RichPlugin
getIdentifier, log

Methods inherited from interface org.scijava.Contextual
context, getContext, setContext

Methods inherited from interface org.scijava.Prioritized
compareTo, getPriority, setPriority

Methods inherited from interface org.scijava.plugin.HasPluginInfo
getInfo, setInfo

Methods inherited from interface org.scijava.Locatable
getLocation

Methods inherited from interface org.scijava.Versioned
getVersion

- Method Detail
  - isAlwaysActive
```
default boolean isAlwaysActive()
```
    When true, tool has no button but rather is active all the time.
  - isActiveInAppFrame
```
default boolean isActiveInAppFrame()
```
    When true, tool receives events when the main application frame is active. When false, tool only receives events when a display window is active.
  - getCursor
```
default MouseCursor getCursor()
```
    The tool's mouse pointer.
  - activate
```
default void activate()
```
    Informs the tool that it is now active.
  - deactivate
```
default void deactivate()
```
    Informs the tool that it is no longer active.
  - onKeyDown
```
default void onKeyDown(KyPressedEvent evt)
```
    Occurs when a key on the keyboard is pressed while the tool is active.
  - onKeyUp
```
default void onKeyUp(KyReleasedEvent evt)
```
    Occurs when a key on the keyboard is released while the tool is active.
  - onMouseDown
```
default void onMouseDown(MsPressedEvent evt)
```
    Occurs when a mouse button is pressed while the tool is active.
  - onMouseUp
```
default void onMouseUp(MsReleasedEvent evt)
```
    Occurs when a mouse button is released while the tool is active.
  - onMouseClick
```
default void onMouseClick(MsClickedEvent evt)
```
    Occurs when a mouse button is double clicked while the tool is active.
  - onMouseMove
```
default void onMouseMove(MsMovedEvent evt)
```
    Occurs when the mouse is moved while the tool is active.
  - onMouseDrag
```
default void onMouseDrag(MsDraggedEvent evt)
```
    Occurs when the mouse is dragged while the tool is active.
  - onMouseWheel
```
default void onMouseWheel(MsWheelEvent evt)
```
    Occurs when the mouse wheel is moved while the tool is active.
  - configure
```
default void configure()
```
    Occurs when the user right clicks this tool's icon.
  - getDescription
```
default String getDescription()
```
    Returns the text the tool provides when mouse hovers over tool

Interface Tool

Method Summary

Methods inherited from interface org.scijava.plugin.RichPlugin

Methods inherited from interface org.scijava.Contextual

Methods inherited from interface org.scijava.Prioritized

Methods inherited from interface org.scijava.plugin.HasPluginInfo

Methods inherited from interface org.scijava.Locatable

Methods inherited from interface org.scijava.Versioned

Method Detail

isAlwaysActive

isActiveInAppFrame

getCursor

activate

deactivate

onKeyDown

onKeyUp

onMouseDown

onMouseUp

onMouseClick

onMouseMove

onMouseDrag

onMouseWheel

configure

getDescription