gnu.apdf

Class PDFObject

java.lang.Object

gnu.apdf.PDFObject

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

PDFAnnot, PDFBorder, PDFCatalog, PDFFont, PDFInfo, PDFOutline, PDFPage, PDFPage.procset, PDFPageList, PDFStream

public abstract class PDFObject
extends Object
implements Serializable

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, Jon Sevy, jsevy@cs.drexel.edu

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PDFObject(String type) This is usually called by extensors to this class, and sets the PDF Object Type

Method Summary

Modifier and Type	Method and Description
int	getGeneration() Returns the unique serial number of this object.
String	getName() Get the name
PDFDocument	getPDFDocument() Returns the PDF document this object belongs to.
int	getSerialID() Returns the unique serial number of this object.
String	getType() Returns the PDF Type of this object
void	setName(String n) Set the name of this object, for use as a named resource reference in a PDFPage.
static String	toArray(Vector<? extends PDFObject> v) This utility method returns a String containing an array definition based on a Vector containing PDFObjects
String	toString() Returns the unique serial number in PDF format
abstract void	write(OutputStream os) Writes the object to the output stream.
void	writeEnd(OutputStream os) The write method should call this after writing anything to the OutputStream.
void	writeStart(OutputStream os) The write method should call this before writing anything to the OutputStream.

Methods inherited from class java.lang.Object

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

Constructor Detail

PDFObject

public PDFObject(String type)

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

Parameters:

type - the PDF Object Type

Method Detail

getType

public String getType()

Returns the PDF Type of this object

Returns:

The PDF Type of this object

setName

public void setName(String n)

Set the name of this object, for use as a named resource reference in a PDFPage.

Parameters:

n - a String value

getName

public String getName()

Get the name

Returns:

a String value

getSerialID

public final int getSerialID()

Returns the unique serial number of this object.

Returns:

Unique serial number of this object.

getGeneration

public final int getGeneration()

Returns the unique serial number of this object.

Returns:

Unique serial number of this object.

getPDFDocument

public final PDFDocument getPDFDocument()

Returns the PDF document this object belongs to.

Returns:

PDF containing this object

write

public abstract void write(OutputStream os)
                    throws IOException

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

Throws:

IOException - on error

writeStart

public final void writeStart(OutputStream os)
                      throws IOException

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

Throws:

IOException - on error

writeEnd

public final void writeEnd(OutputStream os)
                    throws IOException

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

Throws:

IOException - on error

toString

public String toString()

Returns the unique serial number in PDF format

Overrides:

toString in class Object

Returns:

the serial number in PDF format

toArray

public static String toArray(Vector<? extends PDFObject> v)

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