graphicmouseevent.java

GEo 地理操作源代码

/**************************************************************************************************
 **
 ** $Id: GraphicMouseEvent.java,v 1.3 2004/03/02 03:14:41 gregreynolds Exp $
 **
 ** $Source: /cvsroot/geoapi/src/org/opengis/go/display/event/GraphicMouseEvent.java,v $
 **
 ** Copyright (C) 2003 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 <A HREF="http://www.opengis.org">OpenGIS&reg; consortium</A>
 * @version $Revision: 1.3 $, $Date: 2004/03/02 03:14:41 $
 *
 * @revisit 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 <code>MouseEvent</code>,
     * e.g. {@link #MOUSE_DWELLED}.
     *
     * @revisit 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 <code>MouseEvent</code> that this event references.
     *
     * @return the <code>MouseEvent</code> referenced by this event.
         */
        public MouseEvent getMouseEvent();
        
}