Class CodeTemplateManager

java.lang.Object
org.fife.ui.rsyntaxtextarea.CodeTemplateManager
public class CodeTemplateManager extends Object
Manages "code templates."

All methods in this class are synchronized for thread safety, but as a best practice, you should probably only modify the templates known to a CodeTemplateManager on the EDT. Modifying a CodeTemplate retrieved from a CodeTemplateManager while not on the EDT could cause problems.

For more flexible boilerplate code insertion, consider using the TemplateCompletion class in the AutoComplete add-on library.

Version:
1.0
Author:
Robert Futrell

  • Constructor Details

    • CodeTemplateManager

      public CodeTemplateManager()
      Constructor.

  • Method Details

    • addTemplate

      public void addTemplate(CodeTemplate template)
      Registers the specified template with this template manager.
      Parameters:
      template - The template to register.
      Throws:
      IllegalArgumentException - If template is null.
      See Also:

    • getTemplate

      public CodeTemplate getTemplate(RSyntaxTextArea textArea)
      Returns the template that should be inserted at the current caret position, assuming the trigger character was pressed.
      Parameters:
      textArea - The text area that's getting text inserted into it.
      Returns:
      A template that should be inserted, if appropriate, or null if no template should be inserted.

    • getTemplates

      public CodeTemplate[] getTemplates()
      Returns the templates currently available.
      Returns:
      The templates available.

    • removeTemplate

      public boolean removeTemplate(CodeTemplate template)
      Returns the specified code template.
      Parameters:
      template - The template to remove.
      Returns:
      true if the template was removed, false if the template was not in this template manager.
      Throws:
      IllegalArgumentException - If template is null.
      See Also:

    • removeTemplate

      public CodeTemplate removeTemplate(String id)
      Returns the code template with the specified id.
      Parameters:
      id - The id to check for.
      Returns:
      The code template that was removed, or null if there was no template with the specified ID.
      Throws:
      IllegalArgumentException - If id is null.
      See Also:

    • replaceTemplates

      public void replaceTemplates(CodeTemplate[] newTemplates)
      Replaces the current set of available templates with the ones specified.
      Parameters:
      newTemplates - The new set of templates. Note that we will be taking a shallow copy of these and sorting them.

    • saveTemplates

      public boolean saveTemplates()
      Saves all templates as XML files in the current template directory.
      Returns:
      Whether the save was successful.

    • setTemplateDirectory

      public int setTemplateDirectory(File dir)
      Sets the directory in which to look for templates. Calling this method adds any new templates found in the specified directory to the templates already registered.
      Parameters:
      dir - The new directory in which to look for templates.
      Returns:
      The new number of templates in this template manager, or -1 if the specified directory does not exist.