fop 0.94

org.apache.fop.pdf
Class PDFDictionary

java.lang.Object
  extended by org.apache.fop.pdf.PDFObject
      extended by org.apache.fop.pdf.PDFDictionary
All Implemented Interfaces:
PDFWritable
Direct Known Subclasses:
PDFNames, PDFNameTreeNode

public class PDFDictionary
extends PDFObject

Class representing a PDF dictionary object


Field Summary
protected  java.util.Map entries
          the entry map
protected  java.util.List order
          maintains the order of the entries added to the entry map.
 
Fields inherited from class org.apache.fop.pdf.PDFObject
DATE_FORMAT, log
 
Constructor Summary
PDFDictionary()
          Create the dictionary object
 
Method Summary
 java.lang.Object get(java.lang.String name)
          Returns the value given a name.
 void put(java.lang.String name, java.lang.Object value)
          Puts a new name/value pair.
 java.lang.String toPDFString()
          This method returns a String representation of the PDF object.
 
Methods inherited from class org.apache.fop.pdf.PDFObject
encode, encodeString, encodeText, formatDateTime, formatObject, getDocument, getDocumentSafely, getGeneration, getObjectID, getObjectNumber, hasObjectNumber, makeReference, output, referencePDF, setDocument, setObjectNumber, toInlinePDFString, toPDF
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

entries

protected java.util.Map entries
the entry map


order

protected java.util.List order
maintains the order of the entries added to the entry map. Whenever you modify "entries", always make sure you adjust this list accordingly.

Constructor Detail

PDFDictionary

public PDFDictionary()
Create the dictionary object

Method Detail

put

public void put(java.lang.String name,
                java.lang.Object value)
Puts a new name/value pair.

Parameters:
name - the name
value - the value

get

public java.lang.Object get(java.lang.String name)
Returns the value given a name.

Parameters:
name - the name of the value
Returns:
the value or null, if there's no value with the given name.

toPDFString

public java.lang.String toPDFString()
Description copied from class: PDFObject
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.

Overrides:
toPDFString in class PDFObject
Returns:
String the String representation
See Also:
PDFObject.toPDFString()

fop 0.94

Copyright 1999-2007 The Apache Software Foundation. All Rights Reserved.