|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.faceless.pdf2.viewer2.ViewerFeature
org.faceless.pdf2.viewer2.ViewerWidget
org.faceless.pdf2.viewer2.ToggleViewerWidget
org.faceless.pdf2.viewer2.feature.AbstractRegionSelector
public abstract class AbstractRegionSelector
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.
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. |
protected JComponent |
createRubberBoxComponent()
Create the JComponent that it used to display the "rubber box". |
void |
documentUpdated(DocumentPanelEvent event)
Called when an DocumentPanelEvent is raised |
void |
initialize(PDFViewer viewer)
Called when the feature is first added to a viewer |
protected boolean |
isSelectedAfterAction()
Called after action(org.faceless.pdf2.viewer2.PagePanel, java.awt.geom.Point2D, java.awt.geom.Point2D) , this method should return true if the tool should
stay selected after use, false otherwise (the default) |
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 Widget is selected. |
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 |
---|
action, getGroupName, getGroupOwner, getGroupSelection, getWidgets, isSelected, setGroupOwner |
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, getFeatureURLProperty, getName, isEnabledByDefault, setFeatureName, teardown |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
protected AbstractRegionSelector(String name)
Method Detail |
---|
public void initialize(PDFViewer viewer)
ViewerFeature
initialize
in class ToggleViewerWidget
public void setSelected(boolean selected)
ToggleViewerWidget
setSelected(false)
on all the other
widgets in this group. Subclasses should override this method to do
whatever they need to do when their active status is changed.
setSelected
in class ToggleViewerWidget
selected
- whether this Widget is active or notprotected void updateViewport(DocumentViewport vp, boolean selected)
ToggleViewerWidget
ToggleViewerWidget.setSelected(boolean)
, this method is called in each
viewport in use by the PDFViewer
or DocumentPanel
so
it can update its status. By default it is a no-op.
updateViewport
in class ToggleViewerWidget
public void documentUpdated(DocumentPanelEvent event)
DocumentPanelListener
DocumentPanelEvent
is raised
documentUpdated
in interface DocumentPanelListener
protected JComponent createRubberBoxComponent()
public void pageAction(PagePanelInteractionEvent event)
PagePanelInteractionListener
PagePanelInteractionEvent
is raised
pageAction
in interface PagePanelInteractionListener
public void paintRubberBandComponent(JComponent component, Graphics2D g)
component
- the "rubber band" box being drawng
- the Graphic2D object to draw on.public void action(PagePanel panel, Point2D start, Point2D end)
panel
- the PagePanel the selection was made on.start
- the start point of the selection, in PDF-unitsend
- the end point of the selection, in PDF-unitsprotected boolean isSelectedAfterAction()
action(org.faceless.pdf2.viewer2.PagePanel, java.awt.geom.Point2D, java.awt.geom.Point2D)
, this method should return true if the tool should
stay selected after use, false otherwise (the default)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |