com.fr.design.gui.syntax.ui.rsyntaxtextarea.templates

接口 CodeTemplate

所有超级接口:

java.lang.Cloneable, java.lang.Comparable<CodeTemplate>, java.io.Serializable

所有已知实现类:

AbstractCodeTemplate, StaticCodeTemplate

public interface CodeTemplate
extends java.lang.Cloneable, java.lang.Comparable<CodeTemplate>, java.io.Serializable

A "code template" is a kind of macro for commonly-typed code. It associates a short identifier with a longer code snippet, then when the code template is enabled and the short identifier is typed, it is replaced with the longer code snippet.

For example, you can associate the identifier forb (short for "for-block") with the following code:

   for (<caret>) {

   }
 

Then, whenever you type forb followed by a trigger (e.g., a space) into a text area with this CodeTemplate, the code snippet is added in place of forb. Further, the caret is placed at the position denoted by <caret>.

Static text replacements are done with StaticCodeTemplate. Dynamic templates can also be created and used.

版本:

0.1

作者:

Robert Futrell

另请参阅:

StaticCodeTemplate

方法概要

方法

限定符和类型	方法和说明
java.lang.Object	clone() Creates a deep copy of this template.
java.lang.String	getID() Returns the ID of this code template.
void	invoke(RSyntaxTextArea textArea) Invokes this code template.

从接口继承的方法 java.lang.Comparable

compareTo

方法详细资料

clone

java.lang.Object clone()

Creates a deep copy of this template.

返回:

A deep copy of this template.

getID

java.lang.String getID()

Returns the ID of this code template.

返回:

The template's ID.

invoke

void invoke(RSyntaxTextArea textArea)
            throws javax.swing.text.BadLocationException

Invokes this code template. The changes are made to the given text area.

参数:

textArea - The text area to operate on.

抛出:

javax.swing.text.BadLocationException - If something bad happens.