Module io.github.sosuisen.api.jfxbuilder.graphics

Package io.github.sosuisen.jfxbuilder.graphics

Class DragEventBuilder

java.lang.Object

io.github.sosuisen.jfxbuilder.graphics.DragEventBuilder

public class DragEventBuilder
extends Object

The DragEventBuilder class constructs instances of the DragEvent class and offers a fluent interface for creating and configuring it.

This class includes a static create method that accepts the same arguments as the original DragEvent constructor and returns an instance of the DragEventBuilder.

You can use method chaining to call the builder methods for configuring the DragEvent. Finally, invoke the build method to generate an instance of the DragEvent class.

Note that intermediate builder methods are not evaluated until the build method is called, meaning they are evaluated lazily.

Author:

Hidekazu Kubota <hidekazu.kubota@gmail.com>

Method Summary

Modifier and Type	Method	Description
DragEventBuilder	apply(Consumer<DragEvent> func)	Applies a function to the DragEvent instance being constructed.
DragEvent	build()	Builds and returns an instance of the DragEvent class.
static DragEventBuilder	create(Object source, EventTarget target, EventType<DragEvent> eventType, Dragboard dragboard, double x, double y, double screenX, double screenY, TransferMode transferMode, Object gestureSource, Object gestureTarget, PickResult pickResult)	Accepts the constructor arguments of DragEvent(Object, EventTarget, EventType, Dragboard, double, double, double, double, TransferMode, Object, Object, PickResult) and returns an instance of DragEventBuilder.
static DragEventBuilder	create(EventType<DragEvent> eventType, Dragboard dragboard, double x, double y, double screenX, double screenY, TransferMode transferMode, Object gestureSource, Object gestureTarget, PickResult pickResult)	Accepts the constructor arguments of DragEvent(EventType, Dragboard, double, double, double, double, TransferMode, Object, Object, PickResult) and returns an instance of DragEventBuilder.
DragEventBuilder	dropCompleted(boolean isTransferDone)	A builder method that invokes the setDropCompleted method on the instance being constructed.

Methods inherited from class java.lang.Object

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

Method Details

create

public static DragEventBuilder create(Object source,
 EventTarget target,
 EventType<DragEvent> eventType,
 Dragboard dragboard,
 double x,
 double y,
 double screenX,
 double screenY,
 TransferMode transferMode,
 Object gestureSource,
 Object gestureTarget,
 PickResult pickResult)

Accepts the constructor arguments of DragEvent(Object, EventTarget, EventType, Dragboard, double, double, double, double, TransferMode, Object, Object, PickResult) and returns an instance of DragEventBuilder.

Returns:

an instance of the DragEventBuilder.

create

public static DragEventBuilder create(EventType<DragEvent> eventType,
 Dragboard dragboard,
 double x,
 double y,
 double screenX,
 double screenY,
 TransferMode transferMode,
 Object gestureSource,
 Object gestureTarget,
 PickResult pickResult)

Accepts the constructor arguments of DragEvent(EventType, Dragboard, double, double, double, double, TransferMode, Object, Object, PickResult) and returns an instance of DragEventBuilder.

Returns:

an instance of the DragEventBuilder.

build

public DragEvent build()

Builds and returns an instance of the DragEvent class.

Intermediate builder methods are not evaluated until the build method is called; in other words, they are evaluated lazily.

Returns:

new instance of the DragEvent class

apply

public DragEventBuilder apply(Consumer<DragEvent> func)

Applies a function to the DragEvent instance being constructed. Most operations on the instance can be performed using this method.

Returns:

builder instance

dropCompleted

public DragEventBuilder dropCompleted(boolean isTransferDone)

A builder method that invokes the setDropCompleted method on the instance being constructed.

Returns:

builder instance