skrueger/geotools/XMapPaneAction.java

/*******************************************************************************
 * Copyright (c) 2009 Martin O. J. Schmitz.
 * 
 * This file is part of the SCHMITZM library - a collection of utility 
 * classes based on Java 1.6, focusing (not only) on Java Swing 
 * and the Geotools library.
 * 
 * The SCHMITZM project is hosted at:
 * http://wald.intevation.org/projects/schmitzm/
 * 
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation; either version 3
 * of the License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public License (license.txt)
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 * or try this link: http://www.gnu.org/licenses/lgpl.html
 * 
 * Contributors:
 *     Martin O. J. Schmitz - initial API and implementation
 *     Stefan A. Krüger - additional utility classes
 ******************************************************************************/
package skrueger.geotools;

import java.awt.Point;
import java.awt.event.MouseEvent;
import java.awt.event.MouseWheelEvent;

import org.opengis.geometry.DirectPosition;

import schmitzm.swing.event.MouseInputType;

/**
 * Defines an action (e.g. Zoom in, zoom out, drag) when a click, drag or
 * window selection is performed on a {@link XMapPane}. 
 * @author <a href="mailto:[email protected]">Martin Schmitz</a> (University of Bonn/Germany)
 */
public interface XMapPaneAction {
  
  /**
   * Defines the action in case of a single click on the map. Called by
   * ### XMapPaneMouseAdapter ### on {@link MouseInputType#LClick} and
   * {@link MouseInputType#RClick}.
   * @param mapPane map pane the action should be performed on
   * @param ev      mouse event of the action
   * @param coord   geo coordinate the click is performed on
   */
  public void performClick(XMapPane mapPane, MouseEvent ev, DirectPosition coord);
  
  /**
   * Defines the action in case of a mouse drag on the map. This method
   * is called on every mouse motion.
   * @param mapPane      map pane the action should be performed on
   * @param ev           mouse event of the action
   * @param dragStartPos window position the drag was started (the current
   *                     position can be determined from the mouse event)  
   * @param startCoord   geo coordinate the drag was started
   * @param endCoord     geo coordinate the drag is currently moved over
   */
  public void performDragging(XMapPane mapPane, MouseEvent ev, Point dragStartPos, DirectPosition startCoord, DirectPosition endCoord);

  /**
   * Defines the action in case of a window selection on the map (the moment
   * a drag ends).
   * @param mapPane      map pane the action should be performed on
   * @param ev           mouse event of the action
   * @param dragStartPos window position the window starts (the end
   *                     position can be determined from the mouse event)  
   * @param startCoord   geo coordinate the window starts
   * @param endCoord     geo coordinate the window ends
   */
  public void performDragged(XMapPane mapPane, MouseEvent ev, Point dragStartPos, DirectPosition startCoord, DirectPosition endCoord);

  /**
   * Defines the action in case of a mouse wheel action on the map (the moment
   * a drag ends).
   * @param mapPane      map pane the action should be performed on
   * @param ev           mouse event of the action
   * @param coord        geo coordinate the wheel is turned on
   */
  public void performWheel(XMapPane mapPane, MouseWheelEvent ev, DirectPosition coord);
  
  public static XMapPaneAction_ZoomIn ZOOM_IN = new XMapPaneAction_ZoomIn();

}
1	mojays	630	/*******************************************************************************
2			* Copyright (c) 2009 Martin O. J. Schmitz.
3			*
4			* This file is part of the SCHMITZM library - a collection of utility
5			* classes based on Java 1.6, focusing (not only) on Java Swing
6			* and the Geotools library.
7			*
8			* The SCHMITZM project is hosted at:
9			* http://wald.intevation.org/projects/schmitzm/
10			*
11			* This program is free software; you can redistribute it and/or
12			* modify it under the terms of the GNU Lesser General Public License
13			* as published by the Free Software Foundation; either version 3
14			* of the License, or (at your option) any later version.
15			*
16			* This program is distributed in the hope that it will be useful,
17			* but WITHOUT ANY WARRANTY; without even the implied warranty of
18			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19			* GNU General Public License for more details.
20			*
21			* You should have received a copy of the GNU Lesser General Public License (license.txt)
22			* along with this program; if not, write to the Free Software
23			* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
24			* or try this link: http://www.gnu.org/licenses/lgpl.html
25			*
26			* Contributors:
27			* Martin O. J. Schmitz - initial API and implementation
28			* Stefan A. Krüger - additional utility classes
29			******************************************************************************/
30			package skrueger.geotools;
31
32	alfonx	639	import java.awt.Point;
33	mojays	630	import java.awt.event.MouseEvent;
34	mojays	634	import java.awt.event.MouseWheelEvent;
35	mojays	630
36			import org.opengis.geometry.DirectPosition;
37
38	mojays	631	import schmitzm.swing.event.MouseInputType;
39
40	mojays	630	/**
41	mojays	631	* Defines an action (e.g. Zoom in, zoom out, drag) when a click, drag or
42			* window selection is performed on a {@link XMapPane}.
43	mojays	630	* @author <a href="mailto:[email protected]">Martin Schmitz</a> (University of Bonn/Germany)
44			*/
45			public interface XMapPaneAction {
46
47			/**
48	mojays	631	* Defines the action in case of a single click on the map. Called by
49			* ### XMapPaneMouseAdapter ### on {@link MouseInputType#LClick} and
50			* {@link MouseInputType#RClick}.
51	mojays	630	* @param mapPane map pane the action should be performed on
52			* @param ev mouse event of the action
53			* @param coord geo coordinate the click is performed on
54			*/
55			public void performClick(XMapPane mapPane, MouseEvent ev, DirectPosition coord);
56
57			/**
58			* Defines the action in case of a mouse drag on the map. This method
59			* is called on every mouse motion.
60			* @param mapPane map pane the action should be performed on
61			* @param ev mouse event of the action
62			* @param dragStartPos window position the drag was started (the current
63			* position can be determined from the mouse event)
64			* @param startCoord geo coordinate the drag was started
65			* @param endCoord geo coordinate the drag is currently moved over
66			*/
67	alfonx	639	public void performDragging(XMapPane mapPane, MouseEvent ev, Point dragStartPos, DirectPosition startCoord, DirectPosition endCoord);
68	mojays	630
69			/**
70			* Defines the action in case of a window selection on the map (the moment
71			* a drag ends).
72			* @param mapPane map pane the action should be performed on
73			* @param ev mouse event of the action
74			* @param dragStartPos window position the window starts (the end
75			* position can be determined from the mouse event)
76			* @param startCoord geo coordinate the window starts
77			* @param endCoord geo coordinate the window ends
78			*/
79	alfonx	639	public void performDragged(XMapPane mapPane, MouseEvent ev, Point dragStartPos, DirectPosition startCoord, DirectPosition endCoord);
80	mojays	634
81			/**
82			* Defines the action in case of a mouse wheel action on the map (the moment
83			* a drag ends).
84			* @param mapPane map pane the action should be performed on
85			* @param ev mouse event of the action
86			* @param coord geo coordinate the wheel is turned on
87			*/
88			public void performWheel(XMapPane mapPane, MouseWheelEvent ev, DirectPosition coord);
89	alfonx	639
90			public static XMapPaneAction_ZoomIn ZOOM_IN = new XMapPaneAction_ZoomIn();
91	mojays	634
92	mojays	630	}