Class PDThread
java.lang.Object
org.apache.pdfbox.pdmodel.interactive.pagenavigation.PDThread
- All Implemented Interfaces:
COSObjectable
This a single thread in a PDF document.
- Version:
- $Revision: 1.2 $
- Author:
- Ben Litchfield
-
Constructor Summary
ConstructorsConstructorDescriptionPDThread()
Default constructor.Constructor that is used for a preexisting dictionary. -
Method Summary
Modifier and TypeMethodDescriptionConvert this standard java object to a COS object.This will get the underlying dictionary that this object wraps.Get the first bead in the thread, or null if it has not been set yet.Get info about the thread, or null if there is nothing.void
setFirstBead
(PDThreadBead bead) This will set the first bead in the thread.void
Set the thread info, can be null.
-
Constructor Details
-
PDThread
Constructor that is used for a preexisting dictionary.- Parameters:
t
- The underlying dictionary.
-
PDThread
public PDThread()Default constructor.
-
-
Method Details
-
getDictionary
This will get the underlying dictionary that this object wraps.- Returns:
- The underlying info dictionary.
-
getCOSObject
Convert this standard java object to a COS object.- Specified by:
getCOSObject
in interfaceCOSObjectable
- Returns:
- The cos object that matches this Java object.
-
getThreadInfo
Get info about the thread, or null if there is nothing.- Returns:
- The thread information.
-
setThreadInfo
Set the thread info, can be null.- Parameters:
info
- The info dictionary about this thread.
-
getFirstBead
Get the first bead in the thread, or null if it has not been set yet. This is a required field for this object.- Returns:
- The first bead in the thread.
-