Home » pdfbox-1.1.0-src » org.apache.pdfbox.pdmodel.interactive.pagenavigation » [javadoc | source]
org.apache.pdfbox.pdmodel.interactive.pagenavigation
public class: PDThreadBead [javadoc | source]
java.lang.Object
   org.apache.pdfbox.pdmodel.interactive.pagenavigation.PDThreadBead

All Implemented Interfaces:
    COSObjectable

This a single bead in a thread in a PDF document.
Constructor:
 public PDThreadBead() 
 public PDThreadBead(COSDictionary b) 
    Constructor that is used for a preexisting dictionary.
    Parameters:
    b - The underlying dictionary.
Method from org.apache.pdfbox.pdmodel.interactive.pagenavigation.PDThreadBead Summary:
appendBead,   getCOSObject,   getDictionary,   getNextBead,   getPage,   getPreviousBead,   getRectangle,   getThread,   setNextBead,   setPage,   setPreviousBead,   setRectangle,   setThread
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.pdfbox.pdmodel.interactive.pagenavigation.PDThreadBead Detail:
 public  void appendBead(PDThreadBead append) 
    Append a bead after this bead. This will correctly set the next/previous beads in the linked list.
 public COSBase getCOSObject() 
    Convert this standard java object to a COS object.
 public COSDictionary getDictionary() 
    This will get the underlying dictionary that this object wraps.
 public PDThreadBead getNextBead() 
    This will get the next bead. If this bead is the last bead in the list then this will return the first bead.
 public PDPage getPage() 
    Get the page that this bead is part of.
 public PDThreadBead getPreviousBead() 
    This will get the previous bead. If this bead is the first bead in the list then this will return the last bead.
 public PDRectangle getRectangle() 
    The rectangle on the page that this bead is part of.
 public PDThread getThread() 
    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.
 protected  void setNextBead(PDThreadBead next) 
    Set the next bead in the thread.
 public  void setPage(PDPage 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.
 protected  void setPreviousBead(PDThreadBead previous) 
    Set the previous bead in the thread.
 public  void setRectangle(PDRectangle rect) 
    Set the rectangle on the page that this bead covers.
 public  void setThread(PDThread thread) 
    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.