KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > lowagie > text > pdf > interfaces > PdfVersion


1 /*
2  * $Id: PdfVersion.java 2571 2007-02-06 13:37:06Z blowagie $
3  *
4  * Copyright 2006 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.interfaces;
51
52 import com.lowagie.text.pdf.PdfName;
53
54 /**
55  * The PDF version is described in the PDF Reference 1.7 p92
56  * (about the PDF Header) and page 139 (the version entry in
57  * the Catalog). You'll also find info about setting the version
58  * in the book 'iText in Action' sections 2.1.3 (PDF Header)
59  * and 3.3 (Version history).
60  */
61
62 public interface PdfVersion {
63     
64     /**
65      * If the PDF Header hasn't been written yet,
66      * this changes the version as it will appear in the PDF Header.
67      * If the PDF header was already written to the OutputStream,
68      * this changes the version as it will appear in the Catalog.
69      * @param version a character representing the PDF version
70      */
71     public void setPdfVersion(char version);
72     /**
73      * If the PDF Header hasn't been written yet,
74      * this changes the version as it will appear in the PDF Header,
75      * but only if param refers to a higher version.
76      * If the PDF header was already written to the OutputStream,
77      * this changes the version as it will appear in the Catalog.
78      * @param version a character representing the PDF version
79      */
80     public void setAtLeastPdfVersion(char version);
81     /**
82      * Sets the PDF version as it will appear in the Catalog.
83      * Note that this only has effect if you use a later version
84      * than the one that appears in the header; this method
85      * ignores the parameter if you try to set a lower version.
86      * @param version the PDF name that will be used for the Version key in the catalog
87      */
88     public void setPdfVersion(PdfName version);
89 }
Popular Tags