Modifier and Type	Class and Description
public static class	PlainTextFormatter.Builder
pack-priv static enum	PlainTextFormatter.TextAlign

Field Summary

Modifier and Type	Field and Description
private final AppearanceStyle	appearanceStyle
private final PDAppearanceContentStream	contents
private static final int	FONTSCALE The scaling factor for font units to PDF units
private float	horizontalOffset
private final PlainTextFormatter.TextAlign	textAlignment
private final PlainText	textContent
private float	verticalOffset
private final float	width
private final boolean	wrapLines

Access	Constructor and Description
private	PlainTextFormatter(PlainTextFormatter.Builder builder)

Method Summary

Modifier and Type	Method and Description
public void	format() Format the text block.
private void	processLines(List<PlainText.Line> the lines to process. lines, boolean isFirstParagraph) Process lines for output.

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

Field Detail

appearanceStyle	back to summary
private final AppearanceStyle appearanceStyle

contents	back to summary
private final PDAppearanceContentStream contents

FONTSCALE	back to summary
private static final int FONTSCALE The scaling factor for font units to PDF units

horizontalOffset	back to summary
private float horizontalOffset

textAlignment	back to summary
private final PlainTextFormatter.TextAlign textAlignment

textContent	back to summary
private final PlainText textContent

verticalOffset	back to summary
private float verticalOffset

width	back to summary
private final float width

wrapLines	back to summary
private final boolean wrapLines

PlainTextFormatter	back to summary
private PlainTextFormatter(PlainTextFormatter.Builder builder)

Method Detail

format	back to summary
public void format() throws IOException Format the text block. Exceptions IOException: if there is an error writing to the stream.

format

back to summary

public void format() throws IOException

Format the text block.

Exceptions

IOException:: if there is an error writing to the stream.

processLines	back to summary
private void processLines(List<PlainText.Line> lines, boolean isFirstParagraph) throws IOException Process lines for output. Process lines for an individual paragraph and generate the commands for the content stream to show the text. Parameters lines:List<PlainText.Line> the lines to process. Exceptions IOException: if there is an error writing to the stream.

processLines

back to summary

private void processLines(List<PlainText.Line> lines, boolean isFirstParagraph) throws IOException

Process lines for output. Process lines for an individual paragraph and generate the commands for the content stream to show the text.

Parameters

lines:List<PlainText.Line>: the lines to process.

Exceptions

IOException:: if there is an error writing to the stream.

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

public Class PlainTextFormatter.Builder

Class Inheritance

extends Object

java.lang.Object
org.apache.pdfbox.pdmodel.interactive.annotation.layout.PlainTextFormatter.Builder

Field Summary

Modifier and Type	Field and Description
private AppearanceStyle	appearanceStyle
private final PDAppearanceContentStream	contents
private float	horizontalOffset
private PlainTextFormatter.TextAlign	textAlignment
private PlainText	textContent
private float	verticalOffset
private float	width
private boolean	wrapLines

Constructor Summary

Access	Constructor and Description
public	Builder(PDAppearanceContentStream contents)

Method Summary

Modifier and Type	Method and Description
public PlainTextFormatter	build()
public PlainTextFormatter.Builder	initialOffset(float horizontalOffset, float verticalOffset)
public PlainTextFormatter.Builder	style(AppearanceStyle appearanceStyle)
public PlainTextFormatter.Builder	text(PlainText textContent)
public PlainTextFormatter.Builder	textAlign(int alignment)
public PlainTextFormatter.Builder	textAlign(PlainTextFormatter.TextAlign alignment)
public PlainTextFormatter.Builder	width(float width)
public PlainTextFormatter.Builder	wrapLines(boolean wrapLines)

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

Field Detail

appearanceStyle	back to summary
private AppearanceStyle appearanceStyle

contents	back to summary
private final PDAppearanceContentStream contents

horizontalOffset	back to summary
private float horizontalOffset

textAlignment	back to summary
private PlainTextFormatter.TextAlign textAlignment

textContent	back to summary
private PlainText textContent

verticalOffset	back to summary
private float verticalOffset

width	back to summary
private float width

wrapLines	back to summary
private boolean wrapLines

Constructor Detail

Builder	back to summary
public Builder(PDAppearanceContentStream contents)

Method Detail

build	back to summary
public PlainTextFormatter build()

initialOffset	back to summary
public PlainTextFormatter.Builder initialOffset(float horizontalOffset, float verticalOffset)

style	back to summary
public PlainTextFormatter.Builder style(AppearanceStyle appearanceStyle)

text	back to summary
public PlainTextFormatter.Builder text(PlainText textContent)

textAlign	back to summary
public PlainTextFormatter.Builder textAlign(int alignment)

textAlign	back to summary
public PlainTextFormatter.Builder textAlign(PlainTextFormatter.TextAlign alignment)

width	back to summary
public PlainTextFormatter.Builder width(float width)

wrapLines	back to summary
public PlainTextFormatter.Builder wrapLines(boolean wrapLines)

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

pack-priv final Enum PlainTextFormatter.TextAlign

Class Inheritance

extends Enum<PlainTextFormatter.TextAlign>

java.lang.Object
java.lang.Enum
org.apache.pdfbox.pdmodel.interactive.annotation.layout.PlainTextFormatter.TextAlign

Field Summary

Modifier and Type	Field and Description
private final int	alignment
public static final PlainTextFormatter.TextAlign	CENTER
public static final PlainTextFormatter.TextAlign	JUSTIFY
public static final PlainTextFormatter.TextAlign	LEFT
public static final PlainTextFormatter.TextAlign	RIGHT

Constructor Summary

Access	Constructor and Description
private	TextAlign(int alignment)

Method Summary

Modifier and Type	Method and Description
pack-priv int	getTextAlign()
public static PlainTextFormatter.TextAlign	valueOf(String name)
public static PlainTextFormatter.TextAlign	valueOf(int alignment)
public static PlainTextFormatter.TextAlign[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

alignment	back to summary
private final int alignment

CENTER	back to summary
public static final PlainTextFormatter.TextAlign CENTER

JUSTIFY	back to summary
public static final PlainTextFormatter.TextAlign JUSTIFY

LEFT	back to summary
public static final PlainTextFormatter.TextAlign LEFT

RIGHT	back to summary
public static final PlainTextFormatter.TextAlign RIGHT

Constructor Detail

TextAlign	back to summary
private TextAlign(int alignment)

Method Detail

getTextAlign	back to summary
pack-priv int getTextAlign()

valueOf	back to summary
public static PlainTextFormatter.TextAlign valueOf(String name)

valueOf	back to summary
public static PlainTextFormatter.TextAlign valueOf(int alignment)

values	back to summary
public static PlainTextFormatter.TextAlign[] values()

public Class PlainTextFormatter

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class PlainTextFormatter.Builder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv final Enum PlainTextFormatter.TextAlign

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail