org.faceless.pdf2.viewer2.feature
Class OutlinePanel

java.lang.Object
  extended by org.faceless.pdf2.viewer2.ViewerFeature
      extended by org.faceless.pdf2.viewer2.SidePanelFactory
          extended by 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

Constructor Summary
OutlinePanel()
          Create a new OutlinePanel
 
Method Summary
 SidePanel createSidePanel()
          Create and return a new SidePanel.
 boolean isSidePanelRequired(PDF pdf)
          Determines whether this side panel is required for this PDF.
 
Methods inherited from class org.faceless.pdf2.viewer2.SidePanelFactory
toString
 
Methods inherited from class org.faceless.pdf2.viewer2.ViewerFeature
getAllEnabledFeatures, getAllFeatures, getCustomJavaScript, getFeatureProperty, getFeatureURLProperty, getName, initialize, isEnabledByDefault, setFeatureName, teardown
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

OutlinePanel

public OutlinePanel()
Create a new OutlinePanel

Since:
2.11
Method Detail

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


Copyright © 2001-2013 Big Faceless Organization