de.saxsys.bindablefx

Class Bindings

java.lang.Object

de.saxsys.bindablefx.Bindings

public final class Bindings
extends Object

Utility class to allow for the binding mechanisms in the lib to be used and is also the only point of entrance.

Author:

Xyanid on 06.05.2016.

Method Summary

Modifier and Type	Method and Description
static <TValue,TConvertedValue> BidirectionalBinding<Object>	bindBidirectional(@NotNull javafx.beans.property.Property<TValue> property1, @NotNull javafx.beans.property.Property<TConvertedValue> property2, @NotNull IConverter<TValue,TConvertedValue> converter) Binds the given property1 bidirectional against the property2, the values will be converted using the given IConverter.
static <TValue,TConvertedValue> IFluentBinding<TConvertedValue>	convert(@NotNull javafx.beans.value.ObservableValue<TValue> observableValue, @NotNull Function<TValue,TConvertedValue> converter) Creates
static <TValue> IFluentBinding<TValue>	observe(@NotNull javafx.beans.value.ObservableValue<TValue> observedValue) Creates a new RootBinding that listens to changes made to the given ObservableValue and then invokes its own binding mechanism.
static <TValue,TConvertedValue> void	unbindBidirectional(@NotNull javafx.beans.property.Property<TValue> property1, @NotNull javafx.beans.property.Property<TConvertedValue> property2) Unbinds the given property1 bidirectional from property2.

Methods inherited from class java.lang.Object

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

Method Detail

observe

public static <TValue> IFluentBinding<TValue> observe(@NotNull
                                                      @NotNull javafx.beans.value.ObservableValue<TValue> observedValue)

Creates a new RootBinding that listens to changes made to the given ObservableValue and then invokes its own binding mechanism.

Type Parameters:

TValue - the type of the value of the ObservableValue

Parameters:

observedValue - the ObservableValue to listen to.

Returns:

a new RootBinding.

convert

public static <TValue,TConvertedValue> IFluentBinding<TConvertedValue> convert(@NotNull
                                                                               @NotNull javafx.beans.value.ObservableValue<TValue> observableValue,
                                                                               @NotNull
                                                                               @NotNull Function<TValue,TConvertedValue> converter)

Creates

Type Parameters:

TValue -

TConvertedValue -

Parameters:

observableValue -

converter -

Returns:

bindBidirectional

public static <TValue,TConvertedValue> BidirectionalBinding<Object> bindBidirectional(@NotNull
                                                                                      @NotNull javafx.beans.property.Property<TValue> property1,
                                                                                      @NotNull
                                                                                      @NotNull javafx.beans.property.Property<TConvertedValue> property2,
                                                                                      @NotNull
                                                                                      @NotNull IConverter<TValue,TConvertedValue> converter)

Binds the given property1 bidirectional against the property2, the values will be converted using the given IConverter.

Type Parameters:

TValue - the type of the first Property.

TConvertedValue - the type of the second Property.

Parameters:

property1 - the first Property to be bind.

property2 - the second Property to be bind.

converter - the IConverter to use.

unbindBidirectional

public static <TValue,TConvertedValue> void unbindBidirectional(@NotNull
                                                                @NotNull javafx.beans.property.Property<TValue> property1,
                                                                @NotNull
                                                                @NotNull javafx.beans.property.Property<TConvertedValue> property2)

Unbinds the given property1 bidirectional from property2.

NOTE: this method is incompatible with the BidirectionalBinding, so calling this unbind will not destroy any BidirectionalBinding but only the BidirectionalBinding.

Type Parameters:

TValue - the type of the first Property.

TConvertedValue - the type of the second Property.

Parameters:

property1 - the first Property to be unbound.

property2 - the second Property to be unbound.