Module ij

Package ij.plugin

Class MacroInstaller

java.lang.Object

ij.plugin.MacroInstaller

All Implemented Interfaces:

MacroConstants, PlugIn, java.awt.event.ActionListener, java.util.EventListener

public class MacroInstaller
extends java.lang.Object
implements PlugIn, MacroConstants, java.awt.event.ActionListener

This plugin implements the Plugins/Macros/Install Macros command. It is also used by the Editor class to install macros in menus and by the ImageJ class to install macros at startup.

Field Summary

Fields

Modifier and Type	Field	Description
static char	commandPrefix
static int	MAX_MACROS
static int	MAX_SIZE
static int	XINC
static int	YINC

Fields inherited from interface ij.macro.MacroConstants

ABS, ACOS, ARRAY, ARRAY_FUNC, ARRAY_FUNCTION, arrayFunctionIDs, arrayFunctions, ASIN, ATAN, ATAN2, AUTO_UPDATE, BEEP, BIT_DEPTH, BREAK, CALCULATOR, CALIBRATE, CALL, CHANGE_VALUES, CHAR_CODE_AT, CLOSE, COLOR, CONTINUE, COS, D2S, DEBUG, DIALOG, DIV_EQUAL, DO, DO_COMMAND, DO_WAND, DRAW_LINE, DRAW_OVAL, DRAW_RECT, DRAW_STRING, DUMP, ELSE, ENDS_WITH, EOF, EQ, EVAL, EXEC, EXIT, EXP, EXT, FALSE, FILE, FILL, FILL_OVAL, FILL_RECT, FIT, FLOOD_FILL, FLOOR, FOR, FROM_CHAR_CODE, FUNCTION, functionIDs, functions, GET_ARGUMENT, GET_BOOLEAN, GET_BOUNDING_RECT, GET_BOUNDS, GET_COORDINATES, GET_COUNT, GET_CURSOR_LOC, GET_DATE_AND_TIME, GET_DIMENSIONS, GET_DIR, GET_DIRECTORY, GET_DISPLAYED_AREA, GET_FILE_LIST, GET_FONT_LIST, GET_HEIGHT, GET_HISTOGRAM, GET_ID, GET_IMAGE_INFO, GET_INFO, GET_LINE, GET_LIST, GET_LOCATION_AND_SIZE, GET_LUT, GET_METADATA, GET_MIN_AND_MAX, GET_NUMBER, GET_PIXEL, GET_PIXEL_SIZE, GET_PROFILE, GET_RAW_STATISTICS, GET_RESULT, GET_RESULT_LABEL, GET_RESULT_STRING, GET_SLICE_NUMBER, GET_STATISTICS, GET_STRING, GET_STRING_WIDTH, GET_THRESHOLD, GET_TIME, GET_TITLE, GET_VALUE, GET_VERSION, GET_VOXEL_SIZE, GET_WIDTH, GET_ZOOM, GT, GTE, IF, IJ_CALL, IMAGE, INDEX_OF, INVERT, IS, IS_ACTIVE, IS_KEY_DOWN, IS_NAN, IS_OPEN, keywordIDs, keywords, LAST_INDEX_OF, LENGTH_OF, LINE_TO, LIST, LOG, LOGICAL_AND, LOGICAL_OR, LT, LTE, MACRO, MAKE_ARROW, MAKE_ELLIPSE, MAKE_LINE, MAKE_OVAL, MAKE_POINT, MAKE_POLYGON, MAKE_RECTANGLE, MAKE_ROTATED_RECT, MAKE_SELECTION, MAKE_TEXT, MATCHES, MATH, MAX_OF, MIN_OF, MINUS_EQUAL, MINUS_MINUS, MOVE_TO, MUL_EQUAL, NaN, NEQ, NEW_ARRAY, NEW_IMAGE, NEW_MENU, NIMAGES, NOP, NRESULTS, NSLICES, NUMBER, NUMERIC_FUNCTION, numericFunctionIDs, numericFunctions, OPEN, OVERLAY, PARSE_FLOAT, PARSE_INT, PI, PLOT, PLUS_EQUAL, PLUS_PLUS, POW, PREDEFINED_FUNCTION, PRINT, PROPERTY, PUT_PIXEL, RANDOM, RENAME, REPLACE, REQUIRES, RESET, RESET_MIN_MAX, RESET_THRESHOLD, RESTORE_PREVIOUS_TOOL, RESTORE_SETTINGS, RETURN, ROI, ROI_MANAGER, ROI_MANAGER2, ROUND, RUN, RUN_MACRO, SAVE, SAVE_AS, SAVE_SETTINGS, SCREEN_HEIGHT, SCREEN_WIDTH, SELECT, SELECT_IMAGE, SELECTION_CONTAINS, SELECTION_NAME, SELECTION_TYPE, SET_AUTO_THRESHOLD, SET_BACKGROUND, SET_BATCH_MODE, SET_COLOR, SET_FONT, SET_FOREGROUND, SET_JUSTIFICATION, SET_KEY_DOWN, SET_LINE_WIDTH, SET_LOCATION, SET_LUT, SET_METADATA, SET_MIN_MAX, SET_OPTION, SET_PASTE_MODE, SET_PIXEL, SET_RESULT, SET_RGB_WEIGHTS, SET_SELECTION_LOC, SET_SELECTION_NAME, SET_SLICE, SET_THRESHOLD, SET_TOOL, SET_VOXEL_SIZE, SET_Z_COORDINATE, SETUP_UNDO, SHIFT_LEFT, SHIFT_RIGHT, SHOW_MESSAGE, SHOW_MESSAGE_WITH_CANCEL, SHOW_PROGRESS, SHOW_STATUS, SHOW_TEXT, SIN, SNAPSHOT, SPLIT, SQRT, STACK, STARTS_WITH, STRING, STRING_CONSTANT, STRING_FUNCTION, stringFunctionIDs, stringFunctions, SUBSTRING, TABLE, TAN, TO_BINARY, TO_HEX, TO_LOWER_CASE, TO_SCALED, TO_STRING, TO_UNSCALED, TO_UPPER_CASE, TOK_MASK, TOK_SHIFT, TOOL_ID, TRIM, TRUE, UPDATE_DISPLAY, UPDATE_RESULTS, USER_FUNCTION, VAR, VARIABLE_FUNCTION, variableFunctionIDs, variableFunctions, WAIT, WAIT_FOR_USER, WHILE, WORD, WRITE

