griffon.javafx.beans.property

Interface ResetableProperty<T>

All Known Implementing Classes:

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

public interface ResetableProperty<T>

Since:

2.10.0

Author:

Andres Almiray

Property Summary

Type	Property and Description
javafx.beans.property.ReadOnlyProperty<T>	baseValue A property that tracks the base value of this ResetableProperty.
javafx.beans.binding.BooleanBinding	dirty A property that tracks if the current value differs form the base value.
javafx.beans.property.Property<T>	value A property that tracks the current value of this ResetableProperty.

Method Summary

Modifier and Type	Method and Description
javafx.beans.property.ReadOnlyProperty<T>	baseValueProperty() A property that tracks the base value of this ResetableProperty.
javafx.beans.binding.BooleanBinding	dirtyProperty() A property that tracks if the current value differs form the base value.
T	getBaseValue() Returns the base value of this ResetableProperty.
java.lang.Object	getBean() Returns the Object that contains this property.
java.lang.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.
javafx.beans.property.Property<T>	valueProperty() A property that tracks the current value of this ResetableProperty.

Property Detail

baseValue

@Nonnull
javafx.beans.property.ReadOnlyProperty<T> baseValueProperty

A property that tracks the base value of this ResetableProperty.

See Also:

getBaseValue()

value

@Nonnull
javafx.beans.property.Property<T> valueProperty

A property that tracks the current value of this ResetableProperty.

See Also:

getValue()

dirty

@Nonnull
javafx.beans.binding.BooleanBinding dirtyProperty

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

Method Detail

baseValueProperty

@Nonnull
javafx.beans.property.ReadOnlyProperty<T> baseValueProperty()

A property that tracks the base value of this ResetableProperty.

See Also:

getBaseValue()

valueProperty

@Nonnull
javafx.beans.property.Property<T> valueProperty()

A property that tracks the current value of this ResetableProperty.

See Also:

getValue()

dirtyProperty

@Nonnull
javafx.beans.binding.BooleanBinding dirtyProperty()

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

getBaseValue

@Nullable
T getBaseValue()

Returns the base value of this ResetableProperty.

Returns:

the base value

getValue

@Nullable
T getValue()

Returns the current value of this ResetableProperty.

Returns:

the current value

setValue

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

Sets the current value.

Parameters:

value - the new value

isDirty

boolean isDirty()

Query if the current value differs from the base value.

Returns:

true if values differ, false otherwise

rebase

@Nonnull
ResetableProperty<T> rebase()

Sets the current value as the base value.

Returns:

this ResetableProperty

reset

@Nonnull
ResetableProperty<T> reset()

Sets the base value as the current value.

Returns:

this ResetableProperty

getBean

@Nullable
java.lang.Object getBean()

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

Returns:

the containing Object or null

getName

@Nonnull
java.lang.String getName()

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

Returns:

the name or an empty String