1 /*
2  * $Id: PdfFormXObject.java 3903 2009-04-24 10:03:48Z blowagie $
3  *
4  * Copyright 2001, 2002 Bruno Lowagie
5  *
6  * The contents of this file are subject to the Mozilla Public License Version 1.1
7  * (the "License"); you may not use this file except in compliance with the License.
8  * You may obtain a copy of the License at http://www.mozilla.org/MPL/
9  *
10  * Software distributed under the License is distributed on an "AS IS" basis,
11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
12  * for the specific language governing rights and limitations under the License.
13  *
14  * The Original Code is 'iText, a free JAVA-PDF library'.
15  *
16  * The Initial Developer of the Original Code is Bruno Lowagie. Portions created by
17  * the Initial Developer are Copyright (C) 1999, 2000, 2001, 2002 by Bruno Lowagie.
18  * All Rights Reserved.
19  * Co-Developer of the code is Paulo Soares. Portions created by the Co-Developer
20  * are Copyright (C) 2000, 2001, 2002 by Paulo Soares. All Rights Reserved.
21  *
22  * Contributor(s): all the names of the contributors are added in the source code
23  * where applicable.
24  *
25  * Alternatively, the contents of this file may be used under the terms of the
26  * LGPL license (the "GNU LIBRARY GENERAL PUBLIC LICENSE"), in which case the
27  * provisions of LGPL are applicable instead of those above.  If you wish to
28  * allow use of your version of this file only under the terms of the LGPL
29  * License and not to allow others to use your version of this file under
30  * the MPL, indicate your decision by deleting the provisions above and
31  * replace them with the notice and other provisions required by the LGPL.
32  * If you do not delete the provisions above, a recipient may use your version
33  * of this file under either the MPL or the GNU LIBRARY GENERAL PUBLIC LICENSE.
34  *
35  * This library is free software; you can redistribute it and/or modify it
36  * under the terms of the MPL as stated above or under the terms of the GNU
37  * Library General Public License as published by the Free Software Foundation;
38  * either version 2 of the License, or any later version.
39  *
40  * This library is distributed in the hope that it will be useful, but WITHOUT
41  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
42  * FOR A PARTICULAR PURPOSE. See the GNU Library general Public License for more
43  * details.
44  *
45  * If you didn't download this code from the following link, you should check if
46  * you aren't using an obsolete version:
47  * http://www.lowagie.com/iText/
48  */

49
50 package com.lowagie.text.pdf;
51
52 /**
53  * <CODE>PdfFormObject</CODE> is a type of XObject containing a template-object.
54  */

55
56 public class PdfFormXObject extends PdfStream {
57     
58     // public static final variables
59     
60 /** This is a PdfNumber representing 0. */
61     public static final PdfNumber ZERO = new PdfNumber(0);
62     
63 /** This is a PdfNumber representing 1. */
64     public static final PdfNumber ONE = new PdfNumber(1);
65     
66 /** This is the 1 - matrix. */
67     public static final PdfLiteral MATRIX = new PdfLiteral("[1 0 0 1 0 0]");
68     
69 /**
70  * Constructs a <CODE>PdfFormXObject</CODE>-object.
71  *
72  * @param    template            the template
73  * @param    compressionLevel    the compression level for the stream
74  * @since    2.1.3 (Replacing the existing constructor with param compressionLevel)
75  */

76     
77     PdfFormXObject(PdfTemplate template, int compressionLevel) // throws BadPdfFormatException
78     {
79         super();
80         put(PdfName.TYPE, PdfName.XOBJECT);
81         put(PdfName.SUBTYPE, PdfName.FORM);
82         put(PdfName.RESOURCES, template.getResources());
83         put(PdfName.BBOX, new PdfRectangle(template.getBoundingBox()));
84         put(PdfName.FORMTYPE, ONE);
85         if (template.getLayer() != null)
86             put(PdfName.OC, template.getLayer().getRef());
87         if (template.getGroup() != null)
88             put(PdfName.GROUP, template.getGroup());
89         PdfArray matrix = template.getMatrix();
90         if (matrix == null)
91             put(PdfName.MATRIX, MATRIX);
92         else
93             put(PdfName.MATRIX, matrix);
94         bytes = template.toPdf(null);
95         put(PdfName.LENGTH, new PdfNumber(bytes.length));
96         flateCompress(compressionLevel);
97     }
98     
99 }
100