AbstractTool (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- fiji.tool.AbstractTool

All Implemented Interfaces:

ij.ImageListener, ij.plugin.PlugIn, WindowFocusListener, EventListener

Direct Known Subclasses:

AbstractTrackingTool, ArrowTool, Lasso_, RoiPicker, SpotEditTool
```
public abstract class AbstractTool
extends Object
implements ij.ImageListener, WindowFocusListener, ij.plugin.PlugIn
```

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected class`	`AbstractTool.KeyProxy`
`protected class`	`AbstractTool.KeyProxyIfNotConsumed`
`protected class`	`AbstractTool.MouseMotionProxy`
`protected class`	`AbstractTool.MouseMotionProxyIfNotConsumed`
`protected class`	`AbstractTool.MouseProxy`
`protected class`	`AbstractTool.MouseWheelProxy`
`protected class`	`AbstractTool.MouseWheelProxyIfNotConsumed`
`protected class`	`AbstractTool.ToolbarMouseAdapter` This class is used to monitor tool toggles and double-clicks on the toolbar icon of this concrete tool.

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`clearToolsIfNecessary`
`protected AbstractTool.KeyProxyIfNotConsumed`	`ijKeyProxy`
`protected AbstractTool.KeyProxy`	`keyProxy`
`protected AbstractTool.MouseMotionProxy`	`mouseMotionProxy`
`protected AbstractTool.MouseProxy`	`mouseProxy`
`protected AbstractTool.MouseWheelProxy`	`mouseWheelProxy`
`protected String`	`savedToolName`
`protected SliceListener`	`sliceListener`
`protected List<SliceObserver>`	`sliceObservers`
`protected boolean`	`toolActive`
`protected Toolbar`	`toolbar`
`protected AbstractTool.ToolbarMouseAdapter`	`toolbarMouseListener`
`protected int`	`toolID`
`protected ToolToggleListener`	`toolToggleListener`

Constructor Summary

Constructors
Constructor and Description

AbstractTool()

Constructors
Constructor and Description
`AbstractTool()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addKeyListener(Component component)`
`protected void`	`addMouseMotionListener(ImageCanvas canvas)`
`protected void`	`addMouseWheelListener(ImageWindow window)`
`ImageCanvas`	`getImageCanvas(ComponentEvent e)`
`ij.ImagePlus`	`getImagePlus(ComponentEvent e)`
`ImageWindow`	`getImageWindow(ComponentEvent e)`
`int`	`getOffscreenX(MouseEvent e)`
`double`	`getOffscreenXDouble(MouseEvent e)`
`int`	`getOffscreenY(MouseEvent e)`
`double`	`getOffscreenYDouble(MouseEvent e)`
`String`	`getToolIcon()` Return the string encoding of the tool icon as it will appear in the toolbar.
`int`	`getToolID()`
`String`	`getToolName()` Return the tool name.
`void`	`imageClosed(ij.ImagePlus image)`
`void`	`imageOpened(ij.ImagePlus image)`
`void`	`imageUpdated(ij.ImagePlus image)`
`boolean`	`isThisTool()`
`protected boolean`	`maybeUnregister()`
`protected void`	`registerTool()`
`protected void`	`registerTool(ImageCanvas canvas)`
`protected void`	`registerTool(ij.ImagePlus image)`
`void`	`run(String arg)`
`protected void`	`unregisterTool()`
`protected void`	`unregisterTool(ImageCanvas canvas)`
`protected void`	`unregisterTool(ij.ImagePlus image)`
`protected boolean`	`wasToolbarCleared()`
`void`	`windowGainedFocus(WindowEvent e)`
`void`	`windowLostFocus(WindowEvent e)`

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

Field Detail

toolbar
```
protected Toolbar toolbar
```

toolID
```
protected int toolID
```

mouseProxy

protected AbstractTool.MouseProxy mouseProxy

mouseWheelProxy

protected AbstractTool.MouseWheelProxy mouseWheelProxy

mouseMotionProxy

protected AbstractTool.MouseMotionProxy mouseMotionProxy

keyProxy

protected AbstractTool.KeyProxy keyProxy

ijKeyProxy

protected AbstractTool.KeyProxyIfNotConsumed ijKeyProxy

sliceListener
```
protected SliceListener sliceListener
```

sliceObservers

protected List<SliceObserver> sliceObservers

toolbarMouseListener

protected AbstractTool.ToolbarMouseAdapter toolbarMouseListener

toolToggleListener

protected ToolToggleListener toolToggleListener

savedToolName
```
protected String savedToolName
```

clearToolsIfNecessary

protected boolean clearToolsIfNecessary

toolActive
```
protected boolean toolActive
```

Constructor Detail
- AbstractTool
```
public AbstractTool()
```

Method Detail

run
```
public void run(String arg)
```
Specified by:

run in interface ij.plugin.PlugIn

imageOpened
```
public void imageOpened(ij.ImagePlus image)
```
Specified by:

imageOpened in interface ij.ImageListener

imageClosed
```
public void imageClosed(ij.ImagePlus image)
```
Specified by:

imageClosed in interface ij.ImageListener

imageUpdated
```
public void imageUpdated(ij.ImagePlus image)
```
Specified by:

imageUpdated in interface ij.ImageListener

windowGainedFocus
```
public void windowGainedFocus(WindowEvent e)
```
Specified by:

windowGainedFocus in interface WindowFocusListener

windowLostFocus
```
public void windowLostFocus(WindowEvent e)
```
Specified by:

windowLostFocus in interface WindowFocusListener

getToolID
```
public final int getToolID()
```

isThisTool
```
public final boolean isThisTool()
```

registerTool
```
protected void registerTool()
```

registerTool

protected void registerTool(ij.ImagePlus image)

registerTool

protected void registerTool(ImageCanvas canvas)

addKeyListener

protected void addKeyListener(Component component)

addMouseMotionListener

protected void addMouseMotionListener(ImageCanvas canvas)

addMouseWheelListener

protected void addMouseWheelListener(ImageWindow window)

maybeUnregister
```
protected boolean maybeUnregister()
```

wasToolbarCleared
```
protected boolean wasToolbarCleared()
```

unregisterTool
```
protected void unregisterTool()
```

unregisterTool

protected void unregisterTool(ij.ImagePlus image)

unregisterTool

protected void unregisterTool(ImageCanvas canvas)

getImagePlus

public ij.ImagePlus getImagePlus(ComponentEvent e)

getImageCanvas

public ImageCanvas getImageCanvas(ComponentEvent e)

getImageWindow

public ImageWindow getImageWindow(ComponentEvent e)

getOffscreenX

public int getOffscreenX(MouseEvent e)

getOffscreenY

public int getOffscreenY(MouseEvent e)

getOffscreenXDouble

public double getOffscreenXDouble(MouseEvent e)

getOffscreenYDouble

public double getOffscreenYDouble(MouseEvent e)

getToolName
```
public String getToolName()
```
Return the tool name.

getToolIcon
```
public String getToolIcon()
```
Return the string encoding of the tool icon as it will appear in the toolbar. See syntax for icon string.

Class AbstractTool

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

toolbar

toolID

mouseProxy

mouseWheelProxy

mouseMotionProxy

keyProxy

ijKeyProxy

sliceListener

sliceObservers

toolbarMouseListener

toolToggleListener

savedToolName

clearToolsIfNecessary

toolActive

Constructor Detail

AbstractTool

Method Detail

run

imageOpened

imageClosed

imageUpdated

windowGainedFocus

windowLostFocus

getToolID

isThisTool

registerTool

registerTool

registerTool

addKeyListener

addMouseMotionListener

addMouseWheelListener

maybeUnregister

wasToolbarCleared

unregisterTool

unregisterTool

unregisterTool

getImagePlus

getImageCanvas

getImageWindow

getOffscreenX

getOffscreenY

getOffscreenXDouble

getOffscreenYDouble

getToolName

getToolIcon