Modifier and Type	Class and Description
private static enum	TextToPDF.PageSizes

Field Summary

Modifier and Type	Field and Description
private float	bottomMargin
private Charset	charset
private static final float	DEFAULT_FONT_SIZE The default font size
private static final float	DEFAULT_LINE_HEIGHT_FACTOR The line height as a factor of the font size
private static final float	DEFAULT_MARGIN The default margin
private PDFont	font
private static final int	FONTSCALE The scaling factor for font units to PDF units
private float	fontSize
private File	infile
private boolean	landscape
private float	leftMargin
private float	lineSpacing
private float[]	margins
private PDRectangle	mediaBox
private File	outfile
private TextToPDF.PageSizes	pageSize
private float	rightMargin
private Standard14Fonts.FontName	standardFont
private final PrintStream	SYSERR
private float	topMargin
private File	ttf

Constructor Summary

Access	Constructor and Description
public	TextToPDF() Constructor.

Method Summary

Modifier and Type	Method and Description
public Integer	call() Implements java.util.concurrent.Callable.call. Computes a result, or throws an exception if unable to do so.
public PDDocument	Returns: The document with the text in it. createPDFFromText(Reader The stream of text data. text) Create a PDF document with some text.
public void	createPDFFromText(PDDocument The document. doc, Reader The stream of text data. text) Create a PDF document with some text.
public float	Returns: Returns the bottom margin. getBottomMargin()
public PDFont	Returns: Returns the font. getFont()
public int	Returns: Returns the fontSize, truncated to integer. getFontSize()
public float	Returns: Returns the left margin. getLeftMargin()
public float	Returns: Returns the lineSpacing. getLineSpacing()
public PDRectangle	Returns: returns the page size (media box) getMediaBox() Sets page size of produced PDF.
public float	Returns: Returns the right margin. getRightMargin()
public float	Returns: Returns the top margin. getTopMargin()
public boolean	Returns: true for landscape orientation isLandscape() Tells the paper orientation.
public static void	main(String[] Command line arguments. args) This will create a PDF document with some text in it.
public void	setBottomMargin(float The bottom margin to be set. bottomMargin)
public void	setFont(PDFont The font to set. aFont)
public void	setFontSize(int The fontSize to set. aFontSize) Deprecated use `setFontSize(float)`
public void	setFontSize(float The fontSize to set. aFontSize)
public void	setLandscape(boolean true for landscape orientation landscape) Sets paper orientation.
public void	setLeftMargin(float The left margin to be set. leftMargin)
public void	setLineSpacing(float The lineSpacing to set. lineSpacing)
public void	setMediaBox(PDRectangle mediaBox) Sets page size of produced PDF.
public void	setRightMargin(float The right margin to be set. rightMargin)
public void	setTopMargin(float The top margin to be set. topMargin)

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

Field Detail

bottomMargin	back to summary
private float bottomMargin

charset	back to summary
private Charset charset Annotations @Option names:-charset description:the charset to use. (default: ${DEFAULT-VALUE})

DEFAULT_FONT_SIZE	back to summary
private static final float DEFAULT_FONT_SIZE The default font size

DEFAULT_LINE_HEIGHT_FACTOR	back to summary
private static final float DEFAULT_LINE_HEIGHT_FACTOR The line height as a factor of the font size

DEFAULT_MARGIN	back to summary
private static final float DEFAULT_MARGIN The default margin

font	back to summary
private PDFont font

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

fontSize	back to summary
private float fontSize Annotations @Option names:-fontSize description:the size of the font to use (default: ${DEFAULT-VALUE})

infile	back to summary
private File infile Annotations @Option names:-i, --input description:the text file to convert required:true

landscape	back to summary
private boolean landscape Annotations @Option names:-landscape description:set orientation to landscape

leftMargin	back to summary
private float leftMargin

lineSpacing	back to summary
private float lineSpacing Annotations @Option names:-lineSpacing description:the factor of the font size for the line height (default: ${DEFAULT-VALUE})

margins	back to summary
private float[] margins Annotations @Option names:-margins arity:0..4 description:Left Right Top Bottom margins (default: ${DEFAULT-VALUE})

mediaBox	back to summary
private PDRectangle mediaBox

outfile	back to summary
private File outfile Annotations @Option names:-o, --output description:the generated PDF file required:true

pageSize	back to summary
private TextToPDF.PageSizes pageSize Annotations @Option names:-pageSize description:the page size to use. Candidates: ${COMPLETION-CANDIDATES} (default: ${DEFAULT-VALUE})

rightMargin	back to summary
private float rightMargin

standardFont	back to summary
private Standard14Fonts.FontName standardFont Annotations @Option names:-standardFont description:the font to use for the text. Either this or -ttf should be specified but not both. Candidates: ${COMPLETION-CANDIDATES} (default: ${DEFAULT-VALUE})

SYSERR	back to summary
private final PrintStream SYSERR Annotations @SuppressWarnings:squid:S106

topMargin	back to summary
private float topMargin

ttf	back to summary
private File ttf Annotations @Option names:-ttf paramLabel: description:the TTF font to use for the text. Either this or -standardFont should be specified but not both.

Constructor Detail

TextToPDF	back to summary
public TextToPDF() Constructor.

Method Detail

call	back to summary
public Integer call() Implements java.util.concurrent.Callable.call. Doc from java.util.concurrent.Callable.call. Computes a result, or throws an exception if unable to do so. Returns:Integer computed result Annotations @Override

call

back to summary

public Integer call()

Implements java.util.concurrent.Callable.call.

Doc from java.util.concurrent.Callable.call.

Computes a result, or throws an exception if unable to do so.

Returns:Integer

computed result

Annotations

@Override

createPDFFromText	back to summary
public PDDocument createPDFFromText(Reader text) throws IOException Create a PDF document with some text. Parameters text:Reader The stream of text data. Returns:PDDocument The document with the text in it. Exceptions IOException: If there is an error writing the data.

createPDFFromText

back to summary

public PDDocument createPDFFromText(Reader text) throws IOException

Create a PDF document with some text.

Parameters

text:Reader: The stream of text data.

Returns:PDDocument

The document with the text in it.

Exceptions

IOException:: If there is an error writing the data.

createPDFFromText	back to summary
public void createPDFFromText(PDDocument doc, Reader text) throws IOException Create a PDF document with some text. Parameters doc:PDDocument The document. text:Reader The stream of text data. Exceptions IOException: If there is an error writing the data.

createPDFFromText

back to summary

public void createPDFFromText(PDDocument doc, Reader text) throws IOException

Create a PDF document with some text.

Parameters

doc:PDDocument: The document.
text:Reader: The stream of text data.

Exceptions

IOException:: If there is an error writing the data.

getBottomMargin	back to summary
public float getBottomMargin() Returns:float Returns the bottom margin.

getFont	back to summary
public PDFont getFont() Returns:PDFont Returns the font.

getFontSize	back to summary
public int getFontSize() Returns:int Returns the fontSize, truncated to integer.

getLeftMargin	back to summary
public float getLeftMargin() Returns:float Returns the left margin.

getLineSpacing	back to summary
public float getLineSpacing() Returns:float Returns the lineSpacing.

getMediaBox	back to summary
public PDRectangle getMediaBox() Sets page size of produced PDF. Returns:PDRectangle returns the page size (media box)

getMediaBox

back to summary

public PDRectangle getMediaBox()

Sets page size of produced PDF.

Returns:PDRectangle: returns the page size (media box)

getRightMargin	back to summary
public float getRightMargin() Returns:float Returns the right margin.

getTopMargin	back to summary
public float getTopMargin() Returns:float Returns the top margin.

isLandscape	back to summary
public boolean isLandscape() Tells the paper orientation. Returns:boolean true for landscape orientation

isLandscape

back to summary

public boolean isLandscape()

Tells the paper orientation.

