org.eclipse.gmf.runtime.common.ui.services.dnd/src/org/eclipse/gmf/runtime/common/ui/services/dnd/core/ITransferAgent.java

/******************************************************************************
 * Copyright (c) 2002, 2005 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.gmf.runtime.common.ui.services.dnd.core;

import org.eclipse.jface.viewers.ISelection;
import org.eclipse.swt.dnd.Transfer;
import org.eclipse.swt.dnd.TransferData;

/**
 * Interface to be implemented by providers of new transfer agents for drag and
 * drop operations
 * 
 * @author Vishy Ramaswamy
 */
public interface ITransferAgent {

	/**
	 * Returns the unique id for this transfer agent
	 * 
	 * @return String the transfer id
	 */
	public String getTransferId();

	/**
	 * Returns the transfer agent
	 * 
	 * @return Transfer the transfer
	 */
	public Transfer getTransfer();

	/**
	 * Returns a boolean indicating whether the transfer agent is selection
	 * transfer
	 * 
	 * @return boolean true or false
	 */
	public boolean isSelectionType();

	/**
	 * Set the selection if the transfer is a selection transfer
	 * 
	 * @param selection
	 *            The selection to be set
	 */
	public void setSelection(ISelection selection);

	/**
	 * Return the selection if the transfer is a selection transfer
	 * 
	 * @param transferData
	 *            the platform specific representation of the data to be
	 *            converted
	 * @return ISelection the selection
	 */
	public ISelection getSelection(TransferData transferData);
}