Package swingtree

Class DragDropComponentConf<C extends JComponent>

java.lang.Object
swingtree.DragDropComponentConf<C>
Type Parameters:
C - The type of the component to be dragged away.
public final class DragDropComponentConf<C extends JComponent> extends Object
A value based builder object for configuring drop target events for a component using the UIForAnySwing.withDropSite(Configurator) method, where an instance of this class is passed to the Configurator lambda defining how the component should behave and look when something is dragged and dropped on top of it.

For listening to drop events, the following methods are available:
  • onDragEnter(Action) - Called while a drag operation is ongoing, when the mouse pointer enters the operable part of the drop site for the DropTarget registered with this listener.
  • onDragOver(Action) - Called when a drag operation is ongoing, while the mouse pointer is still over the operable part of the drop site for the DropTarget registered with this listener.
  • onDropActionChanged(Action) - Called if the user has modified the current drop gesture.
  • onDragExit(Action) - Called while a drag operation is ongoing, when the mouse pointer has exited the operable part of the drop site for the DropTarget registered with this listener.
  • onDrop(Action) - Called when the drag operation has terminated with a drop on the operable part of the drop site for the DropTarget registered with this listener. This is where the transfer of the data should take place.

  • Method Details

    • of

      public static <C extends JComponent> DragDropComponentConf<C> of(C component)

    • component

      public C component()
      Returns the component that this configuration is for so that it can be used in the UIForAnySwing.withDropSite(Configurator) method to configure the drop site based on the component state.
      Returns:
      The component that this configuration is for.

    • onDragEnter

      public DragDropComponentConf<C> onDragEnter(sprouts.Action<ComponentDelegate<C,DropTargetDragEvent>> action)
      The supplied action is called while a drag operation is ongoing, when the mouse pointer enters the operable part of the drop site for the DropTarget registered with this listener.
      Parameters:
      action - An Action with a DropTargetDragEvent wrapped in a ComponentDelegate passed to it.
      Returns:
      A new DragDropComponentConf updated with the supplied action.

    • onDragOver

      public DragDropComponentConf<C> onDragOver(sprouts.Action<ComponentDelegate<C,DropTargetDragEvent>> action)
      The supplied action is called when a drag operation is ongoing, while the mouse pointer is still over the operable part of the drop site for the DropTarget registered with this listener.
      Parameters:
      action - An Action with a DropTargetDragEvent wrapped in a ComponentDelegate passed to it.
      Returns:
      A new DragDropComponentConf updated with the supplied action.

    • onDropActionChanged

      public DragDropComponentConf<C> onDropActionChanged(sprouts.Action<ComponentDelegate<C,DropTargetDragEvent>> action)
      The supplied action is called if the user has modified the current drop gesture.
      Parameters:
      action - An Action with a DropTargetDragEvent wrapped in a ComponentDelegate passed to it.
      Returns:
      A new DragDropComponentConf updated with the supplied action.

    • onDragExit

      public DragDropComponentConf<C> onDragExit(sprouts.Action<ComponentDelegate<C,DropTargetEvent>> action)
      The supplied action is called while a drag operation is ongoing, when the mouse pointer has exited the operable part of the drop site for the DropTarget registered with this listener.
      Parameters:
      action - An Action with a DropTargetEvent wrapped in a ComponentDelegate passed to it.
      Returns:
      A new DragDropComponentConf updated with the supplied action.

    • onDrop

      public DragDropComponentConf<C> onDrop(sprouts.Action<ComponentDelegate<C,DropTargetDropEvent>> action)
      The supplied Action is called when the drag operation has terminated with a drop on the operable part of the drop site for the DropTarget registered with this listener.

      This method is responsible for undertaking the transfer of the data associated with the gesture. The DropTargetDropEvent provides a means to obtain a Transferable object that represents the data object(s) to be transfered.

      From this method, the DropTargetListener shall accept or reject the drop via the acceptDrop(int dropAction) or rejectDrop() methods of the DropTargetDropEvent parameter.

      After acceptDrop(), but not before, DropTargetDropEvent's getTransferable() method may be invoked, and data transfer may be performed via the returned Transferable's getTransferData() method.

      At the completion of a drop, an implementation of this method is required to signal the success/failure of the drop by passing an appropriate boolean to the DropTargetDropEvent's dropComplete(boolean success) method.

      Note: The data transfer should be completed before the call to the DropTargetDropEvent's dropComplete(boolean success) method. After that, a call to the getTransferData() method of the Transferable returned by DropTargetDropEvent.getTransferable() is guaranteed to succeed only if the data transfer is local; that is, only if DropTargetDropEvent.isLocalTransfer() returns true. Otherwise, the behavior of the call is implementation-dependent.

      Parameters:
      action - An Action with a DropTargetDropEvent wrapped in a ComponentDelegate passed to it.
      Returns:
      A new DragDropComponentConf updated with the supplied action.