org.scijava.ui.dnd
Interface DragAndDropService

All Superinterfaces:

Comparable<Prioritized>, Contextual, Disposable, HandlerService<Object,DragAndDropHandler<Object>>, HasPluginInfo, Prioritized, PTService<DragAndDropHandler<Object>>, RichPlugin, SciJavaPlugin, SciJavaService, Service, SingletonService<DragAndDropHandler<Object>>, Typed<Object>, TypedService<Object,DragAndDropHandler<Object>>

All Known Implementing Classes:

DefaultDragAndDropService

public interface DragAndDropService
extends HandlerService<Object,DragAndDropHandler<Object>>, SciJavaService

Interface for service that handles drag and drop events.

Author:

Curtis Rueden

Method Summary

boolean	drop(DragAndDropData data, Display<?> display) Performs a drag-and-drop operation in the given display with the specified DragAndDropData, using the first available compatible handler.
boolean	drop(Object data, Display<?> display) Performs a drag-and-drop operation in the given display with the specified data object, using the first available compatible handler.
DragAndDropHandler<?>	getHandler(DragAndDropData data, Display<?> display) Gets the drag-and-drop handler which will be used to handle the given DragAndDropData dragged onto the specified display.
DragAndDropHandler<?>	getHandler(Object object, Display<?> display) Gets the drag-and-drop handler which will be used to handle the given object dragged onto the specified display.
List<DragAndDropHandler<Object>>	getInstances() Gets the list of available drag-and-drop handlers, which are used to perform drag-and-drop operations.
boolean	supports(DragAndDropData data, Display<?> display) Checks whether the given DragAndDropData can be dropped onto the specified display.
boolean	supports(Object object, Display<?> display) Checks whether the given object can be dropped onto the specified display.

Methods inherited from interface org.scijava.plugin.HandlerService

getHandler, supports

Methods inherited from interface org.scijava.plugin.SingletonService

getInstance

Methods inherited from interface org.scijava.plugin.PTService

getPlugins, getPluginService, getPluginType

Methods inherited from interface org.scijava.service.Service

initialize, registerEventHandlers

Methods inherited from interface org.scijava.Contextual

context, getContext, setContext

Methods inherited from interface org.scijava.Prioritized

getPriority, setPriority

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface org.scijava.plugin.HasPluginInfo

getInfo, setInfo

Methods inherited from interface org.scijava.Disposable

dispose

Methods inherited from interface org.scijava.Typed

getType

Method Detail

supports

boolean supports(DragAndDropData data,
                 Display<?> display)

Checks whether the given DragAndDropData can be dropped onto the specified display. A (data, display) pair is deemed compatible if a compatible handler exists for them.

See Also:

DragAndDropHandler

supports

boolean supports(Object object,
                 Display<?> display)

Checks whether the given object can be dropped onto the specified display. An (object, display) pair is deemed compatible if a compatible handler exists for them.

See Also:

DragAndDropHandler

drop

boolean drop(DragAndDropData data,
             Display<?> display)

Performs a drag-and-drop operation in the given display with the specified DragAndDropData, using the first available compatible handler.

Returns:

true if the drop operation was successful

Throws:

IllegalArgumentException - if the display and/or data object are unsupported, or are incompatible with one another.

See Also:

DragAndDropHandler

drop

boolean drop(Object data,
             Display<?> display)

Performs a drag-and-drop operation in the given display with the specified data object, using the first available compatible handler.

Returns:

true if the drop operation was successful

Throws:

IllegalArgumentException - if the display and/or data object are unsupported, or are incompatible with one another.

See Also:

DragAndDropHandler

getHandler

DragAndDropHandler<?> getHandler(DragAndDropData data,
                                 Display<?> display)

Gets the drag-and-drop handler which will be used to handle the given DragAndDropData dragged onto the specified display.

Returns:

The first compatible drag-and-drop handler, or null if none available.

getHandler

DragAndDropHandler<?> getHandler(Object object,
                                 Display<?> display)

Gets the drag-and-drop handler which will be used to handle the given object dragged onto the specified display.

Returns:

The first compatible drag-and-drop handler, or null if none available.

getInstances

List<DragAndDropHandler<Object>> getInstances()

Gets the list of available drag-and-drop handlers, which are used to perform drag-and-drop operations.

Specified by:

getInstances in interface HandlerService<Object,DragAndDropHandler<Object>>

Specified by:

getInstances in interface SingletonService<DragAndDropHandler<Object>>