Constructor Summary

Constructors

Constructor	Description
MacroInstaller()

Method Summary

Modifier and Type	Method	Description
void	actionPerformed(java.awt.event.ActionEvent evt)
static void	autoRun()	Runs the StartupMacros AutoRun macro on the current thread.
static java.lang.String	getFileName()
int	getMacroCount()
Program	getProgram()
int	install(java.lang.String text)
int	install(java.lang.String text, java.awt.Menu menu)
void	installFile(java.lang.String path)
void	installFromIJJar(java.lang.String path)	Installs a macro set contained in ij.jar.
static void	installFromJar(java.lang.String path)	Installs a macro set contained in ij.jar.
void	installLibrary(java.lang.String path)
void	installSingleTool(java.lang.String text)
void	installStartupMacros(java.lang.String path)	Installs startup macros and runs AutoRun macro on current thread.
void	installTool(java.lang.String path)
boolean	isAutoRunAndHide()	Returns true if an "AutoRunAndHide" macro was run/installed.
static boolean	isMacroCommand(java.lang.String name)	Returns 'true' if the macro command 'name' exists.
java.lang.String	openFromIJJar(java.lang.String path)	Returns a text file contained in ij.jar.
void	run(java.lang.String path)	This method is called when the plugin is loaded.
void	runMacro(java.lang.String name)
void	runMacro(java.lang.String name, Editor editor)
static boolean	runMacroCommand(java.lang.String name)	Runs a command in the Plugins/Macros submenu on the current thread.
static void	runMacroShortcut(java.lang.String name)
boolean	runMacroTool(java.lang.String name)
boolean	runMenuTool(java.lang.String name, java.lang.String command)
void	setFileName(java.lang.String fileName)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

MAX_SIZE

public static final int MAX_SIZE

See Also:

Constant Field Values

MAX_MACROS

public static final int MAX_MACROS

See Also:

Constant Field Values

XINC

public static final int XINC

See Also:

Constant Field Values

YINC

public static final int YINC

See Also:

Constant Field Values

commandPrefix

public static final char commandPrefix

See Also:

Constant Field Values

Constructor Detail

MacroInstaller

public MacroInstaller()

Method Detail

run

public void run(java.lang.String path)

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

install

public int install(java.lang.String text)

install

public int install(java.lang.String text,
                   java.awt.Menu menu)

installFile

public void installFile(java.lang.String path)

installTool

public void installTool(java.lang.String path)

installLibrary

public void installLibrary(java.lang.String path)

installFromJar

public static void installFromJar(java.lang.String path)

Installs a macro set contained in ij.jar.

installFromIJJar

public void installFromIJJar(java.lang.String path)

Installs a macro set contained in ij.jar.

installSingleTool

public void installSingleTool(java.lang.String text)

openFromIJJar

public java.lang.String openFromIJJar(java.lang.String path)

Returns a text file contained in ij.jar.

runMacroTool

public boolean runMacroTool(java.lang.String name)

runMenuTool

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

runMacroCommand

public static boolean runMacroCommand(java.lang.String name)

Runs a command in the Plugins/Macros submenu on the current thread.

isMacroCommand

public static boolean isMacroCommand(java.lang.String name)

Returns 'true' if the macro command 'name' exists.

runMacroShortcut

public static void runMacroShortcut(java.lang.String name)

runMacro

public void runMacro(java.lang.String name)

runMacro

public void runMacro(java.lang.String name,
                     Editor editor)

getMacroCount

public int getMacroCount()

getProgram

public Program getProgram()

isAutoRunAndHide

public boolean isAutoRunAndHide()

Returns true if an "AutoRunAndHide" macro was run/installed.

setFileName

public void setFileName(java.lang.String fileName)

getFileName

public static java.lang.String getFileName()

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent evt)

Specified by:

actionPerformed in interface java.awt.event.ActionListener

installStartupMacros

public void installStartupMacros(java.lang.String path)

Installs startup macros and runs AutoRun macro on current thread.

autoRun

public static void autoRun()

Runs the StartupMacros AutoRun macro on the current thread.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object