PDFDict Class Documentation
classPDFDict : PDFObjectNamespace:com::datalogics::PDFL
- Inherits from:
PDFObject
Detailed Description
Represents an associative collection of data elements within a PDF document. All objects in a PDF document are built from a collection of simpler objects that represent fundamental datatypes like numbers, strings and arrays. PDFObject and its subclasses allow direct access and manipulation of these simple objects. Some subclasses represent single data elements, such as PDFInteger, which represents a single integer value. Other subclasses represent a collection of PDFObjects, like PDFArray, an indexed array of data elements.
A PDFDict is a heterogenous collection object that maps other PDFObjects (including other PDFDicts) to PDFName objects.
Referenced by
Uses types
Constructor & Destructor Documentation
PDFDict
PDFDict(Documentdoc, booleanindirect)Parameters
doc: DocumentDocument object containing this PDFDict
indirect: booleanflag marking this as an indirect PDFObject
General constructor
PDFDict
PDFDict(PDFObjectdocFromObj, booleanindirect)Parameters
docFromObj: PDFObjectThe new PDFArray will be created in the same document as this object.
indirect: booleanflag marking this as an indirect PDFObject
General constructor
Member Function Documentation
DisposeChildren
voidDisposeChildren()Returns:
void[static initializer]
static void[static initializer]()clone
PDFObjectclone()Returns:
PDFObjectMakes a new copy of this PDFObject in memory, in the same document and using same direct/indirect setting as this PDFObject.
clone
Parameters
doc: Document
Returns:
PDFObjectMakes a new copy of this PDFObject in memory, in the supplied document, using the same direct/indirect setting as this PDFObject.
clone
Parameters
doc: Documentindirect: boolean
Returns:
PDFObjectMakes a new copy of this PDFObject in memory, in the supplied document, using supplied direct/indirect setting.
clone
Parameters
obj: PDFObject
Returns:
PDFObjectMakes a new copy of this PDFObject in memory, in the same document as another object, using the same direct/indirect setting as this PDFObject.
clone
Parameters
obj: PDFObjectindirect: boolean
Returns:
PDFObjectMakes a new copy of this PDFObject in memory, in the same document as another object, using supplied direct/indirect setting.
compareTo
PDFObjectComparisoncompareTo(PDFObjectrhs)Parameters
rhs: PDFObjectthe other PDFObject to compare.
Returns:
A PDFObjectComparison value that relates this object to the rhs objectCompares this object to another object. The result is useful for ordering or sorting PDFObjects. No other significance should be attached to the result. In particular, an unequal result indicates nothing about the type of either object.
The result is valid only within a single instance of the document.
contains
booleancontains(PDFNamekey)Parameters
key: PDFNameA PDFName for the key
Returns:
true if the given key existsTests whether the given key exists in the dictionary
contains
booleancontains(Stringkey)Parameters
key: StringA string representing the name for the key
Returns:
true if the given key existsTests whether the given key exists in the dictionary
delete
synchronized voiddelete(Booleandisposing)Parameters
disposing: Boolean
Returns:
synchronized voiddelete
synchronized voiddelete()Returns:
synchronized voiddestroy
voiddestroy()Returns:
voidDestroys this object.
This method does nothing if this object is a direct scalar object.
If a composite object (an array, dictionary or stream) is destroyed:
All the direct objects in it are automatically destroyed.
The indirect objects in it are not destroyed.
enumPDFObjects
booleanenumPDFObjects(PDFObjectEnumProcenumProc)Parameters
enumProc: PDFObjectEnumProcA user-supplied callback to call for each element of the object. of obj. Neither proc nor any routine called by proc may modify the object. Doing so can produce undefined results or errors. For example, if the object is an array, enumProc must not call Remove(); if the object is a dictionary, enumProc must not call Put().
Returns:
Returns true if every call to enumProc returned true. As soon as any call to enumProc returns false, the enumeration stops and EnumPDFObject() returns false.Enumerates the elements of a PDFObject by calling a user-supplied procedure for each component of the object.
For scalars or strings, the proc is not called, and CosObjEnum() returns true.
For dictionaries, proc is called for each key-value pair. The order in which the key-value pairs are enumerated is undefined.
For arrays, proc is called with each element as the first paramater to proc, and the NULL object as the second parameter. Array elements are enumerated in ascending order of index.
For streams, proc is called once, with the stream's dictionary as the first parameter to the proc and the NULL object as the second parameter.
equals
booleanequals(Objectrhs)Parameters
rhs: Object
Returns:
booleanfinalize
voidfinalize()Returns:
voidfromCPtr
static PDFObjectfromCPtr(longp)Parameters
p: long
Returns:
PDFObjectget
Parameters
key: PDFNameA PDFName for the key
Returns:
A PDFObject matching the keyReturns the object matching the given key.
get
PDFObjectget(Stringkey)Parameters
key: StringA string representing the name for the key
Returns:
A PDFObject matching the keyReturns the object matching the given key string.
getDocument
DocumentgetDocument()Returns:
the Document in which the object resides.The Document of which this object is a member.
Returns null if the Document is not known by PDFL, or if it is a temporary document.
If the Document is not null, then it shares the same internal data with other Document objects that refer to the same file. Document objects returned this way do not contribute to the internal count that keeps the Document open, and will become invalid if the main reference to the document is disposed.
getGeneration
intgetGeneration()Returns:
intThe generation number for this object. Only indirect objects have a generation number.
getID
intgetID()Returns:
intThe ID number for this object. Only indirect objects have an ID number.
getIndirect
booleangetIndirect()Returns:
booleanIndicates if this object is indirect or direct.
getKeys
java.util.List< PDFObject >getKeys()Returns:
a list of all the keysGet a list of all keys in the dictionary
getPDFHashValue
intgetPDFHashValue()Returns:
intThe 32-bit hash value for this object. The hash value is used internally to quickly access the object, and is not generally useful for PDFObject users. Note that two PDFObjects with equal hash values are not necessarily equal; use Equals() to check for equality.
getXMPMetadata
StringgetXMPMetadata()Returns:
StringThe XMP metadata associated with this dictionary.
NULL if there is no such data.
Note: PDFL will not attempt to verify that obj is one of the objects specified to allow XMP metadata by the PDF reference.
put
Parameters
Returns:
voidPuts an object with the matching key into the dictionary, adding the entry if the key is not already present.
put
voidput(Stringkey, PDFObjectobj)Parameters
key: StringA string representing the name for the key
obj: PDFObjectA PDFObject to add to the dictionary
Returns:
voidPuts an object with the matching key string into the dictionary, adding the entry if the key is not already present.
remove
voidremove(PDFNamekey)Parameters
key: PDFNameA PDFName for the key
Returns:
voidRemoves a key/object pair from the dictionary.
remove
voidremove(Stringkey)Parameters
key: StringA string representing the name for the key
Returns:
voidRemoves a key/object pair from the dictionary.
sameTypeEquals
booleansameTypeEquals(PDFObjectarg0)Parameters
arg0: PDFObject
Returns:
booleansetXMPMetadata
voidsetXMPMetadata(Stringmetadata)Parameters
metadata: String
Returns:
voidThe XMP metadata associated with this dictionary.
NULL if there is no such data.
Note: PDFL will not attempt to verify that obj is one of the objects that is specified in the PDF reference to allow XMP metadata.
toString
StringtoString()Returns:
String