Returns:boolean: true for landscape orientation

main	back to summary
public static void main(String[] args) This will create a PDF document with some text in it. see usage() for commandline Parameters args:String[] Command line arguments.

main

back to summary

public static void main(String[] args)

This will create a PDF document with some text in it.
see usage() for commandline

Parameters

args:String[]: Command line arguments.

setBottomMargin	back to summary
public void setBottomMargin(float bottomMargin) Parameters bottomMargin:float The bottom margin to be set.

setFont	back to summary
public void setFont(PDFont aFont) Parameters aFont:PDFont The font to set.

setFontSize	back to summary
public void setFontSize(int aFontSize) Deprecated use `setFontSize(float)` Parameters aFontSize:int The fontSize to set. Annotations @Deprecated

setFontSize	back to summary
public void setFontSize(float aFontSize) Parameters aFontSize:float The fontSize to set.

setLandscape	back to summary
public void setLandscape(boolean landscape) Sets paper orientation. Parameters landscape:boolean true for landscape orientation

setLandscape

back to summary

public void setLandscape(boolean landscape)

Sets paper orientation.

Parameters

landscape:boolean: true for landscape orientation

setLeftMargin	back to summary
public void setLeftMargin(float leftMargin) Parameters leftMargin:float The left margin to be set.

setLineSpacing	back to summary
public void setLineSpacing(float lineSpacing) Parameters lineSpacing:float The lineSpacing to set.

setMediaBox	back to summary
public void setMediaBox(PDRectangle mediaBox) Sets page size of produced PDF.

setRightMargin	back to summary
public void setRightMargin(float rightMargin) Parameters rightMargin:float The right margin to be set.

setTopMargin	back to summary
public void setTopMargin(float topMargin) Parameters topMargin:float The top margin to be set.

org.apache.pdfbox.tools back to summary

private final Enum TextToPDF.PageSizes

Class Inheritance

extends Enum<TextToPDF.PageSizes>

java.lang.Object
java.lang.Enum
org.apache.pdfbox.tools.TextToPDF.PageSizes

Field Summary

Modifier and Type	Field and Description
public static final TextToPDF.PageSizes	A0
public static final TextToPDF.PageSizes	A1
public static final TextToPDF.PageSizes	A2
public static final TextToPDF.PageSizes	A3
public static final TextToPDF.PageSizes	A4
public static final TextToPDF.PageSizes	A5
public static final TextToPDF.PageSizes	A6
public static final TextToPDF.PageSizes	LEGAL
public static final TextToPDF.PageSizes	LETTER
pack-priv final PDRectangle	pageSize

Constructor Summary

Access	Constructor and Description
private	PageSizes(PDRectangle pageSize)

Method Summary

Modifier and Type	Method and Description
public PDRectangle	getPageSize()
public static TextToPDF.PageSizes	valueOf(String name)
public static TextToPDF.PageSizes[]	values()

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

Field Detail

A0	back to summary
public static final TextToPDF.PageSizes A0

A1	back to summary
public static final TextToPDF.PageSizes A1

A2	back to summary
public static final TextToPDF.PageSizes A2

A3	back to summary
public static final TextToPDF.PageSizes A3

A4	back to summary
public static final TextToPDF.PageSizes A4

A5	back to summary
public static final TextToPDF.PageSizes A5

A6	back to summary
public static final TextToPDF.PageSizes A6

LEGAL	back to summary
public static final TextToPDF.PageSizes LEGAL

LETTER	back to summary
public static final TextToPDF.PageSizes LETTER

pageSize	back to summary
pack-priv final PDRectangle pageSize

Constructor Detail

PageSizes	back to summary
private PageSizes(PDRectangle pageSize)

Method Detail

getPageSize	back to summary
public PDRectangle getPageSize()

valueOf	back to summary
public static TextToPDF.PageSizes valueOf(String name)

values	back to summary
public static TextToPDF.PageSizes[] values()

public Class TextToPDF

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Enum TextToPDF.PageSizes

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail