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

Modifier and Type	Field	Description
private static final int	HIDDEN	A type of PDF Collection
private static final int	TILE	A type of PDF Collection

Fields inherited from class PdfDictionary

hashMap

Fields inherited from class PdfObject

ARRAY, bytes, INDIRECT, STREAM, TEXT_UNICODE, type

Constructor Summary

Constructors

Constructor	Description
PdfCollection()

Method Summary

Modifier and Type	Method	Description
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(PdfCollectionSchema schema)	Sets the Collection schema dictionary.
void	setSort(PdfCollectionSort sort)	Sets the Collection sort dictionary.

Methods inherited from class PdfDictionary

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

Methods inherited from class PdfObject

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

Methods inherited from class Object

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

Field Details

TILE

private static final int TILE

A type of PDF Collection

See Also:

• Constant Field Values

HIDDEN

private static final int HIDDEN

A type of PDF Collection

See Also:

• Constant Field Values

Constructor Details

PdfCollection

public PdfCollection()

Method Details

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(PdfCollectionSchema schema)

Sets the Collection schema dictionary.

Parameters:

schema - an overview of the collection fields

getSchema

public PdfCollectionSchema getSchema()

Gets the Collection schema dictionary.

Returns:

schema an overview of the collection fields

setSort

public void setSort(PdfCollectionSort sort)

Sets the Collection sort dictionary.

Parameters:

sort - a collection sort dictionary