| java.lang.Object
 gnu.jpdf.PDFDocument
| PDFDocument | | public class PDFDocument implements Serializable(Code) | | This class is the base of the PDF generator. A PDFDocument class is
created for a document, and each page, object, annotation,
etc is added to the document.
Once complete, the document can be written to an OutputStream, and the PDF
document's internal structures are kept in sync.
Note that most programmers using this package will NEVER access
one of these objects directly. Most everything can be done using
PDFJob and PDFGraphics, so you don't need
to directly instantiate a PDFDocument
ezb - 20011115 - Wondering if the constructors should even be public.
When would someone want to make one of these and manipulate it outside
the context of a job and graphics object?
author:
Peter T Mount, http://www.retep.org.uk/pdf/
author:
Eric Z. Beard, ericzbeard@hotmail.com
author:
$Author: ezb $
version:
$Revision: 1.2 $, $Date: 2001/11/15 20:18:11 $ |
| Field Summary | |
| final public static int | FULLSCREEN
This page mode indicates that when the document is opened, it is displayed
in full-screen-mode. | | final public static String | PDF_PAGE_MODES
These map the page modes just defined to the pagemodes setting of PDF. | | final public static int | USENONE
This page mode indicates that the document
should be opened just with the page visible. | | final public static int | USEOUTLINES
| | final public static int | USETHUMBS
| | protected PDFObject | defaultOutlineBorder
This holds a PDFObject describing the default border for annotations. | | protected Vector | objects
This vector contains each indirect object within the document. | | protected int | objser
This is used to allocate objects a unique serial number in the document. |
| FULLSCREEN | | final public static int FULLSCREEN(Code) | |
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.
|
| PDF_PAGE_MODES | | final public static String PDF_PAGE_MODES(Code) | |
These map the page modes just defined to the pagemodes setting of PDF.
|
| USENONE | | final public static int USENONE(Code) | | This page mode indicates that the document
should be opened just with the page visible. This is the default
|
| USEOUTLINES | | final public static int USEOUTLINES(Code) | | This page mode indicates that the Outlines
should also be displayed when the document is opened.
|
| USETHUMBS | | final public static int USETHUMBS(Code) | | This page mode indicates that the Thumbnails should be visible when the
document first opens.
|
| defaultOutlineBorder | | protected PDFObject defaultOutlineBorder(Code) | | This holds a PDFObject describing the default border for annotations.
It's only used when the document is being written.
|
| objects | | protected Vector objects(Code) | | This vector contains each indirect object within the document.
|
| objser | | protected int objser(Code) | | This is used to allocate objects a unique serial number in the document.
|
| PDFDocument | | public PDFDocument()(Code) | | This creates a PDF document with the default pagemode
|
| PDFDocument | | public PDFDocument(int pagemode)(Code) | | This creates a PDF document
Parameters:
pagemode - an int, determines how the document will present itself tothe viewer when it first opens. |
| add | | public synchronized int add(PDFObject obj)(Code) | | This adds a top level object to the document.
Once added, it is allocated a unique serial number.
Note: Not all object 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 the unique serial number for this object. |
| getFont | | public PDFFont getFont(String type, String font, int style)(Code) | | This returns a font of the specified type and font. 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"
Parameters:
font - Java font name
Parameters:
style - java.awt.Font style (NORMAL, BOLD etc) PDFFont defining this font |
| getPDFInfo | | public PDFInfo getPDFInfo()(Code) | | Get the PDFInfo object, which contains author, title, keywords,
etc
|
| getPage | | public PDFPage getPage(int page)(Code) | | This returns a specific page. It's used mainly when using a
Serialized template file.
?? How does a serialized template file work ???
Parameters:
page - page number to return PDFPage at that position |
| setImageName | | public String setImageName(PDFImage img)(Code) | | Sets a unique name to a PDFImage
Parameters:
img - PDFImage to set the name of the name given to the image |
| setPDFInfo | | public void setPDFInfo(PDFInfo info)(Code) | | Set the PDFInfo object, which contains author, title,
keywords, etc
|
| write | | public void write(OutputStream os) throws IOException(Code) | | 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
exception:
IOException - on error |
|
|