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
-
public class PdfCollection extends PdfDictionary
-
-
Constructor Summary
Constructors Constructor Description PdfCollection(int type)
Constructs a PDF Collection.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PdfCollectionSchema
getSchema()
Gets the Collection schema dictionary.void
setInitialDocument(java.lang.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 Detail
-
DETAILS
public static final int DETAILS
A type of PDF Collection- See Also:
- Constant Field Values
-
TILE
public static final int TILE
A type of PDF Collection- See Also:
- Constant Field Values
-
HIDDEN
public static final int HIDDEN
A type of PDF Collection- See Also:
- Constant Field Values
-
-
Method Detail
-
setInitialDocument
public void setInitialDocument(java.lang.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
-
getSchema
public PdfCollectionSchema getSchema()
Gets the Collection schema dictionary.- Returns:
- schema an overview of the collection fields
-
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
-
-