ij.plugin.frame
Class Recorder

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by java.awt.Window
              extended by java.awt.Frame
                  extended by ij.plugin.frame.PlugInFrame
                      extended by ij.plugin.frame.Recorder
All Implemented Interfaces:
ImageListener, PlugIn, java.awt.event.ActionListener, java.awt.event.FocusListener, java.awt.event.ItemListener, java.awt.event.WindowListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible

public class Recorder
extends PlugInFrame
implements PlugIn, java.awt.event.ActionListener, ImageListener, java.awt.event.ItemListener

This is ImageJ's macro recorder.

See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class java.awt.Frame
java.awt.Frame.AccessibleAWTFrame
 
Nested classes/interfaces inherited from class java.awt.Window
java.awt.Window.AccessibleAWTWindow
 
Nested classes/interfaces inherited from class java.awt.Container
java.awt.Container.AccessibleAWTContainer
 
Nested classes/interfaces inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
 
Field Summary
static boolean record
          This variable is true if the recorder is running.
static boolean recordInMacros
          Set this variable true to allow recording within IJ.run() calls.
 
Fields inherited from class java.awt.Frame
CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR
 
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
 
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
Recorder()
           
 
Method Summary
 void actionPerformed(java.awt.event.ActionEvent e)
           
 void close()
          Closes this window.
static void disablePathRecording()
          Temporarily disables path recording.
static java.lang.String getCommand()
          Returns the name of the command currently being recorded, or null.
static java.lang.String getCommandOptions()
          Used by GenericDialog to determine if any options have been recorded.
static Recorder getInstance()
           
 java.lang.String getText()
           
 void imageClosed(ImagePlus imp)
           
 void imageOpened(ImagePlus imp)
           
 void imageUpdated(ImagePlus imp)
           
 void itemStateChanged(java.awt.event.ItemEvent e)
           
static void record(java.lang.String method)
           
static void record(java.lang.String method, double a1, double a2)
           
static void record(java.lang.String method, int a1)
           
static void record(java.lang.String method, int a1, int a2)
           
static void record(java.lang.String method, int a1, int a2, int a3)
           
static void record(java.lang.String method, int a1, int a2, int a3, int a4)
           
static void record(java.lang.String method, int a1, int a2, int a3, int a4, int a5)
           
static void record(java.lang.String method, java.lang.String arg)
           
static void record(java.lang.String method, java.lang.String a1, int a2)
           
static void record(java.lang.String method, java.lang.String args, int a1, int a2)
           
static void record(java.lang.String method, java.lang.String arg1, java.lang.String arg2)
           
static void record(java.lang.String method, java.lang.String path, java.lang.String args, int a1, int a2, int a3, int a4, int a5)
           
static void record(java.lang.String method, java.lang.String arg1, java.lang.String arg2, java.lang.String arg3)
           
static void recordCall(java.lang.String call)
           
static void recordOption(java.lang.String key)
           
static void recordOption(java.lang.String key, java.lang.String value)
           
static void recordPath(java.lang.String key, java.lang.String path)
           
static void recordRoi(java.awt.Polygon p, int type)
           
static void recordScriptRoi(java.awt.Polygon p, int type)
           
static void recordString(java.lang.String str)
           
static void saveCommand()
          Writes the current command and options to the Recorder window.
static boolean scriptMode()
           
static void setCommand(java.lang.String command)
          Starts recording a command.
 void windowClosing(java.awt.event.WindowEvent e)
           
 
Methods inherited from class ij.plugin.frame.PlugInFrame
focusGained, focusLost, run, windowActivated, windowClosed, windowDeactivated, windowDeiconified, windowIconified, windowOpened
 
Methods inherited from class java.awt.Frame
addNotify, getAccessibleContext, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, paramString, remove, removeNotify, setCursor, setExtendedState, setIconImage, setMaximizedBounds, setMenuBar, setResizable, setState, setTitle, setUndecorated
 
