io.github.palexdev.mfxcore.base.properties.synced.SynchronizedObjectProperty Maven / Gradle / Ivy
Show all versions of materialfx-all Show documentation
/*
* Copyright (C) 2022 Parisi Alessandro - [email protected]
* This file is part of MaterialFX (https://github.com/palexdev/MaterialFX)
*
* MaterialFX is free software: you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public License
* as published by the Free Software Foundation; either version 3 of the License,
* or (at your option) any later version.
*
* MaterialFX is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
* See the GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with MaterialFX. If not, see the type of the wrapped Object
*/
public class SynchronizedObjectProperty extends ReadOnlyObjectWrapper implements SynchronizedProperty {
//================================================================================
// Properties
//================================================================================
private final ReadOnlyBooleanWrapper waiting = new ReadOnlyBooleanWrapper() {
@Override
public void set(boolean newValue) {
super.set(newValue);
if (!newValue) SynchronizedObjectProperty.this.fireValueChangedEvent();
}
};
//================================================================================
// Constructors
//================================================================================
public SynchronizedObjectProperty() {}
public SynchronizedObjectProperty(T initialValue) {
super(initialValue);
}
public SynchronizedObjectProperty(Object bean, String name) {
super(bean, name);
}
public SynchronizedObjectProperty(Object bean, String name, T initialValue) {
super(bean, name, initialValue);
}
//================================================================================
// Implemented/Overridden Methods
//================================================================================
/**
* {@inheritDoc}
*/
@Override
public void setAndWait(T value, ObservableValue observable) {
if (!Helper.check(this, value, observable)) return;
waiting.set(true);
When.onChanged(observable)
.then((oldValue, newValue) -> awake())
.oneShot()
.listen();
set(value);
}
/**
* {@inheritDoc}
*/
@Override
public boolean isWaiting() {
return waiting.get();
}
/**
* {@inheritDoc}
*/
@Override
public ReadOnlyBooleanProperty waiting() {
return waiting.getReadOnlyProperty();
}
/**
* {@inheritDoc}
*/
@Override
public void awake() {
waiting.set(false);
}
/**
* {@inheritDoc}
*
* Overridden to not fire a change event if {@link #waiting()} is true.
*/
@Override
protected void fireValueChangedEvent() {
if (isWaiting()) return;
super.fireValueChangedEvent();
}
//================================================================================
// Binding
//================================================================================
/**
* Creates a unidirectional bindings with the given observable.
*
* The binding is created using the new {@link MFXBindings} mechanism.
*
* If the property is already bound it is automatically unbound before bindings to the new observable.
*
* @throws IllegalArgumentException if the given observable is the property itself
* @see MFXBindings
*/
@Override
public void bind(ObservableValue source) {
if (this == source) {
throw new IllegalArgumentException("Cannot bind to itself!");
}
if (isBound()) unbind();
MFXBindings.instance().bind(this).source(source).get();
}
/**
* Creates a bidirectional bindings between this property and the given property.
*
* The binding is created using the new {@link MFXBindings} 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
*
* @throws IllegalArgumentException if the given observable is the property itself
* @see MFXBindings
*/
@Override
public void bindBidirectional(Property other) {
if (this == other) {
throw new IllegalArgumentException("Cannot bind to itself!");
}
if (isBound()) unbind();
MFXBindings.instance().bindBidirectional(this).addSource(
new Source<>(other).implicit(this, other)).get();
}
/**
* Overridden to call {@link MFXBindings#unbind(ObservableValue)}.
*/
@Override
public void unbind() {
MFXBindings.instance().unbind(this);
}
/**
* Overridden to call {@link MFXBindings#unbindBidirectional(ObservableValue, ObservableValue)}.
*/
@Override
public void unbindBidirectional(Property other) {
MFXBindings.instance().unbindBidirectional(this, other);
}
/**
* Delegate method for {@link MFXBindings#disposeBidirectional(ObservableValue)}.
*/
public void clearBidirectional() {
MFXBindings.instance().disposeBidirectional(this);
}
/**
* Overridden to check the {@link MFXBindings#isBound(ObservableValue)} flag value and {@link MFXBindings#isIgnoreBinding(ObservableValue)}.
*
* @return true only if `MFXBindings.isBound()` is true and `isIgnoreBound()` is false
*/
@Override
public boolean isBound() {
return MFXBindings.instance().isBound(this) && !MFXBindings.instance().isIgnoreBinding(this);
}
}