org.apache.fop.pdf
Class PDFObject
java.lang.Object
org.apache.fop.pdf.PDFObject
- PDFWritable
public abstract class PDFObject
extends java.lang.Object
generic PDF object.
A PDF Document is essentially a collection of these objects. A PDF
Object has a number and a generation (although the generation will always
be 0 in new documents).
protected static SimpleDateFormat | DATE_FORMAT - Formatting pattern for PDF date
|
protected static Log | log - logger for all PDFObjects (and descendants)
|
static byte[] | encode(String text) - Converts text to a byte array for writing to a PDF file.
|
protected byte[] | encodeString(String string) - Encodes a String (3.2.3 in PDF 1.4 specs)
|
protected byte[] | encodeText(String text) - Encodes a Text String (3.8.1 in PDF 1.4 specs)
|
protected String | formatDateTime(Date time) - Formats a date/time according to the PDF specification
(D:YYYYMMDDHHmmSSOHH'mm').
|
protected void | formatObject(Object obj, StringBuffer sb) - Formats an object for serialization to PDF.
|
PDFDocument | getDocument() - Returns the parent PDFDocument if assigned.
|
PDFDocument | getDocumentSafely() - Returns the parent PDFDocument, but unlike
getDocument()
it throws an informative Exception if the parent document is unavailable
instead of having a NullPointerException somewhere without a message.
|
int | getGeneration() - Returns the object's generation.
|
String | getObjectID() - Returns the PDF representation of the Object ID.
|
int | getObjectNumber() - Returns the object's number.
|
boolean | hasObjectNumber() - Indicates whether this PDFObject has already been assigned an
object number.
|
PDFReference | makeReference() - Creates and returns a reference to this object.
|
protected int | output(OutputStream stream) - Write the PDF represention of this object
|
String | referencePDF() - Returns the PDF representation of a reference to this object.
|
void | setDocument(PDFDocument doc) - Sets the parent PDFDocument.
|
void | setObjectNumber(int objnum) - Sets the object number
|
String | toInlinePDFString() - Returns a representation of this object for in-object placement, i.e.
|
protected byte[] | toPDF() - Encodes the object as a byte array for output to a PDF file.
|
protected String | toPDFString() - This method returns a String representation of the PDF object.
|
DATE_FORMAT
protected static final SimpleDateFormat DATE_FORMAT
Formatting pattern for PDF date
log
protected static Log log
logger for all PDFObjects (and descendants)
encode
public static final byte[] encode(String text)
Converts text to a byte array for writing to a PDF file.
text
- text to convert/encode
- byte[] the resulting byte array
encodeString
protected byte[] encodeString(String string)
Encodes a String (3.2.3 in PDF 1.4 specs)
string
- the string to encode
- byte[] the encoded string
encodeText
protected byte[] encodeText(String text)
Encodes a Text String (3.8.1 in PDF 1.4 specs)
text
- the text to encode
formatDateTime
protected String formatDateTime(Date time)
Formats a date/time according to the PDF specification
(D:YYYYMMDDHHmmSSOHH'mm').
time
- date/time value to format
- the requested String representation
formatObject
protected void formatObject(Object obj,
StringBuffer sb)
Formats an object for serialization to PDF.
obj
- the objectsb
- the StringBuffer to write to
getDocument
public final PDFDocument getDocument()
Returns the parent PDFDocument if assigned.
- the parent PDFDocument (May be null if the parent PDFDocument
has not been assigned)
getDocumentSafely
public final PDFDocument getDocumentSafely()
Returns the parent PDFDocument, but unlike getDocument()
it throws an informative Exception if the parent document is unavailable
instead of having a NullPointerException somewhere without a message.
getGeneration
public int getGeneration()
Returns the object's generation.
- the PDF Object generation
getObjectID
public String getObjectID()
Returns the PDF representation of the Object ID.
getObjectNumber
public int getObjectNumber()
Returns the object's number.
hasObjectNumber
public boolean hasObjectNumber()
Indicates whether this PDFObject has already been assigned an
object number.
- True if it has an object number
makeReference
public PDFReference makeReference()
Creates and returns a reference to this object.
output
protected int output(OutputStream stream)
throws IOException
Write the PDF represention of this object
stream
- the stream to write the PDF to
- the number of bytes written
referencePDF
public String referencePDF()
Returns the PDF representation of a reference to this object.
setDocument
public void setDocument(PDFDocument doc)
Sets the parent PDFDocument.
setObjectNumber
public void setObjectNumber(int objnum)
Sets the object number
objnum
- the object number
toInlinePDFString
public String toInlinePDFString()
Returns a representation of this object for in-object placement, i.e. if the object
has an object number its reference is returned. Otherwise, its PDF representation is
returned.
- toInlinePDFString in interface PDFWritable
- the String representation
toPDF
protected byte[] toPDF()
Encodes the object as a byte array for output to a PDF file.
toPDFString
protected String toPDFString()
This method returns a String representation of the PDF object. The result
is normally converted/encoded to a byte array by toPDF(). Only use
this method to implement the serialization if the object can be fully
represented as text. If the PDF representation of the object contains
binary content use toPDF() or output(OutputStream) instead.
- String the String representation
Copyright 1999-2007 The Apache Software Foundation. All Rights Reserved.