org.codefx.libfx.nesting.property

Interface NestedProperty<T>

Type Parameters:

T - the type of the value wrapped by the property

All Superinterfaces:

Nested, javafx.beans.Observable, javafx.beans.value.ObservableValue<T>, javafx.beans.property.Property<T>, ReadOnlyNestedProperty<T>, javafx.beans.property.ReadOnlyProperty<T>, javafx.beans.value.WritableValue<T>

All Known Implementing Classes:

NestedBooleanProperty, NestedDoubleProperty, NestedFloatProperty, NestedIntegerProperty, NestedLongProperty, NestedObjectProperty, NestedStringProperty

public interface NestedProperty<T>
extends javafx.beans.property.Property<T>, ReadOnlyNestedProperty<T>

A Property which is based on a Nesting.

Simply put, this property is always bound to the nesting's inner observable (more precisely, it is bound to the Property instance contained in the optional value held by the nesting's innerObservable property).

Value Changes

This property is bidirectionally bound to the nesting's inner observable. So when that observable's value changes, so does this property's value and vice versa.

Inner Observable Is Replaced

When the nesting's inner observable is replaced by a present observable, this nested property's value changes to the new observable's value. Like all other value changes this one also results in calling invalidation and change listeners.

Missing Inner Observable

It is possible that a nesting's inner observable is missing (see comment on Nesting). In that case the innerObservablePresent property is false. How else the nested property behaves depends on its configuration which was determined when it was build.

When Inner Observable Goes Missing

When the inner observable goes missing, the nested property will either keep its value (this is the default behavior) or change to a value which was determined at build time. This can be done with the onInnerObservableMissing... methods on the nested property builder (e.g. onInnerObservableMissingSetDefaultValue ).

Update While Inner Observable Is Missing

When a value is set on the nested property while the inner observable is missing, it can not be propagated anywhere. For this reason the default behavior is to throw an exception. Alternatively the property can hold new values until a new inner observable is found (with onUpdateWhenInnerObservableMissingAcceptValues). The property will then be bound to the new observable and hence forget the intermediate value. (Since this property's change listeners are called, the replaced value can be caught there before it gets lost.)

Property Summary

Properties inherited from interface org.codefx.libfx.nesting.Nested

innerObservablePresentProperty

Method Summary

Methods inherited from interface javafx.beans.property.Property

bind, bindBidirectional, isBound, unbind, unbindBidirectional

Methods inherited from interface javafx.beans.value.WritableValue

getValue, setValue

Methods inherited from interface org.codefx.libfx.nesting.Nested

innerObservablePresentProperty, isInnerObservablePresent

Methods inherited from interface javafx.beans.property.ReadOnlyProperty

getBean, getName

Methods inherited from interface javafx.beans.value.ObservableValue

addListener, getValue, removeListener

Methods inherited from interface javafx.beans.Observable

addListener, removeListener