rst.pdfbox.layout.text

Class ControlCharacter

java.lang.Object

rst.pdfbox.layout.text.ControlCharacter

All Implemented Interfaces:

CharSequence

Direct Known Subclasses:

AnnotationCharacters.AnnotationControlCharacter, ControlCharacters.BoldControlCharacter, ControlCharacters.ColorControlCharacter, ControlCharacters.ItalicControlCharacter, ControlCharacters.MetricsControlCharacter, ControlCharacters.NewLineControlCharacter, IndentCharacters.IndentCharacter

public class ControlCharacter
extends Object
implements CharSequence

A control character represents the pattern to match and escape sequence for character sequences with a special meaning. Currently there is newline for all kinds of text, and bold and italic for markup.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ControlCharacter(String description, String charaterToEscape)

Method Summary

Modifier and Type	Method and Description
char	charAt(int index)
String	escape(String text) Escapes the control character in the given text if necessary.
String	getCharacterToEscape()
int	length()
boolean	mustEscape()
CharSequence	subSequence(int start, int end)
String	toString()
String	unescape(String text) Un-escapes the control character in the given text if necessary.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.CharSequence

chars, codePoints

Constructor Detail

ControlCharacter

protected ControlCharacter(String description,
                           String charaterToEscape)

Method Detail

getCharacterToEscape

public String getCharacterToEscape()

Returns:

the character to escape, e.g. '*' for bold.

mustEscape

public boolean mustEscape()

Returns:

true if this control character must be escaped in text.

escape

public String escape(String text)

Escapes the control character in the given text if necessary.

Parameters:

text - the text to escape.

Returns:

the escaped text.

unescape

public String unescape(String text)

Un-escapes the control character in the given text if necessary.

Parameters:

text - the text to un-escape.

Returns:

the un-escaped text.

length

public int length()

Specified by:

length in interface CharSequence

charAt

public char charAt(int index)

Specified by:

charAt in interface CharSequence

subSequence

public CharSequence subSequence(int start,
                                int end)

Specified by:

subSequence in interface CharSequence

toString

public String toString()

Specified by:

toString in interface CharSequence

Overrides:

toString in class Object