org.scijava.ui.dnd.DragAndDropHandler Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of scijava-common Show documentation
SciJava Common is a shared library for SciJava software. It provides a plugin framework, with an extensible mechanism for service discovery, backed by its own annotation processor, so that plugins can be loaded dynamically. It is used by both ImageJ and SCIFIO.
There is a newer version: 2.99.0
Show newest version
/*
 * #%L
 * SciJava Common shared library for SciJava software.
 * %%
 * Copyright (C) 2009 - 2016 Board of Regents of the University of
 * Wisconsin-Madison, Broad Institute of MIT and Harvard, and Max Planck
 * Institute of Molecular Cell Biology and Genetics.
 * %%
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * 
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 * #L%
 */

package org.scijava.ui.dnd;

import org.scijava.display.Display;
import org.scijava.plugin.HandlerPlugin;
import org.scijava.plugin.Plugin;

/**
 * Interface for drag-and-drop handlers. A drag-and-drop handler defines
 * behavior for drag-and-drop operations with respect to a specific sort of
 * objects.
 * 
 * Drag-and-drop handlers discoverable at runtime must implement this interface
 * and be annotated with @{@link Plugin} with attribute {@link Plugin#type()} =
 * {@link DragAndDropHandler}.class. While it possible to create a drag-and-drop
 * handler merely by implementing this interface, it is encouraged to instead
 * extend {@link AbstractDragAndDropHandler}, for convenience.
 * 
 * 
 * @author Curtis Rueden
 * @see Plugin
 * @see DragAndDropService
 */
public interface DragAndDropHandler extends HandlerPlugin {

	/**
	 * Gets whether this handler supports dropping the given data object onto the
	 * specified display.
	 */
	boolean supports(final D dataObject, final Display display);

	/**
	 * Gets whether this handler supports dropping the given
	 * {@link DragAndDropData} onto a compatible display.
	 */
	boolean supportsData(final DragAndDropData data);

	/**
	 * Gets whether this handler supports dropping the given
	 * {@link DragAndDropData} onto the specified display.
	 */
	boolean supportsData(final DragAndDropData data, final Display display);

	/**
	 * Gets whether this handler supports dropping the given object onto a
	 * compatible display.
	 */
	boolean supportsObject(final Object object);

	/**
	 * Gets whether this handler supports dropping the given object onto the
	 * specified display.
	 */
	boolean supportsObject(final Object object, final Display display);

	/**
	 * Gets whether this handler supports dropping an assumed-to-be-compatible
	 * data object onto the given {@link Display}.
	 */
	boolean supportsDisplay(final Display display);

	/**
	 * Converts the given {@link DragAndDropData} to the type of data object
	 * supported by this handler.
	 * 
	 * @throws IllegalArgumentException if the handler does not support the given
	 *           {@link DragAndDropData}.
	 */
	D convertData(final DragAndDropData data);

	/**
	 * Converts the given object to the type of data object supported by this
	 * handler.
	 * 
	 * @throws IllegalArgumentException if the handler does not support the given
	 *           object.
	 */
	D convertObject(final Object object);

	/**
	 * Performs a drop operation with the given data object in the specified
	 * {@link Display}.
	 * 
	 * @throws IllegalArgumentException if the handler is not compatible with the
	 *           given data/display combination.
	 */
	boolean drop(final D dataObject, final Display display);

	/**
	 * Performs a drop operation with the given data in the specified
	 * {@link Display}.
	 * 
	 * @throws IllegalArgumentException if the handler is not compatible with the
	 *           given data/display combination.
	 */
	boolean dropData(final DragAndDropData data, final Display display);

	/**
	 * Performs a drop operation with the given data in the specified
	 * {@link Display}.
	 * 
	 * @throws IllegalArgumentException if the handler is not compatible with the
	 *           given data/display combination.
	 */
	boolean dropObject(final Object object, final Display display);

	// NB: Javadoc overrides.

	// -- Typed methods --

	/**
	 * Gets whether this handler supports dropping the given data object onto a
	 * compatible display.
	 */
	@Override
	boolean supports(final D dataObject);

}