TripleClickConnector.java

/** 
 * This file Copyright (c) 2005-2007 Aptana, Inc. This program is
 * dual-licensed under both the Aptana Public License and the GNU General
 * Public license. You may elect to use one or the other of these licenses.
 * 
 * This program is distributed in the hope that it will be useful, but
 * AS-IS and WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE, TITLE, or
 * NONINFRINGEMENT. Redistribution, except as permitted by whichever of
 * the GPL or APL you select, is prohibited.
 *
 * 1. For the GPL license (GPL), you can redistribute and/or modify this
 * program under the terms of the GNU General Public License,
 * Version 3, as published by the Free Software Foundation.  You should
 * have received a copy of the GNU General Public License, Version 3 along
 * with this program; if not, write to the Free Software Foundation, Inc., 51
 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 * 
 * Aptana provides a special exception to allow redistribution of this file
 * with certain Eclipse Public Licensed code and certain additional terms
 * pursuant to Section 7 of the GPL. You may view the exception and these
 * terms on the web at http://www.aptana.com/legal/gpl/.
 * 
 * 2. For the Aptana Public License (APL), this program and the
 * accompanying materials are made available under the terms of the APL
 * v1.0 which accompanies this distribution, and is available at
 * http://www.aptana.com/legal/apl/.
 * 
 * You may view the GPL, Aptana's exception and additional terms, and the
 * APL in the file titled license.html at the root of the corresponding
 * plugin containing this source file.
 * 
 * Any modifications to this file must keep this entire header intact.
 */
package com.aptana.ide.editors.unified;

import org.eclipse.swt.events.MouseAdapter;
import org.eclipse.swt.events.MouseEvent;
import org.eclipse.swt.events.MouseListener;
import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Event;

/**
 * Triple click listener. Should be subclassesd and passes as a mouse listener
 * to any mouse event emitter.
 * @author Denis Denisenko
 */
public abstract class TripleClickConnector extends MouseAdapter implements MouseListener
{
    /**
     * Max timeout of the whole triple-click in milliseconds.
     */
    private static final int MAX_TIMEOUT = 1000;
    
    /**
     * First click time.
     */
    private int clickTime1 = -1;
    
    /**
     * Second click time.
     */
    private int clickTime2 = -1;
    
    /**
     * Is called when triple click listener decides that triple click was done. 
     * @param e - last mouse event that is the final click in a triple sequence.
     */
    public abstract void mouseTripleClick(MouseEvent e);
    
	@Override
	public void mouseUp(MouseEvent e) {
		int currentClickTime = e.time;
		
		//checking whether platform supports triple clicks.
		boolean platformSupportsTripleClicks = true;
        try {
			MouseEvent.class.getField("count"); //$NON-NLS-1$
		} catch (SecurityException e1) {
			return;
		} catch (NoSuchFieldException e1) {
			platformSupportsTripleClicks = false;
		}
		
		//if platform supports triple clicks, we have nothing to do
		if (platformSupportsTripleClicks)
		{
			return;
		}
		
        if(clickTime1 != -1 && clickTime2 != -1)
        {
            if (currentClickTime > clickTime1 && currentClickTime - clickTime1 <= MAX_TIMEOUT
                    && currentClickTime > clickTime2 && currentClickTime - clickTime2 <= MAX_TIMEOUT)
            {
                clickTime1 = -1;
                clickTime2 = -1;
                
                final MouseEvent event = e;
                Display.getCurrent().asyncExec(new Runnable(){

					public void run() {
						mouseTripleClick(event);
					}
                	
                });
                
                return;
            }
        }
        
        clickTime1 = clickTime2;
        clickTime2 = currentClickTime;
	}
}