Class MouseDragEventBuilder

java.lang.Object

io.github.sosuisen.jfxbuilder.graphics.MouseDragEventBuilder

public class MouseDragEventBuilder
extends Object

The MouseDragEventBuilder class constructs instances of the MouseDragEvent 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 MouseDragEvent constructor and returns an instance of the MouseDragEventBuilder.

You can use method chaining to call the builder methods for configuring the MouseDragEvent. Finally, invoke the build method to generate an instance of the MouseDragEvent 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
MouseDragEventBuilder	apply(Consumer<MouseDragEvent> func)	Applies a function to the MouseDragEvent instance being constructed.
MouseDragEvent	build()	Builds and returns an instance of the MouseDragEvent class.
static MouseDragEventBuilder	create(Object source, EventTarget target, EventType<MouseDragEvent> eventType, double x, double y, double screenX, double screenY, MouseButton button, int clickCount, boolean shiftDown, boolean controlDown, boolean altDown, boolean metaDown, boolean primaryButtonDown, boolean middleButtonDown, boolean secondaryButtonDown, boolean backButtonDown, boolean forwardButtonDown, boolean synthesized, boolean popupTrigger, PickResult pickResult, Object gestureSource)	Accepts the constructor arguments of MouseDragEvent(Object, EventTarget, EventType, double, double, double, double, MouseButton, int, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, PickResult, Object) and returns an instance of MouseDragEventBuilder.
static MouseDragEventBuilder	create(Object source, EventTarget target, EventType<MouseDragEvent> eventType, double x, double y, double screenX, double screenY, MouseButton button, int clickCount, boolean shiftDown, boolean controlDown, boolean altDown, boolean metaDown, boolean primaryButtonDown, boolean middleButtonDown, boolean secondaryButtonDown, boolean synthesized, boolean popupTrigger, PickResult pickResult, Object gestureSource)	Accepts the constructor arguments of MouseDragEvent(Object, EventTarget, EventType, double, double, double, double, MouseButton, int, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, PickResult, Object) and returns an instance of MouseDragEventBuilder.
static MouseDragEventBuilder	create(EventType<MouseDragEvent> eventType, double x, double y, double screenX, double screenY, MouseButton button, int clickCount, boolean shiftDown, boolean controlDown, boolean altDown, boolean metaDown, boolean primaryButtonDown, boolean middleButtonDown, boolean secondaryButtonDown, boolean synthesized, boolean popupTrigger, PickResult pickResult, Object gestureSource)	Accepts the constructor arguments of MouseDragEvent(EventType, double, double, double, double, MouseButton, int, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, PickResult, Object) and returns an instance of MouseDragEventBuilder.
MouseDragEventBuilder	dragDetect(boolean dragDetect)	A builder method that invokes the setDragDetect 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 MouseDragEventBuilder create(Object source,
 EventTarget target,
 EventType<MouseDragEvent> eventType,
 double x,
 double y,
 double screenX,
 double screenY,
 MouseButton button,
 int clickCount,
 boolean shiftDown,
 boolean controlDown,
 boolean altDown,
 boolean metaDown,
 boolean primaryButtonDown,
 boolean middleButtonDown,
 boolean secondaryButtonDown,
 boolean backButtonDown,
 boolean forwardButtonDown,
 boolean synthesized,
 boolean popupTrigger,
 PickResult pickResult,
 Object gestureSource)

Accepts the constructor arguments of MouseDragEvent(Object, EventTarget, EventType, double, double, double, double, MouseButton, int, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, PickResult, Object) and returns an instance of MouseDragEventBuilder.

Returns:

an instance of the MouseDragEventBuilder.

create

public static MouseDragEventBuilder create(Object source,
 EventTarget target,
 EventType<MouseDragEvent> eventType,
 double x,
 double y,
 double screenX,
 double screenY,
 MouseButton button,
 int clickCount,
 boolean shiftDown,
 boolean controlDown,
 boolean altDown,
 boolean metaDown,
 boolean primaryButtonDown,
 boolean middleButtonDown,
 boolean secondaryButtonDown,
 boolean synthesized,
 boolean popupTrigger,
 PickResult pickResult,
 Object gestureSource)

Accepts the constructor arguments of MouseDragEvent(Object, EventTarget, EventType, double, double, double, double, MouseButton, int, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, PickResult, Object) and returns an instance of MouseDragEventBuilder.

Returns:

an instance of the MouseDragEventBuilder.

create

public static MouseDragEventBuilder create(EventType<MouseDragEvent> eventType,
 double x,
 double y,
 double screenX,
 double screenY,
 MouseButton button,
 int clickCount,
 boolean shiftDown,
 boolean controlDown,
 boolean altDown,
 boolean metaDown,
 boolean primaryButtonDown,
 boolean middleButtonDown,
 boolean secondaryButtonDown,
 boolean synthesized,
 boolean popupTrigger,
 PickResult pickResult,
 Object gestureSource)

Accepts the constructor arguments of MouseDragEvent(EventType, double, double, double, double, MouseButton, int, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, PickResult, Object) and returns an instance of MouseDragEventBuilder.

Returns:

an instance of the MouseDragEventBuilder.

build

public MouseDragEvent build()

Builds and returns an instance of the MouseDragEvent 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 MouseDragEvent class

apply

public MouseDragEventBuilder apply(Consumer<MouseDragEvent> func)

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

Returns:

builder instance

dragDetect

public MouseDragEventBuilder dragDetect(boolean dragDetect)

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

Returns:

builder instance