org.geotools.swt.tool
Class ZoomOutTool

Object
  extended by MapMouseAdapter
      extended by CursorTool
          extended by AbstractZoomTool
              extended by ZoomOutTool
All Implemented Interfaces:
MapMouseListener

public class ZoomOutTool
extends AbstractZoomTool

A zoom-out tool for JMapPane.

For mouse clicks, the display will be zoomed-out such that the map centre is the position of the mouse click and the map width and height are calculated as:

   len = len.old * z 
where z is the linear zoom increment (>= 1.0)

Since:
2.6
Author:
Michael Bedward, Andrea Antonello (www.hydrologis.com)

Field Summary
static String TOOL_NAME
          Tool name
static String TOOL_TIP
          Tool tip text
 
Fields inherited from class AbstractZoomTool
DEFAULT_ZOOM_FACTOR, zoom
 
Fields inherited from class CursorTool
ANY_BUTTON
 
Constructor Summary
ZoomOutTool()
          Constructs a new zoom out tool which is triggered by any mouse button.
ZoomOutTool(int triggerButtonMask)
          Constructs a new zoom out tool.
 
Method Summary
 boolean canDraw()
          Checks if the tool can draw when dragging.
 boolean canMove()
          Checks if the tool can move the map when dragging.
 Cursor getCursor()
          Get the mouse cursor for this tool
 void onMouseClicked(MapMouseEvent ev)
          Zoom out by the currently set increment, with the map centred at the location (in world coords) of the mouse click
 
Methods inherited from class AbstractZoomTool
getZoom, setZoom
 
Methods inherited from class CursorTool
getMapPane, isDrawing, isTriggerMouseButton, setMapPane
 
Methods inherited from class MapMouseAdapter
onMouseDragged, onMouseEntered, onMouseExited, onMouseMoved, onMousePressed, onMouseReleased, onMouseWheelMoved
 
Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

TOOL_NAME

public static final String TOOL_NAME
Tool name


TOOL_TIP

public static final String TOOL_TIP
Tool tip text

Constructor Detail

ZoomOutTool

public ZoomOutTool(int triggerButtonMask)
Constructs a new zoom out tool. To activate the tool only on certain mouse events provide a single mask, e.g. SWT.BUTTON1, or a combination of multiple SWT-masks.

Parameters:
triggerButtonMask - Mouse button which triggers the tool's activation or if the tool is to be triggered by any button

ZoomOutTool

public ZoomOutTool()
Constructs a new zoom out tool which is triggered by any mouse button.

Method Detail

onMouseClicked

public void onMouseClicked(MapMouseEvent ev)
Zoom out by the currently set increment, with the map centred at the location (in world coords) of the mouse click

Specified by:
onMouseClicked in interface MapMouseListener
Overrides:
onMouseClicked in class MapMouseAdapter
Parameters:
ev - the mouse event

getCursor

public Cursor getCursor()
Get the mouse cursor for this tool

Overrides:
getCursor in class CursorTool
Returns:
the default cursor

canDraw

public boolean canDraw()
Description copied from class: CursorTool
Checks if the tool can draw when dragging.

Specified by:
canDraw in class CursorTool
Returns:
true if the tool can draw.

canMove

public boolean canMove()
Description copied from class: CursorTool
Checks if the tool can move the map when dragging.

Specified by:
canMove in class CursorTool
Returns:
true if the tool can move the map while dragging.


Copyright © 1996-2014 Geotools. All Rights Reserved.