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

Package io.github.sosuisen.jfxbuilder.graphics

Class MouseEventBuilder

java.lang.Object

io.github.sosuisen.jfxbuilder.graphics.MouseEventBuilder

public class MouseEventBuilder
extends Object

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

You can use method chaining to call the builder methods for configuring the MouseEvent. Finally, invoke the build method to generate an instance of the MouseEvent 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
MouseEventBuilder	apply(Consumer<MouseEvent> func)	Applies a function to the MouseEvent instance being constructed.
MouseEvent	build()	Builds and returns an instance of the MouseEvent class.
static MouseEventBuilder	create(Object source, EventTarget target, EventType<? extends MouseEvent> 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, boolean stillSincePress, PickResult pickResult)	Accepts the constructor arguments of MouseEvent(Object, EventTarget, EventType, double, double, double, double, MouseButton, int, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, PickResult) and returns an instance of MouseEventBuilder.
static MouseEventBuilder	create(Object source, EventTarget target, EventType<? extends MouseEvent> 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, boolean stillSincePress, PickResult pickResult)	Accepts the constructor arguments of MouseEvent(Object, EventTarget, EventType, double, double, double, double, MouseButton, int, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, PickResult) and returns an instance of MouseEventBuilder.
static MouseEventBuilder	create(EventType<? extends MouseEvent> 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, boolean stillSincePress, PickResult pickResult)	Accepts the constructor arguments of MouseEvent(EventType, double, double, double, double, MouseButton, int, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, PickResult) and returns an instance of MouseEventBuilder.
static MouseEventBuilder	create(EventType<? extends MouseEvent> 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, boolean stillSincePress, PickResult pickResult)	Accepts the constructor arguments of MouseEvent(EventType, double, double, double, double, MouseButton, int, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, PickResult) and returns an instance of MouseEventBuilder.
MouseEventBuilder	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 MouseEventBuilder create(Object source,
 EventTarget target,
 EventType<? extends MouseEvent> 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,
 boolean stillSincePress,
 PickResult pickResult)

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

Returns:

an instance of the MouseEventBuilder.

create

public static MouseEventBuilder create(Object source,
 EventTarget target,
 EventType<? extends MouseEvent> 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,
 boolean stillSincePress,
 PickResult pickResult)

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

Returns:

an instance of the MouseEventBuilder.

create

public static MouseEventBuilder create(EventType<? extends MouseEvent> 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,
 boolean stillSincePress,
 PickResult pickResult)

Accepts the constructor arguments of MouseEvent(EventType, double, double, double, double, MouseButton, int, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, PickResult) and returns an instance of MouseEventBuilder.

Returns:

an instance of the MouseEventBuilder.

create

public static MouseEventBuilder create(EventType<? extends MouseEvent> 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,
 boolean stillSincePress,
 PickResult pickResult)

Accepts the constructor arguments of MouseEvent(EventType, double, double, double, double, MouseButton, int, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, PickResult) and returns an instance of MouseEventBuilder.

Returns:

an instance of the MouseEventBuilder.

build

public MouseEvent build()

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

apply

public MouseEventBuilder apply(Consumer<MouseEvent> func)

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

Returns:

builder instance

dragDetect

public MouseEventBuilder dragDetect(boolean dragDetect)

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

Returns:

builder instance