Top Description Fields Constructors Methods
org.apache.pdfbox.pdmodel.interactive.pagenavigation

public Class PDThread

extends Object
implements COSObjectable
Class Inheritance
All Implemented Interfaces
org.apache.pdfbox.pdmodel.common.COSObjectable
Imports
org.apache.pdfbox.cos.COSDictionary, .COSName, org.apache.pdfbox.pdmodel.PDDocumentInformation, org.apache.pdfbox.pdmodel.common.COSObjectable
This a single thread in a PDF document.
Author
Ben Litchfield

Field Summary

Modifier and TypeField and Description
private final COSDictionary
thread

Constructor Summary

AccessConstructor and Description
public
PDThread(COSDictionary
The underlying dictionary.
t)

Constructor that is used for a preexisting dictionary.

public
PDThread()

Default constructor.

Method Summary

Modifier and TypeMethod and Description
public COSDictionary

Returns:

The underlying info dictionary.
getCOSObject()

Implements org.apache.pdfbox.pdmodel.common.COSObjectable.getCOSObject.

This will get the underlying dictionary that this object wraps.

public PDThreadBead

Returns:

The first bead in the thread.
getFirstBead()

Get the first bead in the thread, or null if it has not been set yet.

public PDDocumentInformation

Returns:

The thread information.
getThreadInfo()

Get info about the thread, or null if there is nothing.

public void
setFirstBead(PDThreadBead
The first bead in the thread.
bead)

This will set the first bead in the thread.

public void
setThreadInfo(PDDocumentInformation
The info dictionary about this thread.
info)

Set the thread info, can be null.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

threadback to summary
private final COSDictionary thread

Constructor Detail

PDThreadback to summary
public PDThread(COSDictionary t)

Constructor that is used for a preexisting dictionary.

Parameters
t:COSDictionary

The underlying dictionary.

PDThreadback to summary
public PDThread()

Default constructor.

Method Detail

getCOSObjectback to summary
public COSDictionary getCOSObject()

Implements org.apache.pdfbox.pdmodel.common.COSObjectable.getCOSObject.

This will get the underlying dictionary that this object wraps.

Returns:COSDictionary

The underlying info dictionary.

Annotations
@Override
getFirstBeadback to summary
public PDThreadBead 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:PDThreadBead

The first bead in the thread.

getThreadInfoback to summary
public PDDocumentInformation getThreadInfo()

Get info about the thread, or null if there is nothing.

Returns:PDDocumentInformation

The thread information.

setFirstBeadback to summary
public void setFirstBead(PDThreadBead bead)

This will set the first bead in the thread. When this is set it will also set the thread property of the bead object.

Parameters
bead:PDThreadBead

The first bead in the thread.

setThreadInfoback to summary
public void setThreadInfo(PDDocumentInformation info)

Set the thread info, can be null.

Parameters
info:PDDocumentInformation

The info dictionary about this thread.