Module ij

Package ij.plugin.tool

Class PlugInTool

java.lang.Object

ij.plugin.tool.PlugInTool

All Implemented Interfaces:

PlugIn

Direct Known Subclasses:

ArrowTool, BrushTool, MacroToolRunner, OverlayBrushTool, PixelInspectionTool, RoiRotationTool

public abstract class PlugInTool
extends java.lang.Object
implements PlugIn

Constructor Summary

Constructors

Constructor	Description
PlugInTool()

Method Summary

Modifier and Type	Method	Description
Program	getMacroProgram()
java.lang.String	getToolIcon()	Return the string encoding of the tool icon.
java.lang.String	getToolName()	Return the tool name.
void	mouseClicked(ImagePlus imp, java.awt.event.MouseEvent e)
void	mouseDragged(ImagePlus imp, java.awt.event.MouseEvent e)
void	mouseEntered(ImagePlus imp, java.awt.event.MouseEvent e)
void	mouseExited(ImagePlus imp, java.awt.event.MouseEvent e)
void	mouseMoved(ImagePlus imp, java.awt.event.MouseEvent e)
void	mousePressed(ImagePlus imp, java.awt.event.MouseEvent e)
void	mouseReleased(ImagePlus imp, java.awt.event.MouseEvent e)
void	run(java.lang.String arg)	This method is called when the plugin is loaded.
void	runMacroTool(java.lang.String name)	These methods are overridden by MacroToolRunner.
void	runMenuTool(java.lang.String name, java.lang.String command)
void	showOptionsDialog()
void	showPopupMenu(java.awt.event.MouseEvent e, Toolbar tb)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PlugInTool

public PlugInTool()

Method Detail

run

public void run(java.lang.String arg)

Description copied from interface: PlugIn

This method is called when the plugin is loaded. 'arg', which may be blank, is the argument specified for this plugin in IJ_Props.txt.

Specified by:

run in interface PlugIn

mousePressed

public void mousePressed(ImagePlus imp,
                         java.awt.event.MouseEvent e)

mouseReleased

public void mouseReleased(ImagePlus imp,
                          java.awt.event.MouseEvent e)

mouseClicked

public void mouseClicked(ImagePlus imp,
                         java.awt.event.MouseEvent e)

mouseDragged

public void mouseDragged(ImagePlus imp,
                         java.awt.event.MouseEvent e)

mouseMoved

public void mouseMoved(ImagePlus imp,
                       java.awt.event.MouseEvent e)

mouseEntered

public void mouseEntered(ImagePlus imp,
                         java.awt.event.MouseEvent e)

mouseExited

public void mouseExited(ImagePlus imp,
                        java.awt.event.MouseEvent e)

showPopupMenu

public void showPopupMenu(java.awt.event.MouseEvent e,
                          Toolbar tb)

getToolName

public java.lang.String getToolName()

Return the tool name.

getToolIcon

public java.lang.String getToolIcon()

Return the string encoding of the tool icon. See http://rsb.info.nih.gov/ij/developer/macro/macros.html#icons The default icon is the first letter of the tool name.

showOptionsDialog

public void showOptionsDialog()

runMacroTool

public void runMacroTool(java.lang.String name)

These methods are overridden by MacroToolRunner.

runMenuTool

public void runMenuTool(java.lang.String name,
                        java.lang.String command)

getMacroProgram

public Program getMacroProgram()