/*
Copyright 2008-2012 Gephi
Authors : Eduardo Ramos
Website : http://www.gephi.org
This file is part of Gephi.
DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
Copyright 2011 Gephi Consortium. All rights reserved.
The contents of this file are subject to the terms of either the GNU
General Public License Version 3 only ("GPL") or the Common
Development and Distribution License("CDDL") (collectively, the
"License"). You may not use this file except in compliance with the
License. You can obtain a copy of the License at
http://gephi.org/about/legal/license-notice/
or /cddl-1.0.txt and /gpl-3.0.txt. See the License for the
specific language governing permissions and limitations under the
License. When distributing the software, include this License Header
Notice in each file and include the License files at
/cddl-1.0.txt and /gpl-3.0.txt. If applicable, add the following below the
License Header, with the fields enclosed by brackets [] replaced by
your own identifying information:
"Portions Copyrighted [year] [name of copyright owner]"
If you wish your version of this file to be governed by only the CDDL
or only the GPL Version 3, indicate your decision by adding
"[Contributor] elects to include this software in this distribution
under the [CDDL or GPL Version 3] license." If you do not indicate a
single choice of license, a recipient has the option to distribute
your version of this file under either the CDDL, the GPL Version 3 or
to extend the choice of license to its licensees as provided above.
However, if you add GPL Version 3 code and therefore, elected the GPL
Version 3 license, then the option applies only if the new code is
made subject to such option by the copyright holder.
Contributor(s):
Portions Copyrighted 2012 Gephi Consortium.
*/
package org.gephi.preview.spi;
import org.gephi.preview.api.PreviewMouseEvent;
import org.gephi.preview.api.PreviewProperties;
import org.gephi.project.api.Workspace;
/**
* <p>Listener for mouse events in Preview.</p>
* <p>Listeners will <b>always</b> receive left mouse button events. Right button is reserved for zooming and moving the canvas</p>
*
* <p>In order to enable a <code>PreviewMouseListener</code>, annotate it with <code>ServiceProvider</code> annotation and implement <code>MouseResponsiveRenderer</code>
* in a <code>Renderer</code> and return true for the listener in the <code>needsPreviewMouseListener</code> method.</p>
* @author Eduardo Ramos
*/
public interface PreviewMouseListener {
/**
* A single click event.
* @param event Mouse event
* @param properties Preview properties for the workspace
* @param workspace Current workspace
*/
public void mouseClicked(PreviewMouseEvent event, PreviewProperties properties, Workspace workspace);
/**
* A mouse press event. If your listener needs to receive drag or release events, you <b>must</b> mark the previous press event as consumed.
* @param event Mouse event
* @param properties Preview properties for the workspace
* @param workspace Current workspace
*/
public void mousePressed(PreviewMouseEvent event, PreviewProperties properties, Workspace workspace);
/**
* If your listener needs to receive drag events, you <b>must</b> mark the previous press event as consumed.
* @param event Mouse event
* @param properties Preview properties for the workspace
* @param workspace Current workspace
*/
public void mouseDragged(PreviewMouseEvent event, PreviewProperties properties, Workspace workspace);
/**
* If your listener needs to receive release events, you <b>must</b> mark the previous press event as consumed.
* @param event Mouse event
* @param properties Preview properties for the workspace
* @param workspace Current workspace
*/
public void mouseReleased(PreviewMouseEvent event, PreviewProperties properties, Workspace workspace);
}