ThumbnailPanel (Big Faceless PDF Library 2.11.11)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.faceless.pdf2.viewer2.feature
Class ThumbnailPanel

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

public class ThumbnailPanel
extends SidePanelFactory
extends SidePanelFactory

Creates a SidePanel that displays the page thumbnails. Since release 2.10.2 the Thumbnail panel can also be used to reorder, delete and insert pages or entire documents. Modifying a document in this way requires the EncryptionHandler on the document grants the "Assemble" right.

The following initialization parameters can be specified to configure this feature.

editable	`true` or `false`, for `setEditable()`
scrollFollow	`true` or `false`, for `setScrollFollow()`

The name of this feature is ShowHideThumbnails

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
`ThumbnailPanel()` Create a new ThumbnailPanel

Method Summary
`SidePanel`	`createSidePanel()` Create and return a new `SidePanel`.
`ThumbnailPanel`	`getInstance()` Deprecated. since 2.10.2 just calls the public constructor
`void`	`initialize(PDFViewer viewer)` Called when the feature is first added to a viewer
`void`	`setEditable(boolean editmode)` Determine whether SidePanels created by this factory allow pages to be reordered, deleted and so on.
`void`	`setScrollFollow(boolean follow)` Set whether the thumbnail panel should scroll to follow the currently selected page or not.

Methods inherited from class org.faceless.pdf2.viewer2.SidePanelFactory
`isSidePanelRequired, toString`

Methods inherited from class org.faceless.pdf2.viewer2.ViewerFeature
`getAllEnabledFeatures, getAllFeatures, getCustomJavaScript, getFeatureProperty, getName, isEnabledByDefault`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Constructor Detail

ThumbnailPanel

public ThumbnailPanel()

Create a new ThumbnailPanel

Since:: 2.10.2

Method Detail

getInstance

public ThumbnailPanel getInstance()

Deprecated. since 2.10.2 just calls the public constructor

Return a new ThumbnailPanel

setEditable

public void setEditable(boolean editmode)

Determine whether SidePanels created by this factory allow pages to be reordered, deleted and so on. The default is true.

Parameters:: editmode - true if SidePanels created by this Factory allow alterations to the PDF
Since:: 2.10.2

setScrollFollow

public void setScrollFollow(boolean follow)

Set whether the thumbnail panel should scroll to follow the currently selected page or not. The default is true.

Parameters:: follow - whether to follow the currently selected page in the viewport or not.
Since:: 2.11.6

initialize

public void initialize(PDFViewer viewer)

Description copied from class: ViewerFeature

Called when the feature is first added to a viewer

Overrides:: initialize in class ViewerFeature

createSidePanel

public SidePanel createSidePanel()

Description copied from class: SidePanelFactory

Create and return a new SidePanel.

Specified by:: createSidePanel in class SidePanelFactory