org.faceless.pdf2.viewer2.feature
Class AbstractRegionSelector

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

All Implemented Interfaces:

DocumentPanelListener, PagePanelInteractionListener

Direct Known Subclasses:

AnnotationAdd, ZoomSelection

public abstract class AbstractRegionSelector
extends ToggleViewerWidget
implements DocumentPanelListener, PagePanelInteractionListener

An abstract superclass for any widgets that require a region to be selected. Subclasses should override the action(PagePanel, Point2D, Point2D) method.

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

Constructor Summary

protected

AbstractRegionSelector(String name)

Method Summary

void	action(PagePanel panel, Point2D start, Point2D end) Called when an area of the PDF has been selected.
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
void	paintRubberBandComponent(JComponent component, Graphics2D g) Paint the component while the "rubber band" box is being stretched.
void	setSelected(boolean selected) Set whether this Region Selector is selected or not on the specified panel.

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

action, getGroupName, getGroupOwner, getGroupSelection, getWidgets, isSelected, setGroupOwner

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

getComponent, getViewer, setButton, setComponent, setDocumentRequired, setMenu, setMenu, setToolBarEnabled, setToolBarEnabledAlways, setToolBarFloatable, setToolBarFloating, toString

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

getAllFeatures, getName

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractRegionSelector

protected AbstractRegionSelector(String name)

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

setSelected

public void setSelected(boolean selected)

Set whether this Region Selector is selected or not on the specified panel. Normally called automatically by ToggleViewerWidget.action(ViewerEvent)}

Overrides:

setSelected in class ToggleViewerWidget

Parameters:

selected - whether this Widget is active or not

Since:

2.10

documentUpdated

public void documentUpdated(DocumentPanelEvent event)

Description copied from interface: DocumentPanelListener

Called when an DocumentPanelEvent is raised

Specified by:

documentUpdated in interface DocumentPanelListener

pageAction

public void pageAction(PagePanelInteractionEvent event)

Description copied from interface: PagePanelInteractionListener

Called when a PagePanelInteractionEvent is raised

Specified by:

pageAction in interface PagePanelInteractionListener

paintRubberBandComponent

public void paintRubberBandComponent(JComponent component,
                                     Graphics2D g)

Paint the component while the "rubber band" box is being stretched. This method may be overriden if something is to be painted inside the box during this time.

Parameters:

component - the "rubber band" box being drawn

g - the Graphic2D object to draw on.

action

public void action(PagePanel panel,
                   Point2D start,
                   Point2D end)

Called when an area of the PDF has been selected.

Parameters:

panel - the PagePanel the selection was made on.

start - the start point of the selection, in PDF-units

end - the end point of the selection, in PDF-units