001/*
002 * $Id: PdfVersion.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.interfaces;
045
046import com.itextpdf.text.pdf.PdfDeveloperExtension;
047import com.itextpdf.text.pdf.PdfName;
048
049/**
050 * The PDF version is described in the PDF Reference 1.7 p92
051 * (about the PDF Header) and page 139 (the version entry in
052 * the Catalog). You'll also find info about setting the version
053 * in the book 'iText in Action' sections 2.1.3 (PDF Header)
054 * and 3.3 (Version history).
055 */
056
057public interface PdfVersion {
058    
059    /**
060         * If the PDF Header hasn't been written yet,
061         * this changes the version as it will appear in the PDF Header.
062         * If the PDF header was already written to the OutputStream,
063         * this changes the version as it will appear in the Catalog.
064         * @param version       a character representing the PDF version
065         */
066        public void setPdfVersion(char version);
067    /**
068         * If the PDF Header hasn't been written yet,
069         * this changes the version as it will appear in the PDF Header,
070         * but only if the parameter refers to a higher version.
071         * If the PDF header was already written to the OutputStream,
072         * this changes the version as it will appear in the Catalog.
073         * @param version       a character representing the PDF version
074         */
075        public void setAtLeastPdfVersion(char version);
076        /**
077         * Sets the PDF version as it will appear in the Catalog.
078         * Note that this only has effect if you use a later version
079         * than the one that appears in the header; this method
080         * ignores the parameter if you try to set a lower version.
081         * @param version       the PDF name that will be used for the Version key in the catalog
082         */
083        public void setPdfVersion(PdfName version);
084        /**
085         * Adds a developer extension to the Extensions dictionary
086         * in the Catalog.
087         * @param de    an object that contains the extensions prefix and dictionary
088         * @since       2.1.6
089         */
090        public void addDeveloperExtension(PdfDeveloperExtension de);
091}