Class InputMethodEventBuilder

java.lang.Object

io.github.sosuisen.jfxbuilder.graphics.InputMethodEventBuilder

public class InputMethodEventBuilder
extends Object

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

You can use method chaining to call the builder methods for configuring the InputMethodEvent. Finally, invoke the build method to generate an instance of the InputMethodEvent 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
final InputMethodEventBuilder	addComposed(Collection<? extends InputMethodTextRun> col)	Calls the addAll method on the ObservableList returned by the InputMethodEvent#getComposed() method.
final InputMethodEventBuilder	addComposed(InputMethodTextRun... elements)	Calls the addAll method on the ObservableList returned by the InputMethodEvent#getComposed() method.
InputMethodEventBuilder	apply(Consumer<InputMethodEvent> func)	Applies a function to the InputMethodEvent instance being constructed.
InputMethodEvent	build()	Builds and returns an instance of the InputMethodEvent class.
static InputMethodEventBuilder	create(Object source, EventTarget target, EventType<InputMethodEvent> eventType, List<InputMethodTextRun> composed, String committed, int caretPosition)	Accepts the constructor arguments of InputMethodEvent(Object, EventTarget, EventType, List, String, int) and returns an instance of InputMethodEventBuilder.
static InputMethodEventBuilder	create(EventType<InputMethodEvent> eventType, List<InputMethodTextRun> composed, String committed, int caretPosition)	Accepts the constructor arguments of InputMethodEvent(EventType, List, String, int) and returns an instance of InputMethodEventBuilder.

Methods inherited from class Object

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

Method Details

create

public static InputMethodEventBuilder create(Object source,
 EventTarget target,
 EventType<InputMethodEvent> eventType,
 List<InputMethodTextRun> composed,
 String committed,
 int caretPosition)

Accepts the constructor arguments of InputMethodEvent(Object, EventTarget, EventType, List, String, int) and returns an instance of InputMethodEventBuilder.

Returns:

an instance of the InputMethodEventBuilder.

create

public static InputMethodEventBuilder create(EventType<InputMethodEvent> eventType,
 List<InputMethodTextRun> composed,
 String committed,
 int caretPosition)

Accepts the constructor arguments of InputMethodEvent(EventType, List, String, int) and returns an instance of InputMethodEventBuilder.

Returns:

an instance of the InputMethodEventBuilder.

build

public InputMethodEvent build()

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

apply

public InputMethodEventBuilder apply(Consumer<InputMethodEvent> func)

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

Returns:

builder instance

addComposed

public final InputMethodEventBuilder addComposed(InputMethodTextRun... elements)

Calls the addAll method on the ObservableList returned by the InputMethodEvent#getComposed() method.

Returns:

builder instance

addComposed

public final InputMethodEventBuilder addComposed(Collection<? extends InputMethodTextRun> col)

Calls the addAll method on the ObservableList returned by the InputMethodEvent#getComposed() method.

Returns:

builder instance