rst.pdfbox.layout.text.annotations

Class AnnotatedStyledText

java.lang.Object

rst.pdfbox.layout.text.StyledText

rst.pdfbox.layout.text.annotations.AnnotatedStyledText

All Implemented Interfaces:

Iterable<Annotation>, Annotated, Area, TextFragment

public class AnnotatedStyledText
extends StyledText
implements Annotated

Extension of styled text that supports annotations.

Constructor Summary

Constructors

Constructor and Description
AnnotatedStyledText(String text, float size, org.apache.pdfbox.pdmodel.font.PDFont font, Color color, float baselineOffset, Collection<? extends Annotation> annotations) Creates a styled text.
AnnotatedStyledText(String text, FontDescriptor fontDescriptor, Color color, float leftMargin, float rightMargin, float baselineOffset, Collection<? extends Annotation> annotations) Creates a styled text.

Method Summary

Modifier and Type	Method and Description
void	addAllAnnotation(Collection<Annotation> annos) Adds all annotations.
void	addAnnotation(Annotation annotation) Adds an annotation.
<T extends Annotation> Iterable<T>	getAnnotationsOfType(Class<T> type) Gets the annotations of a specific type.
AnnotatedStyledText	inheritAttributes(String text, float leftMargin, float rightMargin)
Iterator<Annotation>	iterator()

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

asSequence, getAsent, getBaselineOffset, getColor, getFontDescriptor, getHeight, getLeftMargin, getRightMargin, getText, getWidth, getWidthWithoutMargin, hasMargin, inheritAttributes, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

AnnotatedStyledText

public AnnotatedStyledText(String text,
                           FontDescriptor fontDescriptor,
                           Color color,
                           float leftMargin,
                           float rightMargin,
                           float baselineOffset,
                           Collection<? extends Annotation> annotations)

Creates a styled text.

Parameters:

text - the text to draw. Must not contain line feeds ('\n').

fontDescriptor - the font to use.

color - the color to use.

baselineOffset - the offset of the baseline.

leftMargin - the margin left to the text.

rightMargin - the margin right to the text.

annotations - the annotations associated with the text.

AnnotatedStyledText

public AnnotatedStyledText(String text,
                           float size,
                           org.apache.pdfbox.pdmodel.font.PDFont font,
                           Color color,
                           float baselineOffset,
                           Collection<? extends Annotation> annotations)

Creates a styled text.

Parameters:

text - the text to draw. Must not contain line feeds ('\n').

size - the size of the font.

font - the font to use..

color - the color to use.

baselineOffset - the offset of the baseline.

annotations - the annotations associated with the text.

Method Detail

iterator

public Iterator<Annotation> iterator()

Specified by:

iterator in interface Iterable<Annotation>

getAnnotationsOfType

public <T extends Annotation> Iterable<T> getAnnotationsOfType(Class<T> type)

Description copied from interface: Annotated

Gets the annotations of a specific type.

Specified by:

getAnnotationsOfType in interface Annotated

Type Parameters:

T - the annotation type.

Parameters:

type - the type of interest.

Returns:

the annotations of that type, or an empty collection.

addAnnotation

public void addAnnotation(Annotation annotation)

Adds an annotation.

Parameters:

annotation - the annotation to add.

addAllAnnotation

public void addAllAnnotation(Collection<Annotation> annos)

Adds all annotations.

Parameters:

annos - the annotations to add.

inheritAttributes

public AnnotatedStyledText inheritAttributes(String text,
                                             float leftMargin,
                                             float rightMargin)

Overrides:

inheritAttributes in class StyledText