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

类 StaticCodeTemplate

java.lang.Object

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

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

所有已实现的接口:

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

public class StaticCodeTemplate
extends AbstractCodeTemplate

A code template that inserts static text before and after the caret.

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>.

版本:

0.1

作者:

Robert Futrell

另请参阅:

CodeTemplate, 序列化表格

构造器概要

构造器

构造器和说明
StaticCodeTemplate() Constructor.
StaticCodeTemplate(java.lang.String id, java.lang.String beforeCaret, java.lang.String afterCaret) Constructor.

方法概要

方法

限定符和类型	方法和说明
java.lang.String	getAfterCaretText() Returns the text that will be placed after the caret.
java.lang.String	getBeforeCaretText() Returns the text that will be placed before the caret.
void	invoke(RSyntaxTextArea textArea) Invokes this code template.
void	setAfterCaretText(java.lang.String afterCaret) Sets the text to place after the caret.
void	setBeforeCaretText(java.lang.String beforeCaret) Sets the text to place before the caret.
java.lang.String	toString() Returns a string representation of this template for debugging purposes.

从类继承的方法 com.fr.design.gui.syntax.ui.rsyntaxtextarea.templates.AbstractCodeTemplate

clone, compareTo, equals, getID, hashCode, setID

从类继承的方法 java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

构造器详细资料

StaticCodeTemplate

public StaticCodeTemplate()

Constructor. This constructor only exists to support persistance through serialization.

StaticCodeTemplate

public StaticCodeTemplate(java.lang.String id,
                  java.lang.String beforeCaret,
                  java.lang.String afterCaret)

Constructor.

参数:

id - The ID of this code template.

beforeCaret - The text to place before the caret.

afterCaret - The text to place after the caret.

方法详细资料

getAfterCaretText

public java.lang.String getAfterCaretText()

Returns the text that will be placed after the caret.

返回:

The text.

另请参阅:

setAfterCaretText(java.lang.String)

getBeforeCaretText

public java.lang.String getBeforeCaretText()

Returns the text that will be placed before the caret.

返回:

The text.

另请参阅:

setBeforeCaretText(java.lang.String)

invoke

public 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.

setAfterCaretText

public void setAfterCaretText(java.lang.String afterCaret)

Sets the text to place after the caret.

参数:

afterCaret - The text.

另请参阅:

getAfterCaretText()

setBeforeCaretText

public void setBeforeCaretText(java.lang.String beforeCaret)

Sets the text to place before the caret.

参数:

beforeCaret - The text.

另请参阅:

getBeforeCaretText()

toString

public java.lang.String toString()

Returns a string representation of this template for debugging purposes.

覆盖:

toString 在类中 java.lang.Object

返回:

A string representation of this template.