/**************************************************************************************************
 **
 ** $Id: CanvasHandler.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/canvas/CanvasHandler.java $
 **
 ** Copyright (C) 2003-2005 Open GIS Consortium, Inc.
 ** All Rights Reserved. http://www.opengis.org/legal/
 **
 *************************************************************************************************/
package org.opengis.go.display.canvas;

/**
 * The CanvasHandler interface provides programmers with a 
 * mechanism to change Canvas properties.  When a handler is 
 * passed in to Canvas.enableHandler(CanvasHandler), the 
 * Canvas will give it the active 
 * CanvasController.  The active controller allows the handler to
 * change the canvas, until the handler is removed.
 *
 * @author Open GIS Consortium, Inc.
 * @version $Revision: 658 $, $Date: 2006-02-23 12:09:34 +1100 (jeu., 23 févr. 2006) $
 */
public interface CanvasHandler {

    /**
     * Enables this CanvasHandler, giving it the active 
     * CanvasController and thus the ability to modify the 
     * Canvas that enabled it.
     * @param controller the active CanvasController.
     */
    public void handlerEnabled(CanvasController controller);

    /**
     * Removes this CanvasHandler, meaning that calling methods
     * on its CanvasController will no longer affect the 
     * Canvas.  A CanvasHandler should 
     * never attempt to re-enable itself after it has been removed.
     */
    public void handlerRemoved();

}
 

Ads help maintain this website.