Methods inherited from class java.awt.Window
addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOwnedWindows, getOwner, getOwnerlessWindows, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, pack, postEvent, processEvent, processWindowEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setVisible, show, toBack, toFront
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, setLayout, transferFocusBackward, transferFocusDownCycle, update, validate, validateTree
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resize, resize, setBackground, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface ij.plugin.PlugIn
run
 
Methods inherited from interface java.awt.MenuContainer
getFont, postEvent
 

Field Detail

record

public static boolean record
This variable is true if the recorder is running.


recordInMacros

public static boolean recordInMacros
Set this variable true to allow recording within IJ.run() calls.

Constructor Detail

Recorder

public Recorder()
Method Detail

record

public static void record(java.lang.String method)

setCommand

public static void setCommand(java.lang.String command)
Starts recording a command. Does nothing if the recorder is not open or the command being recorded has called IJ.run().


getCommand

public static java.lang.String getCommand()
Returns the name of the command currently being recorded, or null.


record

public static void record(java.lang.String method,
                          java.lang.String arg)

record

public static void record(java.lang.String method,
                          java.lang.String arg1,
                          java.lang.String arg2)

record

public static void record(java.lang.String method,
                          java.lang.String arg1,
                          java.lang.String arg2,
                          java.lang.String arg3)

record

public static void record(java.lang.String method,
                          int a1)

record

public static void record(java.lang.String method,
                          int a1,
                          int a2)

record

public static void record(java.lang.String method,
                          double a1,
                          double a2)

record

public static void record(java.lang.String method,
                          int a1,
                          int a2,
                          int a3)

record

public static void record(java.lang.String method,
                          java.lang.String a1,
                          int a2)

record

public static void record(java.lang.String method,
                          java.lang.String args,
                          int a1,
                          int a2)

record

public static void record(java.lang.String method,
                          int a1,
                          int a2,
                          int a3,
                          int a4)

record

public static void record(java.lang.String method,
                          int a1,
                          int a2,
                          int a3,
                          int a4,
                          int a5)

record

public static void record(java.lang.String method,
                          java.lang.String path,
                          java.lang.String args,
                          int a1,
                          int a2,
                          int a3,
                          int a4,
                          int a5)

recordString

public static void recordString(java.lang.String str)

recordCall

public static void recordCall(java.lang.String call)

recordRoi

public static void recordRoi(java.awt.Polygon p,
                             int type)

recordScriptRoi

public static void recordScriptRoi(java.awt.Polygon p,
                                   int type)

recordOption

public static void recordOption(java.lang.String key,
                                java.lang.String value)

recordPath

public static void recordPath(java.lang.String key,
                              java.lang.String path)

recordOption

public static void recordOption(java.lang.String key)

saveCommand

public static void saveCommand()
Writes the current command and options to the Recorder window.


getCommandOptions

public static java.lang.String getCommandOptions()
Used by GenericDialog to determine if any options have been recorded.


disablePathRecording

public static void disablePathRecording()
Temporarily disables path recording.


scriptMode

public static boolean scriptMode()

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent e)
Specified by:
actionPerformed in interface java.awt.event.ActionListener

itemStateChanged

public void itemStateChanged(java.awt.event.ItemEvent e)
Specified by:
itemStateChanged in interface java.awt.event.ItemListener

imageUpdated

public void imageUpdated(ImagePlus imp)
Specified by:
imageUpdated in interface ImageListener

imageOpened

public void imageOpened(ImagePlus imp)
Specified by:
imageOpened in interface ImageListener

imageClosed

public void imageClosed(ImagePlus imp)
Specified by:
imageClosed in interface ImageListener

windowClosing

public void windowClosing(java.awt.event.WindowEvent e)
Specified by:
windowClosing in interface java.awt.event.WindowListener
Overrides:
windowClosing in class PlugInFrame

close

public void close()
Description copied from class: PlugInFrame
Closes this window.

Overrides:
close in class PlugInFrame

getText

public java.lang.String getText()

getInstance

public static Recorder getInstance()