com.qoppa.pdfViewer.panels

Interface BookmarkPanel

All Superinterfaces:

PDFPanel

All Known Subinterfaces:

BookmarkPanelEditor

public interface BookmarkPanel
extends PDFPanel

Interface to the panel that shows the document outlines (known as bookmarks in the PDF specs).

Author:

Qoppa Software

Field Summary

Fields inherited from interface com.qoppa.pdfViewer.panels.PDFPanel

ALWAYS_ACTIVE, DEFAULT_POLICY, NEVER_ACTIVE

Method Summary

Modifier and Type	Method and Description
void	collapseAll() Collapse all the leafs in the bookmarks tree.
void	expandAll() Expand all the leafs in the bookmarks tree.
void	expandCurrentBookmark() Scrolls to and expands the bookmark in the tree that corresponding to the current location in the document displayed in the viewer bean.
JTree	getBookmarkTree() Returns a reference to the bookmark tree component.
boolean	getHighlight() Gets the highlight property.
JButton	getjbCollapseAll() Returns a reference to the collapse all button
JButton	getjbExpandAll() Returns a reference to the expand all button
JButton	getjbExport() Returns a reference to the Export button
void	setHighlight(boolean highlight) Enable highlighting of the current bookmark.
void	setToolTipDisplay(boolean enabled) Enable or disable displaying the bookmark text in a tool tip.

Methods inherited from interface com.qoppa.pdfViewer.panels.PDFPanel

getActivePolicy, getToolbar, isActive, isPaneSelected, setActive, setActivePolicy, setPaneVisible, setTouchEnabled

Method Detail

getBookmarkTree

JTree getBookmarkTree()

Returns a reference to the bookmark tree component. The host application can use this to change the look of the tree.

expandAll

void expandAll()

Expand all the leafs in the bookmarks tree.

collapseAll

void collapseAll()

Collapse all the leafs in the bookmarks tree.

getjbExpandAll

JButton getjbExpandAll()

Returns a reference to the expand all button

Returns:

reference to the expand all button

getjbCollapseAll

JButton getjbCollapseAll()

Returns a reference to the collapse all button

Returns:

A reference to the collapse all button

setToolTipDisplay

void setToolTipDisplay(boolean enabled)

Enable or disable displaying the bookmark text in a tool tip. This option can be enabled to display long bookmark text that would be truncated in the BoomkarkPanel.

Parameters:

enabled - Controls whether to show full bookmark text in a tool tip.

getjbExport

JButton getjbExport()

Returns a reference to the Export button

Returns:

A reference to the Export button

setHighlight

void setHighlight(boolean highlight)

Enable highlighting of the current bookmark. As the document is viewed, the current bookmark's icon will be updated, indicating that the current bookmark's destination is near the current view.

Parameters:

highlight - if true, the current bookmark will be highlighted; otherwise false

See Also:

getHighlight()

getHighlight

boolean getHighlight()

Gets the highlight property.

Returns:

the value of the highlight property

See Also:

setHighlight(boolean)

expandCurrentBookmark

void expandCurrentBookmark()

Scrolls to and expands the bookmark in the tree that corresponding to the current location in the document displayed in the viewer bean.