/**************************************************************************************************
 **
 ** $Id: GraphicMouseEvent.java 831 2006-05-01 00:27:23Z Desruisseaux $
 **
 ** $URL: http://svn.code.sf.net/p/geoapi/code/branches/2.0.x/geoapi/src/main/java/org/opengis/go/display/event/GraphicMouseEvent.java $
 **
 ** Copyright (C) 2003-2005 Open GIS Consortium, Inc.
 ** All Rights Reserved. http://www.opengis.org/legal/
 **
 *************************************************************************************************/
package org.opengis.go.display.event;

// J2SE direct dependencies
import java.awt.event.MouseEvent;

/**
 * Provides a common abstraction for the various event objects pertaining
 * to mouse events on a {@link org.opengis.go.display.primitive.Graphic}.
 * 
 * @author OpenGIS® consortium
 * @version $Revision: 658 $, $Date: 2006-02-23 12:09:34 +1100 (jeu., 23 févr. 2006) $
 *
 * @todo This interface wrap a {@link MouseEvent}, which is not used by some toolkit like SWT.
 */
public interface GraphicMouseEvent extends GraphicEvent {
    
    /**
     * Flag for mouse clicked.
     */
    public static final int MOUSE_CLICKED = 0;    
    
    /**
     * Flag for mouse dwelled.
     */
    public static final int MOUSE_DWELLED = 1; 
    
    /**
     * Flag for mouse pressed.
     */   
    public static final int MOUSE_PRESSED = 2;   
    
    /**
     * Flag for mouse released.
     */ 
    public static final int MOUSE_RELEASED = 3;
    
    /**
     * Get the ID flag for this event. Returns {@link MouseEvent#getID()},
     * unless the semantic is not supported by MouseEvent,
     * e.g. {@link #MOUSE_DWELLED}.
     *
     * @todo This specification is incompatible with {@link MouseEvent} constants!
     *       This is because {@link #MOUSE_CLICKED} value is different from
     *       {@link MouseEvent#MOUSE_CLICKED} value, etc.
     */
    public int getID();
    
	/**
     * Returns the MouseEvent that this event references.
     *
     * @return the MouseEvent referenced by this event.
	 */
	public MouseEvent getMouseEvent();
	
}



 

Ads help maintain this website.