001/* 002 * $Id: PdfCollection.java 4784 2011-03-15 08:33:00Z blowagie $ 003 * 004 * This file is part of the iText (R) project. 005 * Copyright (c) 1998-2011 1T3XT BVBA 006 * Authors: Bruno Lowagie, Paulo Soares, et al. 007 * 008 * This program is free software; you can redistribute it and/or modify 009 * it under the terms of the GNU Affero General Public License version 3 010 * as published by the Free Software Foundation with the addition of the 011 * following permission added to Section 15 as permitted in Section 7(a): 012 * FOR ANY PART OF THE COVERED WORK IN WHICH THE COPYRIGHT IS OWNED BY 1T3XT, 013 * 1T3XT DISCLAIMS THE WARRANTY OF NON INFRINGEMENT OF THIRD PARTY RIGHTS. 014 * 015 * This program is distributed in the hope that it will be useful, but 016 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY 017 * or FITNESS FOR A PARTICULAR PURPOSE. 018 * See the GNU Affero General Public License for more details. 019 * You should have received a copy of the GNU Affero General Public License 020 * along with this program; if not, see http://www.gnu.org/licenses or write to 021 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, 022 * Boston, MA, 02110-1301 USA, or download the license from the following URL: 023 * http://itextpdf.com/terms-of-use/ 024 * 025 * The interactive user interfaces in modified source and object code versions 026 * of this program must display Appropriate Legal Notices, as required under 027 * Section 5 of the GNU Affero General Public License. 028 * 029 * In accordance with Section 7(b) of the GNU Affero General Public License, 030 * a covered work must retain the producer line in every PDF that is created 031 * or manipulated using iText. 032 * 033 * You can be released from the requirements of the license by purchasing 034 * a commercial license. Buying such a license is mandatory as soon as you 035 * develop commercial activities involving the iText software without 036 * disclosing the source code of your own applications. 037 * These activities include: offering paid services to customers as an ASP, 038 * serving PDFs on the fly in a web application, shipping iText with a closed 039 * source product. 040 * 041 * For more information, please contact iText Software Corp. at this 042 * address: sales@itextpdf.com 043 */ 044package com.itextpdf.text.pdf.collection; 045 046import com.itextpdf.text.pdf.PdfDictionary; 047import com.itextpdf.text.pdf.PdfName; 048import com.itextpdf.text.pdf.PdfString; 049 050public class PdfCollection extends PdfDictionary { 051 052 /** A type of PDF Collection */ 053 public static final int DETAILS = 0; 054 /** A type of PDF Collection */ 055 public static final int TILE = 1; 056 /** A type of PDF Collection */ 057 public static final int HIDDEN = 2; 058 /** 059 * A type of PDF Collection 060 * @since 5.0.2 061 */ 062 public static final int CUSTOM = 3; 063 064 /** 065 * Constructs a PDF Collection. 066 * @param type the type of PDF collection. 067 */ 068 public PdfCollection(int type) { 069 super(PdfName.COLLECTION); 070 switch(type) { 071 case TILE: 072 put(PdfName.VIEW, PdfName.T); 073 break; 074 case HIDDEN: 075 put(PdfName.VIEW, PdfName.H); 076 break; 077 case CUSTOM: 078 put(PdfName.VIEW, PdfName.C); 079 break; 080 default: 081 put(PdfName.VIEW, PdfName.D); 082 } 083 } 084 085 /** 086 * Identifies the document that will be initially presented 087 * in the user interface. 088 * @param description the description that was used when attaching the file to the document 089 */ 090 public void setInitialDocument(String description) { 091 put(PdfName.D, new PdfString(description, null)); 092 } 093 094 /** 095 * Sets the Collection schema dictionary. 096 * @param schema an overview of the collection fields 097 */ 098 public void setSchema(PdfCollectionSchema schema) { 099 put(PdfName.SCHEMA, schema); 100 } 101 102 /** 103 * Gets the Collection schema dictionary. 104 * @return schema an overview of the collection fields 105 */ 106 public PdfCollectionSchema getSchema() { 107 return (PdfCollectionSchema)get(PdfName.SCHEMA); 108 } 109 110 /** 111 * Sets the Collection sort dictionary. 112 * @param sort a collection sort dictionary 113 */ 114 public void setSort(PdfCollectionSort sort) { 115 put(PdfName.SORT, sort); 116 } 117}