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.event.MouseEvent;
import java.awt.geom.Point2D;

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, Point2D 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 performWindow(XMapPane mapPane, MouseEvent ev, Point2D dragStartPos, DirectPosition startCoord, DirectPosition endCoord);
}
1	/*******************************************************************************
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	import java.awt.event.MouseEvent;
33	import java.awt.geom.Point2D;
34
35	import org.opengis.geometry.DirectPosition;
36
37	import schmitzm.swing.event.MouseInputType;
38
39	/**
40	* Defines an action (e.g. Zoom in, zoom out, drag) when a click, drag or
41	* window selection is performed on a {@link XMapPane}.
42	* @author <a href="mailto:[email protected]">Martin Schmitz</a> (University of Bonn/Germany)
43	*/
44	public interface XMapPaneAction {
45
46	/**
47	* Defines the action in case of a single click on the map. Called by
48	* ### XMapPaneMouseAdapter ### on {@link MouseInputType#LClick} and
49	* {@link MouseInputType#RClick}.
50	* @param mapPane map pane the action should be performed on
51	* @param ev mouse event of the action
52	* @param coord geo coordinate the click is performed on
53	*/
54	public void performClick(XMapPane mapPane, MouseEvent ev, DirectPosition coord);
55
56	/**
57	* Defines the action in case of a mouse drag on the map. This method
58	* is called on every mouse motion.
59	* @param mapPane map pane the action should be performed on
60	* @param ev mouse event of the action
61	* @param dragStartPos window position the drag was started (the current
62	* position can be determined from the mouse event)
63	* @param startCoord geo coordinate the drag was started
64	* @param endCoord geo coordinate the drag is currently moved over
65	*/
66	public void performDragging(XMapPane mapPane, MouseEvent ev, Point2D dragStartPos, DirectPosition startCoord, DirectPosition endCoord);
67
68	/**
69	* Defines the action in case of a window selection on the map (the moment
70	* a drag ends).
71	* @param mapPane map pane the action should be performed on
72	* @param ev mouse event of the action
73	* @param dragStartPos window position the window starts (the end
74	* position can be determined from the mouse event)
75	* @param startCoord geo coordinate the window starts
76	* @param endCoord geo coordinate the window ends
77	*/
78	public void performWindow(XMapPane mapPane, MouseEvent ev, Point2D dragStartPos, DirectPosition startCoord, DirectPosition endCoord);
79	}