Class DragTool

java.lang.Object

com.vividsolutions.jump.workbench.ui.cursortool.AbstractCursorTool

com.vividsolutions.jump.workbench.ui.cursortool.DragTool

All Implemented Interfaces:

CursorTool, MouseListener, MouseMotionListener, EventListener

Direct Known Subclasses:

AbstractZoomTool, MoveSelectedItemsTool, MoveVertexTool, RectangleTool, RotateSelectedItemTool, ScaleSelectedItemsTool, SelectItemsByCircleTool, SelectTool, SpecifyFeaturesTool, SuperZoomPanTool

public abstract class DragTool
extends AbstractCursorTool

The default implementation draws a selection box, but this can be overridden (even to draw nothing).

Nested Class Summary

Nested classes/interfaces inherited from class AbstractCursorTool

AbstractCursorTool.Listener

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_VIEW_CLICK_BUFFER
protected org.locationtech.jts.geom.Coordinate	modelDestination	Modify using #setDestination
protected org.locationtech.jts.geom.Coordinate	modelSource	Modify using #setSource

Fields inherited from class AbstractCursorTool

isLinuxOS, panel

Constructor Summary

Constructors

Constructor	Description
DragTool(WorkbenchContext context)

Method Summary

Modifier and Type	Method	Description
void	deactivate()
protected org.locationtech.jts.geom.Envelope	getBoxInModelCoordinates()
protected org.locationtech.jts.geom.Coordinate	getModelDestination()
protected org.locationtech.jts.geom.Coordinate	getModelSource()
protected Shape	getShape()
protected Shape	getShape(Point2D source, Point2D destination)
protected Point2D	getViewDestination()
protected Point2D	getViewSource()
protected double	modelClickBuffer()
void	mouseDragged(MouseEvent e)
void	mousePressed(MouseEvent e)	Begins handling of the drag.
void	mouseReleased(MouseEvent e)
protected void	setModelDestination(org.locationtech.jts.geom.Coordinate destination)
protected void	setModelSource(org.locationtech.jts.geom.Coordinate source)
protected void	setViewClickBuffer(int clickBuffer)	A click is converted into a box by being expanded by this amount in the four directions.
protected void	setViewDestination(Point2D destination)
protected void	setViewSource(Point2D source)
protected boolean	wasClick()

Methods inherited from class AbstractCursorTool

activate, add, allowSnapping, cancelGesture, check, cleanup, clearImage, clearShape, componentWithFocusIsHandledByCursorTools, createCursor, createCursor, createCursor, createStandardSnappingPolicies, drawImageXOR, drawImageXOR, drawShapeXOR, drawShapeXOR, execute, execute, fireGestureFinished, gestureFinished, getColor, getCursor, getImage, getImagePosition, getName, getPanel, getPanel, getSnapManager, getStroke, getTaskFrame, getWorkbench, getWorkbenchContext, isGestureInProgress, isRightMouseButtonUsed, isRollingBackInvalidEdits, isShapeOnScreen, mouseClicked, mouseEntered, mouseExited, mouseMoved, name, prohibitSnapping, redrawImage, redrawShape, reportNothingToUndoYet, setColor, setControlPressed, setFilling, setPanel, setShiftPressed, setStroke, setup, snap, snap, supportsSnapping, toString, wasControlPressed, wasShiftPressed

Methods inherited from class Object

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

Methods inherited from interface CursorTool

getIcon

Field Details

DEFAULT_VIEW_CLICK_BUFFER

public static final int DEFAULT_VIEW_CLICK_BUFFER

See Also:

• Constant Field Values

modelSource

protected org.locationtech.jts.geom.Coordinate modelSource

Modify using #setSource

modelDestination

protected org.locationtech.jts.geom.Coordinate modelDestination

Modify using #setDestination

Constructor Details

DragTool

public DragTool(WorkbenchContext context)

Method Details

deactivate

public void deactivate()

Specified by:

deactivate in interface CursorTool

Overrides:

deactivate in class AbstractCursorTool

mousePressed

public void mousePressed(MouseEvent e)

Begins handling of the drag. Subclasses can prevent handling of the drag by overriding this method and not calling it.

Specified by:

mousePressed in interface MouseListener

Overrides:

mousePressed in class AbstractCursorTool

setViewClickBuffer

protected void setViewClickBuffer(int clickBuffer)

A click is converted into a box by being expanded by this amount in the four directions.

Parameters:

clickBuffer - buffer size in view coordinates

wasClick

protected boolean wasClick()

getBoxInModelCoordinates

protected org.locationtech.jts.geom.Envelope getBoxInModelCoordinates()
                                                               throws NoninvertibleTransformException

Throws:

NoninvertibleTransformException

modelClickBuffer

protected double modelClickBuffer()

mouseDragged

public void mouseDragged(MouseEvent e)

Specified by:

mouseDragged in interface MouseMotionListener

Overrides:

mouseDragged in class AbstractCursorTool

getModelSource

protected org.locationtech.jts.geom.Coordinate getModelSource()

getModelDestination

protected org.locationtech.jts.geom.Coordinate getModelDestination()

setModelSource

protected void setModelSource(org.locationtech.jts.geom.Coordinate source)

setViewSource

protected void setViewSource(Point2D source)
                      throws NoninvertibleTransformException

Throws:

NoninvertibleTransformException

setViewDestination

protected void setViewDestination(Point2D destination)
                           throws NoninvertibleTransformException

Throws:

NoninvertibleTransformException

setModelDestination

protected void setModelDestination(org.locationtech.jts.geom.Coordinate destination)

mouseReleased

public void mouseReleased(MouseEvent e)

Specified by:

mouseReleased in interface MouseListener

Overrides:

mouseReleased in class AbstractCursorTool

getShape

protected Shape getShape()
                  throws Exception

Specified by:

getShape in class AbstractCursorTool

Returns:

null if nothing should be drawn

Throws:

Exception - if an Exception occurs during Shape construction

getViewSource

protected Point2D getViewSource()
                         throws NoninvertibleTransformException

Throws:

NoninvertibleTransformException

getViewDestination

protected Point2D getViewDestination()
                              throws NoninvertibleTransformException

Throws:

NoninvertibleTransformException

getShape

protected Shape getShape(Point2D source,
 Point2D destination)
                  throws Exception

Parameters:

source - initial position

destination - final position

Returns:

a Rectangle defined by the initial and final position or null if nothing should be drawn

Throws:

Exception - if an Exception occurs during the Rectangle construction