/*
 * The Unified Mapping Platform (JUMP) is an extensible, interactive GUI 
 * for visualizing and manipulating spatial features with geometry and attributes.
 *
 * Copyright (C) 2003 Vivid Solutions
 * 
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 * 
 * For more information, contact:
 *
 * Vivid Solutions
 * Suite #1A
 * 2328 Government Street
 * Victoria BC  V8T 5G5
 * Canada
 *
 * (250)385-6040
 * www.vividsolutions.com
 */

package com.vividsolutions.jump.workbench.ui.cursortool;

import java.awt.Cursor;
import java.awt.event.MouseListener;
import java.awt.event.MouseMotionListener;

import javax.swing.Icon;

import com.vividsolutions.jump.workbench.ui.LayerViewPanel;


public interface CursorTool extends MouseListener, MouseMotionListener {
    public Cursor getCursor();

    /**
     * @return null to use a default icon
     */
    public Icon getIcon();

    public void activate(LayerViewPanel layerViewPanel);

    public void deactivate();

    /**
     * @return true if this CursorTool uses the right mouse button; false
     * to allow the panel to show a popup-menu on right-clicks
     */
    public boolean isRightMouseButtonUsed();

    public boolean isGestureInProgress();

    /**
     * Notifies the CursorTool that a party is requesting that the gesture
     * currently in progress be aborted.
     */
    public void cancelGesture();

    /**
     * Returns a very brief description of this CursorTool.
     * @return the name of this CursorTool
     */
    public String getName();
}