public class ThumbnailPanel 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.
It's also possible to add custom actions to a ThumbnailPanel by
adding features implementing ThumbnailPanel.ThumbnailSelectionAction
.
These will be available via keyboard shortcut or the popup menu
on the panel.
editable | true or false , for setEditable() . Default is true |
---|---|
draggable | true or false , for setDraggable() . Default is true |
scrollFollow | true or false , for setScrollFollow() . Default is true |
usePageLabels | true or false , for setUsePageLabels() . Default is true |
thumbnailSize | number , for setThumbnailSize() . Default is 100 |
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.
ThumbnailPanel.ThumbnailSelectionAction
Modifier and Type | Class and Description |
---|---|
static class |
ThumbnailPanel.SinglePagePanel
A
JPanel representing a single page image. |
static interface |
ThumbnailPanel.ThumbnailSelectionAction
This interface should be implemented by any
ViewerFeature that
should be available as an action on the ThumbnailPanel.View , either by the popup
menu or by keypress. |
static class |
ThumbnailPanel.ThumbnailSidePanel
This type of
SidePanel is returned from a call to createSidePanel() . |
static class |
ThumbnailPanel.View
This class is the JPanel containing all the thumbnails.
|
Constructor and Description |
---|
ThumbnailPanel()
Create a new ThumbnailPanel
|
Modifier and Type | Method and Description |
---|---|
void |
addAction(ThumbnailPanel.ThumbnailSelectionAction action)
If this ThumbnailPanel is part of a DocumentPanel with no viewer, use
this method add add
ThumbnailPanel.ThumbnailSelectionAction actions to the
panel. |
SidePanel |
createSidePanel()
Create and return a new
SidePanel . |
void |
initialize(PDFViewer viewer)
Called when the feature is first added to a viewer
|
void |
setDraggable(boolean draggable)
Determines whether SidePanels created by this factory can be
edited by dragging pages around or dragging new documents in.
|
void |
setEditable(boolean editmode)
Determine whether SidePanels created by this factory allow
pages to be edited in any way - either reordered via dragging
or through any editing
ThumbnailPanel.ThumbnailSelectionAction . |
void |
setScrollFollow(boolean follow)
Set whether the thumbnail panel should scroll to follow the
currently selected page or not.
|
void |
setThumbnailSize(int thumbnailsize)
Set the size of the longest dimension of each thumbnail.
|
void |
setUsePageLabels(boolean uselabels)
Set whether to number the pages using the "page labels" if defined
on this PDF, or whether to always use the physical page number.
|
isSidePanelRequired, toString
getAllEnabledFeatures, getAllFeatures, getCustomJavaScript, getFeatureProperty, getFeatureURLProperty, getName, isEnabledByDefault, setFeatureName, teardown
public void setEditable(boolean editmode)
ThumbnailPanel.ThumbnailSelectionAction
.
The default is true, but this may be overridden by the PDF itself
if it is encrypted and doesn't allow editing.
s* Pages may not be edited if the PDF is not yet fully loaded.editmode
- true if SidePanels created by this Factory allow alterations to the PDFpublic void setDraggable(boolean draggable)
setEditable(boolean)
- if that flag is
true but this flag false, the document can still be edited by
other means via the Thumbnail panel. The default is truedraggable
- if the PDF can be edited by draggingpublic void setScrollFollow(boolean follow)
follow
- whether to follow the currently selected page in the viewportpublic void setUsePageLabels(boolean uselabels)
uselabels
- if true, use the page labels if definedPDF.getPageLabel(int)
,
PageNumber.setUsePageLabels(boolean)
public void addAction(ThumbnailPanel.ThumbnailSelectionAction action)
ThumbnailPanel.ThumbnailSelectionAction
actions to the
panel.public void setThumbnailSize(int thumbnailsize)
public void initialize(PDFViewer viewer)
ViewerFeature
initialize
in class ViewerFeature
public SidePanel createSidePanel()
SidePanelFactory
SidePanel
.createSidePanel
in class SidePanelFactory
Copyright © 2001-2017 Big Faceless Organization