org.jeditor.core

Class SyntaxTokenizer

java.lang.Object

org.jeditor.core.SyntaxTokenizer

public class SyntaxTokenizer
extends java.lang.Object

A syntax Tokenizer. This class accept a Document, an return a StyledDocument after applying a syntax on the Document.

Example

 Document doc = ...
 CodeEditorDefaults defaults = CodeEditorDefaults.getDefaults();
 SyntaxTokenizer tokenizer = new SyntaxTokenizer("java", defaults);
 StyledDocument styleDoc = tokenizer.applySyntax(doc);
 

Using a StyledDocument

It is possible to use a StyleDocument to apply the Syntax. In that case the method will merge the syntax with the background colors detected in the input StyleDocument.

Constructor Summary

Constructors

Constructor and Description
SyntaxTokenizer(java.lang.String syntax) Constructor.
SyntaxTokenizer(java.lang.String syntax, CodeEditorDefaults defaults) Constructor.

Method Summary

Modifier and Type	Method and Description
javax.swing.text.StyledDocument	applySyntax(javax.swing.text.Document doc) Apply the syntax of the SyntaxTokenizer on a Document and return the associated StyledDocument.
java.lang.String	getSyntax() Return the SyntaxTokenizer syntax name.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SyntaxTokenizer

public SyntaxTokenizer(java.lang.String syntax)

Constructor.

Parameters:

syntax - the syntax name

SyntaxTokenizer

public SyntaxTokenizer(java.lang.String syntax,
                       CodeEditorDefaults defaults)

Constructor.

Parameters:

syntax - the syntax name

defaults - the CodeEditorDefaults

Method Detail

getSyntax

public java.lang.String getSyntax()

Return the SyntaxTokenizer syntax name.

Returns:

the SyntaxTokenizer syntax name

applySyntax

public javax.swing.text.StyledDocument applySyntax(javax.swing.text.Document doc)

Apply the syntax of the SyntaxTokenizer on a Document and return the associated StyledDocument.

Using a StyledDocument

If the input Document is a StyledDocument,the method will merge the syntax with the background colors detected in the input StyleDocument. For example:

 DefaultStyledDocument doc = ...

 SimpleAttributeSet attrs = new SimpleAttributeSet();
 Style style = doc.addStyle("style", null);
 StyleConstants.setBackground(style, Color.YELLOW);
 doc.setCharacterAttributes(offset, length, style, false);

 CodeEditorDefaults defaults = CodeEditorDefaults.getDefaults();
 SyntaxTokenizer tokenizer = new SyntaxTokenizer("java", defaults);
 StyledDocument styleDoc = tokenizer.applySyntax(doc);
 

Parameters:

doc - the Document

Returns:

the StyledDocument after applying the syntax