org.fife.ui.rsyntaxtextarea.templates
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 FormConstructor and Description |
---|
StaticCodeTemplate()
Constructor.
|
StaticCodeTemplate(String id,
String beforeCaret,
String afterCaret)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
String |
getAfterCaretText()
Returns the text that will be placed after the caret.
|
String |
getBeforeCaretText()
Returns the text that will be placed before the caret.
|
void |
invoke(RSyntaxTextArea textArea)
Invokes this code template.
|
void |
setAfterCaretText(String afterCaret)
Sets the text to place after the caret.
|
void |
setBeforeCaretText(String beforeCaret)
Sets the text to place before the caret.
|
String |
toString()
Returns a string representation of this template for debugging
purposes.
|
public StaticCodeTemplate()
public String getAfterCaretText()
setAfterCaretText(java.lang.String)
public String getBeforeCaretText()
setBeforeCaretText(java.lang.String)
public void invoke(RSyntaxTextArea textArea) throws BadLocationException
textArea
- The text area to operate on.BadLocationException
- If something bad happens.public void setAfterCaretText(String afterCaret)
afterCaret
- The text.getAfterCaretText()
public void setBeforeCaretText(String beforeCaret)
beforeCaret
- The text.getBeforeCaretText()