processing.app.syntax

Class TokenMarker

Object

TokenMarker

Direct Known Subclasses:

PdeTokenMarker

public abstract class TokenMarker
extends Object

A token marker that splits lines of text into tokens. Each token carries a length field and an indentification tag that can be mapped to a color for painting that token.

For performance reasons, the linked list of tokens is reused after each line is tokenized. Therefore, the return value of markTokens should only be used for immediate painting. Notably, it cannot be cached.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TokenMarker.TokenListener

Method Summary

Modifier and Type	Method and Description
abstract void	addColoring(String keyword, String coloring)
TokenMarkerState	createStateInstance()
void	setTokenListener(TokenMarker.TokenListener listener)
boolean	supportsMultilineTokens() Returns if the token marker supports tokens that span multiple lines.

Methods inherited from class Object

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

Method Detail

setTokenListener

public final void setTokenListener(TokenMarker.TokenListener listener)

createStateInstance

public final TokenMarkerState createStateInstance()

addColoring

public abstract void addColoring(String keyword,
                                 String coloring)

supportsMultilineTokens

public boolean supportsMultilineTokens()

Returns if the token marker supports tokens that span multiple lines. If this is true, the object using this token marker is required to pass all lines in the document to the markTokens() method (in turn).

The default implementation returns true; it should be overridden to return false on simpler token markers for increased speed.