| java.lang.Object
 com.lowagie.text.pdf.PdfObject
com.lowagie.text.pdf.PdfDictionary
All known Subclasses: com.lowagie.text.pdf.PdfOCProperties, com.lowagie.text.pdf.PdfStructureTreeRoot, com.lowagie.text.pdf.PRAcroForm, com.lowagie.text.pdf.PdfAnnotation, com.lowagie.text.pdf.PdfStream, com.lowagie.text.pdf.collection.PdfCollectionSort, com.lowagie.text.pdf.PdfPage, com.lowagie.text.pdf.PdfResources, com.lowagie.text.pdf.PdfFileSpecification, com.lowagie.text.pdf.PdfBorderDictionary, com.lowagie.text.pdf.PdfRendition, com.lowagie.text.pdf.collection.PdfCollection, com.lowagie.text.pdf.collection.PdfTargetDictionary, com.lowagie.text.pdf.PdfAction, com.lowagie.text.pdf.collection.PdfCollectionSchema, com.lowagie.text.pdf.PdfGState, com.lowagie.text.pdf.PdfShadingPattern, com.lowagie.text.pdf.PdfTransparencyGroup, com.lowagie.text.pdf.PdfMediaClipData, com.lowagie.text.pdf.PdfSignature, com.lowagie.text.pdf.collection.PdfCollectionField, com.lowagie.text.pdf.PdfOutline, com.lowagie.text.pdf.PdfLayerMembership, com.lowagie.text.pdf.PdfAcroForm, com.lowagie.text.pdf.collection.PdfCollectionItem, com.lowagie.text.pdf.PdfLayer, com.lowagie.text.pdf.PdfStructureElement,
| PdfDictionary | | public class PdfDictionary extends PdfObject (Code) | | PdfDictionary is the Pdf dictionary object.
A dictionary is an associative table containing pairs of objects. The first element
of each pair is called the key and the second element is called the value.
Unlike dictionaries in the PostScript language, a key must be a PdfName.
A value can be any kind of PdfObject, including a dictionary. A dictionary is
generally used to collect and tie together the attributes of a complex object, with each
key-value pair specifying the name and value of an attribute.
A dictionary is represented by two left angle brackets (<<), followed by a sequence of
key-value pairs, followed by two right angle brackets (>>).
This object is described in the 'Portable Document Format Reference Manual version 1.7'
section 3.2.6 (page 59-60).
See Also: PdfObject
See Also: PdfName
See Also: BadPdfFormatException |
| Constructor Summary | |
| public | PdfDictionary()
Constructs an empty PdfDictionary-object. | | public | PdfDictionary(PdfName type)
Constructs a PdfDictionary-object of a certain type. |
| CATALOG | | final public static PdfName CATALOG(Code) | | This is a possible type of dictionary
|
| FONT | | final public static PdfName FONT(Code) | | This is a possible type of dictionary
|
| OUTLINES | | final public static PdfName OUTLINES(Code) | | This is a possible type of dictionary
|
| PAGE | | final public static PdfName PAGE(Code) | | This is a possible type of dictionary
|
| PAGES | | final public static PdfName PAGES(Code) | | This is a possible type of dictionary
|
| hashMap | | protected HashMap hashMap(Code) | | This is the hashmap that contains all the values and keys of the dictionary
|
| PdfDictionary | | public PdfDictionary()(Code) | | Constructs an empty PdfDictionary-object.
|
| PdfDictionary | | public PdfDictionary(PdfName type)(Code) | | Constructs a PdfDictionary-object of a certain type.
Parameters:
type - a PdfName |
| get | | public PdfObject get(PdfName key)(Code) | | Gets a PdfObject with a certain key from the PdfDictionary.
Parameters:
key - key of the entry (a PdfName) the previous PdfObject corresponding with the key |
| getAsDict | | public PdfDictionary getAsDict(PdfName key)(Code) | | All the getAs functions will return either null, or the specified object type
This function will automatically look up indirect references. There's one obvious
exception, the one that will only return an indirect reference. All direct objects
come back as a null.
Mark A Storer (2/17/06)
Parameters:
key - the appropriate object in its final type, or null |
| getDirectObject | | public PdfObject getDirectObject(PdfName key)(Code) | | This function behaves the same as 'get', but will never return an indirect reference,
it will always look such references up and return the actual object.
Parameters:
key - null, or a non-indirect object |
| isCatalog | | public boolean isCatalog()(Code) | | Checks if a Dictionary is of the type CATALOG.
true if it is, false if it isn't. |
| isDictionaryType | | public boolean isDictionaryType(PdfName type)(Code) | | Checks if a PdfDictionary is of a certain type.
Parameters:
type - a type of dictionary true of false |
| isFont | | public boolean isFont()(Code) | | Checks if a Dictionary is of the type FONT.
true if it is, false if it isn't. |
| isOutlineTree | | public boolean isOutlineTree()(Code) | | Checks if a Dictionary is of the type OUTLINES.
true if it is, false if it isn't. |
| isPage | | public boolean isPage()(Code) | | Checks if a Dictionary is of the type PAGE.
true if it is, false if it isn't. |
| isPages | | public boolean isPages()(Code) | | Checks if a Dictionary is of the type PAGES.
true if it is, false if it isn't. |
| put | | public void put(PdfName key, PdfObject value)(Code) | | Adds a PdfObject and its key to the PdfDictionary.
If the value is null or PdfNull the key is deleted.
Parameters:
key - key of the entry (a PdfName)
Parameters:
value - value of the entry (a PdfObject) |
| putEx | | public void putEx(PdfName key, PdfObject value)(Code) | | Adds a PdfObject and its key to the PdfDictionary.
If the value is null it does nothing.
Parameters:
key - key of the entry (a PdfName)
Parameters:
value - value of the entry (a PdfObject) |
| remove | | public void remove(PdfName key)(Code) | | Removes a PdfObject and its key from the PdfDictionary.
Parameters:
key - key of the entry (a PdfName) |
|
|