JavaFX 24 · javafx.beans.property.Property · APIdia, the JavaDoc alternative

Method Summary

Modifier and Type	Method and Description
public void	bind(ObservableValue<? extends T> The observable this `Property` should be bound to. observable) Create a unidirection binding for this `Property`.
public void	bindBidirectional(Property<T> the other `Property` other) Create a bidirectional binding between this `Property` and another one.
public boolean	Returns: `true` if the `Property` is bound, `false` otherwise isBound() Can be used to check, if a `Property` is bound.
public void	unbind() Remove the unidirectional binding for this `Property`.
public void	unbindBidirectional(Property<T> the other `Property` other) Removes a bidirectional binding between this `Property` and another one.

Inherited from javafx.beans.property.ReadOnlyProperty:: getBean getName
Inherited from javafx.beans.value.WritableValue:: getValue setValue

Method Detail

bind back to summary

bind	back to summary
public void bind(ObservableValue<? extends T> observable) Create a unidirection binding for this `Property`. Note that JavaFX has all the bind calls implemented through weak listeners. This means the bound property can be garbage collected and stopped from being updated. Parameters observable:ObservableValue<? extends T> The observable this `Property` should be bound to. Exceptions NullPointerException: if `observable` is `null`

public void bind(ObservableValue<? extends T> observable)

Create a unidirection binding for this Property.

Note that JavaFX has all the bind calls implemented through weak listeners. This means the bound property can be garbage collected and stopped from being updated.

Parameters

observable:ObservableValue<? extends T>: The observable this Property should be bound to.

Exceptions

NullPointerException:: if observable is null

bindBidirectional back to summary

bindBidirectional	back to summary
public void bindBidirectional(Property<T> other) Create a bidirectional binding between this `Property` and another one. Bidirectional bindings exists independently of unidirectional bindings. So it is possible to add unidirectional binding to a property with bidirectional binding and vice-versa. However, this practice is discouraged. It is possible to have multiple bidirectional bindings of one Property. JavaFX bidirectional binding implementation use weak listeners. This means bidirectional binding does not prevent properties from being garbage collected. Parameters other:Property<T> the other `Property` Exceptions NullPointerException: if `other` is `null` IllegalArgumentException: if `other` is `this`

public void bindBidirectional(Property<T> other)

Create a bidirectional binding between this Property and another one. Bidirectional bindings exists independently of unidirectional bindings. So it is possible to add unidirectional binding to a property with bidirectional binding and vice-versa. However, this practice is discouraged.

It is possible to have multiple bidirectional bindings of one Property.

JavaFX bidirectional binding implementation use weak listeners. This means bidirectional binding does not prevent properties from being garbage collected.

Parameters

other:Property<T>: the other Property

Exceptions

NullPointerException:: if other is null
IllegalArgumentException:: if other is this

isBound back to summary

isBound	back to summary
public boolean isBound() Can be used to check, if a `Property` is bound. Returns:boolean `true` if the `Property` is bound, `false` otherwise See Also `bind(javafx.beans.value.ObservableValue)`

public boolean isBound()

Can be used to check, if a Property is bound.

Returns:boolean: true if the Property is bound, false otherwise
See Also: bind(javafx.beans.value.ObservableValue)

unbind back to summary

unbind	back to summary
public void unbind() Remove the unidirectional binding for this `Property`. If the `Property` is not bound, calling this method has no effect. See Also `bind(javafx.beans.value.ObservableValue)`

public void unbind()

Remove the unidirectional binding for this Property. If the Property is not bound, calling this method has no effect.

See Also: bind(javafx.beans.value.ObservableValue)

unbindBidirectional back to summary

unbindBidirectional	back to summary
public void unbindBidirectional(Property<T> other) Removes a bidirectional binding between this `Property` and another one. If no bidirectional binding between the properties exists, calling this method has no effect. It is possible to unbind by a call on the second property. This code will work: property1.bindBidirectional(property2); property2.unbindBidirectional(property1); Parameters other:Property<T> the other `Property` Exceptions NullPointerException: if `other` is `null` IllegalArgumentException: if `other` is `this`

public void unbindBidirectional(Property<T> other)

Removes a bidirectional binding between this Property and another one. If no bidirectional binding between the properties exists, calling this method has no effect. It is possible to unbind by a call on the second property. This code will work:

    property1.bindBidirectional(property2);
    property2.unbindBidirectional(property1);

Parameters

other:Property<T>: the other Property

Exceptions

NullPointerException:: if other is null
IllegalArgumentException:: if other is this

public Interface Property<T>

Method Summary

Method Detail