graphicevent.java

GEo 地理操作源代码

/**************************************************************************************************
 **
 ** $Id: GraphicEvent.java,v 1.3 2004/03/02 03:14:41 gregreynolds Exp $
 **
 ** $Source: /cvsroot/geoapi/src/org/opengis/go/display/event/GraphicEvent.java,v $
 **
 ** Copyright (C) 2003 Open GIS Consortium, Inc. All Rights Reserved. http://www.opengis.org/Legal/
 **
 *************************************************************************************************/
package org.opengis.go.display.event;

// OpenGIS direct dependencies
import org.opengis.go.display.primitive.Graphic;

/**
 * Provides a common abstraction for the various event objects pertaining to
 * key, mouse, other implementation-specific controls, or change 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 $
 */
public interface GraphicEvent {

    //*************************************************************************
    //  methods
    //*************************************************************************

    /**
     * Returns the <code>Graphic</code> this <code>GraphicEvent</code> initially occurred on.
     *
     * @return the <code>Graphic</code> source of this event or <code>null</code> if none.
     */
    public Graphic getGraphic();

    /**
     * Consumes this <code>GraphicEvent</code> so that it will not be 
     * processed in the default manner by the source from which it originated.
     */
    public void consume();

    /**
     * Returns whether or not this event has been consumed.
     *
     * @return the consumed status.
     */
    public boolean isConsumed();
}