// $Id: UMLLinkMouseListener.java,v 1.2 2004/09/13 19:21:23 mvw Exp $
// Copyright (c) 1996-2004 The Regents of the University of California. All
// Rights Reserved. Permission to use, copy, modify, and distribute this
// software and its documentation without fee, and without a written
// agreement is hereby granted, provided that the above copyright notice
// and this paragraph appear in all copies.  This software program and
// documentation are copyrighted by The Regents of the University of
// California. The software program and documentation are supplied "AS
// IS", without any accompanying services from The Regents. The Regents
// does not warrant that the operation of the program will be
// uninterrupted or error-free. The end-user understands that the program
// was developed for research purposes and is advised not to rely
// exclusively on the program for any reason.  IN NO EVENT SHALL THE
// UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT,
// SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS,
// ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
// THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
// SUCH DAMAGE. THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY
// WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
// PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
// CALIFORNIA HAS NO OBLIGATIONS TO PROVIDE MAINTENANCE, SUPPORT,
// UPDATES, ENHANCEMENTS, OR MODIFICATIONS.

//$Id: UMLLinkMouseListener.java,v 1.2 2004/09/13 19:21:23 mvw Exp $
package org.argouml.uml.ui;

import java.awt.event.MouseEvent;
import java.awt.event.MouseListener;

import javax.swing.SwingUtilities;

import org.argouml.ui.targetmanager.TargetManager;

/**
 * A mouselistener that implements behaviour 
 * to navigate to a selected modelelement
 * on double click of the left mousebutton.
 * 
 * @since Juli 9, 2004
 * @author jaap.branderhorst@xs4all.nl
 */
public class UMLLinkMouseListener implements MouseListener {
    
    private Object selectedValue = null;
    
    /**
     * The graphical object for which this mouselistener is registrated.
     */
    private Object owner = null;
    
    /**
     * The total amount of mouseclicks the user has to do, 
     * to go to the selected element.
     */
    private int numberOfMouseClicks;
    
    /**
     * The constructor.
     * 
     * @param theOwner the graphical object for which 
     *                 this mouselistener is registered
     */
    public UMLLinkMouseListener(Object theOwner) {
        this(theOwner, 2);
    }
    
    /**
     * The constructor.
     * 
     * @param theOwner the graphical object for which 
     *                 this mouselistener is registered
     * @param numberOfmouseClicks the total amount of mouseclicks the user 
     *                            has to do, to go to the selected element
     */
    public UMLLinkMouseListener(Object theOwner, int numberOfmouseClicks) {
        owner = theOwner;
        numberOfMouseClicks = numberOfmouseClicks;
    }

    /**
     * @see java.awt.event.MouseListener#mouseClicked(
     *          java.awt.event.MouseEvent)
     */
    public void mouseClicked(MouseEvent e) {       
        if (e.getClickCount() >= numberOfMouseClicks
                && SwingUtilities.isLeftMouseButton(e)) {
            
            Object o = getSelectedValue();
            if (org.argouml.model.ModelFacade.isAModelElement(o)) {
                TargetManager.getInstance().setTarget(o);
            }
            e.consume();       
        }         
            
    }

    /**
     * @see java.awt.event.MouseListener#mouseEntered(java.awt.event.MouseEvent)
     */
    public void mouseEntered(MouseEvent e) {
    }

    /**
     * @see java.awt.event.MouseListener#mouseExited(java.awt.event.MouseEvent)
     */
    public void mouseExited(MouseEvent e) {
    }

    /**
     * @see java.awt.event.MouseListener#mousePressed(java.awt.event.MouseEvent)
     */
    public void mousePressed(MouseEvent e) {
    }

    /**
     * @see java.awt.event.MouseListener#mouseReleased(
     *          java.awt.event.MouseEvent)
     */
    public void mouseReleased(MouseEvent e) {
    }
    /**
     * @return Returns the selectedValue.
     */
    public Object getSelectedValue() {
        return selectedValue;
    }
    /**
     * @param v The selectedValue to set.
     */
    public void setSelectedValue(Object v) {
        selectedValue = v;
    }
}