Module MaterialFX

Package io.github.palexdev.materialfx.bindings

Class BiBindingBuilder<T>

java.lang.Object

io.github.palexdev.materialfx.bindings.BiBindingBuilder<T>

public class BiBindingBuilder<T>
extends Object

Helper class for BiBindingManager.

Makes the creation of bidirectional bindings easier with fluent methods.

Constructor Summary

Constructors

Constructor	Description
BiBindingBuilder(ObservableValue<? extends T> target)

Method Summary

Modifier and Type	Method	Description
BiBindingManager	create()	Confirms the creation of the binding by calling BiBindingManager.apply(BiBindingBuilder, BiBindingHelper, boolean).
BindingsMap<ObservableValue<? extends T>,BiConsumer<T,T>>	getSources()
boolean	isEagerEvaluation()
BiBindingBuilder<T>	lazy()	Disables the binding eager evaluation mechanism.
BiBindingBuilder<T>	override(boolean override)	If a binding for the specified target is already present specifies if this builder's targetUpdater must replace the existing one.
ObservableValue<? extends T>	target()
BiConsumer<T,T>	targetUpdater()
final BiBindingBuilder<T>	to(Map.Entry<ObservableValue<? extends T>,BiConsumer<T,T>>... sources)	Allows adding multiple entries to the map at once.
BiBindingBuilder<T>	to(Property<T> source)	Calls to(ObservableValue, BiConsumer) with the given property.
BiBindingBuilder<T>	to(ObservableValue<T> source, BiConsumer<T,T> sourceUpdater)	Adds a new entry in the map which associates the given source to the given BiConsumer that is responsible for updating the source when needed.
BiBindingBuilder<T>	with(BiConsumer<T,T> targetUpdater)	Sets the BiConsumer function responsible for updating the target when the source changes.
BiBindingBuilder<T>	withHelper(BiBindingHelper<T> bindingHelper)	Specifies the BiBindingHelper that will be used for the binding.

Methods inherited from class java.lang.Object

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

Constructor Details

BiBindingBuilder

public BiBindingBuilder(ObservableValue<? extends T> target)

Method Details

with

public BiBindingBuilder<T> with(BiConsumer<T,T> targetUpdater)

Sets the BiConsumer function responsible for updating the target when the source changes.

withHelper

public BiBindingBuilder<T> withHelper(BiBindingHelper<T> bindingHelper)

Specifies the BiBindingHelper that will be used for the binding.

This is optional as a default helper will be created when needed.

to

public BiBindingBuilder<T> to(Property<T> source)

Calls to(ObservableValue, BiConsumer) with the given property. Since it is a Property the BiConsumer will make use of WritableValue.setValue(Object).

to

public BiBindingBuilder<T> to(ObservableValue<T> source,
 BiConsumer<T,T> sourceUpdater)

Adds a new entry in the map which associates the given source to the given BiConsumer that is responsible for updating the source when needed.

to

@SafeVarargs
public final BiBindingBuilder<T> to(Map.Entry<ObservableValue<? extends T>,BiConsumer<T,T>>... sources)

Allows adding multiple entries to the map at once. Basically the same as to(ObservableValue, BiConsumer).

lazy

public BiBindingBuilder<T> lazy()

Disables the binding eager evaluation mechanism. At the time of the binding the values won't be updated automatically.

override

public BiBindingBuilder<T> override(boolean override)

If a binding for the specified target is already present specifies if this builder's targetUpdater must replace the existing one.

target

public ObservableValue<? extends T> target()

Returns:

the target observable

targetUpdater

public BiConsumer<T,T> targetUpdater()

Returns:

the target updater

getSources

public BindingsMap<ObservableValue<? extends T>,BiConsumer<T,T>> getSources()

Returns:

the map containing the sources and their updater

isEagerEvaluation

public boolean isEagerEvaluation()

Returns:

if the bindings uses eager evaluation or it's lazy

create

public BiBindingManager create()

Confirms the creation of the binding by calling BiBindingManager.apply(BiBindingBuilder, BiBindingHelper, boolean).