rst.pdfbox.layout.text

Interface ControlCharacters.ControlCharacterFactory

All Known Subinterfaces:

AnnotationCharacters.AnnotationControlCharacterFactory<T>

Enclosing class:

ControlCharacters

public static interface ControlCharacters.ControlCharacterFactory

A control character factory is used to create control characters on the fly from the control pattern. This allows to parameterize the characters as needed for e.g. colors.

Method Summary

Modifier and Type	Method and Description
ControlCharacter	createControlCharacter(String text, Matcher matcher, List<CharSequence> charactersSoFar) Creates the control character from the given matched pattern.
Pattern	getPattern()
boolean	patternMatchesBeginOfLine() Indicates if the pattern should be applied to the begin of line only.
String	unescape(String text) Unescapes the pattern.

Method Detail

createControlCharacter

ControlCharacter createControlCharacter(String text,
                                        Matcher matcher,
                                        List<CharSequence> charactersSoFar)

Creates the control character from the given matched pattern.

Parameters:

text - the parsed text.

matcher - the matcher.

charactersSoFar - the characters created so far.

Returns:

the created character.

getPattern

Pattern getPattern()

Returns:

the pattern used to match the control character.

patternMatchesBeginOfLine

boolean patternMatchesBeginOfLine()

Indicates if the pattern should be applied to the begin of line only.

Returns:

true if the pattern is to be applied at the begin of a line.

unescape

String unescape(String text)

Unescapes the pattern.

Parameters:

text - the text to unescape.

Returns:

the unescaped text.