Package org.apache.pdfbox.pdmodel.interactive.annotation.layout

Class PlainText

java.lang.Object

org.apache.pdfbox.pdmodel.interactive.annotation.layout.PlainText

public class PlainText
extends Object

A block of text.

A block of text can contain multiple paragraphs which will be treated individually within the block placement.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	PlainText.Line	An individual line of text.
(package private) static class	PlainText.Paragraph	A block of text to be formatted as a whole.
(package private) static class	PlainText.TextAttribute	Attribute keys and attribute values used for text handling.
(package private) static class	PlainText.Word	An individual word.

Field Summary

Fields

Modifier and Type	Field	Description
private static final float	FONTSCALE
private final List<PlainText.Paragraph>	paragraphs

Constructor Summary

Constructors

Constructor	Description
PlainText(String textValue)	Construct the text block from a single value.
PlainText(List<String> listValue)	Construct the text block from a list of values.

Method Summary

Modifier and Type	Method	Description
(package private) List<PlainText.Paragraph>	getParagraphs()	Get the list of paragraphs.

Methods inherited from class java.lang.Object

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

Field Details

FONTSCALE

private static final float FONTSCALE

See Also:

• Constant Field Values

paragraphs

private final List<PlainText.Paragraph> paragraphs

Constructor Details

PlainText

public PlainText(String textValue)

Construct the text block from a single value. Constructs the text block from a single value splitting into individual PlainText.Paragraph when a new line character is encountered.

Parameters:

textValue - the text block string.

PlainText

public PlainText(List<String> listValue)

Construct the text block from a list of values. Constructs the text block from a list of values treating each entry as an individual PlainText.Paragraph.

Parameters:

listValue - the text block string.

Method Details

getParagraphs

List<PlainText.Paragraph> getParagraphs()

Get the list of paragraphs.

Returns:

the paragraphs.