ArrowTool (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- fiji.tool.AbstractTool
- - fiji.util.ArrowTool

All Implemented Interfaces:

ToolWithOptions, ij.ImageListener, ij.plugin.PlugIn, ActionListener, MouseListener, MouseMotionListener, MouseWheelListener, WindowFocusListener, EventListener
```
public class ArrowTool
extends AbstractTool
implements ActionListener, MouseListener, MouseMotionListener, MouseWheelListener, ToolWithOptions
```
ArrowTool plugin
This plugin aims at being a convenient interactive tool for drawing arrow shape on ImageJ windows. It was made trying to copy the behavior of existing ROI tools in ImageJ.
Usage in ImageJ
Run the plugin. A tool icon appear in ImageJ toolbar. When this icon is selected, drag the mouse with left button to draw non-destructively a ROI arrow. To draw pixels on the image, use the classical draw command (shortcut 'd') to draw the outline of the arrow, and the fill command (shortcut 'f') to draw its interior.
Clicking and dragging near the arrow base or head drags them individually. Clicking and dragging near the line drags the whole arrow.
Hold the SHIFT key to constrain the arrow direction to multiples of PI/4.
Double-click on the toolbar icon to display an option panel, on which the arrow head length, the line thickness and the arrow style can be changed.
For backward compatibility with the previous Arrow_.java, if there is a Line ROI on the image when this plugin is called, we draw an arrow non-interactively.
Code and classes
Four classes are at play:
- ArrowTool is the plugin class, that controls the arrow shape and position and deals with user interactions.
- It inherits from AbstractTool, which is an abstract tool aimed at standardizing future ROI tools. It has the mechanisms to register the tool to windows and to the toolbar.
- ArrowShape is the arrow class that has the mechanism to draw the arrow, according to a given style, head length, ... For convenience, it is wrapped in ArrowShapeRoi that extends ShapeRoi.
- ArrowOptionPanel is the option panel displayed when the toolbar icon is double-clicked.
Version:

1.0 - 3 Dec 2009

Author:

Jean-Yves Tinevez, Johannes Schindelin

Nested Class Summary
- Nested classes/interfaces inherited from class fiji.tool.AbstractTool
  AbstractTool.KeyProxy, AbstractTool.KeyProxyIfNotConsumed, AbstractTool.MouseMotionProxy, AbstractTool.MouseMotionProxyIfNotConsumed, AbstractTool.MouseProxy, AbstractTool.MouseWheelProxy, AbstractTool.MouseWheelProxyIfNotConsumed, AbstractTool.ToolbarMouseAdapter

Field Summary
- Fields inherited from class fiji.tool.AbstractTool
  clearToolsIfNecessary, ijKeyProxy, keyProxy, mouseMotionProxy, mouseProxy, mouseWheelProxy, savedToolName, sliceListener, sliceObservers, toolActive, toolbar, toolbarMouseListener, toolID, toolToggleListener

Constructor Summary

Constructors
Constructor and Description

ArrowTool()

Constructors
Constructor and Description
`ArrowTool()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`actionPerformed(ActionEvent e)` Is called when the user change a property using the option panel.
`String`	`getToolIcon()` Return the string encoding of the tool icon as it will appear in the toolbar.
`String`	`getToolName()` Return the tool name.
`protected void`	`handleRecording()`
`static Roi`	`makeRoi(ArrowShape.ArrowStyle style, double x1, double y1, double x2, double y2, float width, double headLength)`
`void`	`mouseClicked(MouseEvent e)`
`void`	`mouseDragged(MouseEvent e)`
`void`	`mouseEntered(MouseEvent e)`
`void`	`mouseExited(MouseEvent e)`
`void`	`mouseMoved(MouseEvent e)`
`void`	`mousePressed(MouseEvent e)`
`void`	`mouseReleased(MouseEvent e)` If the mouse is released near the base AND if we are not dragging the base, then we want to delete the tool.
`void`	`mouseWheelMoved(MouseWheelEvent e)` SHIFT key + MouseWheelEvent are used to change the arrow field.
`void`	`run(String arg)`
`static void`	`select(ArrowShape.ArrowStyle style, double x1, double y1, double x2, double y2, float width, double headLength)`
`static void`	`select(String style, String x1, String y1, String x2, String y2, String width, String headLength)`
`void`	`showOptionDialog()` When called, this method displays the configuration panel for the concrete implementation of this tool.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ArrowTool
```
public ArrowTool()
```
- Method Detail
  - run
```
public void run(String arg)
```
    Specified by:
    
    run in interface ij.plugin.PlugIn
    
    Overrides:
    
    run in class AbstractTool
  - getToolName
```
public String getToolName()
```
    Description copied from class: AbstractTool
    
    Return the tool name.
    
    Overrides:
    
    getToolName in class AbstractTool
  - getToolIcon
```
public String getToolIcon()
```
    Description copied from class: AbstractTool
    
    Return the string encoding of the tool icon as it will appear in the toolbar. See syntax for icon string.
    
    Overrides:
    
    getToolIcon in class AbstractTool
  - mousePressed
```
public void mousePressed(MouseEvent e)
```
    Specified by:
    
    mousePressed in interface MouseListener
  - mouseDragged
```
public void mouseDragged(MouseEvent e)
```
    Specified by:
    
    mouseDragged in interface MouseMotionListener
  - mouseReleased
```
public void mouseReleased(MouseEvent e)
```
    If the mouse is released near the base AND if we are not dragging the base, then we want to delete the tool.
    
    Specified by:
    
    mouseReleased in interface MouseListener
  - mouseWheelMoved
```
public void mouseWheelMoved(MouseWheelEvent e)
```
    SHIFT key + MouseWheelEvent are used to change the arrow field.
    
    Specified by:
    
    mouseWheelMoved in interface MouseWheelListener
  - mouseClicked
```
public void mouseClicked(MouseEvent e)
```
    Specified by:
    
    mouseClicked in interface MouseListener
  - mouseEntered
```
public void mouseEntered(MouseEvent e)
```
    Specified by:
    
    mouseEntered in interface MouseListener
  - mouseExited
```
public void mouseExited(MouseEvent e)
```
    Specified by:
    
    mouseExited in interface MouseListener
  - mouseMoved
```
public void mouseMoved(MouseEvent e)
```
    Specified by:
    
    mouseMoved in interface MouseMotionListener
  - showOptionDialog
```
public void showOptionDialog()
```
    Description copied from interface: ToolWithOptions
    
    When called, this method displays the configuration panel for the concrete implementation of this tool. It is normally called when the user double-click the toolbar icon of this tool.
    
    Specified by:
    
    showOptionDialog in interface ToolWithOptions
  - actionPerformed
```
public void actionPerformed(ActionEvent e)
```
    Is called when the user change a property using the option panel. We update the arrow fields, and let the paint() method draw it.
    
    Specified by:
    
    actionPerformed in interface ActionListener
  - handleRecording
```
protected void handleRecording()
```
  - select
```
public static void select(String style,
                          String x1,
                          String y1,
                          String x2,
                          String y2,
                          String width,
                          String headLength)
```
  - select
```
public static void select(ArrowShape.ArrowStyle style,
                          double x1,
                          double y1,
                          double x2,
                          double y2,
                          float width,
                          double headLength)
```
  - makeRoi
```
public static Roi makeRoi(ArrowShape.ArrowStyle style,
                          double x1,
                          double y1,
                          double x2,
                          double y2,
                          float width,
                          double headLength)
```

Class ArrowTool

ArrowTool plugin

Usage in ImageJ

Code and classes

Nested Class Summary

Nested classes/interfaces inherited from class fiji.tool.AbstractTool

Field Summary

Fields inherited from class fiji.tool.AbstractTool

Constructor Summary

Method Summary

Methods inherited from class fiji.tool.AbstractTool

Methods inherited from class java.lang.Object

Constructor Detail

ArrowTool

Method Detail

run

getToolName

getToolIcon

mousePressed

mouseDragged

mouseReleased

mouseWheelMoved

mouseClicked

mouseEntered

mouseExited

mouseMoved

showOptionDialog

actionPerformed

handleRecording

select

select

makeRoi