Class SuperZoomPanTool

java.lang.Object

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

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

org.openjump.core.ui.plugin.view.SuperZoomPanTool

All Implemented Interfaces:

CursorTool, MouseListener, MouseMotionListener, MouseWheelListener, EventListener

public class SuperZoomPanTool
extends DragTool
implements MouseWheelListener

This tool have the following functions: - zoom in/out with left/right mouse click - pan with mouse drag - zoom in/out with mousewheel and then left click for zoom or right click for cancel In wheelMode you can see the new area after zooming. Also known as "Area of interest".

Author:

Matthias Scholz <ms@jammerhund.de>

Nested Class Summary

Nested classes/interfaces inherited from class AbstractCursorTool

AbstractCursorTool.Listener

Field Summary

Fields

Modifier and Type	Field	Description
static Cursor	CURSOR_PAN
static Cursor	CURSOR_WHEEL
static Cursor	CURSOR_ZOOM
static final int	INDICATOR_MODE_IMAGE	The visual indicator (area of interest) is painted as an Image.
static final int	INDICATOR_MODE_SHAPE	The visual indicator (area of interest) is painted as a Shape.
static final double	WHEEL_ZOOM_FACTOR
static final double	ZOOM_IN_FACTOR

Fields inherited from class DragTool

DEFAULT_VIEW_CLICK_BUFFER, modelDestination, modelSource

Fields inherited from class AbstractCursorTool

isLinuxOS, panel

Constructor Summary

Constructors

Constructor	Description
SuperZoomPanTool(WorkbenchContext context)

Method Summary

Modifier and Type	Method	Description
void	activate(LayerViewPanel layerViewPanel)
void	cacheImage()
Image	createImageIfNeeded(Image currImage)	Creates a new Image if currImage doesn't exist or is the wrong size for the panel.
void	deactivate()
protected void	gestureFinished()
boolean	getAnimatingZoom()
Cursor	getCursor()
Icon	getIcon()
protected Image	getImage()	This method have to return an Image as a visual indicator.
protected Point	getImagePosition()	This method have to return the position for the Image.
int	getIndicatorMode()
String	getName()	Returns a very brief description of this CursorTool.
protected Shape	getShape()
protected Shape	getShape(Point2D source, Point2D destination)
boolean	isRightMouseButtonUsed()
void	mouseClicked(MouseEvent e)
void	mouseDragged(MouseEvent e)
void	mouseMoved(MouseEvent e)
void	mousePressed(MouseEvent e)	Begins handling of the drag.
void	mouseReleased(MouseEvent e)
void	mouseWheelMoved(MouseWheelEvent e)
void	redrawIndicator()	Redraws the visual indicator.
boolean	setAnimatingZoom(boolean animating)
void	setIndicatorMode(int indicatorMode)	Sets the indicatorMode.
protected void	zoomAt(Point2D p, double zoomFactor, boolean animatingZoom)

Methods inherited from class DragTool

getBoxInModelCoordinates, getModelDestination, getModelSource, getViewDestination, getViewSource, modelClickBuffer, setModelDestination, setModelSource, setViewClickBuffer, setViewDestination, setViewSource, wasClick

Methods inherited from class AbstractCursorTool

add, allowSnapping, cancelGesture, check, cleanup, clearImage, clearShape, componentWithFocusIsHandledByCursorTools, createCursor, createCursor, createCursor, createStandardSnappingPolicies, drawImageXOR, drawImageXOR, drawShapeXOR, drawShapeXOR, execute, execute, fireGestureFinished, getColor, getPanel, getPanel, getSnapManager, getStroke, getTaskFrame, getWorkbench, getWorkbenchContext, isGestureInProgress, isRollingBackInvalidEdits, isShapeOnScreen, mouseEntered, mouseExited, 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

Field Details

WHEEL_ZOOM_FACTOR

public static final double WHEEL_ZOOM_FACTOR

See Also:

• Constant Field Values

ZOOM_IN_FACTOR

public static final double ZOOM_IN_FACTOR

See Also:

• Constant Field Values

CURSOR_ZOOM

public static Cursor CURSOR_ZOOM

CURSOR_PAN

public static Cursor CURSOR_PAN

CURSOR_WHEEL

public static Cursor CURSOR_WHEEL

INDICATOR_MODE_SHAPE

public static final int INDICATOR_MODE_SHAPE

The visual indicator (area of interest) is painted as a Shape.

See Also:

• Constant Field Values

INDICATOR_MODE_IMAGE

public static final int INDICATOR_MODE_IMAGE

The visual indicator (area of interest) is painted as an Image.

See Also:

• Constant Field Values

