eu.fthevenet.util.javafx.bindings

Class BindingManager

java.lang.Object

eu.fthevenet.util.javafx.bindings.BindingManager

All Implemented Interfaces:

java.lang.AutoCloseable

public class BindingManager
extends java.lang.Object
implements java.lang.AutoCloseable

A class that provide methods to centralize and register the attachment of listeners and bindings onto Observable instances.

This makes it possible to remove all listeners and bindings attached to to registered Observable instances in a determinist fashion (on invoking close()) and helps alleviate the potential for references leaks in some scenarios.

Author:

Frederic Thevenet

Constructor Summary

Constructors

Constructor and Description
BindingManager()

Method Summary

Modifier and Type	Method and Description
void	attachListener(javafx.collections.ObservableList<?> observable, javafx.collections.ListChangeListener listener) Attach a ListChangeListener to an ObservableList and registers the resulting binding.
void	attachListener(javafx.beans.value.ObservableValue<?> observable, javafx.beans.value.ChangeListener<?> listener) Attach a ChangeListener to an ObservableValue and registers the resulting binding.
void	attachListener(javafx.beans.value.ObservableValue<?> observable, javafx.beans.InvalidationListener listener) Attach a InvalidationListener to an ObservableValue and registers the resulting binding.
<T> void	bind(javafx.beans.property.Property<T> property, javafx.beans.value.ObservableValue<T> binding) Binds the specified ObservableValue onto the specified Property and registers the resulting binding.
void	close()
void	detachAllChangeListeners(javafx.beans.value.ObservableValue<?> observable) Remove all ChangeListener from an ObservableValue.
void	detachAllInvalidationListeners(javafx.beans.value.ObservableValue<?> observable) Remove all InvalidationListener from an ObservableValue.
void	detachAllListChangeListeners(javafx.collections.ObservableList<?> observable) Remove all ListChangeListener from an ObservableList.
void	detachListener(javafx.collections.ObservableList<?> observable, javafx.collections.ListChangeListener<?> listener) Remove a specific ListChangeListener from an ObservableList.
void	detachListener(javafx.beans.value.ObservableValue<?> observable, javafx.beans.value.ChangeListener listener) Remove a specific ChangeListener from an ObservableValue.
void	detachListener(javafx.beans.value.ObservableValue<?> observable, javafx.beans.InvalidationListener listener) Remove a specific InvalidationListener from an ObservableValue.
void	unbindAll() Unbinds all registered bindings

Methods inherited from class java.lang.Object

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

Constructor Detail

BindingManager

public BindingManager()

Method Detail

bind

public <T> void bind(javafx.beans.property.Property<T> property,
                     javafx.beans.value.ObservableValue<T> binding)

Binds the specified ObservableValue onto the specified Property and registers the resulting binding.

Type Parameters:

T - the type common to both Property and ObservableValue

Parameters:

property - the Property to bind

binding - the ObservableValue to bind to the Property

unbindAll

public void unbindAll()

Unbinds all registered bindings

attachListener

public void attachListener(javafx.beans.value.ObservableValue<?> observable,
                           javafx.beans.value.ChangeListener<?> listener)

Attach a ChangeListener to an ObservableValue and registers the resulting binding.

Parameters:

observable - the ObservableValue to attach the listener to.

listener - the ChangeListener to attach

attachListener

public void attachListener(javafx.beans.value.ObservableValue<?> observable,
                           javafx.beans.InvalidationListener listener)

Attach a InvalidationListener to an ObservableValue and registers the resulting binding.

Parameters:

observable - the ObservableValue to attach the listener to.

listener - the InvalidationListener to attach

attachListener

public void attachListener(javafx.collections.ObservableList<?> observable,
                           javafx.collections.ListChangeListener listener)

Attach a ListChangeListener to an ObservableList and registers the resulting binding.

Parameters:

observable - the ObservableList to attach the listener to.

listener - the ListChangeListener to attach

detachListener

public void detachListener(javafx.beans.value.ObservableValue<?> observable,
                           javafx.beans.value.ChangeListener listener)

Remove a specific ChangeListener from an ObservableValue.

Parameters:

observable - the ObservableValue to remove the listener from.

listener - the ChangeListener to remove

detachListener

public void detachListener(javafx.beans.value.ObservableValue<?> observable,
                           javafx.beans.InvalidationListener listener)

Remove a specific InvalidationListener from an ObservableValue.

Parameters:

observable - the ObservableValue to remove the listener from.

listener - the InvalidationListener to remove

detachListener

public void detachListener(javafx.collections.ObservableList<?> observable,
                           javafx.collections.ListChangeListener<?> listener)

Remove a specific ListChangeListener from an ObservableList.

Parameters:

observable - the ObservableList to remove the listener from.

listener - the ListChangeListener to remove

detachAllInvalidationListeners

public void detachAllInvalidationListeners(javafx.beans.value.ObservableValue<?> observable)

Remove all InvalidationListener from an ObservableValue.

Parameters:

observable - the ObservableValue to remove all listeners from.

detachAllChangeListeners

public void detachAllChangeListeners(javafx.beans.value.ObservableValue<?> observable)

Remove all ChangeListener from an ObservableValue.

Parameters:

observable - the ObservableValue to remove all listeners from.

detachAllListChangeListeners

public void detachAllListChangeListeners(javafx.collections.ObservableList<?> observable)

Remove all ListChangeListener from an ObservableList.

Parameters:

observable - the ObservableList to remove all listeners from.

close

public void close()

Specified by:

close in interface java.lang.AutoCloseable