public class StaticCodeTemplate extends AbstractCodeTemplate
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>.CodeTemplate,
Serialized Form| Constructor and Description |
|---|
StaticCodeTemplate()
Constructor.
|
StaticCodeTemplate(java.lang.String id,
java.lang.String beforeCaret,
java.lang.String afterCaret)
Constructor.
|
| Modifier and Type | Method and Description |
|---|---|
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.
|
public StaticCodeTemplate()
public StaticCodeTemplate(java.lang.String id,
java.lang.String beforeCaret,
java.lang.String afterCaret)
id - The ID of this code template.beforeCaret - The text to place before the caret.afterCaret - The text to place after the caret.public java.lang.String getAfterCaretText()
setAfterCaretText(java.lang.String)public java.lang.String getBeforeCaretText()
setBeforeCaretText(java.lang.String)public void invoke(RSyntaxTextArea textArea) throws javax.swing.text.BadLocationException
textArea - The text area to operate on.javax.swing.text.BadLocationException - If something bad happens.public void setAfterCaretText(java.lang.String afterCaret)
afterCaret - The text.getAfterCaretText()public void setBeforeCaretText(java.lang.String beforeCaret)
beforeCaret - The text.getBeforeCaretText()public java.lang.String toString()
toString in class java.lang.Object