org.faceless.pdf2.viewer2.feature
Class OutlinePanel

java.lang.Object
  org.faceless.pdf2.viewer2.ViewerFeature
      org.faceless.pdf2.viewer2.SidePanelFactory
          org.faceless.pdf2.viewer2.feature.OutlinePanel

public class OutlinePanel
extends SidePanelFactory

Create a SidePanel that will display the document bookmarks, as returned by PDF.getBookmarks(). The name of this feature is "ShowHideBookmarks".

This code is copyright the Big Faceless Organization. You're welcome to use, modify and distribute it in any form in your own projects, provided those projects continue to make use of the Big Faceless PDF library.

Since:

2.8

Method Summary

SidePanel	createSidePanel() Create and return a new SidePanel.
static OutlinePanel	getInstance() Return the OutlinePanel
boolean	isSidePanelRequired(PDF pdf) Determines whether this side panel is required for this PDF.

Methods inherited from class org.faceless.pdf2.viewer2.SidePanelFactory

getDisplayName, toString

Methods inherited from class org.faceless.pdf2.viewer2.ViewerFeature

getAllFeatures, getName, initialize

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static OutlinePanel getInstance()

Return the OutlinePanel

isSidePanelRequired

public boolean isSidePanelRequired(PDF pdf)

Description copied from class: SidePanelFactory

Determines whether this side panel is required for this PDF. By default this method returns true, but an example of where this wouldn't apply is for the Bookmarks panel on a PDF with no bookmarks.

Overrides:

isSidePanelRequired in class SidePanelFactory

createSidePanel

public SidePanel createSidePanel()

Description copied from class: SidePanelFactory

Create and return a new SidePanel.

Specified by:

createSidePanel in class SidePanelFactory