Class PDThreadBead
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.
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionDefault constructor.Constructor that is used for a preexisting dictionary. -
Method Summary
Modifier and TypeMethodDescriptionvoid
appendBead
(PDThreadBead append) Append a bead after this bead.This will get the underlying dictionary that this object wraps.This will get the next bead.getPage()
Get the page that this bead is part of.This will get the previous bead.The rectangle on the page that this bead is part of.This will get the thread that this bead is part of.protected final void
setNextBead
(PDThreadBead next) Set the next bead in the thread.void
Set the page that this bead is part of.protected final void
setPreviousBead
(PDThreadBead previous) Set the previous bead in the thread.void
setRectangle
(PDRectangle rect) Set the rectangle on the page that this bead covers.void
Set the thread that this bead is part of.
-
Field Details
-
bead
-
-
Constructor Details
-
PDThreadBead
Constructor that is used for a preexisting dictionary.- Parameters:
b
- The underlying dictionary.
-
PDThreadBead
public PDThreadBead()Default constructor.
-
-
Method Details
-
getCOSObject
This will get the underlying dictionary that this object wraps.- Specified by:
getCOSObject
in interfaceCOSObjectable
- Returns:
- The underlying info dictionary.
-
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.- Returns:
- The thread that this bead is part of.
-
getNextBead
This will get the next bead. If this bead is the last bead in the list then this will return the first bead.- Returns:
- The next bead in the list or the first bead if this is the last bead.
-
getPreviousBead
This will get the previous bead. If this bead is the first bead in the list then this will return the last bead.- Returns:
- The previous bead in the list or the last bead if this is the first bead.
-
getPage
Get the page that this bead is part of.- Returns:
- The page that this bead is part of.
-
setPage
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.- Parameters:
page
- The page that this bead is on.
-
getRectangle
The rectangle on the page that this bead is part of.- Returns:
- The part of the page that this bead covers.
-
setRectangle
Set the rectangle on the page that this bead covers.- Parameters:
rect
- The portion of the page that this bead covers.
-