| Package | org.purepdf.pdf |
| Class | public class PdfDictionary |
| Inheritance | PdfDictionary  PdfObject it.sephiroth.utils.ObjectHash |
| Implements | it.sephiroth.utils.IObject |
| Subclasses | PdfAcroForm, PdfAction, PdfAnnotation, PdfBorderDictionary, PdfCatalog, PdfFileSpecification, PdfGState, PdfInfo, PdfLayer, PdfLayerMembership, PdfMediaClipData, PdfOCProperties, PdfOutline, PdfPage, PdfRendition, PdfResources, PdfShadingPattern, PdfStream, PdfStructureElement, PdfStructureTreeRoot, PdfTrailer, PdfTransparencyGroup |
| Property | Defined By | ||
|---|---|---|---|
| size : int [read-only] | PdfDictionary | ||
| Property | Defined By | ||
|---|---|---|---|
 | bytes : Bytes | PdfObject | |
| dictionaryType : PdfName | PdfDictionary | ||
| hashMap : HashMap | PdfDictionary | ||
| indRef : PRIndirectReference | PdfObject | |
| type : int | PdfObject | |
| Method | Defined By | ||
|---|---|---|---|
PdfDictionary($type:PdfName = null) | PdfDictionary | ||
| canBeInObjStm():Boolean
Whether this object can be contained in an object stream. | PdfObject | |
| PdfDictionary | |||
| dispose():void | PdfObject | |
Returns a PdfObject as a PdfArray,
resolving indirect references. | PdfDictionary | ||
| PdfDictionary | |||
Returns a PdfObject as a PdfNumber,
resolving indirect references. | PdfDictionary | ||
| PdfObject | ||
Returns the PdfObject associated to the specified
key, resolving a possible indirect reference to a direct
object. | PdfDictionary | ||
| PdfObject | ||
getKeys():KeySet | PdfDictionary | ||
| getType():int | PdfObject | |
| PdfDictionary | |||
| isArray():Boolean | PdfObject | |
| isBoolean():Boolean | PdfObject | |
| isDictionary():Boolean | PdfObject | |
| isIndirect():Boolean | PdfObject | |
| isName():Boolean | PdfObject | |
| isNull():Boolean | PdfObject | |
| isNumber():Boolean | PdfObject | |
| isStream():Boolean
Checks if this PdfObject is of the type PdfStream
| PdfObject | |
| isString():Boolean | PdfObject | |
merge(other:PdfDictionary):void | PdfDictionary | ||
mergeDifferent(other:PdfDictionary):void | PdfDictionary | ||
| PdfDictionary | |||
putAll(other:PdfDictionary):void | PdfDictionary | ||
Associates the specified PdfObject as value to the
specified PdfName as key in this map. | PdfDictionary | ||
| PdfDictionary | |||
| setIndRef(indRef:PRIndirectReference):void
Set the indirect reference
| PdfObject | |
[override] | PdfDictionary | ||
toString():String [override] | PdfDictionary | ||
| Constant | Defined By | ||
|---|---|---|---|
| ARRAY : int = 5 [static] | PdfObject | |
| BOOLEAN : int = 1 [static] | PdfObject | |
| CATALOG : PdfName [static] | PdfDictionary | ||
| DICTIONARY : int = 6 [static] | PdfObject | |
| INDIRECT : int = 10 [static] | PdfObject | |
| NAME : int = 4 [static] | PdfObject | |
| NOTHING : String [static] | PdfObject | |
| NULL : int = 8 [static] | PdfObject | |
| NUMBER : int = 2 [static] | PdfObject | |
| OUTLINES : PdfName [static] | PdfDictionary | ||
| PAGE : PdfName [static] | PdfDictionary | ||
| STREAM : int = 7 [static] | PdfObject | |
| STRING : int = 3 [static] | PdfObject | |
| TEXT_PDFDOCENCODING : String = PDF [static] | PdfObject | |
| TEXT_UNICODE : String = UnicodeBig [static] | PdfObject | |
| dictionaryType | property |
Hide Inherited Protected Properties
Show Inherited Protected Propertiesprotected var dictionaryType:PdfName| hashMap | property |
protected var hashMap:HashMap| size | property |
size:int [read-only] public function get size():int| PdfDictionary | () | Constructor |
| contains | () | method |
| getAsArray | () | method |
public function getAsArray(key:PdfName):PdfArray
Returns a PdfObject as a PdfArray,
resolving indirect references.
The object associated with the PdfName given is retrieved
and resolved to a direct object.
If it is a PdfArray, it is cast down and returned as such.
Otherwise null is returned.
Parameters
key:PdfName — A PdfName
|
PdfArray — the associated PdfArray object,
or null
|
| getAsDict | () | method |
| getAsNumber | () | method |
public function getAsNumber(key:PdfName):PdfNumberReturns a PdfObject as a PdfNumber, resolving indirect references. The object associated with the PdfName given is retrieved and resolved to a direct object. If it is a PdfNumber, it is cast down and returned as such. Otherwise null is returned.
Parameters
key:PdfName — a PdfName
|
PdfNumber — the associated PdfNumber object, or null
|
| getDirectObject | () | method |
public function getDirectObject(key:PdfName):PdfObject
Returns the PdfObject associated to the specified
, resolving a possible indirect reference to a direct
object.
This method will never return a PdfIndirectReference
object.
Parameters
key:PdfName |
PdfObject |
| getKeys | () | method |
public function getKeys():KeySetReturnsKeySet |
| getValue | () | method |
| merge | () | method |
| mergeDifferent | () | method |
| put | () | method |
| putAll | () | method |
| putEx | () | method |
public function putEx(key:PdfName, value:PdfObject):voidAssociates the specified PdfObject as value to the specified PdfName as key in this map. If the value is a PdfNull, it is treated just as any other PdfObject. If the value is null however nothing is done.
Parameters
key:PdfName — a PdfName
| |
value:PdfObject — the PdfObject to be associated to the key
|
| remove | () | method |
| toPdf | () | method |
override public function toPdf(writer:PdfWriter, os:IOutputStream):voidParameters
writer:PdfWriter | |
os:IOutputStream |
| toString | () | method |
override public function toString():StringReturnsString |
| CATALOG | Constant |
public static const CATALOG:PdfName| OUTLINES | Constant |
public static const OUTLINES:PdfName| PAGE | Constant |
public static const PAGE:PdfName