Constructor Details

SuperZoomPanTool

public SuperZoomPanTool(WorkbenchContext context)

Method Details

activate

public void activate(LayerViewPanel layerViewPanel)

Specified by:

activate in interface CursorTool

Overrides:

activate in class AbstractCursorTool

deactivate

public void deactivate()

Specified by:

deactivate in interface CursorTool

Overrides:

deactivate in class DragTool

mouseWheelMoved

public void mouseWheelMoved(MouseWheelEvent e)

Specified by:

mouseWheelMoved in interface MouseWheelListener

getShape

protected Shape getShape()
                  throws Exception

Overrides:

getShape in class DragTool

Returns:

null if nothing should be drawn

Throws:

Exception - if an Exception occurs during Shape construction

getImage

protected Image getImage()

Description copied from class: AbstractCursorTool

This method have to return an Image as a visual indicator. Usually this method should to be abstract. But if we do this here, many other derived classes have to implement this method. Thereby we would break the compatibility for many other classes in OJ and 3rd party plugins.

Overrides:

getImage in class AbstractCursorTool

Returns:

a Image or null if nothing should be drawn.

getImagePosition

protected Point getImagePosition()

Description copied from class: AbstractCursorTool

This method have to return the position for the Image. The position is the top left corner of the image for the Graphics2D.drawImage() method. This method is called after the AbstractCursorTool.getImage() method. For the abstract problematic please see AbstractCursorTool.getImage().

Overrides:

getImagePosition in class AbstractCursorTool

Returns:

the position for the Image

mouseMoved

public void mouseMoved(MouseEvent e)

Specified by:

mouseMoved in interface MouseMotionListener

Overrides:

mouseMoved in class AbstractCursorTool

mouseClicked

public void mouseClicked(MouseEvent e)

Specified by:

mouseClicked in interface MouseListener

Overrides:

mouseClicked in class AbstractCursorTool

mousePressed

public void mousePressed(MouseEvent e)

Description copied from class: DragTool

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 DragTool

isRightMouseButtonUsed

public boolean isRightMouseButtonUsed()

Specified by:

isRightMouseButtonUsed in interface CursorTool

Overrides:

isRightMouseButtonUsed in class AbstractCursorTool

Returns:

true if this CursorTool uses the right mouse button; false to allow the panel to show a popup-menu on right-clicks

getCursor

public Cursor getCursor()

Specified by:

getCursor in interface CursorTool

Overrides:

getCursor in class AbstractCursorTool

getIcon

public Icon getIcon()

Specified by:

getIcon in interface CursorTool

Returns:

null to use a default icon

getName

public String getName()

Description copied from interface: CursorTool

Returns a very brief description of this CursorTool.

Specified by:

getName in interface CursorTool

Overrides:

getName in class AbstractCursorTool

Returns:

the name of this CursorTool

mouseDragged

public void mouseDragged(MouseEvent e)

Specified by:

mouseDragged in interface MouseMotionListener

Overrides:

mouseDragged in class DragTool

mouseReleased

public void mouseReleased(MouseEvent e)

Specified by:

mouseReleased in interface MouseListener

Overrides:

mouseReleased in class DragTool

getShape

protected Shape getShape(Point2D source,
 Point2D destination)

Overrides:

getShape in class DragTool

Parameters:

source - initial position

destination - final position

Returns:

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

gestureFinished

protected void gestureFinished()
                        throws NoninvertibleTransformException

Specified by:

gestureFinished in class AbstractCursorTool

Throws:

NoninvertibleTransformException

createImageIfNeeded

public Image createImageIfNeeded(Image currImage)

Creates a new Image if currImage doesn't exist or is the wrong size for the panel.

Parameters:

currImage - an image buffer

Returns:

a new image, or the existing one if it's compatible

cacheImage

public void cacheImage()

setAnimatingZoom

public boolean setAnimatingZoom(boolean animating)

getAnimatingZoom

public boolean getAnimatingZoom()

zoomAt

protected void zoomAt(Point2D p,
 double zoomFactor,
 boolean animatingZoom)
               throws NoninvertibleTransformException

Throws:

NoninvertibleTransformException

redrawIndicator

public void redrawIndicator()

Redraws the visual indicator. This can be a Shape or an Image. It depends of the indicatorMode value.

getIndicatorMode

public int getIndicatorMode()

Returns:

the indicatorMode

setIndicatorMode

public void setIndicatorMode(int indicatorMode)

Sets the indicatorMode. Valid values are INDICATOR_MODE_SHAPE, INDICATOR_MODE_IMAGE.

Parameters:

indicatorMode - the indicatorMode to set