Package jmri.util.iharder.dnd

Class URIDrop

java.lang.Object

jmri.util.iharder.dnd.URIDrop

public class URIDrop
extends java.lang.Object

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

To use this class, construct a new URIDrop 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 URIDrop( myPanel, new URIDrop.Listener() { public void filesDropped( java.io.File[] files ) { // handle file drop ... } });

You can specify the border that will appear when files are being dragged by calling the constructor with a 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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	URIDrop.Listener	Implement this inner interface to listen for when uris are dropped.
static interface	URIDrop.ListenerExt

Constructor Summary

Constructors

Constructor	Description
URIDrop(java.awt.Component c, boolean recursive, URIDrop.Listener listener)	Constructor with a default border and the option to recursively set drop targets.
URIDrop(java.awt.Component c, javax.swing.border.Border dragBorder, boolean recursive, URIDrop.Listener listener)	Constructor with a specified border and the option to recursively set drop targets.
URIDrop(java.awt.Component c, javax.swing.border.Border dragBorder, URIDrop.Listener listener)	Constructor with a specified border
URIDrop(java.awt.Component c, URIDrop.Listener listener)	Constructs a URIDrop 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.
URIDrop(java.io.PrintStream out, java.awt.Component c, boolean recursive, URIDrop.Listener listener)	Constructor with a default border, debugging optionally turned on and the option to recursively set drop targets.
URIDrop(java.io.PrintStream out, java.awt.Component c, javax.swing.border.Border dragBorder, boolean recursive, URIDrop.Listener listener)	Full constructor with a specified border and debugging optionally turned on.
URIDrop(java.io.PrintStream out, java.awt.Component c, javax.swing.border.Border dragBorder, URIDrop.Listener listener)	Constructor with a specified border and debugging optionally turned on.

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

URIDrop

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

Constructs a URIDrop 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

URIDrop

public URIDrop(java.awt.Component c,
               boolean recursive,
               URIDrop.Listener listener)

Constructor with a default border and the option to recursively set drop targets. If your component is a Container, then each of its children components will also listen for drops, though only the parent will change borders.

Parameters:

c - Component on which files will be dropped.

recursive - Recursively set children as drop targets.

listener - Listens for filesDropped.

Since:

1.0

URIDrop

public URIDrop(java.io.PrintStream out,
               java.awt.Component c,
               boolean recursive,
               URIDrop.Listener listener)

Constructor with a default border, debugging optionally turned on and the option to recursively set drop targets. If your component is a Container, then each of its children components will also listen for drops, though only the parent will change borders. With Debugging turned on, more status messages will be displayed to out. A common way to use this constructor is with System.out or System.err. A null value for the parameter out will result in no debugging output.

Parameters:

out - PrintStream to record debugging info or null for no debugging.

c - Component on which files will be dropped.

recursive - Recursively set children as drop targets.

listener - Listens for filesDropped.

Since:

1.0

URIDrop

public URIDrop(java.awt.Component c,
               javax.swing.border.Border dragBorder,
               URIDrop.Listener listener)

Constructor with a specified border

Parameters:

c - Component on which files will be dropped.

dragBorder - Border to use on JComponent when dragging occurs.

listener - Listens for filesDropped.

Since:

1.0

URIDrop

public URIDrop(java.awt.Component c,
               javax.swing.border.Border dragBorder,
               boolean recursive,
               URIDrop.Listener listener)

Constructor with a specified border and the option to recursively set drop targets. If your component is a Container, then each of its children components will also listen for drops, though only the parent will change borders.

Parameters:

c - Component on which files will be dropped.

dragBorder - Border to use on JComponent when dragging occurs.

recursive - Recursively set children as drop targets.

listener - Listens for filesDropped.

Since:

1.0

URIDrop

public URIDrop(java.io.PrintStream out,
               java.awt.Component c,
               javax.swing.border.Border dragBorder,
               URIDrop.Listener listener)

Constructor with a specified border and debugging optionally turned on. With Debugging turned on, more status messages will be displayed to out. A common way to use this constructor is with System.out or System.err. A null value for the parameter out will result in no debugging output.

Parameters:

out - PrintStream to record debugging info or null for no debugging.

c - Component on which files will be dropped.

dragBorder - Border to use on JComponent when dragging occurs.

listener - Listens for filesDropped.

Since:

1.0

URIDrop

public URIDrop(java.io.PrintStream out,
               java.awt.Component c,
               javax.swing.border.Border dragBorder,
               boolean recursive,
               URIDrop.Listener listener)

Full constructor with a specified border and debugging optionally turned on. With Debugging turned on, more status messages will be displayed to out. A common way to use this constructor is with System.out or System.err. A null value for the parameter out will result in no debugging output.

Parameters:

out - PrintStream to record debugging info or null for no debugging.

c - Component on which files will be dropped.

dragBorder - Border to use on JComponent when dragging occurs.

recursive - Recursively set children as drop targets.

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

Returns:

true if any components were unregistered

Since:

1.0

remove

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

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.

Parameters:

c - The component to unregister

recursive - Recursively unregister components within a container

Returns:

true if any components were unregistered

Since:

1.0