Nested and Inner Type Summary

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

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

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

Method Summary

Modifier and Type	Method and Description
pack-priv List<PlainText.Paragraph>	Returns: the paragraphs. getParagraphs() Get the list of paragraphs.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

FONTSCALE	back to summary
private static final float FONTSCALE

paragraphs	back to summary
private final List<PlainText.Paragraph> paragraphs

Constructor Detail

PlainText back to summary

PlainText	back to summary
public PlainText(String textValue) Construct the text block from a single value. Constructs the text block from a single value splitting into individual `Paragraph` when a new line character is encountered. Parameters textValue:String the text block string.

public PlainText(String textValue)

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

Parameters

textValue:String: the text block string.

PlainText back to summary

PlainText	back to summary
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 `Paragraph`. Parameters listValue:List<String> the text block string.

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 Paragraph.

Parameters

listValue:List<String>: the text block string.

Method Detail

getParagraphs	back to summary
pack-priv List<PlainText.Paragraph> getParagraphs() Get the list of paragraphs. Returns:List<PlainText.Paragraph> the paragraphs.

getParagraphs

back to summary

pack-priv List<PlainText.Paragraph> getParagraphs()

Get the list of paragraphs.

Returns:List<PlainText.Paragraph>: the paragraphs.

org.apache.pdfbox.pdmodel.interactive.annotation.layout back to summary

pack-priv Class PlainText.Line

Class Inheritance

extends Object

java.lang.Object
org.apache.pdfbox.pdmodel.interactive.annotation.layout.PlainText.Line

An individual line of text.

Field Summary

Modifier and Type	Field and Description
private float	lineWidth
private final List<PlainText.Word>	words

Constructor Summary

Access	Constructor and Description
pack-priv	Line()

Method Summary

Modifier and Type	Method and Description
pack-priv void	addWord(PlainText.Word word)
pack-priv float	calculateWidth(PDFont font, float fontSize)
pack-priv float	getInterWordSpacing(float width)
pack-priv float	getWidth()
pack-priv List<PlainText.Word>	getWords()
pack-priv void	setWidth(float width)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

lineWidth	back to summary
private float lineWidth

words	back to summary
private final List<PlainText.Word> words

Constructor Detail

Line	back to summary
pack-priv Line()

Method Detail

addWord	back to summary
pack-priv void addWord(PlainText.Word word)

calculateWidth	back to summary
pack-priv float calculateWidth(PDFont font, float fontSize) throws IOException

getInterWordSpacing	back to summary
pack-priv float getInterWordSpacing(float width)

getWidth	back to summary
pack-priv float getWidth()

getWords	back to summary
pack-priv List<PlainText.Word> getWords()

setWidth	back to summary
pack-priv void setWidth(float width)

org.apache.pdfbox.pdmodel.interactive.annotation.layout back to summary

pack-priv Class PlainText.Paragraph

Class Inheritance

extends Object

java.lang.Object
org.apache.pdfbox.pdmodel.interactive.annotation.layout.PlainText.Paragraph

A block of text to be formatted as a whole.

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

Field Summary

Modifier and Type	Field and Description
private final String	textContent

Constructor Summary

Access	Constructor and Description
pack-priv	Paragraph(String text)

Method Summary

Modifier and Type	Method and Description
pack-priv List<PlainText.Line>	Returns: the individual lines. getLines(PDFont the font used for rendering the text. font, float the fontSize used for rendering the text. fontSize, float the width of the box holding the content. width) Break the paragraph into individual lines.
pack-priv String	Returns: the text. getText() Get the paragraph text.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

textContent	back to summary
private final String textContent

Constructor Detail

Paragraph	back to summary
pack-priv Paragraph(String text)

Method Detail

getLines	back to summary
pack-priv List<PlainText.Line> getLines(PDFont font, float fontSize, float width) throws IOException Break the paragraph into individual lines. Parameters font:PDFont the font used for rendering the text. fontSize:float the fontSize used for rendering the text. width:float the width of the box holding the content. Returns:List<PlainText.Line> the individual lines.

getLines

back to summary

pack-priv List<PlainText.Line> getLines(PDFont font, float fontSize, float width) throws IOException

Break the paragraph into individual lines.

Parameters

font:PDFont: the font used for rendering the text.
fontSize:float: the fontSize used for rendering the text.
width:float: the width of the box holding the content.

Returns:List<PlainText.Line>

the individual lines.

getText	back to summary
pack-priv String getText() Get the paragraph text. Returns:String the text.

getText

back to summary

pack-priv String getText()

Get the paragraph text.

Returns:String: the text.

org.apache.pdfbox.pdmodel.interactive.annotation.layout back to summary

pack-priv Class PlainText.TextAttribute

Class Inheritance

extends Attribute

java.lang.Object
java.text.AttributedCharacterIterator.Attribute
org.apache.pdfbox.pdmodel.interactive.annotation.layout.PlainText.TextAttribute

Attribute keys and attribute values used for text handling. This is similar to java.awt.font.TextAttribute but handled individually as to avoid a dependency on awt.

Field Summary

Modifier and Type	Field and Description
private static final long	serialVersionUID Hides java.text.AttributedCharacterIterator.Attribute.serialVersionUID. UID for serializing.
public static final AttributedCharacterIterator.Attribute	WIDTH Attribute width of the text.

Inherited from java.text.AttributedCharacterIterator.Attribute:: INPUT_METHOD_SEGMENT LANGUAGE READING

Constructor Summary

Access	Constructor and Description
protected	TextAttribute(String name)

Method Summary

Inherited from java.text.AttributedCharacterIterator.Attribute:: equals getName hashCode readResolve toString

Field Detail

serialVersionUID	back to summary
private static final long serialVersionUID Hides java.text.AttributedCharacterIterator.Attribute.serialVersionUID. UID for serializing.

serialVersionUID

back to summary

private static final long serialVersionUID

Hides java.text.AttributedCharacterIterator.Attribute.serialVersionUID.

UID for serializing.

WIDTH	back to summary
public static final AttributedCharacterIterator.Attribute WIDTH Attribute width of the text.

Constructor Detail

TextAttribute	back to summary
protected TextAttribute(String name)

org.apache.pdfbox.pdmodel.interactive.annotation.layout back to summary

pack-priv Class PlainText.Word

Class Inheritance

extends Object

java.lang.Object
org.apache.pdfbox.pdmodel.interactive.annotation.layout.PlainText.Word

An individual word. A word is defined as a string which must be kept on the same line.

Field Summary

Modifier and Type	Field and Description
private AttributedString	attributedString
private final String	textContent

Constructor Summary

Access	Constructor and Description
pack-priv	Word(String text)

Method Summary

Modifier and Type	Method and Description
pack-priv AttributedString	getAttributes()
pack-priv String	getText()
pack-priv void	setAttributes(AttributedString as)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

attributedString	back to summary
private AttributedString attributedString

textContent	back to summary
private final String textContent

Constructor Detail

Word	back to summary
pack-priv Word(String text)

Method Detail

getAttributes	back to summary
pack-priv AttributedString getAttributes()

getText	back to summary
pack-priv String getText()

setAttributes	back to summary
pack-priv void setAttributes(AttributedString as)

public Class PlainText

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class PlainText.Line

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class PlainText.Paragraph

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class PlainText.TextAttribute

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

pack-priv Class PlainText.Word

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail