1 files changed, 503 insertions, 0 deletions
diff --git a/src/main/java/org/pdfbox/pdmodel/interactive/annotation/PDAnnotation.java b/src/main/java/org/pdfbox/pdmodel/interactive/annotation/PDAnnotation.java
new file mode 100644
index 0000000..4d245c0
--- /dev/null
+++ b/src/main/java/org/pdfbox/pdmodel/interactive/annotation/PDAnnotation.java
@@ -0,0 +1,503 @@
+/**
+ * Copyright (c) 2003-2005, www.pdfbox.org
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice,
+ *    this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ * 3. Neither the name of pdfbox; nor the names of its
+ *    contributors may be used to endorse or promote products derived from this
+ *    software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY
+ * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * http://www.pdfbox.org
+ *
+ */
+package org.pdfbox.pdmodel.interactive.annotation;
+
+import java.io.IOException;
+
+import org.pdfbox.cos.COSArray;
+import org.pdfbox.cos.COSDictionary;
+import org.pdfbox.cos.COSName;
+
+import org.pdfbox.pdmodel.common.COSObjectable;
+import org.pdfbox.pdmodel.common.PDRectangle;
+import org.pdfbox.pdmodel.interactive.action.PDAdditionalActions;
+import org.pdfbox.util.BitFlagHelper;
+import org.pdfbox.cos.COSBase;
+
+/**
+ * This class represents a PDF annotation.
+ *
+ * @author Ben Litchfield (ben@benlitchfield.com)
+ * @version $Revision: 1.10 $
+ */
+public abstract class PDAnnotation implements COSObjectable
+{
+    /**
+     * An annotation flag.
+     */
+    public static final int FLAG_INVISIBLE = 1 << 0;
+    /**
+     * An annotation flag.
+     */
+    public static final int FLAG_HIDDEN = 1 << 1;
+    /**
+     * An annotation flag.
+     */
+    public static final int FLAG_PRINTED = 1 << 2;
+    /**
+     * An annotation flag.
+     */
+    public static final int FLAG_NO_ZOOM = 1 << 3;
+    /**
+     * An annotation flag.
+     */
+    public static final int FLAG_NO_ROTATE = 1 << 4;
+    /**
+     * An annotation flag.
+     */
+    public static final int FLAG_NO_VIEW = 1 << 5;
+    /**
+     * An annotation flag.
+     */
+    public static final int FLAG_READ_ONLY = 1 << 6;
+    /**
+     * An annotation flag.
+     */
+    public static final int FLAG_LOCKED = 1 << 7;
+    /**
+     * An annotation flag.
+     */
+    public static final int FLAG_TOGGLE_NO_VIEW = 1 << 8;
+    
+    
+    
+    private COSDictionary dictionary;
+    
+    /**
+     * Create the correct annotation from the base COS object.
+     * 
+     * @param base The COS object that is the annotation.
+     * @return The correctly typed annotation object.
+     * @throws IOException If there is an error while creating the annotation.
+     */
+    public static PDAnnotation createAnnotation( COSBase base ) throws IOException
+    {
+        PDAnnotation annot = null;
+        if( base instanceof COSDictionary )
+        {
+            COSDictionary annotDic = (COSDictionary)base;
+            String subtype = annotDic.getString( COSName.SUBTYPE );
+            if( subtype.equals( PDAnnotationRubberStamp.SUB_TYPE ) )
+            {
+                annot = new PDAnnotationRubberStamp(annotDic);
+            }
+            else
+            {
+                annot = new PDAnnotationUnknown( annotDic );
+            }
+        }
+        else
+        {
+            throw new IOException( "Error: Unknown annotation type " + base );
+        }
+        
+        return annot;
+    }
+
+    /**
+     * Constructor.
+     */
+    public PDAnnotation()
+    {
+        dictionary = new COSDictionary();
+        dictionary.setItem( COSName.TYPE, COSName.getPDFName( "Annot" ) );
+    }
+
+    /**
+     * Constructor.
+     *
+     * @param dict The annotations dictionary.
+     */
+    public PDAnnotation( COSDictionary dict )
+    {
+        dictionary = dict;
+    }
+
+    /**
+     * returns the dictionary.
+     * @return the dictionary
+     */
+    public COSDictionary getDictionary()
+    {
+        return dictionary;
+    }
+
+    /**
+     * The annotation rectangle, defining the location of the annotation
+     * on the page in default user space units.  This is usually required and should
+     * not return null on valid PDF documents.  But where this is a parent form field
+     * with children, such as radio button collections then the rectangle will be null.
+     *
+     * @return The Rect value of this annotation.
+     */
+    public PDRectangle getRectangle()
+    {
+        COSArray rectArray = (COSArray)dictionary.getDictionaryObject( COSName.getPDFName( "Rect" ) );
+        PDRectangle rectangle = null;
+        if( rectArray != null )
+        {
+            rectangle = new PDRectangle( rectArray );
+        }
+        return rectangle;
+    }
+
+    /**
+     * This will set the rectangle for this annotation.
+     *
+     * @param rectangle The new rectangle values.
+     */
+    public void setRectangle( PDRectangle rectangle )
+    {
+        dictionary.setItem( COSName.getPDFName( "Rect" ), rectangle.getCOSArray() );
+    }
+
+   /**
+     * This will get the flags for this field.
+     *
+     * @return flags The set of flags.
+     */
+    public int getAnnotationFlags()
+    {
+        return getDictionary().getInt( "F", 0 );
+    }
+
+    /**
+     * This will set the flags for this field.
+     *
+     * @param flags The new flags.
+     */
+    public void setAnnotationFlags( int flags )
+    {
+        getDictionary().setInt( "F", flags );
+    }
+
+    /**
+     * Interface method for COSObjectable.
+     *
+     * @return This object as a standard COS object.
+     */
+    public COSBase getCOSObject()
+    {
+        return getDictionary();
+    }
+
+    /**
+     * This will get the name of the current appearance stream if any.
+     *
+     * @return The name of the appearance stream.
+     */
+    public String getAppearanceStream()
+    {
+        String retval = null;
+        COSName name = (COSName)getDictionary().getDictionaryObject( COSName.getPDFName( "AS" ) );
+        if( name != null )
+        {
+            retval = name.getName();
+        }
+        return retval;
+    }
+
+    /**
+     * This will set the annotations appearance stream name.
+     *
+     * @param as The name of the appearance stream.
+     */
+    public void setAppearanceStream( String as )
+    {
+        if( as == null )
+        {
+            getDictionary().removeItem( COSName.getPDFName( "AS" ) );
+        }
+        else
+        {
+            getDictionary().setItem( COSName.getPDFName( "AS" ), COSName.getPDFName( as ) );
+        }
+    }
+
+    /**
+     * This will get the appearance dictionary associated with this annotation.
+     * This may return null.
+     *
+     * @return This annotations appearance.
+     */
+    public PDAppearanceDictionary getAppearance()
+    {
+        PDAppearanceDictionary ap = null;
+        COSDictionary apDic = (COSDictionary)dictionary.getDictionaryObject( COSName.getPDFName( "AP" ) );
+        if( apDic != null )
+        {
+            ap = new PDAppearanceDictionary( apDic );
+        }
+        return ap;
+    }
+
+    /**
+     * This will set the appearance associated with this annotation.
+     *
+     * @param appearance The appearance dictionary for this annotation.
+     */
+    public void setAppearance( PDAppearanceDictionary appearance )
+    {
+        COSDictionary ap = null;
+        if( appearance != null )
+        {
+            ap = appearance.getDictionary();
+        }
+        dictionary.setItem( COSName.getPDFName( "AP" ), ap );
+    }
+    
+    /**
+     * Get the invisible flag.
+     * 
+     * @return The invisible flag.
+     */
+    public boolean isInvisible()
+    {
+        return BitFlagHelper.getFlag( getDictionary(), "F", FLAG_INVISIBLE );
+    }
+    
+    /**
+     * Set the invisible flag.
+     * 
+     * @param invisible The new invisible flag.
+     */
+    public void setInvisible( boolean invisible )
+    {
+        BitFlagHelper.setFlag( getDictionary(), "F", FLAG_INVISIBLE, invisible );
+    }
+    
+    /**
+     * Get the hidden flag.
+     * 
+     * @return The hidden flag.
+     */
+    public boolean isHidden()
+    {
+        return BitFlagHelper.getFlag( getDictionary(), "F", FLAG_HIDDEN );
+    }
+    
+    /**
+     * Set the hidden flag.
+     * 
+     * @param hidden The new hidden flag.
+     */
+    public void setHidden( boolean hidden )
+    {
+        BitFlagHelper.setFlag( getDictionary(), "F", FLAG_HIDDEN, hidden );
+    }
+    
+    /**
+     * Get the printed flag.
+     * 
+     * @return The printed flag.
+     */
+    public boolean isPrinted()
+    {
+        return BitFlagHelper.getFlag( getDictionary(), "F", FLAG_PRINTED );
+    }
+    
+    /**
+     * Set the printed flag.
+     * 
+     * @param printed The new printed flag.
+     */
+    public void setPrinted( boolean printed )
+    {
+        BitFlagHelper.setFlag( getDictionary(), "F", FLAG_PRINTED, printed );
+    }
+    
+    /**
+     * Get the noZoom flag.
+     * 
+     * @return The noZoom flag.
+     */
+    public boolean isNoZoom()
+    {
+        return BitFlagHelper.getFlag( getDictionary(), "F", FLAG_NO_ZOOM );
+    }
+    
+    /**
+     * Set the noZoom flag.
+     * 
+     * @param noZoom The new noZoom flag.
+     */
+    public void setNoZoom( boolean noZoom )
+    {
+        BitFlagHelper.setFlag( getDictionary(), "F", FLAG_NO_ZOOM, noZoom );
+    }
+    
+    /**
+     * Get the noRotate flag.
+     * 
+     * @return The noRotate flag.
+     */
+    public boolean isNoRotate()
+    {
+        return BitFlagHelper.getFlag( getDictionary(), "F", FLAG_NO_ROTATE );
+    }
+    
+    /**
+     * Set the noRotate flag.
+     * 
+     * @param noRotate The new noRotate flag.
+     */
+    public void setNoRotate( boolean noRotate )
+    {
+        BitFlagHelper.setFlag( getDictionary(), "F", FLAG_NO_ROTATE, noRotate );
+    }
+    
+    /**
+     * Get the noView flag.
+     * 
+     * @return The noView flag.
+     */
+    public boolean isNoView()
+    {
+        return BitFlagHelper.getFlag( getDictionary(), "F", FLAG_NO_VIEW );
+    }
+    
+    /**
+     * Set the noView flag.
+     * 
+     * @param noView The new noView flag.
+     */
+    public void setNoView( boolean noView )
+    {
+        BitFlagHelper.setFlag( getDictionary(), "F", FLAG_NO_VIEW, noView );
+    }
+    
+    /**
+     * Get the readOnly flag.
+     * 
+     * @return The readOnly flag.
+     */
+    public boolean isReadOnly()
+    {
+        return BitFlagHelper.getFlag( getDictionary(), "F", FLAG_READ_ONLY );
+    }
+    
+    /**
+     * Set the readOnly flag.
+     * 
+     * @param readOnly The new readOnly flag.
+     */
+    public void setReadOnly( boolean readOnly )
+    {
+        BitFlagHelper.setFlag( getDictionary(), "F", FLAG_READ_ONLY, readOnly );
+    }
+    
+    /**
+     * Get the locked flag.
+     * 
+     * @return The locked flag.
+     */
+    public boolean isLocked()
+    {
+        return BitFlagHelper.getFlag( getDictionary(), "F", FLAG_LOCKED );
+    }
+    
+    /**
+     * Set the locked flag.
+     * 
+     * @param locked The new locked flag.
+     */
+    public void setLocked( boolean locked )
+    {
+        BitFlagHelper.setFlag( getDictionary(), "F", FLAG_LOCKED, locked );
+    }
+    
+    /**
+     * Get the toggleNoView flag.
+     * 
+     * @return The toggleNoView flag.
+     */
+    public boolean isToggleNoView()
+    {
+        return BitFlagHelper.getFlag( getDictionary(), "F", FLAG_TOGGLE_NO_VIEW );
+    }
+    
+    /**
+     * Set the toggleNoView flag.
+     * 
+     * @param toggleNoView The new toggleNoView flag.
+     */
+    public void setToggleNoView( boolean toggleNoView )
+    {
+        BitFlagHelper.setFlag( getDictionary(), "F", FLAG_TOGGLE_NO_VIEW, toggleNoView );
+    }
+    
+    /**
+     * Get the additional actions for this field.  This will return null
+     * if there are no additional actions for this field.
+     * 
+     * @return The actions of the field.
+     */
+    public PDAdditionalActions getActions()
+    {
+        COSDictionary aa = (COSDictionary)dictionary.getDictionaryObject( "AA" );
+        PDAdditionalActions retval = null;
+        if( aa != null )
+        {
+            retval = new PDAdditionalActions( aa );
+        }
+        return retval;
+    }
+    
+    /**
+     * Set the actions of the field.
+     * 
+     * @param actions The field actions.
+     */
+    public void setActions( PDAdditionalActions actions )
+    {
+        dictionary.setItem( "AA", actions );
+    }
+    
+    /**
+     * Get the "contents" of the field.
+     * 
+     * @return the value of the contents
+     */
+    public String getContents()
+    {
+        return dictionary.getString(COSName.CONTENTS);
+    }
+    
+    /**
+     * Set the "contents" of the field.
+     * 
+     * @param value the value of the contents.
+     */
+    public void setContents( String value)
+    {
+        dictionary.setString(COSName.CONTENTS, value);
+    }
+}
+\ No newline at end of file