com.lowagie.text.pdf.collection

Class PdfCollection

public class PdfCollection extends PdfDictionary

Field Summary
static intDETAILS
A type of PDF Collection
static intHIDDEN
A type of PDF Collection
static intTILE
A type of PDF Collection
Constructor Summary
PdfCollection(int type)
Constructs a PDF Collection.
Method Summary
PdfCollectionSchemagetSchema()
Gets the Collection schema dictionary.
voidsetInitialDocument(String description)
Identifies the document that will be initially presented in the user interface.
voidsetSchema(PdfCollectionSchema schema)
Sets the Collection schema dictionary.
voidsetSort(PdfCollectionSort sort)
Sets the Collection sort dictionary.

Field Detail

DETAILS

public static final int DETAILS
A type of PDF Collection

HIDDEN

public static final int HIDDEN
A type of PDF Collection

TILE

public static final int TILE
A type of PDF Collection

Constructor Detail

PdfCollection

public PdfCollection(int type)
Constructs a PDF Collection.

Parameters: type the type of PDF collection.

Method Detail

getSchema

public PdfCollectionSchema getSchema()
Gets the Collection schema dictionary.

Returns: schema an overview of the collection fields

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

setSort

public void setSort(PdfCollectionSort sort)
Sets the Collection sort dictionary.

Parameters: sort a collection sort dictionary