com.lowagie.text.pdf
public class PdfDictionary extends PdfObject
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 PdfName BadPdfFormatException
Field Summary | |
---|---|
static PdfName | CATALOG This is a possible type of dictionary |
PdfName | dictionaryType This is the type of this dictionary |
static PdfName | FONT This is a possible type of dictionary |
protected HashMap | hashMap This is the hashmap that contains all the values and keys of the dictionary |
static PdfName | OUTLINES This is a possible type of dictionary |
static PdfName | PAGE This is a possible type of dictionary |
static PdfName | PAGES This is a possible type of dictionary |
Constructor Summary | |
---|---|
PdfDictionary()
Constructs an empty PdfDictionary -object. | |
PdfDictionary(PdfName type)
Constructs a PdfDictionary -object of a certain type.
|
Method Summary | |
---|---|
boolean | contains(PdfName key) |
PdfObject | get(PdfName key)
Gets a PdfObject with a certain key from the PdfDictionary .
|
PdfArray | getAsArray(PdfName key) |
PdfBoolean | getAsBoolean(PdfName key) |
PdfDictionary | getAsDict(PdfName key)
All the getAs functions will return either null, or the specified object type
This function will automatically look up indirect references. |
PdfIndirectReference | getAsIndirectObject(PdfName key) |
PdfName | getAsName(PdfName key) |
PdfNumber | getAsNumber(PdfName key) |
PdfStream | getAsStream(PdfName key) |
PdfString | getAsString(PdfName key) |
PdfObject | getDirectObject(PdfName key)
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. |
Set | getKeys() |
boolean | isCatalog()
Checks if a Dictionary is of the type CATALOG.
|
boolean | isFont()
Checks if a Dictionary is of the type FONT.
|
boolean | isOutlineTree()
Checks if a Dictionary is of the type OUTLINES.
|
boolean | isPage()
Checks if a Dictionary is of the type PAGE.
|
boolean | isPages()
Checks if a Dictionary is of the type PAGES.
|
void | merge(PdfDictionary other) |
void | mergeDifferent(PdfDictionary other) |
void | put(PdfName key, PdfObject value)
Adds a PdfObject and its key to the PdfDictionary .
|
void | putAll(PdfDictionary dic) |
void | putEx(PdfName key, PdfObject value)
Adds a PdfObject and its key to the PdfDictionary .
|
void | remove(PdfName key)
Removes a PdfObject and its key from the PdfDictionary .
|
int | size() |
void | toPdf(PdfWriter writer, OutputStream os)
Returns the PDF representation of this PdfDictionary . |
String | toString() |
PdfDictionary
-object.PdfDictionary
-object of a certain type.
Parameters: type a PdfName
PdfObject
with a certain key from the PdfDictionary
.
Parameters: key key of the entry (a PdfName
)
Returns: the previous PdfObject corresponding with the key
Parameters: key
Returns: the appropriate object in its final type, or null
Parameters: key
Returns: null, or a non-indirect object
Dictionary
is of the type CATALOG.
Returns: true
if it is, false
if it isn't.
Dictionary
is of the type FONT.
Returns: true
if it is, false
if it isn't.
Dictionary
is of the type OUTLINES.
Returns: true
if it is, false
if it isn't.
Dictionary
is of the type PAGE.
Returns: true
if it is, false
if it isn't.
Dictionary
is of the type PAGES.
Returns: true
if it is, false
if it isn't.
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
) value value of the entry (a PdfObject
)
PdfObject
and its key to the PdfDictionary
.
If the value is null it does nothing.
Parameters: key key of the entry (a PdfName
) value value of the entry (a PdfObject
)
PdfObject
and its key from the PdfDictionary
.
Parameters: key key of the entry (a PdfName
)
PdfDictionary
.See Also: toString