Class Recorder

java.lang.Object
java.awt.Component
java.awt.Container
java.awt.Window
java.awt.Frame
ij.plugin.frame.PlugInFrame
ij.plugin.frame.Recorder
All Implemented Interfaces:
ImageListener, PlugIn, ActionListener, FocusListener, ItemListener, WindowListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible
public class Recorder extends PlugInFrame implements PlugIn, ActionListener, ImageListener, ItemListener
This is ImageJ's macro recorder.
See Also:

  • Field Details

    • record

      public static boolean record
      This variable is true if the recorder is running. It should not be modified; one should use suspendRecording() and resumeRecording() to temporarily disable recording.

    • recordInMacros

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

  • Constructor Details

    • Recorder

      public Recorder()

    • Recorder

      public Recorder(boolean showFrame)

  • Method Details

    • suspendRecording

      public static void suspendRecording()
      Disables recording of commands for the current Thread. Calls to suspendRecording and resumeRecording can be nested: If suspendRecording is called multiple times in a thread, one must call resumeRecording the same number of times to resume recording. The suspendRecording method does nothing if the Recorder window is not open.

    • resumeRecording

      public static void resumeRecording()
      Enables recording of commands for the current Thread after a call to suspendRecording. The resumeRecording method is unrelated to recording in macros, i.e., resumeRecording does not enable recording in macros; use 'recordInMacros' for this.

    • record

      public static void record(String method)

    • setCommand

      public static void setCommand(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 String getCommand()
      Returns the name of the command currently being recorded, or null.

    • fixPath

      public static String fixPath(String path)
      Replaces '\' characters with '/'.

    • fixString

      public static String fixString(String str)
      Replaces special characters in a String for creation of a quoted macro String. Does not add quotes.

    • record

      public static void record(String method, String arg)

    • record

      public static void record(String method, String arg1, String arg2)

    • record

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

    • record

      public static void record(String method, int a1)

    • record

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

    • record

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

    • record

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

    • record

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

    • record

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

    • record

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

    • record

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

    • record

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

    • record

      public static void record(String method, int a1, int a2, int a3, int a4, double a5)

    • record

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

    • recordString

      public static void recordString(String str)

    • disableCommandRecording

      public static void disableCommandRecording()
      Prevents recording the dialogs (GenericDialog, File Open/Save dialog) for the command recently started

    • recordCall

      public static void recordCall(String call)

    • recordCall

      public static void recordCall(String call, boolean recordCommand)
      Records in scriptMode (not ImageJ macro language)

    • recordCall

      public static void recordCall(String className, String call)

    • recordRoi

      public static void recordRoi(Roi roi)

    • recordRoi

      public static void recordRoi(Polygon p, int type)

    • recordScriptRoi

      public static void recordScriptRoi(Polygon p, int type)

    • recordOption

      public static void recordOption(String key, String value)

    • recordOpen

      public static void recordOpen(String path)

    • recordPath

      public static void recordPath(String key, String path)

    • recordOption

      public static void recordOption(String key)

    • saveCommand

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

    • getCommandOptions

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

    • resetCommandOptions

      public static void resetCommandOptions()
      Used by GenericDialog.notifyListeners() to clear the command options.

    • disablePathRecording

      public static void disablePathRecording()
      Temporarily disables path recording.

    • scriptMode

      public static boolean scriptMode()

    • actionPerformed

      public void actionPerformed(ActionEvent e)
      Specified by:
      actionPerformed in interface ActionListener

    • itemStateChanged

      public void itemStateChanged(ItemEvent e)
      Specified by:
      itemStateChanged in interface 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

    • close

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

    • getText

      public String getText()

    • getInstance

      public static Recorder getInstance()

    • setForegroundColor

      public static void setForegroundColor(Color c)

    • setBackgroundColor

      public static void setBackgroundColor(Color c)

    • setBlackBackground

      public static void setBlackBackground()

    • windowActivated

      public void windowActivated(WindowEvent e)
      Override windowActivated in PlugInFrame.
      Specified by:
      windowActivated in interface WindowListener
      Overrides:
      windowActivated in class PlugInFrame