001/*
002 * $Id: Chapter.java 3373 2008-05-12 16:21:24Z xlv $
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;
045
046/**
047 * Beginning with BaseVersion 1.7, the extensions dictionary lets developers
048 * designate that a given document contains extensions to PDF. The presence
049 * of the extension dictionary in a document indicates that it may contain
050 * developer-specific PDF properties that extend a particular base version
051 * of the PDF specification.
052 * The extensions dictionary enables developers to identify their own extensions
053 * relative to a base version of PDF. Additionally, the convention identifies
054 * extension levels relative to that base version. The intent of this dictionary
055 * is to enable developers of PDF-producing applications to identify company-specific
056 * specifications (such as this one) that PDF-consuming applications use to
057 * interpret the extensions.
058 * @since       2.1.6
059 */
060public class PdfDeveloperExtension {
061
062        /** An instance of this class for Adobe 1.7 Extension level 3. */
063        public static final PdfDeveloperExtension ADOBE_1_7_EXTENSIONLEVEL3 =
064                new PdfDeveloperExtension(PdfName.ADBE, PdfWriter.PDF_VERSION_1_7, 3);
065        
066        /** The prefix used in the Extensions dictionary added to the Catalog. */
067        protected PdfName prefix;
068        /** The base version. */
069        protected PdfName baseversion;
070        /** The extension level within the baseversion. */
071        protected int extensionLevel;
072        
073        /**
074         * Creates a PdfDeveloperExtension object.
075         * @param prefix        the prefix referring to the developer
076         * @param baseversion   the number of the base version
077         * @param extensionLevel        the extension level within the baseverion.
078         */
079        public PdfDeveloperExtension(PdfName prefix, PdfName baseversion, int extensionLevel) {
080                this.prefix = prefix;
081                this.baseversion = baseversion;
082                this.extensionLevel = extensionLevel;
083        }
084
085        /**
086         * Gets the prefix name.
087         * @return      a PdfName
088         */
089        public PdfName getPrefix() {
090                return prefix;
091        }
092
093        /**
094         * Gets the baseversion name.
095         * @return      a PdfName
096         */
097        public PdfName getBaseversion() {
098                return baseversion;
099        }
100
101        /**
102         * Gets the extension level within the baseversion.
103         * @return      an integer
104         */
105        public int getExtensionLevel() {
106                return extensionLevel;
107        }
108        
109        /**
110         * Generations the developer extension dictionary corresponding
111         * with the prefix.
112         * @return      a PdfDictionary
113         */
114        public PdfDictionary getDeveloperExtensions() {
115                PdfDictionary developerextensions = new PdfDictionary();
116                developerextensions.put(PdfName.BASEVERSION, baseversion);
117                developerextensions.put(PdfName.EXTENSIONLEVEL, new PdfNumber(extensionLevel));
118                return developerextensions;
119        }
120}