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

public Class PDThreadBead

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

Field Summary

Modifier and TypeField and Description
private final COSDictionary
bead

Constructor Summary

AccessConstructor and Description
public
PDThreadBead(COSDictionary
The underlying dictionary.
b)

Constructor that is used for a preexisting dictionary.

public
PDThreadBead()

Default constructor.

Method Summary

Modifier and TypeMethod and Description
public void
appendBead(PDThreadBead
The bead to insert.
append)

Append a bead after this bead.

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 next bead in the list or the first bead if this is the last bead.
getNextBead()

This will get the next bead.

public PDPage

Returns:

The page that this bead is part of.
getPage()

Get the page that this bead is part of.

public PDThreadBead

Returns:

The previous bead in the list or the last bead if this is the first bead.
getPreviousBead()

This will get the previous bead.

public PDRectangle

Returns:

The part of the page that this bead covers.
getRectangle()

The rectangle on the page that this bead is part of.

public PDThread

Returns:

The thread that this bead is part of.
getThread()

This will get the thread that this bead is part of.

protected final void
setNextBead(PDThreadBead
The next bead.
next)

Set the next bead in the thread.

public void
setPage(PDPage
The page that this bead is on.
page)

Set the page that this bead is part of.

protected final void
setPreviousBead(PDThreadBead
The previous bead.
previous)

Set the previous bead in the thread.

public void
setRectangle(PDRectangle
The portion of the page that this bead covers.
rect)

Set the rectangle on the page that this bead covers.

public void
setThread(PDThread
The thread that this bead is part of.
thread)

Set the thread that this bead is part of.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

beadback to summary
private final COSDictionary bead

Constructor Detail

PDThreadBeadback to summary
public PDThreadBead(COSDictionary b)

Constructor that is used for a preexisting dictionary.

Parameters
b:COSDictionary

The underlying dictionary.

PDThreadBeadback to summary
public PDThreadBead()

Default constructor.

Method Detail

appendBeadback to summary
public void appendBead(PDThreadBead append)

Append a bead after this bead. This will correctly set the next/previous beads in the linked list.

Parameters
append:PDThreadBead

The bead to insert.

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
getNextBeadback to summary
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.

Returns:PDThreadBead

The next bead in the list or the first bead if this is the last bead.

getPageback to summary
public PDPage getPage()

Get the page that this bead is part of.

Returns:PDPage

The page that this bead is part of.

getPreviousBeadback to summary
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.

Returns:PDThreadBead

The previous bead in the list or the last bead if this is the first bead.

getRectangleback to summary
public PDRectangle getRectangle()

The rectangle on the page that this bead is part of.

Returns:PDRectangle

The part of the page that this bead covers.

getThreadback to summary
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.

Returns:PDThread

The thread that this bead is part of.

setNextBeadback to summary
protected final void setNextBead(PDThreadBead next)

Set the next bead in the thread.

Parameters
next:PDThreadBead

The next bead.

setPageback to summary
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.

Parameters
page:PDPage

The page that this bead is on.

setPreviousBeadback to summary
protected final void setPreviousBead(PDThreadBead previous)

Set the previous bead in the thread.

Parameters
previous:PDThreadBead

The previous bead.

setRectangleback to summary
public void setRectangle(PDRectangle rect)

Set the rectangle on the page that this bead covers.

Parameters
rect:PDRectangle

The portion of the page that this bead covers.

setThreadback to summary
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.

Parameters
thread:PDThread

The thread that this bead is part of.