Package org.apache.fop.pdf
Class PDFDictionary
java.lang.Object
org.apache.fop.pdf.PDFObject
org.apache.fop.pdf.PDFDictionary
- All Implemented Interfaces:
PDFWritable
- Direct Known Subclasses:
PDFDPart
,PDFDPartRoot
,PDFEncoding
,PDFFileSpec
,PDFFont
,PDFFontDescriptor
,PDFIdentifiedDictionary
,PDFNames
,PDFNameTreeNode
,PDFNumberTreeNode
,PDFResourceContext
,PDFResources
,PDFRoot
,StructureHierarchyMember
,TransitionDictionary
Class representing a PDF dictionary object
-
Field Summary
Modifier and TypeFieldDescriptionthe entry mapmaintains the order of the entries added to the entry map. -
Constructor Summary
ConstructorDescriptionCreate a new dictionary object.PDFDictionary
(PDFObject parent) Create a new dictionary object. -
Method Summary
Modifier and TypeMethodDescriptionboolean
containsKey
(String name) Returns the value given a name.static void
getChildren
(Collection<Object> values, Set<PDFObject> children) void
getChildren
(Set<PDFObject> children) keySet()
int
output
(OutputStream stream) Write the PDF represention of this objectvoid
Puts a new name/value pair.void
Puts a new name/value pair.void
Removes the mapping for the specified keyprotected void
writeDictionary
(OutputStream out, StringBuilder textBuffer) Writes the contents of the dictionary to a StringBuffer.Methods inherited from class org.apache.fop.pdf.PDFObject
contentEquals, encode, encodeBinaryToHexString, encodeString, encodeText, formatObject, getDocument, getDocumentSafely, getGeneration, getObjectID, getObjectNumber, getParent, hasObjectNumber, makeReference, outputInline, referencePDF, setDocument, setObjectNumber, setObjectNumber, setObjectNumber, setParent, toPDF, toPDFString
-
Field Details
-
entries
the entry map -
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 Details
-
PDFDictionary
public PDFDictionary()Create a new dictionary object. -
PDFDictionary
Create a new dictionary object.- Parameters:
parent
- the object's parent if any
-
-
Method Details
-
put
Puts a new name/value pair.- Parameters:
name
- the namevalue
- the value
-
put
Puts a new name/value pair.- Parameters:
name
- the namevalue
- the value
-
get
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.
-
output
Write the PDF represention of this object- Overrides:
output
in classPDFObject
- Parameters:
stream
- the stream to write the PDF to- Returns:
- the number of bytes written
- Throws:
IOException
- if there is an error writing to the stream
-
writeDictionary
Writes the contents of the dictionary to a StringBuffer.- Parameters:
out
- the OutputStream (for binary content)textBuffer
- the text buffer for text output- Throws:
IOException
- if an I/O error occurs
-
getChildren
- Overrides:
getChildren
in classPDFObject
-
getChildren
-
keySet
-
containsKey
- Parameters:
name
- The key to find in the map.- Returns:
- true if the map contains this key.
- See Also:
-
remove
Removes the mapping for the specified key- Parameters:
name
- key whose mapping is to be removed
-