planetj.helpers
Class PDFHelper

java.lang.Object
  planetj.helpers.FileHelper
      planetj.helpers.PDFHelper

All Implemented Interfaces:

IPDFGenerator

public class PDFHelper

extends FileHelper

implements IPDFGenerator

Portable Document Format - PDF This class will assist in creating PDF files.

Creation date: (1/22/2002 5:01:05 PM)

Method Summary

java.lang.Object	generatePDF(java.lang.Object source, PDFFileDescriptor descriptor, ExecutingContext ec) Generates PDF for an object.
static PDFFileDescriptor	newPDFFileDescriptor() This is the only way to get an instance of a new PDFFileDescriptor Creation date: (1/22/2002 5:01:43 PM)
static PDFFileDescriptor	newPDFFileDescriptor(FilePropertyGroup pProperties) This is the only way to get an instance of a new PDFFileDescriptor Creation date: (12/5/2001 3:15:14 PM)
static PDFHelper	singleton() PDFHelper implements the singleton model so this method is the only way to get an instance of this class Creation date: (1/22/2002 5:02:31 PM)

Methods inherited from class planetj.helpers.FileHelper

getAS400, getFileSeparator, newFileDescriptor, newFileDescriptor, validateFileName, writeData

Methods inherited from class java.lang.Object

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

Method Detail

newPDFFileDescriptor

public static PDFFileDescriptor newPDFFileDescriptor()

This is the only way to get an instance of a new PDFFileDescriptor Creation date: (1/22/2002 5:01:43 PM)

Returns:

new PDFFileDescriptor()

newPDFFileDescriptor

public static PDFFileDescriptor newPDFFileDescriptor(FilePropertyGroup pProperties)

This is the only way to get an instance of a new PDFFileDescriptor Creation date: (12/5/2001 3:15:14 PM)

Returns:

new CSVFileDescriptor()

singleton

public static PDFHelper singleton()

PDFHelper implements the singleton model so this method is the only way to get an instance of this class Creation date: (1/22/2002 5:02:31 PM)

Returns:

planetj.helpers.PDFHelper mSingleton, an instance of this Class

generatePDF

public java.lang.Object generatePDF(java.lang.Object source,
                                    PDFFileDescriptor descriptor,
                                    ExecutingContext ec)
                             throws CMException

Generates PDF for an object. The PDFFileDescriptor contains configuration options for the PDF, including where it is output to. If no custom PDF Generator is used, then null is returned; a custom PDF generator may return a different value.

Specified by:

generatePDF in interface IPDFGenerator

Parameters:

source - This should be a RowCollection (or another List containing INamedCollection objects) unless a custom generator is being used

descriptor - The PDFFile descriptor containing configuration options for the output

Throws:

CMException