com.aowagie.text.pdf.collection

Class PdfCollection

java.lang.Object

com.aowagie.text.pdf.PdfObject

com.aowagie.text.pdf.PdfDictionary

com.aowagie.text.pdf.collection.PdfCollection

public class PdfCollection
extends PdfDictionary

Field Summary

Fields inherited from class com.aowagie.text.pdf.PdfDictionary

hashMap

Fields inherited from class com.aowagie.text.pdf.PdfObject

ARRAY, bytes, INDIRECT, STREAM, TEXT_UNICODE, type

Constructor Summary

Constructors

Constructor and Description
PdfCollection()

Method Summary

Modifier and Type	Method and Description
com.aowagie.text.pdf.collection.PdfCollectionSchema	getSchema() Gets the Collection schema dictionary.
void	setInitialDocument(String description) Identifies the document that will be initially presented in the user interface.
void	setSchema(com.aowagie.text.pdf.collection.PdfCollectionSchema schema) Sets the Collection schema dictionary.
void	setSort(com.aowagie.text.pdf.collection.PdfCollectionSort sort) Sets the Collection sort dictionary.

Methods inherited from class com.aowagie.text.pdf.PdfDictionary

get, getAsArray, getAsDict, getAsName, getAsNumber, getAsString, getDirectObject, getKeys, isCatalog, isFont, isOutlineTree, isPage, isPages, put, remove, size, toPdf, toString

Methods inherited from class com.aowagie.text.pdf.PdfObject

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

Methods inherited from class java.lang.Object

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

Constructor Detail

PdfCollection

public PdfCollection()

Method Detail

setInitialDocument

public void setInitialDocument(String description)

Identifies the document that will be initially presented in the user interface.

Parameters:

description - the description that was used when attaching the file to the document

setSchema

public void setSchema(com.aowagie.text.pdf.collection.PdfCollectionSchema schema)

Sets the Collection schema dictionary.

Parameters:

schema - an overview of the collection fields

getSchema

public com.aowagie.text.pdf.collection.PdfCollectionSchema getSchema()

Gets the Collection schema dictionary.

Returns:

schema an overview of the collection fields

setSort

public void setSort(com.aowagie.text.pdf.collection.PdfCollectionSort sort)

Sets the Collection sort dictionary.

Parameters:

sort - a collection sort dictionary