Module MaterialFX

Package io.github.palexdev.materialfx.bindings

Class BindingManager

java.lang.Object

io.github.palexdev.materialfx.bindings.BindingManager

public class BindingManager
extends Object

This singleton class manages unidirectional bindings.

All bindings are stored in a map which associates the target property to a BindingHelper. For unidirectional bindings a given target property will always have one and only helper at any time.

When a binding is not necessary anymore it's opportune to dispose it either with dispose() or unbind(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 BindingBuilder.with(BiConsumer).

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 BindingBuilder.

Method Summary

Modifier and Type	Method	Description
<T> BindingManager	apply(BindingBuilder<T> bindingBuilder, BindingHelper<T> bindingHelper)	Creates a unidirectional binding with the given arguments.
<T> BindingBuilder<T>	bind(Property<T> target)	Creates a new BindingBuilder with the given target.
<T> BindingBuilder<T>	bind(ObservableValue<? extends T> target)	Creates and returns a new BindingBuilder with the given target.
void	dispose()	Unbinds every property stored in the manager and then clears the bindings map.
static BindingManager	instance()	Retrieves the instance of the BindingManager.
boolean	isBound(ObservableValue target)	Checks if the bindings map contains the given target.
boolean	isEmpty()	Checks if size() is 0;
boolean	isIgnoreBinding(ObservableValue target)	Checks if there's an existing binding for the given target and the associated BindingHelper's ignoreBinding state.
int	size()	The number of bindings in the map.
<T> BindingManager	unbind(ObservableValue<T> target)	If the given target is in the map, removes it and calls BindingHelper.unbind().
BindingManager	unbindReadOnly(ReadOnlyBooleanWrapper target)	Retrieves the read-only property with ReadOnlyBooleanWrapper.getReadOnlyProperty() and calls unbind(ObservableValue) on it.
BindingManager	unbindReadOnly(ReadOnlyDoubleWrapper target)	Retrieves the read-only property with ReadOnlyDoubleWrapper.getReadOnlyProperty() and calls unbind(ObservableValue) on it.
BindingManager	unbindReadOnly(ReadOnlyFloatWrapper target)	Retrieves the read-only property with ReadOnlyFloatWrapper.getReadOnlyProperty() and calls unbind(ObservableValue) on it.
BindingManager	unbindReadOnly(ReadOnlyIntegerWrapper target)	Retrieves the read-only property with ReadOnlyIntegerWrapper.getReadOnlyProperty() and calls unbind(ObservableValue) on it.
BindingManager	unbindReadOnly(ReadOnlyLongWrapper target)	Retrieves the read-only property with ReadOnlyLongWrapper.getReadOnlyProperty() and calls unbind(ObservableValue) on it.
<T> BindingManager	unbindReadOnly(ReadOnlyObjectWrapper<T> target)	Retrieves the read-only property with ReadOnlyObjectWrapper.getReadOnlyProperty() and calls unbind(ObservableValue) on it.
BindingManager	unbindReadOnly(ReadOnlyStringWrapper target)	Retrieves the read-only property with ReadOnlyStringWrapper.getReadOnlyProperty() and calls unbind(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 BindingManager instance()

Retrieves the instance of the BindingManager.

bind

public <T> BindingBuilder<T> bind(ObservableValue<? extends T> target)

Creates and returns a new BindingBuilder with the given target.

bind

public <T> BindingBuilder<T> bind(Property<T> target)

Creates a new BindingBuilder with the given target.

The difference with the above method is that it accepts a Property, which means that it's not necessary to specify how to update the target, by default it uses WritableValue.setValue(Object).

apply

public <T> BindingManager apply(BindingBuilder<T> bindingBuilder,
 BindingHelper<T> bindingHelper)

Creates a unidirectional binding with the given arguments.

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

Calls biBindingCheck(ObservableValue) on the target before proceeding.

If the target is already bound, unbind(ObservableValue) is called on the target before proceeding.

At this point puts a new entry in the bindings map with the target and the specified BindingHelper. Then the actual bind happens by calling the binding helper methods.

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

unbind

public <T> BindingManager unbind(ObservableValue<T> target)

If the given target is in the map, removes it and calls BindingHelper.unbind().

unbindReadOnly

public BindingManager unbindReadOnly(ReadOnlyBooleanWrapper target)

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

unbindReadOnly

public BindingManager unbindReadOnly(ReadOnlyStringWrapper target)

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

unbindReadOnly

public BindingManager unbindReadOnly(ReadOnlyIntegerWrapper target)

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

unbindReadOnly

public BindingManager unbindReadOnly(ReadOnlyLongWrapper target)

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

unbindReadOnly

public BindingManager unbindReadOnly(ReadOnlyFloatWrapper target)

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

unbindReadOnly

public BindingManager unbindReadOnly(ReadOnlyDoubleWrapper target)

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

unbindReadOnly

public <T> BindingManager unbindReadOnly(ReadOnlyObjectWrapper<T> target)

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

dispose

public void dispose()

Unbinds every property stored in the manager and then clears the bindings map.

size

public int size()

The number of bindings in the map.

isEmpty

public boolean isEmpty()

Checks if size() is 0;

isIgnoreBinding

public boolean isIgnoreBinding(ObservableValue target)

Checks if there's an existing binding for the given target and the associated BindingHelper's ignoreBinding state.

isBound

public boolean isBound(ObservableValue target)

Checks if the bindings map contains the given target.