rst.pdfbox.layout.text.annotations

Class AnnotationCharacters.UnderlineControlCharacter

java.lang.Object

rst.pdfbox.layout.text.ControlCharacter

rst.pdfbox.layout.text.annotations.AnnotationCharacters.AnnotationControlCharacter<Annotations.UnderlineAnnotation>

rst.pdfbox.layout.text.annotations.AnnotationCharacters.UnderlineControlCharacter

All Implemented Interfaces:

CharSequence

Enclosing class:

AnnotationCharacters

public static class AnnotationCharacters.UnderlineControlCharacter
extends AnnotationCharacters.AnnotationControlCharacter<Annotations.UnderlineAnnotation>

Control character for underline. It can be escaped with a backslash ('\').

Field Summary

Fields

Modifier and Type	Field and Description
static String	UNDERLINE_DEFAULT_BASELINE_OFFSET_SCALE_PROPERTY constant for the system property pdfbox.layout.underline.baseline.offset.scale.default.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	UnderlineControlCharacter()
protected	UnderlineControlCharacter(String baselineOffsetScaleValue, String lineWeightValue)

Method Summary

Modifier and Type	Method and Description
Annotations.UnderlineAnnotation	getAnnotation()
Class<Annotations.UnderlineAnnotation>	getAnnotationType()

Methods inherited from class rst.pdfbox.layout.text.ControlCharacter

charAt, escape, getCharacterToEscape, length, mustEscape, subSequence, toString, unescape

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

Field Detail

UNDERLINE_DEFAULT_BASELINE_OFFSET_SCALE_PROPERTY

public static final String UNDERLINE_DEFAULT_BASELINE_OFFSET_SCALE_PROPERTY

constant for the system property pdfbox.layout.underline.baseline.offset.scale.default.

See Also:

Constant Field Values

Constructor Detail

UnderlineControlCharacter

protected UnderlineControlCharacter()

UnderlineControlCharacter

protected UnderlineControlCharacter(String baselineOffsetScaleValue,
                                    String lineWeightValue)

Method Detail

getAnnotation

public Annotations.UnderlineAnnotation getAnnotation()

Specified by:

getAnnotation in class AnnotationCharacters.AnnotationControlCharacter<Annotations.UnderlineAnnotation>

Returns:

the associated annotation.

getAnnotationType

public Class<Annotations.UnderlineAnnotation> getAnnotationType()

Specified by:

getAnnotationType in class AnnotationCharacters.AnnotationControlCharacter<Annotations.UnderlineAnnotation>

Returns:

the type of the annotation.