001: /**
002: * Copyright (c) 2004, www.pdfbox.org
003: * All rights reserved.
004: *
005: * Redistribution and use in source and binary forms, with or without
006: * modification, are permitted provided that the following conditions are met:
007: *
008: * 1. Redistributions of source code must retain the above copyright notice,
009: * this list of conditions and the following disclaimer.
010: * 2. Redistributions in binary form must reproduce the above copyright notice,
011: * this list of conditions and the following disclaimer in the documentation
012: * and/or other materials provided with the distribution.
013: * 3. Neither the name of pdfbox; nor the names of its
014: * contributors may be used to endorse or promote products derived from this
015: * software without specific prior written permission.
016: *
017: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
018: * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
019: * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
020: * DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY
021: * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
022: * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
023: * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
024: * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
025: * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
026: * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
027: *
028: * http://www.pdfbox.org
029: *
030: */package org.pdfbox.pdmodel.fdf;
031:
032: import org.pdfbox.cos.COSBase;
033: import org.pdfbox.cos.COSDictionary;
034: import org.pdfbox.cos.COSInteger;
035: import org.pdfbox.cos.COSNumber;
036:
037: import org.pdfbox.pdmodel.common.COSObjectable;
038:
039: /**
040: * This represents an FDF annotation that is part of the FDF document.
041: *
042: * @author <a href="mailto:ben@benlitchfield.com">Ben Litchfield</a>
043: * @version $Revision: 1.3 $
044: */
045: public class FDFAnnotation implements COSObjectable {
046: private COSDictionary annot;
047:
048: /**
049: * Default constructor.
050: */
051: public FDFAnnotation() {
052: annot = new COSDictionary();
053: }
054:
055: /**
056: * Constructor.
057: *
058: * @param a The FDF annotation.
059: */
060: public FDFAnnotation(COSDictionary a) {
061: annot = a;
062: }
063:
064: /**
065: * Convert this standard java object to a COS object.
066: *
067: * @return The cos object that matches this Java object.
068: */
069: public COSBase getCOSObject() {
070: return annot;
071: }
072:
073: /**
074: * Convert this standard java object to a COS object.
075: *
076: * @return The cos object that matches this Java object.
077: */
078: public COSDictionary getCOSDictionary() {
079: return annot;
080: }
081:
082: /**
083: * This will get the page number or null if it does not exist.
084: *
085: * @return The page number.
086: */
087: public Integer getPage() {
088: Integer retval = null;
089: COSNumber page = (COSNumber) annot.getDictionaryObject("Page");
090: if (page != null) {
091: retval = new Integer(page.intValue());
092: }
093: return retval;
094: }
095:
096: /**
097: * This will set the page.
098: *
099: * @param page The page number.
100: */
101: public void setPage(int page) {
102: annot.setItem("Page", new COSInteger(page));
103: }
104:
105: }
|