/**************************************************************************************************
 **
 ** $Id: GraphicEvent.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/GraphicEvent.java $
 **
 ** Copyright (C) 2003-2005 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 OpenGIS® consortium
 * @version $Revision: 658 $, $Date: 2006-02-23 12:09:34 +1100 (jeu., 23 févr. 2006) $
 */
public interface GraphicEvent {

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

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

    /**
     * Consumes this GraphicEvent 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();
}

 

Ads help maintain this website.