Module MaterialFX

Package io.github.palexdev.materialfx.beans.properties.synced

Class SynchronizedFloatProperty

java.lang.Object

javafx.beans.binding.NumberExpressionBase

javafx.beans.binding.FloatExpression

javafx.beans.property.ReadOnlyFloatProperty

javafx.beans.property.FloatProperty

javafx.beans.property.FloatPropertyBase

javafx.beans.property.SimpleFloatProperty

io.github.palexdev.materialfx.beans.properties.synced.SynchronizedFloatProperty

All Implemented Interfaces:

SynchronizedProperty<Number>, NumberExpression, Observable, Property<Number>, ReadOnlyProperty<Number>, ObservableFloatValue, ObservableNumberValue, ObservableValue<Number>, WritableFloatValue, WritableNumberValue, WritableValue<Number>

public class SynchronizedFloatProperty
extends SimpleFloatProperty
implements SynchronizedProperty<Number>

Implementation of SynchronizedProperty for float values.

Nested Class Summary

Nested classes/interfaces inherited from interface io.github.palexdev.materialfx.beans.properties.base.SynchronizedProperty

SynchronizedProperty.Helper

Constructor Summary

Constructors

Constructor	Description
SynchronizedFloatProperty()
SynchronizedFloatProperty(float initialValue)
SynchronizedFloatProperty(Object bean, String name)
SynchronizedFloatProperty(Object bean, String name, float initialValue)

Method Summary

Modifier and Type	Method	Description
void	awake()	Awakes the property by setting SynchronizedProperty.waiting() to false.
void	bind(ObservableValue<? extends Number> source)	Creates a unidirectional bindings with the given observable.
void	bindBidirectional(Property<Number> other)	Creates a bidirectional bindings between this property and the given property.
void	clearBidirectional()	Delegate method for BiBindingManager.disposeFor(ObservableValue).
protected void	fireValueChangedEvent()
boolean	isBound()	Overridden to check the BindingManager.isBound(ObservableValue) and BindingManager.isIgnoreBinding(ObservableValue).
boolean	isWaiting()
void	setAndWait(Number value, ObservableValue<?> observable)	Sets this property's state to "waiting" then uses ExecutionUtils.executeWhen(Observable, Runnable, boolean, Supplier, boolean) to "awake" the property when the given observable changes.
void	unbind()	Overridden to call BindingManager.unbind(ObservableValue).
void	unbindBidirectional(Property<Number> other)	Overridden to call BiBindingManager.unbind(ObservableValue, ObservableValue).
ReadOnlyBooleanProperty	waiting()

Methods inherited from class javafx.beans.property.SimpleFloatProperty

getBean, getName

Methods inherited from class javafx.beans.property.FloatPropertyBase

addListener, addListener, get, invalidated, removeListener, removeListener, set, toString

Methods inherited from class javafx.beans.property.FloatProperty

asObject, floatProperty, setValue

Methods inherited from class javafx.beans.property.ReadOnlyFloatProperty

readOnlyFloatProperty

Methods inherited from class javafx.beans.binding.FloatExpression

add, add, add, add, divide, divide, divide, divide, doubleValue, floatExpression, floatExpression, floatValue, getValue, intValue, longValue, multiply, multiply, multiply, multiply, negate, subtract, subtract, subtract, subtract

Methods inherited from class javafx.beans.binding.NumberExpressionBase

add, asString, asString, asString, divide, greaterThan, greaterThan, greaterThan, greaterThan, greaterThan, greaterThanOrEqualTo, greaterThanOrEqualTo, greaterThanOrEqualTo, greaterThanOrEqualTo, greaterThanOrEqualTo, isEqualTo, isEqualTo, isEqualTo, isEqualTo, isEqualTo, isEqualTo, isEqualTo, isEqualTo, isNotEqualTo, isNotEqualTo, isNotEqualTo, isNotEqualTo, isNotEqualTo, isNotEqualTo, isNotEqualTo, isNotEqualTo, lessThan, lessThan, lessThan, lessThan, lessThan, lessThanOrEqualTo, lessThanOrEqualTo, lessThanOrEqualTo, lessThanOrEqualTo, lessThanOrEqualTo, multiply, numberExpression, subtract

