org.eclipse.fx.ui.controls.dnd

Class EFXDnDAdapter

java.lang.Object

org.eclipse.fx.ui.controls.dnd.EFXDnDAdapter

public class EFXDnDAdapter
extends java.lang.Object

Allows a node to be adapted to the drag and drop system

Constructor Summary

Constructors

Constructor and Description
EFXDnDAdapter(javafx.scene.Node node, javafx.scene.Node doneEventTarget) Create a new adapter

Method Summary

Modifier and Type	Method and Description
void	disable() Disable dnd for the node
void	enable() Enable dnd for the node
void	setDragDoneConsumer(java.util.function.BiConsumer<EFXDnDAdapter,EFXDragEvent> dragDoneConsumer) A consumer notified that the drag has finished
void	setDragStartConsumer(java.util.function.BiConsumer<EFXDnDAdapter,EFXDragEvent> dragStartConsumer) A consumer who is informed that the drag has started
void	setDragStartValidator(java.util.function.BiFunction<EFXDnDAdapter,javafx.scene.input.MouseEvent,java.lang.Boolean> dragStartValidator) Validate that the drag can start

Methods inherited from class java.lang.Object

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

Constructor Detail

EFXDnDAdapter

public EFXDnDAdapter(javafx.scene.Node node,
                     javafx.scene.Node doneEventTarget)

Create a new adapter

Parameters:

node - the node itself

doneEventTarget - the target the done event is sent to

Method Detail

enable

public void enable()

Enable dnd for the node

disable

public void disable()

Disable dnd for the node

setDragStartValidator

public void setDragStartValidator(java.util.function.BiFunction<EFXDnDAdapter,javafx.scene.input.MouseEvent,java.lang.Boolean> dragStartValidator)

Validate that the drag can start

Parameters:

dragStartValidator - a validator who can return false to veto the start of the drag operation

setDragStartConsumer

public void setDragStartConsumer(java.util.function.BiConsumer<EFXDnDAdapter,EFXDragEvent> dragStartConsumer)

A consumer who is informed that the drag has started

Parameters:

dragStartConsumer - the consumer

setDragDoneConsumer

public void setDragDoneConsumer(java.util.function.BiConsumer<EFXDnDAdapter,EFXDragEvent> dragDoneConsumer)

A consumer notified that the drag has finished

Parameters:

dragDoneConsumer - the consumer