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.3'
section 4.7 (page 40-41).
PdfObject
,
PdfName
,
BadPdfFormatException
Modifier and Type | Field and Description |
---|---|
static PdfName |
CATALOG
This is a possible type of dictionary
|
private PdfName |
dictionaryType
This is the type of this dictionary
|
static PdfName |
FONT
This is a possible type of dictionary
|
protected java.util.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 and Description |
---|
PdfDictionary()
Constructs an empty
PdfDictionary -object. |
PdfDictionary(PdfName type)
Constructs a
PdfDictionary -object of a certain type. |
Modifier and Type | Method and Description |
---|---|
boolean |
contains(PdfName key) |
PdfObject |
get(PdfName key)
Gets a
PdfObject with a certain key from the PdfDictionary . |
java.util.Set |
getKeys() |
boolean |
isCatalog()
Checks if a
Dictionary is of the type CATALOG. |
boolean |
isDictionaryType(PdfName type)
Deprecated.
|
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 |
putDel(PdfName key,
PdfObject value)
Adds a
PdfObject and its key to the PdfDictionary . |
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,
java.io.OutputStream os)
Returns the PDF representation of this
PdfDictionary . |
java.lang.String |
toString()
Returns the
String -representation of this PdfObject . |
canBeInObjStm, getBytes, getIndRef, isArray, isBoolean, isDictionary, isIndirect, isName, isNull, isNumber, isStream, isString, length, setContent, setIndRef, type
public static final PdfName FONT
public static final PdfName OUTLINES
public static final PdfName PAGE
public static final PdfName PAGES
public static final PdfName CATALOG
private PdfName dictionaryType
protected java.util.HashMap hashMap
public PdfDictionary()
PdfDictionary
-object.public PdfDictionary(PdfName type)
PdfDictionary
-object of a certain type.type
- a PdfName
public void toPdf(PdfWriter writer, java.io.OutputStream os) throws java.io.IOException
PdfDictionary
.public void put(PdfName key, PdfObject value)
PdfObject
and its key to the PdfDictionary
.key
- key of the entry (a PdfName
)value
- value of the entry (a PdfObject
)public void putEx(PdfName key, PdfObject value)
PdfObject
and its key to the PdfDictionary
.
If the value is null it does nothing.key
- key of the entry (a PdfName
)value
- value of the entry (a PdfObject
)public void putDel(PdfName key, PdfObject value)
PdfObject
and its key to the PdfDictionary
.
If the value is null the key is deleted.key
- key of the entry (a PdfName
)value
- value of the entry (a PdfObject
)public void remove(PdfName key)
PdfObject
and its key from the PdfDictionary
.key
- key of the entry (a PdfName
)public PdfObject get(PdfName key)
PdfObject
with a certain key from the PdfDictionary
.key
- key of the entry (a PdfName
)public boolean isDictionaryType(PdfName type)
PdfDictionary
is of a certain type.type
- a type of dictionarytrue
of false
public boolean isFont()
Dictionary
is of the type FONT.true
if it is, false
if it isn't.public boolean isPage()
Dictionary
is of the type PAGE.true
if it is, false
if it isn't.public boolean isPages()
Dictionary
is of the type PAGES.true
if it is, false
if it isn't.public boolean isCatalog()
Dictionary
is of the type CATALOG.true
if it is, false
if it isn't.public boolean isOutlineTree()
Dictionary
is of the type OUTLINES.true
if it is, false
if it isn't.public void merge(PdfDictionary other)
public void mergeDifferent(PdfDictionary other)
public java.util.Set getKeys()
public void putAll(PdfDictionary dic)
public int size()
public boolean contains(PdfName key)