gnu.apdf

Class PDFDocument

java.lang.Object

gnu.apdf.PDFDocument

All Implemented Interfaces:

Serializable

public class PDFDocument
extends Object
implements Serializable

This class is the base of the PDF library. A PDFDocument class is created for a document, and each page, object, annotation, etc is added to the document. The content of each page is drawn using the class PDFCanvas. Once complete, the document can be written to an OutputStream, which will generate well-formed PDF that will reproduce the text and images drawn on the pages.

The typical flow for use of the PDF library is as follows:

 // Create a PDF document, a page in the document, and get that page's PDFCanvas 
 PDFDocument pdfDoc = new PDFDocument(); 
 PDFPage page = new PDFPage(PageFormat.LETTER); 
 pdfDoc.add(page); 
 PDFCanvas pdfCanvas = page.getCanvas();
 
 // do drawing commands on the PDFCanvas associated with the page as you would on any other Canvas 
 myDrawDesign(pdfCanvas);
 
 // add and draw on other pages as desired
 
 // write the PDF content for the page to a file 
 BufferedOutputStream fileStream = new BufferedOutputStream(new FileOutputStream(file)); 
 pdfDoc.write(outStream); 
 fileStream.flush();
 fileStream.close();
 

Author:

Peter T Mount, http://www.retep.org.uk/pdf/, Eric Z. Beard, ericzbeard@hotmail.com, Gilbert DeLeeuw, gil1@users.sourceforge.net, Jon Sevy, jsevy@cs.drexel.edu

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	FULLSCREEN This page mode indicates that when the document is opened, it is displayed in full-screen-mode.
static String[]	PDF_PAGE_MODES These map the page modes just defined to the pagemodes setting of PDF.
static int	USENONE This page mode indicates that the document should be opened just with the page visible.
static int	USEOUTLINES This page mode indicates that the Outlines should also be displayed when the document is opened.
static int	USETHUMBS This page mode indicates that the Thumbnails should be visible when the document first opens.

Constructor Summary

Constructors

Constructor and Description
PDFDocument() This creates a PDF document with the default pagemode
PDFDocument(int pagemode) This creates a PDF document

Method Summary

Modifier and Type	Method and Description
int	add(PDFObject obj) This adds a top level object to the document.
PDFFont	getFont(String type, Typeface typeface) This returns a font of the specified type and typeface.
PDFOutline	getOutline()
PDFPage	getPage(int page) This returns a specific page
PDFInfo	getPDFInfo() Get the PDFInfo object, which contains author, title, keywords, etc
void	setPDFInfo(PDFInfo info) Set the PDFInfo object, which contains author, title, keywords, etc
void	write(OutputStream os) This writes the document to an OutputStream.

Methods inherited from class java.lang.Object

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

Field Detail

USENONE

public static final int USENONE

This page mode indicates that the document should be opened just with the page visible. This is the default

See Also:

Constant Field Values

USEOUTLINES

public static final int USEOUTLINES

This page mode indicates that the Outlines should also be displayed when the document is opened.

See Also:

Constant Field Values

USETHUMBS

public static final int USETHUMBS

This page mode indicates that the Thumbnails should be visible when the document first opens.

See Also:

Constant Field Values

FULLSCREEN

public static final int FULLSCREEN

This page mode indicates that when the document is opened, it is displayed in full-screen-mode. There is no menu bar, window controls nor any other window present.

See Also:

Constant Field Values

PDF_PAGE_MODES

public static final String[] PDF_PAGE_MODES

These map the page modes just defined to the pagemodes setting of PDF.

Constructor Detail

PDFDocument

public PDFDocument()

This creates a PDF document with the default pagemode

PDFDocument

public PDFDocument(int pagemode)

This creates a PDF document

Parameters:

pagemode - an int, determines how the document will present itself to the viewer when it first opens.

Method Detail

add

public int add(PDFObject obj)

This adds a top level object to the document.

Once added, it is allocated a unique serial number, as well as a unique name relevant to the object type (e.g., /Image47 or /Pattern19)

Note: Not all objects are added directly using this method. Some objects which have Kids (in PDF sub-objects or children are called Kids) will have their own add() method, which will call this one internally.

Parameters:

obj - The PDFObject to add to the document

Returns:

the unique serial number for this object.

getPage

public PDFPage getPage(int page)

This returns a specific page

Parameters:

page - page number to return

Returns:

PDFPage at that position

getOutline

public PDFOutline getOutline()

Returns:

the root outline

getFont

public PDFFont getFont(String type,
                       Typeface typeface)

This returns a font of the specified type and typeface. If the font has not been defined, it creates a new font in the PDF document, and returns it.

Parameters:

type - PDF Font Type - usually "/Type1"

typeface - Android typeface

Returns:

PDFFont defining this font

setPDFInfo

public void setPDFInfo(PDFInfo info)

Set the PDFInfo object, which contains author, title, keywords, etc

Parameters:

info - a PDFInof object

getPDFInfo

public PDFInfo getPDFInfo()

Get the PDFInfo object, which contains author, title, keywords, etc

Returns:

the PDFInfo object for this document.

write

public void write(OutputStream os)
           throws IOException

This writes the document to an OutputStream.

Note: You can call this as many times as you wish, as long as the calls are not running at the same time.

Also, objects can be added or amended between these calls.

Also, the OutputStream is not closed, but will be flushed on completion. It is up to the caller to close the stream.

Parameters:

os - OutputStream to write the document to

Throws:

IOException - on error