griffon.javafx.beans.property

Class AbstractResetableProperty<T>

java.lang.Object

griffon.javafx.beans.property.AbstractResetableProperty<T>

All Implemented Interfaces:

ResetableProperty<T>

Direct Known Subclasses:

ResetableBooleanProperty, ResetableDoubleProperty, ResetableFloatProperty, ResetableIntegerProperty, ResetableLongProperty, ResetableObjectProperty, ResetableStringProperty

public abstract class AbstractResetableProperty<T>
extends Object
implements ResetableProperty<T>

Since:

2.10.0

Author:

Andres Almiray

Property Summary

Type	Property and Description
BooleanBinding	dirty A property that tracks if the current value differs form the base value.
protected abstract Property<T>	writableBaseValue

Properties inherited from interface griffon.javafx.beans.property.ResetableProperty

baseValue, value

Field Summary

Fields

Modifier and Type	Field and Description
protected BooleanBinding	dirty

Constructor Summary

Constructors

Constructor and Description
AbstractResetableProperty() The constructor of AbstractResetableProperty
AbstractResetableProperty(Object bean, String name) The constructor of AbstractResetableProperty
AbstractResetableProperty(Object bean, String name, T baseValue) The constructor of AbstractResetableProperty
AbstractResetableProperty(T baseValue) The constructor of AbstractResetableProperty

Method Summary

Modifier and Type	Method and Description
protected boolean	checkValuesAreNotEqual()
protected BooleanBinding	createDirtyBinding()
BooleanBinding	dirtyProperty() A property that tracks if the current value differs form the base value.
T	getBaseValue() Returns the base value of this ResetableProperty.
Object	getBean() Returns the Object that contains this property.
String	getName() Returns the name of this property.
T	getValue() Returns the current value of this ResetableProperty.
boolean	isDirty() Query if the current value differs from the base value.
ResetableProperty<T>	rebase() Sets the current value as the base value.
ResetableProperty<T>	reset() Sets the base value as the current value.
ResetableProperty<T>	setValue(T value) Sets the current value.
protected abstract Property<T>	writableBaseValueProperty()

Methods inherited from class java.lang.Object

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

Methods inherited from interface griffon.javafx.beans.property.ResetableProperty

baseValueProperty, valueProperty

Property Detail

writableBaseValue

@Nonnull
protected abstract Property<T> writableBaseValueProperty

dirty

@Nonnull
public BooleanBinding dirtyProperty

Specified by:

dirtyProperty in interface ResetableProperty<T>

Field Detail

dirty

protected final BooleanBinding dirty

Constructor Detail

AbstractResetableProperty

public AbstractResetableProperty()

The constructor of AbstractResetableProperty

AbstractResetableProperty

public AbstractResetableProperty(@Nullable
                                 T baseValue)

The constructor of AbstractResetableProperty

Parameters:

baseValue - the base value of this AbstractResetableProperty

AbstractResetableProperty

public AbstractResetableProperty(@Nullable
                                 Object bean,
                                 @Nonnull
                                 String name)

The constructor of AbstractResetableProperty

Parameters:

bean - the bean of this AbstractResetableProperty

name - the name of this AbstractResetableProperty

AbstractResetableProperty

public AbstractResetableProperty(@Nullable
                                 Object bean,
                                 @Nonnull
                                 String name,
                                 @Nullable
                                 T baseValue)

The constructor of AbstractResetableProperty

Parameters:

bean - the bean of this AbstractResetableProperty

name - the name of this AbstractResetableProperty

baseValue - the base value of this AbstractResetableProperty

Method Detail

createDirtyBinding

@Nonnull
protected BooleanBinding createDirtyBinding()

checkValuesAreNotEqual

protected boolean checkValuesAreNotEqual()

writableBaseValueProperty

@Nonnull
protected abstract Property<T> writableBaseValueProperty()

dirtyProperty

@Nonnull
public BooleanBinding dirtyProperty()

Description copied from interface: ResetableProperty

A property that tracks if the current value differs form the base value.

Specified by:

dirtyProperty in interface ResetableProperty<T>

getBaseValue

@Nullable
public T getBaseValue()

Description copied from interface: ResetableProperty

Returns the base value of this ResetableProperty.

Specified by:

getBaseValue in interface ResetableProperty<T>

Returns:

the base value

getValue

@Nullable
public T getValue()

Description copied from interface: ResetableProperty

Returns the current value of this ResetableProperty.

Specified by:

getValue in interface ResetableProperty<T>

Returns:

the current value

setValue

@Nonnull
public ResetableProperty<T> setValue(@Nullable
                                              T value)

Description copied from interface: ResetableProperty

Sets the current value.

Specified by:

setValue in interface ResetableProperty<T>

Parameters:

value - the new value

isDirty

public boolean isDirty()

Description copied from interface: ResetableProperty

Query if the current value differs from the base value.

Specified by:

isDirty in interface ResetableProperty<T>

Returns:

true if values differ, false otherwise

rebase

@Nonnull
public ResetableProperty<T> rebase()

Description copied from interface: ResetableProperty

Sets the current value as the base value.

Specified by:

rebase in interface ResetableProperty<T>

Returns:

this ResetableProperty

reset

@Nonnull
public ResetableProperty<T> reset()

Description copied from interface: ResetableProperty

Sets the base value as the current value.

Specified by:

reset in interface ResetableProperty<T>

Returns:

this ResetableProperty

getBean

@Nullable
public Object getBean()

Description copied from interface: ResetableProperty

Returns the Object that contains this property. If this property is not contained in an Object, null is returned.

Specified by:

getBean in interface ResetableProperty<T>

Returns:

the containing Object or null

getName

@Nonnull
public String getName()

Description copied from interface: ResetableProperty

Returns the name of this property. If the property does not have a name, this method returns an empty String.

Specified by:

getName in interface ResetableProperty<T>

Returns:

the name or an empty String