Class Macro

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      (package private) static class  Macro.MacroRecord
      A "record" of a macro is a single action in the macro (corresponding to a key type and some action in the editor, such as a letter inserted into the document, scrolling one page down, selecting the current line, etc.).
    • Constructor Summary

      Constructors 
      Constructor Description
      Macro()
      Constructor.
      Macro​(java.io.File file)
      Loads a macro from a file on disk.
      Macro​(java.lang.String name)
      Constructor.
      Macro​(java.lang.String name, java.util.List<Macro.MacroRecord> records)
      Constructor.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addMacroRecord​(Macro.MacroRecord record)
      Adds a macro record to this macro.
      java.util.List<Macro.MacroRecord> getMacroRecords()
      Returns the macro records that make up this macro.
      java.lang.String getName()
      Returns the name of this macro.
      private boolean initializeFromXMLFile​(org.w3c.dom.Element root)
      Used in parsing an XML document containing a macro.
      void saveToFile​(java.io.File file)
      Saves this macro to an XML file.
      void saveToFile​(java.lang.String fileName)
      Saves this macro to a file.
      void setName​(java.lang.String name)
      Sets the name of this macro.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • Macro

        public Macro()
        Constructor.
      • Macro

        public Macro​(java.io.File file)
              throws java.io.IOException
        Loads a macro from a file on disk.
        Parameters:
        file - The file from which to load the macro.
        Throws:
        java.io.IOException - If the file does not exist or an I/O exception occurs while reading the file.
        See Also:
        saveToFile(String), saveToFile(File)
      • Macro

        public Macro​(java.lang.String name)
        Constructor.
        Parameters:
        name - The name of the macro.
      • Macro

        public Macro​(java.lang.String name,
                     java.util.List<Macro.MacroRecord> records)
        Constructor.
        Parameters:
        name - The name of the macro.
        records - The initial records of the macro.
    • Method Detail

      • addMacroRecord

        public void addMacroRecord​(Macro.MacroRecord record)
        Adds a macro record to this macro.
        Parameters:
        record - The record to add. If null, nothing happens.
        See Also:
        getMacroRecords()
      • getName

        public java.lang.String getName()
        Returns the name of this macro. A macro's name is simply something to identify it with in a UI; it has nothing to do with the name of the file to save the macro to.
        Returns:
        The macro's name.
        See Also:
        setName(String)
      • initializeFromXMLFile

        private boolean initializeFromXMLFile​(org.w3c.dom.Element root)
        Used in parsing an XML document containing a macro. This method initializes this macro with the data contained in the passed-in node.
        Parameters:
        root - The root node of the parsed XML document.
        Returns:
        true if the macro initialization went okay; false if an error occurred.
      • saveToFile

        public void saveToFile​(java.io.File file)
                        throws java.io.IOException
        Saves this macro to an XML file. This file can later be read in by the constructor taking a File parameter; this is the mechanism for saving macros.
        Parameters:
        file - The file in which to save the macro.
        Throws:
        java.io.IOException - If an error occurs while generating the XML for the output file.
        See Also:
        saveToFile(String)
      • saveToFile

        public void saveToFile​(java.lang.String fileName)
                        throws java.io.IOException
        Saves this macro to a file. This file can later be read in by the constructor taking a File parameter; this is the mechanism for saving macros.
        Parameters:
        fileName - The name of the file in which to save the macro.
        Throws:
        java.io.IOException - If an error occurs while generating the XML for the output file.
        See Also:
        saveToFile(File)
      • setName

        public void setName​(java.lang.String name)
        Sets the name of this macro. A macro's name is simply something to identify it with in a UI; it has nothing to do with the name of the file to save the macro to.
        Parameters:
        name - The new name for the macro.
        See Also:
        getName()