org.eclipse.ui.internal.dnd.IDropTarget Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gef-gwt

The newest version!

/*******************************************************************************
 * Copyright (c) 2004, 2006 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.ui.internal.dnd;

import org.eclipse.swt.graphics.Cursor;
import org.eclipse.swt.graphics.Rectangle;

/**
 * This interface is used to drop objects. It knows how to drop a particular
 * object in a particular location. IDropTargets are typically created by
 * IDragOverListeners, and it is the job of the IDragOverListener to supply the
 * drop target with information about the object currently being dragged.
 * 
 * @see org.eclipse.ui.internal.dnd.IDragOverListener
 */
public interface IDropTarget {

	/**
	 * Drops the object in this position
	 */
	void drop();

	/**
	 * Returns a cursor describing this drop operation
	 * 
	 * @return a cursor describing this drop operation
	 */
	Cursor getCursor();

	/**
	 * Returns a rectangle (screen coordinates) describing the target location
	 * for this drop operation.
	 * 
	 * @return a snap rectangle or null if this drop target does not have a
	 *         specific snap location.
	 */
	Rectangle getSnapRectangle();
}