SyntaxDocument

The SyntaxDocument class is the Document implementation that can be tokenized by the syntax highlighting system.

Useful methods

• The SyntaxDocument.getTextProtected(int, int) allows to return the text at an offset in the document with a specified length, without throwinf a BadLocationException if the location is incorrect^[1]
  In that case it will return null
• The SyntaxDocument.getLineStartOffset(int) return the start offset in the document for a specified line
• The SyntaxDocument.getLineEndOffset(int) return the end offset in the document for a specified line
• The SyntaxDocument.getLineOffset(int, int) return the offset for a specified line and column
• The SyntaxDocument.getLineText(int) return the text for a specified line
• The SyntaxDocument.getLineLength(int) return the length for a specified line
• The SyntaxDocument.tokenizeLines() starts the tokenization of the entire document content. note that this mzethod is not used by the Code Editor component painter, but it can be called by SyntaxListeners

Creating a TokenizedDocument

It is possible to create a TokenizedDocument from a SyntaxDocument by the SyntaxDocument.tokenize method.