Package com.intellij.openapi.editor.markup

Interface GutterDraggableObject

public interface GutterDraggableObject

Interface which should be implemented to handle drag and drop of gutter icons. An example of a gutter icon which can be dragged and dropped is the breakpoint icon.

See Also:

GutterIconRenderer.getDraggableObject()

Field Summary

Fields

Modifier and Type	Field and Description
static java.awt.datatransfer.DataFlavor	flavor

Method Summary

Modifier and Type	Method and Description
boolean	copy(int line, VirtualFile file, int actionId) Called when the icon is dropped over the specified line.
java.awt.Cursor	getCursor(int line, int actionId) Returns the cursor to show when the drag is over the specified line.
static java.awt.datatransfer.DataFlavor[]	getFlavors()
default void	remove()

Field Detail

flavor

static final java.awt.datatransfer.DataFlavor flavor

Method Detail

copy

boolean copy(int line,
             VirtualFile file,
             int actionId)

Called when the icon is dropped over the specified line.

Parameters:

line - the line over which the icon has been dropped.

file - the DnD target file

actionId - the id of the DnD action DnDConstants.

Returns:

true if the drag and drop operation has completed successfully, false otherwise.

getCursor

java.awt.Cursor getCursor(int line,
                          int actionId)

Returns the cursor to show when the drag is over the specified line.

Parameters:

line - the line over which the drag is performed.

actionId - the id of the DnD action DnDConstants.

Returns:

the cursor to show.

remove

default void remove()

getFlavors

static java.awt.datatransfer.DataFlavor[] getFlavors()