net.sourceforge.pmd.util.fxdesigner.util.codearea

Class SimpleRegexSyntaxHighlighter

java.lang.Object

net.sourceforge.pmd.util.fxdesigner.util.codearea.SimpleRegexSyntaxHighlighter

All Implemented Interfaces:

SyntaxHighlighter

Direct Known Subclasses:

ApexSyntaxHighlighter, JavaSyntaxHighlighter, XmlSyntaxHighlighter, XPathSyntaxHighlighter

public abstract class SimpleRegexSyntaxHighlighter
extends java.lang.Object
implements SyntaxHighlighter

Language-specific engine for syntax highlighting. This implementation tokenises the text using regex, and assigns a specific CSS class to every found token. The whole text also receives a style class named after the language of the tokenizer (e.g. "xml" or "java"). Styling of each class is then done in stylesheets.

Since:

6.0.0

Author:

Clément Fournier

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	SimpleRegexSyntaxHighlighter.RegexHighlightGrammar Describes the tokens of the language that should be colored with a regular expression.
protected static class	SimpleRegexSyntaxHighlighter.RegexHighlightGrammarBuilder Builds a highlight grammar in a concise way.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SimpleRegexSyntaxHighlighter(java.lang.String languageName, SimpleRegexSyntaxHighlighter.RegexHighlightGrammar grammar) Creates a highlighter given a name for the language and a "regex grammar".

Method Summary

Modifier and Type	Method and Description
org.fxmisc.richtext.model.StyleSpans<java.util.Collection<java.lang.String>>	computeHighlighting(java.lang.String text) Computes the syntax highlighting on the given text.
java.lang.String	getLanguageTerseName() Gets the terse name of the language this highlighter cares for.
protected static SimpleRegexSyntaxHighlighter.RegexHighlightGrammarBuilder	grammarBuilder(java.util.Collection<java.lang.String> cssClass, java.lang.String pattern) Gets a builder to make a grammar to build a highlighter.

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleRegexSyntaxHighlighter

protected SimpleRegexSyntaxHighlighter(java.lang.String languageName,
                                       SimpleRegexSyntaxHighlighter.RegexHighlightGrammar grammar)

Creates a highlighter given a name for the language and a "regex grammar".

Parameters:

languageName - The language name

grammar - The grammar

Method Detail

computeHighlighting

public org.fxmisc.richtext.model.StyleSpans<java.util.Collection<java.lang.String>> computeHighlighting(java.lang.String text)

Description copied from interface: SyntaxHighlighter

Computes the syntax highlighting on the given text.

Specified by:

computeHighlighting in interface SyntaxHighlighter

Parameters:

text - The text

Returns:

The bounds of the computed style spans

getLanguageTerseName

public final java.lang.String getLanguageTerseName()

Description copied from interface: SyntaxHighlighter

Gets the terse name of the language this highlighter cares for. That's used as a css class for text regions.

Specified by:

getLanguageTerseName in interface SyntaxHighlighter

Returns:

The terse name of the language

grammarBuilder

protected static SimpleRegexSyntaxHighlighter.RegexHighlightGrammarBuilder grammarBuilder(java.util.Collection<java.lang.String> cssClass,
                                                                                          java.lang.String pattern)

Gets a builder to make a grammar to build a highlighter.

Parameters:

cssClass - The css class of the first pattern

pattern - The first pattern

Returns:

A builder