Package net.sf.xslthl.highlighters

Class StringHighlighter

java.lang.Object

net.sf.xslthl.Highlighter

net.sf.xslthl.highlighters.StringHighlighter

public class StringHighlighter
extends Highlighter

Recognizes strings. Accepted parameters:

string

How the string starts. Required.

endString

How the string ends. If not present the start value is used.

escape

Character to use to escape characters. Optional.

doubleEscapes

When present the double usage of start is considered to be an escaped start (used in Pascal). Optional.

spanNewLines

When present strings can span newlines, otherwise a newline breaks the string parsing.

Nested Class Summary

Nested classes/interfaces inherited from class net.sf.xslthl.Highlighter

Highlighter.IgnoreCaseComparator

Field Summary

Fields inherited from class net.sf.xslthl.Highlighter

XMLname

Constructor Summary

Constructors

Constructor	Description
StringHighlighter()

Method Summary

Modifier and Type	Method	Description
String	getDefaultStyle()	The default style name
boolean	highlight(CharIter in, List<Block> out)	Perform highlighting on the current token stream.
void	init(Params params)	Initializer
boolean	startsWith(CharIter in)	return true if the current character is a possible match for this highlighter

Methods inherited from class net.sf.xslthl.Highlighter

isNewLine, reset

Methods inherited from class java.lang.Object

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

Constructor Details

StringHighlighter

public StringHighlighter()

Method Details

init

public void init(Params params)
          throws HighlighterConfigurationException

Description copied from class: Highlighter

Initializer

Overrides:

init in class Highlighter

Parameters:

params -

Throws:

HighlighterConfigurationException

startsWith

public boolean startsWith(CharIter in)

Description copied from class: Highlighter

return true if the current character is a possible match for this highlighter

Overrides:

startsWith in class Highlighter

Parameters:

in -

Returns:

highlight

public boolean highlight(CharIter in,
 List<Block> out)

Description copied from class: Highlighter

Perform highlighting on the current token stream. Return true when highlighting was performed, or false in case of a false positive.

Specified by:

highlight in class Highlighter

Parameters:

in -

out -

Returns:

getDefaultStyle

public String getDefaultStyle()

Description copied from class: Highlighter

The default style name

Specified by:

getDefaultStyle in class Highlighter

Returns: