DragScroll (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 DragScroll

java.lang.Object
  org.faceless.pdf2.viewer2.ViewerFeature
      org.faceless.pdf2.viewer2.ViewerWidget
          org.faceless.pdf2.viewer2.ToggleViewerWidget
              org.faceless.pdf2.viewer2.feature.DragScroll

All Implemented Interfaces:: DocumentPanelListener, PagePanelInteractionListener

public class DragScroll
extends ToggleViewerWidget
implements DocumentPanelListener, PagePanelInteractionListener
extends ToggleViewerWidget
implements DocumentPanelListener, PagePanelInteractionListener

This widget allows the document to be dragged and scrolled. This widget is selected by default if no other items in its group are selected. The name of this feature is DragScroll

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.5

Field Summary
`static String`	`GROUP` The name of the `ToggleViewerWidget` Group that this widget is a part of.

Constructor Summary
`DragScroll()`

Method Summary
`void`	`action(ViewerEvent event)` Toggle the active state of this widget by calling `ToggleViewerWidget.setSelected(boolean)`
`void`	`documentUpdated(DocumentPanelEvent event)` Called when an `DocumentPanelEvent` is raised
`void`	`initialize(PDFViewer viewer)` Called when the feature is first added to a viewer
`void`	`pageAction(PagePanelInteractionEvent event)` Called when a `PagePanelInteractionEvent` is raised
`protected void`	`updateViewport(DocumentViewport vp, boolean selected)` Called from `ToggleViewerWidget.setSelected(boolean)`, this method is called in each viewport in use by the `PDFViewer` or `DocumentPanel` so it can update its status.

Methods inherited from class org.faceless.pdf2.viewer2.ToggleViewerWidget
`getGroupName, getGroupOwner, getGroupSelection, getWidgets, isSelected, setGroupOwner, setSelected`

Methods inherited from class org.faceless.pdf2.viewer2.ViewerWidget
`createActionListener, getComponent, getViewer, isButtonEnabledByDefault, isDocumentRequired, isMenuEnabledByDefault, setButton, setComponent, setDocumentRequired, setMenu, setMenu, setToolBarEnabled, setToolBarEnabledAlways, setToolBarFloatable, setToolBarFloating, 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`

Field Detail

GROUP

public static final String GROUP

The name of the ToggleViewerWidget Group that this widget is a part of. All other widgets that want to control actions on the DocumentViewport itself should be a part of this group.

See Also:: Constant Field Values

Constructor Detail

DragScroll

public DragScroll()

Method Detail

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 ToggleViewerWidget

action

public void action(ViewerEvent event)

Description copied from class: ToggleViewerWidget

Toggle the active state of this widget by calling ToggleViewerWidget.setSelected(boolean)

Overrides:: action in class ToggleViewerWidget

updateViewport

protected void updateViewport(DocumentViewport vp,
                              boolean selected)