1 files changed, 234 insertions, 0 deletions
diff --git a/src/main/java/org/pdfbox/pdmodel/interactive/pagenavigation/PDThreadBead.java b/src/main/java/org/pdfbox/pdmodel/interactive/pagenavigation/PDThreadBead.java
new file mode 100644
index 0000000..547d4bc
--- /dev/null
+++ b/src/main/java/org/pdfbox/pdmodel/interactive/pagenavigation/PDThreadBead.java
@@ -0,0 +1,234 @@
+/**
+ * Copyright (c) 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.pagenavigation;
+
+import org.pdfbox.cos.COSArray;
+import org.pdfbox.cos.COSBase;
+import org.pdfbox.cos.COSDictionary;
+import org.pdfbox.cos.COSName;
+
+import org.pdfbox.pdmodel.PDPage;
+import org.pdfbox.pdmodel.common.COSObjectable;
+import org.pdfbox.pdmodel.common.PDRectangle;
+
+/**
+ * This a single bead in a thread in a PDF document.
+ *
+ * @author Ben Litchfield (ben@csh.rit.edu)
+ * @version $Revision: 1.3 $
+ */
+public class PDThreadBead implements COSObjectable
+{
+    
+    
+    private COSDictionary bead;
+
+    /**
+     * Constructor that is used for a preexisting dictionary.
+     *
+     * @param b The underlying dictionary.
+     */
+    public PDThreadBead( COSDictionary b )
+    {
+        bead = b;
+    }
+    
+    /**
+     * Default constructor.
+     * 
+     */
+    public PDThreadBead()
+    {
+        bead = new COSDictionary();
+        bead.setName( "Type", "Bead" );
+        setNextBead( this );
+        setPreviousBead( this );
+    }
+
+    /**
+     * This will get the underlying dictionary that this object wraps.
+     *
+     * @return The underlying info dictionary.
+     */
+    public COSDictionary getDictionary()
+    {
+        return bead;
+    }
+    
+    /**
+     * Convert this standard java object to a COS object.
+     *
+     * @return The cos object that matches this Java object.
+     */
+    public COSBase getCOSObject()
+    {
+        return bead;
+    }
+    
+    /**
+     * This will get the thread that this bead is part of.  This is only required
+     * for the first bead in a thread, so other beads 'may' return null.
+     * 
+     * @return The thread that this bead is part of.
+     */
+    public PDThread getThread()
+    {
+        PDThread retval = null;
+        COSDictionary dic = (COSDictionary)bead.getDictionaryObject( "T" );
+        if( dic != null )
+        {
+            retval = new PDThread( dic );
+        }
+        return retval;
+    }
+    
+    /**
+     * Set the thread that this bead is part of.  This is only required for the
+     * first bead in a thread.  Note: This property is set for you by the PDThread.setFirstBead() method.
+     * 
+     * @param thread The thread that this bead is part of.
+     */
+    public void setThread( PDThread thread )
+    {
+        bead.setItem( "T", thread );
+    }
+    
+    /**
+     * This will get the next bead.  If this bead is the last bead in the list then this
+     * will return the first bead. 
+     * 
+     * @return The next bead in the list or the first bead if this is the last bead.
+     */
+    public PDThreadBead getNextBead()
+    {
+        return new PDThreadBead( (COSDictionary) bead.getDictionaryObject( "N" ) );
+    }
+    
+    /**
+     * Set the next bead in the thread.
+     * 
+     * @param next The next bead.
+     */
+    protected void setNextBead( PDThreadBead next )
+    {
+        bead.setItem( "N", next );
+    }
+    
+    /**
+     * This will get the previous bead.  If this bead is the first bead in the list then this
+     * will return the last bead. 
+     * 
+     * @return The previous bead in the list or the last bead if this is the first bead.
+     */
+    public PDThreadBead getPreviousBead()
+    {
+        return new PDThreadBead( (COSDictionary) bead.getDictionaryObject( "V" ) );
+    }
+    
+    /**
+     * Set the previous bead in the thread.
+     * 
+     * @param previous The previous bead.
+     */
+    protected void setPreviousBead( PDThreadBead previous )
+    {
+        bead.setItem( "V", previous );
+    }
+    
+    /**
+     * Append a bead after this bead.  This will correctly set the next/previous beads in the
+     * linked list.
+     * 
+     * @param append The bead to insert.
+     */
+    public void appendBead( PDThreadBead append )
+    {
+        PDThreadBead nextBead = getNextBead();
+        nextBead.setPreviousBead( append );
+        append.setNextBead( nextBead );
+        setNextBead( append );
+        append.setPreviousBead( this );
+    }
+    
+    /**
+     * Get the page that this bead is part of.
+     * 
+     * @return The page that this bead is part of.
+     */
+    public PDPage getPage()
+    {
+        PDPage page = null;
+        COSDictionary dic = (COSDictionary)bead.getDictionaryObject( "P" );
+        if( dic != null )
+        {
+            page = new PDPage( dic );
+        }
+        return page;
+    }
+    
+    /**
+     * Set the page that this bead is part of.  This is a required property and must be
+     * set when creating a new bead.  The PDPage object also has a list of beads in the natural
+     * reading order.  It is recommended that you add this object to that list as well.
+     * 
+     * @param page The page that this bead is on.
+     */
+    public void setPage( PDPage page )
+    {
+        bead.setItem( "P", page );
+    }
+    
+    /**
+     * The rectangle on the page that this bead is part of.
+     * 
+     * @return The part of the page that this bead covers.
+     */
+    public PDRectangle getRectangle()
+    {
+        PDRectangle rect = null;
+        COSArray array = (COSArray)bead.getDictionaryObject( COSName.R );
+        if( array != null )
+        {
+            rect = new PDRectangle( array );
+        }
+        return rect;
+    }
+    
+    /**
+     * Set the rectangle on the page that this bead covers.
+     * 
+     * @param rect The portion of the page that this bead covers.
+     */
+    public void setRectangle( PDRectangle rect )
+    {
+        bead.setItem( COSName.R, rect );
+    }
+}
+\ No newline at end of file