Package com.teamten.typeset.element

Class Bookmark

java.lang.Object

com.teamten.typeset.element.Element

com.teamten.typeset.element.NonDiscardableElement

com.teamten.typeset.element.Bookmark

All Implemented Interfaces:

Dimensions

Direct Known Subclasses:

IndexBookmark, LabelBookmark, SectionBookmark

public abstract class Bookmark
extends NonDiscardableElement

Parent of all bookmark elements, which keep track of where certain items (like chapter titles and index entries) are.

Field Summary

Fields inherited from class com.teamten.typeset.element.Element

DRAW_DEBUG

Constructor Summary

Constructors

Constructor	Description
Bookmark()

Method Summary

Modifier and Type	Method	Description
long	getDepth()	Return the depth (below the baseline) of the element.
long	getHeight()	Return the height (above the baseline) of the element.
long	getWidth()	Return the width of the element.
long	layOutHorizontally(long x, long y, org.apache.pdfbox.pdmodel.PDPageContentStream contents)	Add the element to the contents as part of a horizontal sequence.
long	layOutVertically(long x, long y, org.apache.pdfbox.pdmodel.PDPageContentStream contents)	Add the element to the contents as part of a vertical sequence.

Methods inherited from class com.teamten.typeset.element.Element

getVerticalSize, println, println, shouldSkipElementAtStart, toTextString, toTextString, visit

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Bookmark

public Bookmark()

Method Details

getWidth

public long getWidth()

Description copied from class: Element

Return the width of the element.

Specified by:

getWidth in interface Dimensions

Specified by:

getWidth in class Element

getHeight

public long getHeight()

Description copied from class: Element

Return the height (above the baseline) of the element.

Specified by:

getHeight in interface Dimensions

Specified by:

getHeight in class Element

getDepth

public long getDepth()

Description copied from class: Element

Return the depth (below the baseline) of the element.

Specified by:

getDepth in interface Dimensions

Specified by:

getDepth in class Element

layOutHorizontally

public long layOutHorizontally(long x,
 long y,
 org.apache.pdfbox.pdmodel.PDPageContentStream contents)
                        throws IOException

Description copied from class: Element

Add the element to the contents as part of a horizontal sequence.

Specified by:

layOutHorizontally in class Element

Parameters:

x - the left-most point of the element.

y - the baseline of the element.

contents - the stream to add the element to.

Returns:

how much to move right afterward.

Throws:

IOException

layOutVertically

public long layOutVertically(long x,
 long y,
 org.apache.pdfbox.pdmodel.PDPageContentStream contents)
                      throws IOException

Description copied from class: Element

Add the element to the contents as part of a vertical sequence.

Specified by:

layOutVertically in class Element

Parameters:

x - the left-most point of the element.

y - the upper-left point of the element.

contents - the stream to add the element to.

Returns:

how much to move down afterward.

Throws:

IOException