public class Macro extends Object
RTextArea
.
Macro
s are static; when a Macro is loaded, it can be run by any
instance of RTextArea
in the application. To activate and play
back a macro, use the following methods:
RTextArea.beginRecordingMacro()
(this discards the previous
"current" macro, if any)
RTextArea.endRecordingMacro()
(at this point, you could call
playbackLastMacro()
to play this macro immediately if
desired)
RTextArea.getCurrentMacro()
.saveToFile(File)
Macro
s save themselves as XML files, a common technique is
to save all macros in files named "getName()
.xml
", and
place them all in a common directory.Constructor and Description |
---|
Macro()
Constructor.
|
Macro(File file)
Loads a macro from a file on disk.
|
Macro(String name)
Constructor.
|
Macro(String name,
List<org.fife.ui.rtextarea.Macro.MacroRecord> records)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
void |
addMacroRecord(org.fife.ui.rtextarea.Macro.MacroRecord record)
Adds a macro record to this macro.
|
List<org.fife.ui.rtextarea.Macro.MacroRecord> |
getMacroRecords()
Returns the macro records that make up this macro.
|
String |
getName()
Returns the name of this macro.
|
void |
saveToFile(File file)
Saves this macro to an XML file.
|
void |
saveToFile(String fileName)
Saves this macro to a file.
|
void |
setName(String name)
Sets the name of this macro.
|
public Macro()
public Macro(File file) throws FileNotFoundException, IOException
file
- The file from which to load the macro.FileNotFoundException
- If the specified file does not exist, is
a directory instead of a regular file, or otherwise cannot be
opened.IOException
- If an I/O exception occurs while reading the file.saveToFile(String)
,
saveToFile(File)
public Macro(String name)
name
- The name of the macro.public void addMacroRecord(org.fife.ui.rtextarea.Macro.MacroRecord record)
record
- The record to add. If null
, nothing happens.getMacroRecords()
public List<org.fife.ui.rtextarea.Macro.MacroRecord> getMacroRecords()
addMacroRecord(org.fife.ui.rtextarea.Macro.MacroRecord)
public String getName()
setName(String)
public void saveToFile(File file) throws IOException
File
parameter; this is the mechanism
for saving macros.file
- The file in which to save the macro.IOException
- If an error occurs while generating the XML for
the output file.saveToFile(String)
public void saveToFile(String fileName) throws IOException
File
parameter; this is the mechanism
for saving macros.fileName
- The name of the file in which to save the macro.IOException
- If an error occurs while generating the XML for
the output file.saveToFile(File)