Module MaterialFX

Package io.github.palexdev.materialfx.bindings

Class BiBindingManager

java.lang.Object

io.github.palexdev.materialfx.bindings.BiBindingManager

public class BiBindingManager
extends Object

This singleton class manages bidirectional bindings.

All bindings are stored in a map which associates the target property to a BiBindingHelper. For bidirectional bindings a given target property will always have one and only helper at any time. The sources list is managed by that manager, when a new bind is made on the same target, a new BiBindingHelper is created, which is the combination of the old one and the new one, BiBindingHelper.newFor(BiBindingHelper, BiBindingHelper, boolean) is used.

When a binding is not necessary anymore it's opportune to dispose it either with dispose() or unbind(ObservableValue, ObservableValue) or clear(ObservableValue).

This mechanism is so flexible that it also allows to bind read-only properties on the sole condition that you must have a way to set that property and it must be specified with BiBindingBuilder.

For these properties be careful during the unbind as in JavaFX the getReadOnlyProperty() method returns a completely different instance. For this reason the manager also offers unbind methods to unbind read-only wrappers.

To make the bindings building more readable it uses BiBindingBuilder.

Method Summary

Modifier and Type	Method	Description
<T> BiBindingManager	apply(BiBindingBuilder<T> bindingBuilder, BiBindingHelper<T> bindingHelper, boolean override)	Creates a bidirectional binding with the given arguments.
<T> BiBindingBuilder<T>	bindBidirectional(Property<T> target)	Creates and returns a new BiBindingBuilder with the given target.
<T> BiBindingBuilder<T>	bindBidirectional(ObservableValue<? extends T> target)	Creates and returns a new BiBindingBuilder with the given target.
<T> BiBindingManager	clear(ObservableValue<? extends T> target)	Calls BiBindingHelper.clear() for the given target (if existing in tha map).
BiBindingManager	dispose()	Disposes all the bindings and clears the map.
<T> BiBindingManager	disposeFor(ObservableValue<? extends T> target)	Calls BiBindingHelper.dispose() for the given target (if existing in tha map).
static BiBindingManager	instance()	Retrieves the instance of the BiBindingManager
<T> boolean	isBound(ObservableValue<? extends T> target)	Checks if the bindings map contains the given target.
boolean	isEmpty()	Checks if size() is 0;
int	size()
<T> BiBindingManager	unbind(ObservableValue<? extends T> target, ObservableValue<? extends T> source)	Removes the given source from the given target's binding.
BiBindingManager	unbindReadOnly(ReadOnlyBooleanWrapper target, ObservableValue<? extends Boolean> source)	Retrieves the read-only property with ReadOnlyBooleanWrapper.getReadOnlyProperty() and calls unbind(ObservableValue, ObservableValue) on it.
BiBindingManager	unbindReadOnly(ReadOnlyDoubleWrapper target, ObservableValue<? extends Double> source)	Retrieves the read-only property with ReadOnlyDoubleWrapper.getReadOnlyProperty() and calls unbind(ObservableValue, ObservableValue) on it.
BiBindingManager	unbindReadOnly(ReadOnlyFloatWrapper target, ObservableValue<? extends Float> source)	Retrieves the read-only property with ReadOnlyFloatWrapper.getReadOnlyProperty() and calls unbind(ObservableValue, ObservableValue) on it.
BiBindingManager	unbindReadOnly(ReadOnlyIntegerWrapper target, ObservableValue<? extends Integer> source)	Retrieves the read-only property with ReadOnlyIntegerWrapper.getReadOnlyProperty() and calls unbind(ObservableValue, ObservableValue) on it.
BiBindingManager	unbindReadOnly(ReadOnlyLongWrapper target, ObservableValue<? extends Long> source)	Retrieves the read-only property with ReadOnlyLongWrapper.getReadOnlyProperty() and calls unbind(ObservableValue, ObservableValue) on it.
<T> BiBindingManager	unbindReadOnly(ReadOnlyObjectWrapper<T> target, ObservableValue<? extends T> source)	Retrieves the read-only property with ReadOnlyObjectWrapper.getReadOnlyProperty() and calls unbind(ObservableValue, ObservableValue) on it.
BiBindingManager	unbindReadOnly(ReadOnlyStringWrapper target, ObservableValue<? extends String> source)	Retrieves the read-only property with ReadOnlyStringWrapper.getReadOnlyProperty() and calls unbind(ObservableValue, ObservableValue) on it.

Methods inherited from class java.lang.Object

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

Method Details

instance

public static BiBindingManager instance()

