Module MaterialFX

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

Class SynchronizedStringProperty

java.lang.Object

javafx.beans.binding.StringExpression

javafx.beans.property.ReadOnlyStringProperty

javafx.beans.property.StringProperty

javafx.beans.property.StringPropertyBase

javafx.beans.property.SimpleStringProperty

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

All Implemented Interfaces:

SynchronizedProperty<String>, Observable, Property<String>, ReadOnlyProperty<String>, ObservableObjectValue<String>, ObservableStringValue, ObservableValue<String>, WritableObjectValue<String>, WritableStringValue, WritableValue<String>

public class SynchronizedStringProperty
extends SimpleStringProperty
implements SynchronizedProperty<String>

Implementation of SynchronizedProperty for String 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
SynchronizedStringProperty()
SynchronizedStringProperty(Object bean, String name)
SynchronizedStringProperty(Object bean, String name, String initialValue)
SynchronizedStringProperty(String initialValue)

Method Summary

Modifier and Type	Method	Description
void	awake()	Awakes the property by setting SynchronizedProperty.waiting() to false.
void	bind(ObservableValue<? extends String> source)	Creates a unidirectional bindings with the given observable.
void	bindBidirectional(Property<String> 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) flag value and BindingManager.isIgnoreBinding(ObservableValue).
boolean	isWaiting()
void	setAndWait(String 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<String> other)	Overridden to call BiBindingManager.unbind(ObservableValue, ObservableValue).
ReadOnlyBooleanProperty	waiting()

Methods inherited from class javafx.beans.property.SimpleStringProperty

getBean, getName

Methods inherited from class javafx.beans.property.StringPropertyBase

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

Methods inherited from class javafx.beans.property.StringProperty

bindBidirectional, bindBidirectional, setValue, unbindBidirectional

Methods inherited from class javafx.beans.binding.StringExpression

concat, getValue, getValueSafe, greaterThan, greaterThan, greaterThanOrEqualTo, greaterThanOrEqualTo, isEmpty, isEqualTo, isEqualTo, isEqualToIgnoreCase, isEqualToIgnoreCase, isNotEmpty, isNotEqualTo, isNotEqualTo, isNotEqualToIgnoreCase, isNotEqualToIgnoreCase, isNotNull, isNull, length, lessThan, lessThan, lessThanOrEqualTo, lessThanOrEqualTo, stringExpression

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, setValue

Constructor Details

SynchronizedStringProperty

public SynchronizedStringProperty()

SynchronizedStringProperty

public SynchronizedStringProperty(String initialValue)

SynchronizedStringProperty

public SynchronizedStringProperty(Object bean,
 String name)

SynchronizedStringProperty

public SynchronizedStringProperty(Object bean,
 String name,
 String initialValue)

Method Details

setAndWait

public void setAndWait(String 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<String>

Parameters:

value - the new value of the property

observable - the observable to wait for

isWaiting

public boolean isWaiting()

Specified by:

isWaiting in interface SynchronizedProperty<String>

Returns:

whether this property is in waiting state

waiting

public ReadOnlyBooleanProperty waiting()

Specified by:

waiting in interface SynchronizedProperty<String>

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<String>

fireValueChangedEvent

protected void fireValueChangedEvent()

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

Overrides:

fireValueChangedEvent in class StringPropertyBase

bind

public void bind(ObservableValue<? extends String> 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<String>

Overrides:

bind in class StringPropertyBase

Throws:

IllegalArgumentException - if the given observable is the property itself

See Also:

• BindingManager

bindBidirectional

public void bindBidirectional(Property<String> 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<String>

Overrides:

bindBidirectional in class StringProperty

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<String>

Overrides:

unbind in class StringPropertyBase

unbindBidirectional

public void unbindBidirectional(Property<String> other)

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

Specified by:

unbindBidirectional in interface Property<String>

Overrides:

unbindBidirectional in class StringProperty

clearBidirectional

public void clearBidirectional()

Delegate method for BiBindingManager.disposeFor(ObservableValue).

isBound

public boolean isBound()

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

Specified by:

isBound in interface Property<String>

Overrides:

isBound in class StringPropertyBase

Returns:

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