001/*
002 * $Id: PdfFormXObject.java 4798 2011-04-06 11:45:02Z 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;
045
046/**
047 * <CODE>PdfFormObject</CODE> is a type of XObject containing a template-object.
048 */
049
050public class PdfFormXObject extends PdfStream {
051    
052    // public static final variables
053    
054/** This is a PdfNumber representing 0. */
055    public static final PdfNumber ZERO = new PdfNumber(0);
056    
057/** This is a PdfNumber representing 1. */
058    public static final PdfNumber ONE = new PdfNumber(1);
059    
060/** This is the 1 - matrix. */
061    public static final PdfLiteral MATRIX = new PdfLiteral("[1 0 0 1 0 0]");
062    
063/**
064 * Constructs a <CODE>PdfFormXObject</CODE>-object.
065 *
066 * @param       template                        the template
067 * @param       compressionLevel        the compression level for the stream
068 * @since       2.1.3 (Replacing the existing constructor with param compressionLevel)
069 */
070    
071    PdfFormXObject(PdfTemplate template, int compressionLevel) // throws BadPdfFormatException
072    {
073        super();
074        put(PdfName.TYPE, PdfName.XOBJECT);
075        put(PdfName.SUBTYPE, PdfName.FORM);
076        put(PdfName.RESOURCES, template.getResources());
077        put(PdfName.BBOX, new PdfRectangle(template.getBoundingBox()));
078        put(PdfName.FORMTYPE, ONE);
079        if (template.getLayer() != null)
080            put(PdfName.OC, template.getLayer().getRef());
081        if (template.getGroup() != null)
082            put(PdfName.GROUP, template.getGroup());
083        PdfArray matrix = template.getMatrix();
084        if (matrix == null)
085            put(PdfName.MATRIX, MATRIX);
086        else
087            put(PdfName.MATRIX, matrix);
088        bytes = template.toPdf(null);
089        put(PdfName.LENGTH, new PdfNumber(bytes.length));
090        if (template.getAdditional() != null) {
091                putAll(template.getAdditional());
092        }
093        flateCompress(compressionLevel);
094    }
095    
096}