org.eclipse.fx.ui.controls.dnd

Class EFXDragEvent

java.lang.Object

java.util.EventObject

javafx.event.Event

org.eclipse.fx.ui.controls.dnd.EFXDragEvent

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class EFXDragEvent
extends javafx.event.Event

A custom drag event

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static javafx.event.EventType<EFXDragEvent>	ANY Base type for all events
static javafx.event.EventType<EFXDragEvent>	DRAG_DONE Event fired when drag is done
static javafx.event.EventType<EFXDragEvent>	DRAG_DROPPED Event fired when dropped
static javafx.event.EventType<EFXDragEvent>	DRAG_EXITED Event fired when drag exits the area
static javafx.event.EventType<EFXDragEvent>	DRAG_OVER Event fired while dragging over a node
static javafx.event.EventType<EFXDragEvent>	DRAG_START Event fired on a drag start

Fields inherited from class javafx.event.Event

consumed, eventType, NULL_SOURCE_TARGET, target

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
EFXDragEvent(java.lang.Object source, javafx.event.EventTarget target, javafx.event.EventType<? extends javafx.event.Event> eventType, double screenX, double screenY, boolean complete) Create a new drag event

Method Summary

Modifier and Type	Method and Description
boolean	canShowFeedbackDragFeedback()
java.lang.Object	getDraggedContent()
double	getScreenX()
double	getScreenY()
double	getX()
double	getY()
boolean	isComplete()
void	setComplete(boolean complete) Set the drag to be complete.
void	setDraggedContent(java.lang.Object content) Setting the drag content
void	updateFeedback(java.util.function.Consumer<javafx.scene.layout.StackPane> consumer) Update the drag feedback
static void	updateFeedbackLocation(double screenX, double screenY) Update the screen location while no drag over events occur

Methods inherited from class javafx.event.Event

clone, consume, copyFor, fireEvent, getEventType, getTarget, isConsumed

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

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

Field Detail

ANY

public static final javafx.event.EventType<EFXDragEvent> ANY

Base type for all events

DRAG_START

public static javafx.event.EventType<EFXDragEvent> DRAG_START

Event fired on a drag start

DRAG_OVER

public static javafx.event.EventType<EFXDragEvent> DRAG_OVER

Event fired while dragging over a node

DRAG_DROPPED

public static final javafx.event.EventType<EFXDragEvent> DRAG_DROPPED

Event fired when dropped

DRAG_EXITED

public static final javafx.event.EventType<EFXDragEvent> DRAG_EXITED

Event fired when drag exits the area

DRAG_DONE

public static final javafx.event.EventType<EFXDragEvent> DRAG_DONE

Event fired when drag is done

Constructor Detail

EFXDragEvent

public EFXDragEvent(java.lang.Object source,
                    javafx.event.EventTarget target,
                    javafx.event.EventType<? extends javafx.event.Event> eventType,
                    double screenX,
                    double screenY,
                    boolean complete)

Create a new drag event

Parameters:

source - the source

target - the target

eventType - the event type

screenX - the screen x

screenY - the screen y

complete - true when completed

Method Detail

updateFeedback

public void updateFeedback(java.util.function.Consumer<javafx.scene.layout.StackPane> consumer)

Update the drag feedback

Parameters:

consumer - the consumer

updateFeedbackLocation

public static void updateFeedbackLocation(double screenX,
                                          double screenY)

Update the screen location while no drag over events occur

Parameters:

screenX - the screen x

screenY - the screen y

getScreenX

public double getScreenX()

Returns:

the screen x coordinate

getScreenY

public double getScreenY()

Returns:

the screen y coordinate

getX

public double getX()

Returns:

the screen x relative to the source

getY

public double getY()

Returns:

the screen y relative to the source

setDraggedContent

public void setDraggedContent(java.lang.Object content)

Setting the drag content

Parameters:

content - the content

getDraggedContent

public java.lang.Object getDraggedContent()

Returns:

the current drag content

setComplete

public void setComplete(boolean complete)

Set the drag to be complete. Only to call when DRAG_DROPPED

Parameters:

complete - true when completed

isComplete

public boolean isComplete()

Returns:

true if drag is completed

canShowFeedbackDragFeedback

public boolean canShowFeedbackDragFeedback()

Returns:

check if showing drag feedback is possible