Package org.fife.ui.rsyntaxtextarea
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
CodeTemplateManageron the EDT. Modifying aCodeTemplateretrieved from aCodeTemplateManagerwhile not on the EDT could cause problems.For more flexible boilerplate code insertion, consider using the TemplateCompletion class in the AutoComplete add-on library.
-
-
Constructor Summary
Constructors Constructor Description CodeTemplateManager()Constructor.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddTemplate(CodeTemplate template)Registers the specified template with this template manager.CodeTemplategetTemplate(RSyntaxTextArea textArea)Returns the template that should be inserted at the current caret position, assuming the trigger character was pressed.intgetTemplateCount()Returns the number of templates this manager knows about.CodeTemplate[]getTemplates()Returns the templates currently available.static booleanisValidChar(char ch)Returns whether the specified character is a valid character for aCodeTemplateid.CodeTemplateremoveTemplate(String id)Returns the code template with the specified id.booleanremoveTemplate(CodeTemplate template)Returns the specified code template.voidreplaceTemplates(CodeTemplate[] newTemplates)Replaces the current set of available templates with the ones specified.booleansaveTemplates()Saves all templates as XML files in the current template directory.intsetTemplateDirectory(File dir)Sets the directory in which to look for templates.
-
-
-
Method Detail
-
addTemplate
public void addTemplate(CodeTemplate template)
Registers the specified template with this template manager.- Parameters:
template- The template to register.- Throws:
IllegalArgumentException- Iftemplateisnull.- See Also:
removeTemplate(CodeTemplate),removeTemplate(String)
-
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
nullif no template should be inserted.
-
getTemplateCount
public int getTemplateCount()
Returns the number of templates this manager knows about.- Returns:
- The template count.
-
getTemplates
public CodeTemplate[] getTemplates()
Returns the templates currently available.- Returns:
- The templates available.
-
isValidChar
public static final boolean isValidChar(char ch)
Returns whether the specified character is a valid character for aCodeTemplateid.- Parameters:
ch- The character to check.- Returns:
- Whether the character is a valid template character.
-
removeTemplate
public boolean removeTemplate(CodeTemplate template)
Returns the specified code template.- Parameters:
template- The template to remove.- Returns:
trueif the template was removed,falseif the template was not in this template manager.- Throws:
IllegalArgumentException- Iftemplateisnull.- See Also:
removeTemplate(String),addTemplate(CodeTemplate)
-
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
nullif there was no template with the specified ID. - Throws:
IllegalArgumentException- Ifidisnull.- See Also:
removeTemplate(CodeTemplate),addTemplate(CodeTemplate)
-
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 or not 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
-1if the specified directory does not exist.
-
-