KickJava   Java API By Example, From Geeks To Geeks.

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


1 /*
2  * $Id: PdfAnnotations.java 2569 2007-02-06 13:10:39Z 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.PdfAcroForm;
53 import com.lowagie.text.pdf.PdfAnnotation;
54 import com.lowagie.text.pdf.PdfFormField;
55
56 public interface PdfAnnotations {
57
58     /**
59      * Use this methods to get the AcroForm object.
60      * Use this method only if you know what you're doing
61      * @return the PdfAcroform object of the PdfDocument
62      */
63     public PdfAcroForm getAcroForm();
64     
65     /**
66      * Use this methods to add a <CODE>PdfAnnotation</CODE> or a <CODE>PdfFormField</CODE>
67      * to the document. Only the top parent of a <CODE>PdfFormField</CODE>
68      * needs to be added.
69      * @param annot the <CODE>PdfAnnotation</CODE> or the <CODE>PdfFormField</CODE> to add
70      */
71     public void addAnnotation(PdfAnnotation annot);
72     /**
73      * Use this method to adds the <CODE>PdfAnnotation</CODE>
74      * to the calculation order array.
75      * @param annot the <CODE>PdfAnnotation</CODE> to be added
76      */
77     public void addCalculationOrder(PdfFormField annot);
78     
79     /**
80      * Use this method to set the signature flags.
81      * @param f the flags. This flags are ORed with current ones
82      */
83     public void setSigFlags(int f);
84 }
85
Popular Tags