sc.fiji.snt.gui

Class FileDrop

java.lang.Object

sc.fiji.snt.gui.FileDrop

public class FileDrop
extends java.lang.Object

This class makes it easy to drag and drop files from the operating system to a Java program. Any java.awt.Component can be dropped onto, but only javax.swing.JComponents will indicate the drop event with a changed border.

To use this class, construct a new FileDrop by passing it the target component and a Listener to receive notification when file(s) have been dropped. Here is an example:

      JPanel myPanel = new JPanel();
      new FileDrop( myPanel, new FileDrop.Listener()
      {   public void filesDropped( java.io.File[] files )
          {   
              // handle file drop
              ...
          }   // end filesDropped
      }); // end FileDrop.Listener
 

You can specify the border that will appear when files are being dragged by calling the constructor with a javax.swing.border.Border. Only JComponents will show any indication with a border.

You can turn on some debugging features by passing a PrintStream object (such as System.out) into the full constructor. A null value will result in no extra debugging information being output.

I'm releasing this code into the Public Domain. Enjoy.

Original author: Robert Harder, rob@iharder.net

Additional support:

• September 2007, Nathan Blomquist -- Linux (KDE/Gnome) support added.
• December 2010, Joshua Gerth
• June 2019, TF, Adjust defaultBorderColor. Code cleanup. Added the ability to abort drop operation using Esc

Version:

1.1.1

Author:

Robert Harder, rharder@users.sf.net

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	FileDrop.Listener Implement this inner interface to listen for when files are dropped.

Constructor Summary

Constructors

Constructor and Description
FileDrop(java.awt.Component c, FileDrop.Listener listener) Constructs a FileDrop with a default light-blue border and, if c is a Container, recursively sets all elements contained within as drop targets, though only the top level container will change borders.

Method Summary

Modifier and Type	Method and Description
static boolean	remove(java.awt.Component c) Removes the drag-and-drop hooks from the component and optionally from the all children.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FileDrop

public FileDrop(java.awt.Component c,
                FileDrop.Listener listener)

Constructs a FileDrop with a default light-blue border and, if c is a Container, recursively sets all elements contained within as drop targets, though only the top level container will change borders.

Parameters:

c - Component on which files will be dropped.

listener - Listens for filesDropped.

Since:

1.0

Method Detail

remove

public static boolean remove(java.awt.Component c)

Removes the drag-and-drop hooks from the component and optionally from the all children. You should call this if you add and remove components after you've set up the drag-and-drop. This will recursively unregister all components contained within c if c is a Container.

Parameters:

c - The component to unregister as a drop target

Since:

1.0