Package groovy.console.ui.text
Class StructuredSyntaxDocumentFilter
- java.lang.Object
- 
- javax.swing.text.DocumentFilter
- 
- groovy.console.ui.text.StructuredSyntaxDocumentFilter
 
 
- 
- Direct Known Subclasses:
- GroovyFilter
 
 public class StructuredSyntaxDocumentFilter extends DocumentFilter 
- 
- 
Nested Class SummaryNested Classes Modifier and Type Class Description classStructuredSyntaxDocumentFilter.LexerNodeprotected classStructuredSyntaxDocumentFilter.MultiLineRun- 
Nested classes/interfaces inherited from class javax.swing.text.DocumentFilterDocumentFilter.FilterBypass
 
- 
 - 
Field SummaryFields Modifier and Type Field Description protected StructuredSyntaxDocumentFilter.LexerNodelexerThe root of the lexical parsing tree.protected SortedSetmlTextRunSetThe position tree of multi-line comments.protected DefaultStyledDocumentstyledDocumentstatic StringTAB_REPLACEMENT
 - 
Constructor SummaryConstructors Constructor Description StructuredSyntaxDocumentFilter(DefaultStyledDocument document)Creates a new instance of StructuredSyntaxDocumentFilter
 - 
Method SummaryAll Methods Instance Methods Concrete Methods Modifier and Type Method Description StructuredSyntaxDocumentFilter.LexerNodecreateLexerNode()Create a new LexerNode for adding to root.StructuredSyntaxDocumentFilter.LexerNodegetRootNode()Get the root node for lexing the document.voidinsertString(DocumentFilter.FilterBypass fb, int offset, String text, AttributeSet attrs)Insert a string into the document, and then parse it if the parser has been set.protected voidparseDocument(int offset, int length)Parse the Document to update the character styles given an initial start position.voidremove(DocumentFilter.FilterBypass fb, int offset, int length)Remove a string from the document, and then parse it if the parser has been set.voidreplace(DocumentFilter.FilterBypass fb, int offset, int length, String text, AttributeSet attrs)Replace a string in the document, and then parse it if the parser has been set.
 
- 
- 
- 
Field Detail- 
TAB_REPLACEMENTpublic static final String TAB_REPLACEMENT - See Also:
- Constant Field Values
 
 - 
lexerprotected StructuredSyntaxDocumentFilter.LexerNode lexer The root of the lexical parsing tree.
 - 
styledDocumentprotected DefaultStyledDocument styledDocument 
 - 
mlTextRunSetprotected SortedSet mlTextRunSet The position tree of multi-line comments.
 
- 
 - 
Constructor Detail- 
StructuredSyntaxDocumentFilterpublic StructuredSyntaxDocumentFilter(DefaultStyledDocument document) Creates a new instance of StructuredSyntaxDocumentFilter- Parameters:
- document- the styled document to parse
 
 
- 
 - 
Method Detail- 
createLexerNodepublic StructuredSyntaxDocumentFilter.LexerNode createLexerNode() Create a new LexerNode for adding to root.- Returns:
- a new LexerNode
 
 - 
getRootNodepublic StructuredSyntaxDocumentFilter.LexerNode getRootNode() Get the root node for lexing the document. Children can be added such that matching patterns can be further parsed if required.- Returns:
- the root lexing node.
 
 - 
insertStringpublic void insertString(DocumentFilter.FilterBypass fb, int offset, String text, AttributeSet attrs) throws BadLocationException Insert a string into the document, and then parse it if the parser has been set.- Overrides:
- insertStringin class- DocumentFilter
- Parameters:
- fb-
- offset-
- text-
- attrs-
- Throws:
- BadLocationException
 
 - 
parseDocumentprotected void parseDocument(int offset, int length) throws BadLocationExceptionParse the Document to update the character styles given an initial start position. Called by the filter after it has updated the text.- Parameters:
- offset-
- length-
- Throws:
- BadLocationException
 
 - 
removepublic void remove(DocumentFilter.FilterBypass fb, int offset, int length) throws BadLocationException Remove a string from the document, and then parse it if the parser has been set.- Overrides:
- removein class- DocumentFilter
- Parameters:
- fb-
- offset-
- length-
- Throws:
- BadLocationException
 
 - 
replacepublic void replace(DocumentFilter.FilterBypass fb, int offset, int length, String text, AttributeSet attrs) throws BadLocationException Replace a string in the document, and then parse it if the parser has been set.- Overrides:
- replacein class- DocumentFilter
- Parameters:
- fb-
- offset-
- length-
- text-
- attrs-
- Throws:
- BadLocationException
 
 
- 
 
-