Package com.lowagie.text.pdf.collection
Class PdfCollection
java.lang.Object
com.lowagie.text.pdf.PdfObject
com.lowagie.text.pdf.PdfDictionary
com.lowagie.text.pdf.collection.PdfCollection
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
A type of PDF Collectionstatic final int
A type of PDF Collectionstatic final int
A type of PDF Collection -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionGets 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 com.lowagie.text.pdf.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 com.lowagie.text.pdf.PdfObject
canBeInObjStm, getBytes, getIndRef, isArray, isBoolean, isDictionary, isIndirect, isName, isNull, isNumber, isStream, isString, length, setContent, setIndRef, type
-
Field Details
-
DETAILS
public static final int DETAILSA type of PDF Collection- See Also:
-
TILE
public static final int TILEA type of PDF Collection- See Also:
-
HIDDEN
public static final int HIDDENA type of PDF Collection- See Also:
-
-
Constructor Details
-
PdfCollection
public PdfCollection(int type) Constructs a PDF Collection.- Parameters:
type
- the type of PDF collection.
-
-
Method Details
-
setInitialDocument
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
-
getSchema
Gets the Collection schema dictionary.- Returns:
- schema an overview of the collection fields
-
setSchema
Sets the Collection schema dictionary.- Parameters:
schema
- an overview of the collection fields
-
setSort
Sets the Collection sort dictionary.- Parameters:
sort
- a collection sort dictionary
-