FDFAnnotation


1   /**
2    * Copyright (c) 2004, www.pdfbox.org
3    * All rights reserved.
4    *
5    * Redistribution and use in source and binary forms, with or without
6    * modification, are permitted provided that the following conditions are met:
7    *
8    * 1. Redistributions of source code must retain the above copyright notice,
9    *    this list of conditions and the following disclaimer.
10   * 2. Redistributions in binary form must reproduce the above copyright notice,
11   *    this list of conditions and the following disclaimer in the documentation
12   *    and/or other materials provided with the distribution.
13   * 3. Neither the name of pdfbox; nor the names of its
14   *    contributors may be used to endorse or promote products derived from this
15   *    software without specific prior written permission.
16   *
17   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
18   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20   * DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY
21   * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22   * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23   * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
24   * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25   * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
26   * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27   *
28   * http://www.pdfbox.org
29   *
30   */
31  package org.pdfbox.pdmodel.fdf;
32  
33  import org.pdfbox.cos.COSBase;
34  import org.pdfbox.cos.COSDictionary;
35  import org.pdfbox.cos.COSInteger;
36  import org.pdfbox.cos.COSNumber;
37  
38  import org.pdfbox.pdmodel.common.COSObjectable;
39  
40  /**
41   * This represents an FDF annotation that is part of the FDF document.
42   *
43   * @author <a HREF="mailto:ben@benlitchfield.com">Ben Litchfield</a>
44   * @version $Revision: 1.3 $
45   */
46  public class FDFAnnotation implements COSObjectable
47  {
48      private COSDictionary annot;
49  
50      /**
51       * Default constructor.
52       */
53      public FDFAnnotation()
54      {
55          annot = new COSDictionary();
56      }
57  
58      /**
59       * Constructor.
60       *
61       * @param a The FDF annotation.
62       */
63      public FDFAnnotation( COSDictionary a )
64      {
65          annot = a;
66      }
67  
68      /**
69       * Convert this standard java object to a COS object.
70       *
71       * @return The cos object that matches this Java object.
72       */
73      public COSBase getCOSObject()
74      {
75          return annot;
76      }
77  
78      /**
79       * Convert this standard java object to a COS object.
80       *
81       * @return The cos object that matches this Java object.
82       */
83      public COSDictionary getCOSDictionary()
84      {
85          return annot;
86      }
87  
88      /**
89       * This will get the page number or null if it does not exist.
90       *
91       * @return The page number.
92       */
93      public Integer   getPage()
94      {
95          Integer   retval = null;
96          COSNumber page = (COSNumber)annot.getDictionaryObject( "Page" );
97          if( page != null )
98          {
99              retval = new Integer  ( page.intValue() );
100         }
101         return retval;
102     }
103 
104     /**
105      * This will set the page.
106      *
107      * @param page The page number.
108      */
109     public void setPage( int page )
110     {
111         annot.setItem( "Page", new COSInteger( page ) );
112     }
113 
114 }
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags