gnu::jpdf::PDFObject Class Reference

Inheritance diagram for gnu::jpdf::PDFObject:

[legend]Collaboration diagram for gnu::jpdf::PDFObject:

[legend]List of all members.

Public Member Functions
	PDFObject (String type)
String	getType ()
final int	getSerialID ()
final PDFDocument	getPDFDocument ()
abstract void	write (OutputStream os) throws IOException
final void	writeStart (OutputStream os) throws IOException
final void	writeEnd (OutputStream os) throws IOException
String	toString ()
Static Public Member Functions
String	toArray (Vector v)
Protected Attributes
int	objser
PDFDocument	pdfDocument

---

Detailed Description

This is the base class for all Objects that form the PDF document.

Author:

Peter T Mount, http://www.retep.org.uk/pdf/

Eric Z. Beard, ericzbeard@hotmail.com

Author

ezb

Version:

Revision

1.1.1.1

,

Date

2001/10/29 19:51:08

---

Constructor & Destructor Documentation

gnu::jpdf::PDFObject::PDFObject (  String  type  )  [inline]

This is usually called by extensors to this class, and sets the PDF Object Type

---

Member Function Documentation

final PDFDocument gnu::jpdf::PDFObject::getPDFDocument (   )  [inline]

Returns the PDF document this object belongs to. Returns: PDF containing this object

final int gnu::jpdf::PDFObject::getSerialID (   )  [inline]

Returns the unique serial number of this object. Returns: Unique serial number of this object.

String gnu::jpdf::PDFObject::getType (   )  [inline]

Returns the PDF Type of this object Returns: The PDF Type of this object Reimplemented in gnu::jpdf::PDFFont.

String gnu::jpdf::PDFObject::toArray (  Vector  v  )  [inline, static]

This utility method returns a String containing an array definition based on a Vector containing PDFObjects Parameters: v  Vector containing PDFObjects Returns: String containing a PDF array

String gnu::jpdf::PDFObject::toString (   )  [inline]

Returns the unique serial number in PDF format Returns: the serial number in PDF format

abstract void gnu::jpdf::PDFObject::write (  OutputStream  os  )  throws IOException [pure virtual]

Writes the object to the output stream. This method must be overidden. Note: It should not write any other objects, even if they are it's Kids, as they will be written by the calling routine. Parameters: os  OutputStream to send the object to Exceptions: IOException  on error Implemented in gnu::jpdf::PDFAnnot, gnu::jpdf::PDFBorder, gnu::jpdf::PDFCatalog, gnu::jpdf::PDFFont, gnu::jpdf::PDFImage, gnu::jpdf::PDFInfo, gnu::jpdf::PDFOutline, gnu::jpdf::PDFPage, gnu::jpdf::PDFPage::procset, gnu::jpdf::PDFPageList, and gnu::jpdf::PDFStream.

final void gnu::jpdf::PDFObject::writeEnd (  OutputStream  os  )  throws IOException [inline]

The write method should call this after writing anything to the OutputStream. This will send the standard footer for each object. Note: There are a few rare cases where this method is not called. Parameters: os  OutputStream to write to Exceptions: IOException  on error

final void gnu::jpdf::PDFObject::writeStart (  OutputStream  os  )  throws IOException [inline]

The write method should call this before writing anything to the OutputStream. This will send the standard header for each object. Note: There are a few rare cases where this method is not called. Parameters: os  OutputStream to write to Exceptions: IOException  on error

---

Member Data Documentation

int gnu::jpdf::PDFObject::objser [protected]

This is the unique serial number for this object.

PDFDocument gnu::jpdf::PDFObject::pdfDocument [protected]

This allows any PDF object to refer to the document being constructed.

---

The documentation for this class was generated from the following file:

• /home/teplitski/Projects/vgb2/src/gnu/jpdf/PDFObject.java

---