Retrieves the instance of the BiBindingManager

bindBidirectional

public <T> BiBindingBuilder<T> bindBidirectional(ObservableValue<? extends T> target)

Creates and returns a new BiBindingBuilder with the given target.

bindBidirectional

public <T> BiBindingBuilder<T> bindBidirectional(Property<T> target)

Creates and returns a new BiBindingBuilder with the given target. Since it is a Property a default targetUpdater is also set by using WritableValue.setValue(Object).

apply

public <T> BiBindingManager apply(BiBindingBuilder<T> bindingBuilder,
 BiBindingHelper<T> bindingHelper,
 boolean override)

Creates a bidirectional binding with the given arguments.

The BindingBuilder specifies the target, the targetUpdater and the source.

Calls bindingCheck(ObservableValue) on the target before proceeding.

The BiBindingHelper to use must be computed properly as there are several cases:

- The target is already bound to something: in this case a new helper is created by combining the existing one and the given one using BiBindingHelper.newFor(BiBindingHelper, BiBindingHelper, boolean)

- The given helper is null or equal to the existing one: in this case the existing one is used and all the sources of the given one are added to the existing one

The target is not already bound: if the given helper is null a new one is created otherwise the given one is used.

If the given BiBindingBuilder's eager evaluation flag is true (by default it is) BiBindingHelper.invalidate() is called on the chosen helper.

At the end the entry, target-helper, in put into the map.

If using BiBindingBuilder.create() it's not necessary to call this method too!!

unbind

public <T> BiBindingManager unbind(ObservableValue<? extends T> target,
 ObservableValue<? extends T> source)

Removes the given source from the given target's binding.

If by removing the source, the helper becomes empty, the target is removed from the bindings map.

clear

public <T> BiBindingManager clear(ObservableValue<? extends T> target)

Calls BiBindingHelper.clear() for the given target (if existing in tha map).

disposeFor

public <T> BiBindingManager disposeFor(ObservableValue<? extends T> target)

Calls BiBindingHelper.dispose() for the given target (if existing in tha map).

dispose

public BiBindingManager dispose()

Disposes all the bindings and clears the map.

unbindReadOnly

public BiBindingManager unbindReadOnly(ReadOnlyBooleanWrapper target,
 ObservableValue<? extends Boolean> source)

Retrieves the read-only property with ReadOnlyBooleanWrapper.getReadOnlyProperty() and calls unbind(ObservableValue, ObservableValue) on it.

unbindReadOnly

public BiBindingManager unbindReadOnly(ReadOnlyStringWrapper target,
 ObservableValue<? extends String> source)

Retrieves the read-only property with ReadOnlyStringWrapper.getReadOnlyProperty() and calls unbind(ObservableValue, ObservableValue) on it.

unbindReadOnly

public BiBindingManager unbindReadOnly(ReadOnlyIntegerWrapper target,
 ObservableValue<? extends Integer> source)

Retrieves the read-only property with ReadOnlyIntegerWrapper.getReadOnlyProperty() and calls unbind(ObservableValue, ObservableValue) on it.

unbindReadOnly

public BiBindingManager unbindReadOnly(ReadOnlyLongWrapper target,
 ObservableValue<? extends Long> source)

Retrieves the read-only property with ReadOnlyLongWrapper.getReadOnlyProperty() and calls unbind(ObservableValue, ObservableValue) on it.

unbindReadOnly

public BiBindingManager unbindReadOnly(ReadOnlyFloatWrapper target,
 ObservableValue<? extends Float> source)

Retrieves the read-only property with ReadOnlyFloatWrapper.getReadOnlyProperty() and calls unbind(ObservableValue, ObservableValue) on it.

unbindReadOnly

public BiBindingManager unbindReadOnly(ReadOnlyDoubleWrapper target,
 ObservableValue<? extends Double> source)

Retrieves the read-only property with ReadOnlyDoubleWrapper.getReadOnlyProperty() and calls unbind(ObservableValue, ObservableValue) on it.

unbindReadOnly

public <T> BiBindingManager unbindReadOnly(ReadOnlyObjectWrapper<T> target,
 ObservableValue<? extends T> source)

Retrieves the read-only property with ReadOnlyObjectWrapper.getReadOnlyProperty() and calls unbind(ObservableValue, ObservableValue) on it.

isBound

public <T> boolean isBound(ObservableValue<? extends T> target)

Checks if the bindings map contains the given target.

size

public int size()

Returns:

the number of bindings actually present in the map

isEmpty

public boolean isEmpty()

Checks if size() is 0;