planetj.helpers
Class PDFFileDescriptor

java.lang.Object
  planetj.helpers.FileDescriptor
      planetj.helpers.PDFFileDescriptor

public class PDFFileDescriptor

extends FileDescriptor

PDFFileDescriptor is to only be created via planetj.helpers.PDFHelper.newPDFFileDescriptor(); This descriptor will hold attributes about a PDF file. Creation date: (1/22/2002 5:00:09 PM)

Field Summary

Fields inherited from class planetj.helpers.FileDescriptor

COLUMN_HEADINGS_EXTERNAL, COLUMN_HEADINGS_INTERNAL, COLUMN_HEADINGS_NONE, OUTPUT_ROWS_ALL, OUTPUT_ROWS_SCREEN, OUTPUT_ROWS_SELECTED

Method Summary

com.lowagie.text.Document	getDocument() Holds a reference to a PDF document so the same object can be used from multiple invocations of the generate method
java.io.OutputStream	getOutputStream() Gets the OutputStream written to by PDFWriter Creation date: (1/22/2002 6:40:00 PM)
float[]	getRelativeWidths() Gets the width percentages to use.
com.lowagie.text.pdf.PdfPTable	getTable() Holds a reference to a PDF Table so the same object can be used from multiple invocations of the generate method
java.util.List	getTableHeadings() Gets the headings to use for the PDF table.
double[]	getWidthPercentages() Deprecated. Replaced with getRelativeWidths();
com.lowagie.text.pdf.PdfWriter	getWriter() Holds a reference to a PDFWriter so the same object can be used from multiple invocations of the generate method
boolean	isAppendToFile() You can never append to a PDF file Creation date: (2/6/2002 12:39:15 PM)
boolean	isCloseDocument() Should the document be closed, or will more rows be added to the table later on?
boolean	isUseDisplayValues() Should the values displayed to the user be the display values
void	setCloseDocument(boolean finalize) Should the document be closed, or will more rows be added to the table later on?
void	setOutputStream(java.io.OutputStream newOutputStream) Sets the OutputStream used by the PDFWriter Creation date: (1/22/2002 6:40:00 PM)
void	setRelativeWidths(float[] widths) Sets the relative column widths
void	setTableHeadings(java.util.List headings) Sets the headings to use for the PDF table.
void	setUseDisplayValues(boolean displayValues) Should the values in the PDF be the display values?
void	setWidthPercentages(double[] widthPercentages) Deprecated. Replaced with setRelativeWidths(float[])

Methods inherited from class planetj.helpers.FileDescriptor

getColumnHeadingsDisplayType, getDisplayColumns, getFileName, getGeneratorClass, getOutputRowType, getPassword, getPropertyGroup, getPropertyValue, getSystemName, getUserId, setAppendToFile, setColumnHeadingsDisplayType, setDisplayColumns, setFileName, setGeneratorClass, setOutputRowType, setPassword, setSystemName, setUserId

Methods inherited from class java.lang.Object

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

Method Detail

getDocument

public com.lowagie.text.Document getDocument()

Holds a reference to a PDF document so the same object can be used from multiple invocations of the generate method

getOutputStream

public java.io.OutputStream getOutputStream()

Gets the OutputStream written to by PDFWriter Creation date: (1/22/2002 6:40:00 PM)

Returns:

java.io.OutputStream

getRelativeWidths

public float[] getRelativeWidths()

Gets the width percentages to use.

getTable

public com.lowagie.text.pdf.PdfPTable getTable()

Holds a reference to a PDF Table so the same object can be used from multiple invocations of the generate method

getTableHeadings

public java.util.List getTableHeadings()

Gets the headings to use for the PDF table. May be null, but if this is specified there but be the same number of display columns as column headings

getWidthPercentages

public double[] getWidthPercentages()

Deprecated. Replaced with getRelativeWidths();

Gets the width percentages to use.

getWriter

public com.lowagie.text.pdf.PdfWriter getWriter()

Holds a reference to a PDFWriter so the same object can be used from multiple invocations of the generate method

isAppendToFile

public boolean isAppendToFile()

You can never append to a PDF file Creation date: (2/6/2002 12:39:15 PM)

Overrides:

isAppendToFile in class FileDescriptor

Returns:

boolean true will append to existing file, false will start with a fresh file.

isCloseDocument

public boolean isCloseDocument()

Should the document be closed, or will more rows be added to the table later on?

isUseDisplayValues

public boolean isUseDisplayValues()

Should the values displayed to the user be the display values

setCloseDocument

public void setCloseDocument(boolean finalize)

Should the document be closed, or will more rows be added to the table later on?

setOutputStream

public void setOutputStream(java.io.OutputStream newOutputStream)

Sets the OutputStream used by the PDFWriter Creation date: (1/22/2002 6:40:00 PM)

Parameters:

newOutputStream - java.io.OutputStream

setRelativeWidths

public void setRelativeWidths(float[] widths)

Sets the relative column widths

setTableHeadings

public void setTableHeadings(java.util.List headings)

Sets the headings to use for the PDF table. May be null, but if this is specified there but be the same number of display columns as column headings

setUseDisplayValues

public void setUseDisplayValues(boolean displayValues)

Should the values in the PDF be the display values?

setWidthPercentages

public void setWidthPercentages(double[] widthPercentages)

Deprecated. Replaced with setRelativeWidths(float[])

Sets the width percentages to use.