com.qoppa.pdf

Class TextToPDFSettings

java.lang.Object

com.qoppa.pdf.TextToPDFSettings

public class TextToPDFSettings
extends Object

The TextToPDFSettings class manages the settings when converting the text file to PDF document. All units in this class are in points, at 72 DPI. i.e. setting a page height of 792 means setting a page height of 11 inches.

Author:

Qoppa Software

Constructor Summary

Constructors

Constructor and Description
TextToPDFSettings() Constructs a default TextToPDFSettings object.

Method Summary

Methods

Modifier and Type	Method and Description
String	getBgndFile() Gets the background file.
String	getCharset() Gets the character set that will be used when reading the text input.
Font	getFont() Gets the font to use when converting text to PDF.
double	getMarginBottom() Gets the bottom margin value to use when converting text to PDF, units are in points at 72 DPI.
double	getMarginLeft() Gets the left margin value to use when converting text to PDF, units are in points at 72 DPI.
double	getMarginRight() Gets the right margin value to use when converting text to PDF, units are in points at 72 DPI.
double	getMarginTop() Gets the top margin value to use when converting text to PDF, units are in points at 72 DPI.
Character	getPageBreakChar() Gets the page break character to use when converting text to PDF.
double	getPageHeight() Gets the page height value to use when converting text to PDF, units are in points at 72 DPI.
double	getPageWidth() Gets the page width value to use when converting text to PDF, units are in points at 72 DPI.
boolean	isUseBackground() Gets the value of use background tag.
void	setBgndFile(String bgndFile) Sets the background file for the PDF file.
void	setCharset(String charsetName) Sets the character set used when reading the input text file.
void	setFont(Font font) Sets the font for the PDF file.
void	setMarginBottom(double marginBottom) Sets the bottom margin for the PDF file, units are in points at 72 DPI.
void	setMarginLeft(double marginLeft) Sets the left margin for the PDF file, units are in points at 72 DPI.
void	setMarginRight(double marginRight) Sets the right margin for the PDF file, units are in points at 72 DPI.
void	setMarginTop(double marginTop) Sets the top margin for the PDF file, units are in points at 72 DPI.
void	setPageBreakChar(Character pageBreakChar) Sets the page break character in the text file.
void	setPageHeight(double pageHeight) Sets the page height for the PDF file, units are in points at 72 DPI.
void	setPageWidth(double pageWidth) Sets the page width for the PDF document, units are in points at 72 DPI.
void	setUseBackground(boolean useBackground) Sets the use background tag for the PDF file.

Methods inherited from class java.lang.Object

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

Constructor Detail

TextToPDFSettings

public TextToPDFSettings()

Constructs a default TextToPDFSettings object.

Method Detail

getPageWidth

public double getPageWidth()

Gets the page width value to use when converting text to PDF, units are in points at 72 DPI.

setPageWidth

public void setPageWidth(double pageWidth)

Sets the page width for the PDF document, units are in points at 72 DPI.

getPageHeight

public double getPageHeight()

Gets the page height value to use when converting text to PDF, units are in points at 72 DPI.

setPageHeight

public void setPageHeight(double pageHeight)

Sets the page height for the PDF file, units are in points at 72 DPI.

getMarginTop

public double getMarginTop()

Gets the top margin value to use when converting text to PDF, units are in points at 72 DPI.

setMarginTop

public void setMarginTop(double marginTop)

Sets the top margin for the PDF file, units are in points at 72 DPI.

getMarginBottom

public double getMarginBottom()

Gets the bottom margin value to use when converting text to PDF, units are in points at 72 DPI.

setMarginBottom

public void setMarginBottom(double marginBottom)

Sets the bottom margin for the PDF file, units are in points at 72 DPI.

getMarginLeft

public double getMarginLeft()

Gets the left margin value to use when converting text to PDF, units are in points at 72 DPI.

setMarginLeft

public void setMarginLeft(double marginLeft)

Sets the left margin for the PDF file, units are in points at 72 DPI.

getMarginRight

public double getMarginRight()

Gets the right margin value to use when converting text to PDF, units are in points at 72 DPI.

setMarginRight

public void setMarginRight(double marginRight)

Sets the right margin for the PDF file, units are in points at 72 DPI.

isUseBackground

public boolean isUseBackground()

Gets the value of use background tag.

setUseBackground

public void setUseBackground(boolean useBackground)

Sets the use background tag for the PDF file.

getBgndFile

public String getBgndFile()

Gets the background file.

setBgndFile

public void setBgndFile(String bgndFile)

Sets the background file for the PDF file.

getFont

public Font getFont()

Gets the font to use when converting text to PDF.

setFont

public void setFont(Font font)

Sets the font for the PDF file.

getPageBreakChar

public Character getPageBreakChar()

Gets the page break character to use when converting text to PDF. The page break character is used as a delimiter for a page break in the PDF file.

setPageBreakChar

public void setPageBreakChar(Character pageBreakChar)

Sets the page break character in the text file.

setCharset

public void setCharset(String charsetName)

Sets the character set used when reading the input text file. The character set defaults to UTF-8 but can be overridden by the calling application to set it to any other character set.

Parameters:

charsetName - The name of the character set used to read the text content.

getCharset

public String getCharset()

Gets the character set that will be used when reading the text input.

Returns:

Character set of the input text.