Class PdfCollectionItem

java.lang.Object

org.openpdf.text.pdf.PdfObject

org.openpdf.text.pdf.PdfDictionary

org.openpdf.text.pdf.collection.PdfCollectionItem

public class PdfCollectionItem
extends PdfDictionary

Field Summary

Fields

Modifier and Type	Field	Description
(package private) PdfCollectionSchema	schema	The PdfCollectionSchema with the names and types of the items.

Fields inherited from class PdfDictionary

CATALOG, FONT, hashMap, OUTLINES, PAGE, PAGES

Fields inherited from class PdfObject

ARRAY, BOOLEAN, bytes, DICTIONARY, INDIRECT, indRef, NAME, NOTHING, NULL, NUMBER, STREAM, STRING, TEXT_PDFDOCENCODING, TEXT_UNICODE, type

Constructor Summary

Constructors

Constructor	Description
PdfCollectionItem(PdfCollectionSchema schema)	Constructs a Collection Item that can be added to a PdfFileSpecification.

Method Summary

Modifier and Type	Method	Description
void	addItem(String key, double d)	Sets the value of the collection item.
void	addItem(String key, float f)	Sets the value of the collection item.
void	addItem(String key, int i)	Sets the value of the collection item.
void	addItem(String key, String value)	Sets the value of the collection item.
void	addItem(String key, Calendar c)	Sets the value of the collection item.
void	addItem(String key, PdfDate d)	Sets the value of the collection item.
void	addItem(String key, PdfNumber n)	Sets the value of the collection item.
void	addItem(String key, PdfString value)	Sets the value of the collection item.
void	setPrefix(String key, String prefix)	Adds a prefix for the Collection item.

Methods inherited from class PdfDictionary

clear, contains, get, getAsArray, getAsBoolean, getAsDict, getAsIndirectObject, getAsName, getAsNumber, getAsStream, getAsString, getDirectObject, getKeys, getKeysAndValues, isCatalog, isFont, isOutlineTree, isPage, isPages, merge, mergeDifferent, put, putAll, putEx, remove, size, toPdf, toString

Methods inherited from class PdfObject

canBeInObjStm, getBytes, getIndRef, isArray, isBoolean, isDictionary, isIndirect, isName, isNull, isNumber, isStream, isString, length, setContent, setIndRef, type

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

schema

PdfCollectionSchema schema

The PdfCollectionSchema with the names and types of the items.

Constructor Details

PdfCollectionItem

public PdfCollectionItem(PdfCollectionSchema schema)

Constructs a Collection Item that can be added to a PdfFileSpecification.

Parameters:

schema - the PdfCollectionSchema

Method Details

addItem

public void addItem(String key,
 String value)

Sets the value of the collection item.

Parameters:

key - the key

value - the value (a String)

addItem

public void addItem(String key,
 PdfString value)

Sets the value of the collection item.

Parameters:

key - the key

value - the value (a PdfString)

addItem

public void addItem(String key,
 PdfDate d)

Sets the value of the collection item.

Parameters:

key - the key

d - the value (a PdfDate)

addItem

public void addItem(String key,
 PdfNumber n)

Sets the value of the collection item.

Parameters:

key - the key

n - the value (a PdfNumber)

addItem

public void addItem(String key,
 Calendar c)

Sets the value of the collection item.

Parameters:

key - the key

c - the value (a Calendar)

addItem

public void addItem(String key,
 int i)

Sets the value of the collection item.

Parameters:

key - the key

i - the value

addItem

public void addItem(String key,
 float f)

Sets the value of the collection item.

Parameters:

key - the key

f - the value

addItem

public void addItem(String key,
 double d)

Sets the value of the collection item.

Parameters:

key - the key

d - the value

setPrefix

public void setPrefix(String key,
 String prefix)

Adds a prefix for the Collection item. You can only use this method after you have set the value of the item.

Parameters:

key - the key

prefix - a prefix