Methods inherited from class java.lang.Object

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

Methods inherited from interface javafx.beans.Observable

addListener, removeListener

Methods inherited from interface javafx.beans.value.ObservableValue

addListener, getValue, removeListener

Methods inherited from interface javafx.beans.property.ReadOnlyProperty

getBean, getName

Methods inherited from interface javafx.beans.value.WritableValue

getValue

Constructor Details

SynchronizedFloatProperty

public SynchronizedFloatProperty()

SynchronizedFloatProperty

public SynchronizedFloatProperty(float initialValue)

SynchronizedFloatProperty

public SynchronizedFloatProperty(Object bean,
 String name)

SynchronizedFloatProperty

public SynchronizedFloatProperty(Object bean,
 String name,
 float initialValue)

Method Details

setAndWait

public void setAndWait(Number value,
 ObservableValue<?> observable)

Sets this property's state to "waiting" then uses ExecutionUtils.executeWhen(Observable, Runnable, boolean, Supplier, boolean) to "awake" the property when the given observable changes.

Just like JavaFX properties if the new value is the same as the current value the method returns and does nothing.

Specified by:

setAndWait in interface SynchronizedProperty<Number>

Parameters:

value - the new value of the property

observable - the observable to wait for

isWaiting

public boolean isWaiting()

Specified by:

isWaiting in interface SynchronizedProperty<Number>

Returns:

whether this property is in waiting state

waiting

public ReadOnlyBooleanProperty waiting()

Specified by:

waiting in interface SynchronizedProperty<Number>

Returns:

the waiting state property as a read only property

awake

public void awake()

Awakes the property by setting SynchronizedProperty.waiting() to false.

This method should never be invoked by the user, the awakening is automatically managed by the property. If for some reason the property stays in waiting state you are probably doing something wrong.

Specified by:

awake in interface SynchronizedProperty<Number>

fireValueChangedEvent

protected void fireValueChangedEvent()

Overridden to not fire a change event if waiting() is true.

Overrides:

fireValueChangedEvent in class FloatPropertyBase

bind

public void bind(ObservableValue<? extends Number> source)

Creates a unidirectional bindings with the given observable.

The binding is created using the new BindingManager mechanism.

If the property is already bound it is automatically unbound before bindings to the new observable.

Specified by:

bind in interface Property<Number>

Overrides:

bind in class FloatPropertyBase

Throws:

IllegalArgumentException - if the given observable is the property itself

See Also:

• BindingManager

bindBidirectional

public void bindBidirectional(Property<Number> other)

Creates a bidirectional bindings between this property and the given property.

The binding is created using the new BiBindingManager mechanism.

If the property is already bound unidirectionally it is automatically unbound.

If the property is already bound bidirectionally it won't be automatically unbound, just like JavaFX, this way you can have multiple bidirectional bindings

Specified by:

bindBidirectional in interface Property<Number>

Overrides:

bindBidirectional in class FloatProperty

Throws:

IllegalArgumentException - if the given observable is the property itself

See Also:

• BiBindingManager

unbind

public void unbind()

Overridden to call BindingManager.unbind(ObservableValue).

Specified by:

unbind in interface Property<Number>

Overrides:

unbind in class FloatPropertyBase

unbindBidirectional

public void unbindBidirectional(Property<Number> other)

Overridden to call BiBindingManager.unbind(ObservableValue, ObservableValue).

Specified by:

unbindBidirectional in interface Property<Number>

Overrides:

unbindBidirectional in class FloatProperty

clearBidirectional

public void clearBidirectional()

Delegate method for BiBindingManager.disposeFor(ObservableValue).

isBound

public boolean isBound()

Overridden to check the BindingManager.isBound(ObservableValue) and BindingManager.isIgnoreBinding(ObservableValue).

Specified by:

isBound in interface Property<Number>

Overrides:

isBound in class FloatPropertyBase

Returns:

true only if `BindingManager.isBound()` is true and `isIgnoreBound()` is false