Module io.github.sosuisen.api.jfxbuilder.controls

Package io.github.sosuisen.jfxbuilder.controls

Class TextFormatterBuilder<V>

java.lang.Object

io.github.sosuisen.jfxbuilder.controls.TextFormatterBuilder<V>

public class TextFormatterBuilder<V>
extends Object

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

You can use method chaining to call the builder methods for configuring the TextFormatter. Finally, invoke the build method to generate an instance of the TextFormatter 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
TextFormatterBuilder<V>	apply(Consumer<TextFormatter<V>> func)	Applies a function to the TextFormatter instance being constructed.
TextFormatter<V>	build()	Builds and returns an instance of the TextFormatter class.
static <V> TextFormatterBuilder<V>	create(UnaryOperator<TextFormatter.Change> filter)	Accepts the constructor arguments of TextFormatter(UnaryOperator) and returns an instance of TextFormatterBuilder<V>.
static <V> TextFormatterBuilder<V>	create(StringConverter<V> valueConverter)	Accepts the constructor arguments of TextFormatter(StringConverter) and returns an instance of TextFormatterBuilder<V>.
static <V> TextFormatterBuilder<V>	create(StringConverter<V> valueConverter, V defaultValue)	Accepts the constructor arguments of TextFormatter(StringConverter, V) and returns an instance of TextFormatterBuilder<V>.
static <V> TextFormatterBuilder<V>	create(StringConverter<V> valueConverter, V defaultValue, UnaryOperator<TextFormatter.Change> filter)	Accepts the constructor arguments of TextFormatter(StringConverter, V, UnaryOperator) and returns an instance of TextFormatterBuilder<V>.
TextFormatterBuilder<V>	value(V value)	A builder method that invokes the setValue method on the instance being constructed.
TextFormatterBuilder<V>	valuePropertyApply(Consumer<ObjectProperty<V>> op)	Applies a function to the valueProperty of 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 <V> TextFormatterBuilder<V> create(UnaryOperator<TextFormatter.Change> filter)

Accepts the constructor arguments of TextFormatter(UnaryOperator) and returns an instance of TextFormatterBuilder<V>.

Returns:

an instance of the TextFormatterBuilder<V>.

create

public static <V> TextFormatterBuilder<V> create(StringConverter<V> valueConverter)

Accepts the constructor arguments of TextFormatter(StringConverter) and returns an instance of TextFormatterBuilder<V>.

Returns:

an instance of the TextFormatterBuilder<V>.

create

public static <V> TextFormatterBuilder<V> create(StringConverter<V> valueConverter,
 V defaultValue)

Accepts the constructor arguments of TextFormatter(StringConverter, V) and returns an instance of TextFormatterBuilder<V>.

Returns:

an instance of the TextFormatterBuilder<V>.

create

public static <V> TextFormatterBuilder<V> create(StringConverter<V> valueConverter,
 V defaultValue,
 UnaryOperator<TextFormatter.Change> filter)

Accepts the constructor arguments of TextFormatter(StringConverter, V, UnaryOperator) and returns an instance of TextFormatterBuilder<V>.

Returns:

an instance of the TextFormatterBuilder<V>.

build

public TextFormatter<V> build()

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

apply

public TextFormatterBuilder<V> apply(Consumer<TextFormatter<V>> func)

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

Returns:

builder instance

value

public TextFormatterBuilder<V> value(V value)

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

Returns:

builder instance

valuePropertyApply

public TextFormatterBuilder<V> valuePropertyApply(Consumer<ObjectProperty<V>> op)

Applies a function to the valueProperty of the instance being constructed. This serves as a shorthand form of the apply method.

Example:

// Use apply
.apply(obj -> obj.valueProperty().bind(anotherProperty))

// Use shorthand form
.valuePropertyApply(prop -> prop.bind(anotherProperty))

Returns:

builder instance