jfxtras.labs.scene.control

Class BeanPathAdapter.FieldProperty<BT,T,PT>

java.lang.Object

javafx.beans.binding.ObjectExpression<T>

javafx.beans.property.ReadOnlyObjectProperty<T>

javafx.beans.property.ObjectProperty<T>

javafx.beans.property.ObjectPropertyBase<PT>

jfxtras.labs.scene.control.BeanPathAdapter.FieldProperty<BT,T,PT>

Type Parameters:

BT - the bean type

T - the field type

PT - the get() type

All Implemented Interfaces:

javafx.beans.Observable, javafx.beans.property.Property<PT>, javafx.beans.property.ReadOnlyProperty<PT>, javafx.beans.value.ChangeListener<java.lang.Object>, javafx.beans.value.ObservableObjectValue<PT>, javafx.beans.value.ObservableValue<PT>, javafx.beans.value.WritableObjectValue<PT>, javafx.beans.value.WritableValue<PT>, javafx.collections.ListChangeListener<java.lang.Object>, javafx.collections.MapChangeListener<java.lang.Object,java.lang.Object>, javafx.collections.SetChangeListener<java.lang.Object>

Enclosing class:

BeanPathAdapter<B>

public static class BeanPathAdapter.FieldProperty<BT,T,PT>
extends javafx.beans.property.ObjectPropertyBase<PT>
implements javafx.collections.ListChangeListener<java.lang.Object>, javafx.collections.SetChangeListener<java.lang.Object>, javafx.collections.MapChangeListener<java.lang.Object,java.lang.Object>, javafx.beans.value.ChangeListener<java.lang.Object>

A <code>Property</code> extension that uses a bean's getter/setter to define the <code>Property</code>'s value.

Nested Class Summary

Nested classes/interfaces inherited from interface javafx.collections.ListChangeListener

javafx.collections.ListChangeListener.Change<E>

Nested classes/interfaces inherited from interface javafx.collections.SetChangeListener

javafx.collections.SetChangeListener.Change<E>

Nested classes/interfaces inherited from interface javafx.collections.MapChangeListener

javafx.collections.MapChangeListener.Change<K,V>

Constructor Summary

Constructors

Modifier

Constructor and Description

protected

BeanPathAdapter.FieldProperty(BT bean, java.lang.String fullPath, java.lang.String fieldName, jfxtras.labs.scene.control.BeanPathAdapter.FieldPathValueProperty notifyProperty, java.lang.Class<T> declaredFieldType, java.lang.String collectionItemPath, javafx.beans.Observable collectionObservable, java.lang.Class<?> collectionType, javafx.scene.control.SelectionModel<?> collectionSelectionModel, BeanPathAdapter.FieldProperty<?,?,?> itemMaster) Constructor

Method Summary

Modifier and Type	Method and Description
protected void	addRemoveCollectionListener(javafx.beans.Observable observable, boolean add) Adds/Removes the BeanPathAdapter.FieldProperty as a collection listener
void	changed(javafx.beans.value.ObservableValue<? extends java.lang.Object> observable, java.lang.Object oldValue, java.lang.Object newValue) Detects itemMaster changes for selection synchronization
protected BeanPathAdapter.FieldProperty<java.lang.Object,?,?>	extractCollectionItemFieldProperty(BeanPathAdapter.FieldBean<java.lang.Void,java.lang.Object> fieldBean) Extracts the collections BeanPathAdapter.FieldProperty from an associated BeanPathAdapter.FieldBean
protected BeanPathAdapter.FieldProperty<?,?,?>	genCollectionFieldProperty(java.lang.Object bean) Generates a BeanPathAdapter.FieldProperty for a getCollectionItemPath() and getCollectionSelectionModel() when applicable
protected BeanPathAdapter.FieldProperty<?,?,?>	genFieldProperty(java.lang.Object itemBeanValue, java.lang.Object itemBeanPropertyValue) Generates a BeanPathAdapter.FieldProperty using the specified bean and sets the optional value on the bean (when the value is not null).
PT	get()
BT	getBean()
java.lang.String	getCollectionItemPath()
protected javafx.beans.Observable	getCollectionObservable()
protected javafx.scene.control.SelectionModel<java.lang.Object>	getCollectionSelectionModel()
java.lang.Class<?>	getDeclaredFieldType()
java.lang.Object	getDirty()
java.lang.Class<T>	getFieldType()
java.lang.String	getName()
boolean	hasCollectionItemPath()
protected boolean	hasDefaultDerived()
protected boolean	hasFieldPathValueTypeAddOrRemove(boolean add) Determines if the FieldPathValueProperty is registered for adds or removals
boolean	hasItemMaster()
boolean	isList()
boolean	isMap()
protected boolean	isObservableList()
protected static boolean	isObservableList(javafx.beans.Observable observable)
protected boolean	isObservableMap()
protected static boolean	isObservableMap(javafx.beans.Observable observable)
protected boolean	isObservableSet()
protected static boolean	isObservableSet(javafx.beans.Observable observable)
boolean	isSet()
protected BeanPathAdapter.FieldPathValue	newSyncCollectionFieldPathValue(BeanPathAdapter.FieldProperty<?,?,?> fp, java.lang.Object fpv, boolean isAdd) Creates a new BeanPathAdapter.FieldPathValue using specified BeanPathAdapter.FieldProperty or the current BeanPathAdapter.FieldProperty when the specified BeanPathAdapter.FieldProperty is null.
void	onChanged(javafx.collections.ListChangeListener.Change<? extends java.lang.Object> change)
void	onChanged(javafx.collections.MapChangeListener.Change<? extends java.lang.Object,? extends java.lang.Object> change)
void	onChanged(javafx.collections.SetChangeListener.Change<? extends java.lang.Object> change)
protected void	postSet(java.lang.Object prevValue) Executes any post processing that needs to take place after set operation takes place
void	set(java.lang.Object v) Sets an <code>Object</code> value
protected void	setDerived() Sets the BeanPathAdapter.FieldHandle.deriveValueFromAccessor() value
void	setDirty(java.lang.Object v) Flags the <code>Property</code> value as dirty and calls set(Object)
protected void	setFieldPathValues(java.util.Collection<BeanPathAdapter.FieldPathValue> fieldPathValues) Sets a <code>Collection</code> of BeanPathAdapter.FieldPathValue(s) on the notifyProperty
protected void	setTarget(BT bean) Binds a new target to the BeanPathAdapter.FieldHandle
protected java.lang.Object	updateCollectionItemProperty(java.lang.Object itemBeanPropertyValue) Updates the underlying collection item value

Methods inherited from class javafx.beans.property.ObjectPropertyBase

addListener, addListener, bind, fireValueChangedEvent, invalidated, isBound, removeListener, removeListener, toString, unbind

Methods inherited from class javafx.beans.property.ObjectProperty

bindBidirectional, setValue, unbindBidirectional

Methods inherited from class javafx.beans.binding.ObjectExpression

asString, asString, asString, getValue, isEqualTo, isEqualTo, isNotEqualTo, isNotEqualTo, isNotNull, isNull, objectExpression

Methods inherited from class java.lang.Object

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

Methods inherited from interface javafx.beans.value.ObservableValue

getValue

Methods inherited from interface javafx.beans.value.WritableValue

getValue

Constructor Detail

BeanPathAdapter.FieldProperty

protected BeanPathAdapter.FieldProperty(BT bean,
                                        java.lang.String fullPath,
                                        java.lang.String fieldName,
                                        jfxtras.labs.scene.control.BeanPathAdapter.FieldPathValueProperty notifyProperty,
                                        java.lang.Class<T> declaredFieldType,
                                        java.lang.String collectionItemPath,
                                        javafx.beans.Observable collectionObservable,
                                        java.lang.Class<?> collectionType,
                                        javafx.scene.control.SelectionModel<?> collectionSelectionModel,
                                        BeanPathAdapter.FieldProperty<?,?,?> itemMaster)

Constructor

Parameters:

bean - the bean that the path belongs to

fullPath - the full . separated path to the BeanPathAdapter.FieldProperty

fieldName - the name of the field within the bean

notifyProperty - the FieldPathValueProperty that will be set every time the ObjectProperty.setValue(Object) is performed or an item within the value is changed

declaredFieldType - the declared <code>Class</code> of the field

collectionItemPath - the the . separated field names of the <code>Observable</code> collection (only applicable when the <code>Observable</code> is a <code>ObservableList</code>, <code>ObservableSet</code>, or <code>ObservableMap</code>)

collectionObservable - the <code>Observable</code> <code>Collection</code> used to bind to the BeanPathAdapter.FieldProperty OR when the <code>SelectionModel</code> is specified this is the <code>Observable</code> <code>Collection</code> of available items to select from

collectionType - the <code>Collection</code> <code>Class</code> used to attempt to transform the underlying field <code>Observable</code> <code>Collection</code> to the <code>Collection</code> <code>Class</code> (only applicable when the actual field is a <code>Collection</code>)

collectionSelectionModel - the <code>SelectionModel</code> used to set the values within the <code>Observable</code> only applicable when the <code>Observable</code> is used for selection(s) and therefore cannot be updated directly because it is read-only

itemMaster - the BeanPathAdapter.FieldProperty that contains the item(s) that the <code>SelectionModel</code> can select from

Method Detail

get

public PT get()

Specified by:

get in interface javafx.beans.value.ObservableObjectValue<PT>

Specified by:

get in interface javafx.beans.value.WritableObjectValue<PT>

Overrides:

get in class javafx.beans.property.ObjectPropertyBase<PT>

setDerived

protected void setDerived()

Sets the BeanPathAdapter.FieldHandle.deriveValueFromAccessor() value

setDirty

public void setDirty(java.lang.Object v)

Flags the <code>Property</code> value as dirty and calls set(Object)

Parameters:

v - the value to set

set

public void set(java.lang.Object v)

Sets an <code>Object</code> value

Specified by:

set in interface javafx.beans.value.WritableObjectValue<PT>

Overrides:

set in class javafx.beans.property.ObjectPropertyBase<PT>

Parameters:

v - the value to set

postSet

protected final void postSet(java.lang.Object prevValue)
                      throws java.lang.Throwable

Executes any post processing that needs to take place after set operation takes place

Parameters:

prevValue - the ObjectExpression.getValue() before ObjectProperty.setValue(Object) was called

Throws:

java.lang.Throwable - thrown when any errors occur when processing a post set operation

newSyncCollectionFieldPathValue

protected BeanPathAdapter.FieldPathValue newSyncCollectionFieldPathValue(BeanPathAdapter.FieldProperty<?,?,?> fp,
                                                                         java.lang.Object fpv,
                                                                         boolean isAdd)

Creates a new BeanPathAdapter.FieldPathValue using specified BeanPathAdapter.FieldProperty or the current BeanPathAdapter.FieldProperty when the specified BeanPathAdapter.FieldProperty is null.

Parameters:

fp - the BeanPathAdapter.FieldProperty (optional)

fpv - the ObjectExpression.getValue()

isAdd - true when adding an item

Returns:

the BeanPathAdapter.FieldPathValue

hasFieldPathValueTypeAddOrRemove

protected boolean hasFieldPathValueTypeAddOrRemove(boolean add)

Determines if the FieldPathValueProperty is registered for adds or removals

Parameters:

add - true to check for add, false to check for remove

Returns:

true when the FieldPathValueProperty is registered for the add or remove

setFieldPathValues

protected void setFieldPathValues(java.util.Collection<BeanPathAdapter.FieldPathValue> fieldPathValues)

Sets a <code>Collection</code> of BeanPathAdapter.FieldPathValue(s) on the notifyProperty

Parameters:

fieldPathValues - the <code>Collection</code> of BeanPathAdapter.FieldPathValue(s) to set

genFieldProperty

protected BeanPathAdapter.FieldProperty<?,?,?> genFieldProperty(java.lang.Object itemBeanValue,
                                                                java.lang.Object itemBeanPropertyValue)

Generates a BeanPathAdapter.FieldProperty using the specified bean and sets the optional value on the bean (when the value is not null). The returned BeanPathAdapter.FieldProperty will contain the same value instance contained with the item master. When the item master is not available an attempt will be made to get the item value from the getDirty() collection/map.

Parameters:

itemBeanValue - the collection BeanPathAdapter.FieldBean value to add/update. when null the existing BeanPathAdapter.FieldBean value will will be used unless it is null as well- in which case an attempt will be made to instantiate a new instance of the bean using a no-argument constructor

itemBeanPropertyValue - the collection BeanPathAdapter.FieldBean's BeanPathAdapter.FieldProperty value to add/update (null when no update should be made to the BeanPathAdapter.FieldBean's BeanPathAdapter.FieldProperty value)

Returns:

the BeanPathAdapter.FieldProperty for the collection item (null when none is required)

genCollectionFieldProperty

protected BeanPathAdapter.FieldProperty<?,?,?> genCollectionFieldProperty(java.lang.Object bean)

Generates a BeanPathAdapter.FieldProperty for a getCollectionItemPath() and getCollectionSelectionModel() when applicable

Parameters:

bean - the bean to generate a BeanPathAdapter.FieldProperty

Returns:

the generated BeanPathAdapter.FieldProperty

updateCollectionItemProperty

protected java.lang.Object updateCollectionItemProperty(java.lang.Object itemBeanPropertyValue)

Updates the underlying collection item value

Parameters:

itemBeanPropertyValue - the collection BeanPathAdapter.FieldBean's BeanPathAdapter.FieldProperty value to add/update

Returns:

getBean() when the collection item has it's own bean path, the itemBeanPropertyValue when it does not

See Also:

#updateCollectionItemBean(int, Object, Object)

addRemoveCollectionListener

protected void addRemoveCollectionListener(javafx.beans.Observable observable,
                                           boolean add)

Adds/Removes the BeanPathAdapter.FieldProperty as a collection listener

Parameters:

observable - the <code>Observable</code> collection/map to listen for changes on

add - true to add, false to remove

changed

public void changed(javafx.beans.value.ObservableValue<? extends java.lang.Object> observable,
                    java.lang.Object oldValue,
                    java.lang.Object newValue)

Detects itemMaster changes for selection synchronization

Specified by:

changed in interface javafx.beans.value.ChangeListener<java.lang.Object>

onChanged

public final void onChanged(javafx.collections.ListChangeListener.Change<? extends java.lang.Object> change)

Specified by:

onChanged in interface javafx.collections.ListChangeListener<java.lang.Object>

onChanged

public final void onChanged(javafx.collections.SetChangeListener.Change<? extends java.lang.Object> change)

Specified by:

onChanged in interface javafx.collections.SetChangeListener<java.lang.Object>

onChanged

public final void onChanged(javafx.collections.MapChangeListener.Change<? extends java.lang.Object,? extends java.lang.Object> change)

Specified by:

onChanged in interface javafx.collections.MapChangeListener<java.lang.Object,java.lang.Object>

getDirty

public java.lang.Object getDirty()

Returns:

the dirty value before conversion takes place

setTarget

protected void setTarget(BT bean)

Binds a new target to the BeanPathAdapter.FieldHandle

Parameters:

bean - the target bean to bind to

getBean

public BT getBean()

Specified by:

getBean in interface javafx.beans.property.ReadOnlyProperty<PT>

getName

public java.lang.String getName()

Specified by:

getName in interface javafx.beans.property.ReadOnlyProperty<PT>

getFieldType

public java.lang.Class<T> getFieldType()

Returns:

the BeanPathAdapter.FieldHandle.getFieldType()

getDeclaredFieldType

public java.lang.Class<?> getDeclaredFieldType()

Returns:

the BeanPathAdapter.FieldHandle.getDeclaredFieldType()

hasDefaultDerived

protected boolean hasDefaultDerived()

Returns:

the BeanPathAdapter.FieldHandle.hasDefaultDerived()

isList

public boolean isList()

Returns:

true when the BeanPathAdapter.FieldProperty is for a <code>List</code>

isSet

public boolean isSet()

Returns:

true when the BeanPathAdapter.FieldProperty is for a <code>Set</code>

isMap

public boolean isMap()

Returns:

true when the BeanPathAdapter.FieldProperty is for a <code>Map</code>

isObservableList

protected boolean isObservableList()

Returns:

true when the BeanPathAdapter.FieldProperty is bound to an <code>ObservableList</code>

isObservableSet

protected boolean isObservableSet()

Returns:

true when the BeanPathAdapter.FieldProperty is bound to an <code>ObservableSet</code>

isObservableMap

protected boolean isObservableMap()

Returns:

true when the BeanPathAdapter.FieldProperty is bound to an <code>ObservableMap</code>

isObservableList

protected static boolean isObservableList(javafx.beans.Observable observable)

Parameters:

observable - the <code>Observable</code> to check

Returns:

true when the <code>Observable</code> is an <code>ObservableList</code>

isObservableSet

protected static boolean isObservableSet(javafx.beans.Observable observable)

Parameters:

observable - the <code>Observable</code> to check

Returns:

true when the <code>Observable</code> is an <code>ObservableSet</code>

isObservableMap

protected static boolean isObservableMap(javafx.beans.Observable observable)

Parameters:

observable - the <code>Observable</code> to check

Returns:

true when the <code>Observable</code> is an <code>ObservableMap</code>

extractCollectionItemFieldProperty

protected BeanPathAdapter.FieldProperty<java.lang.Object,?,?> extractCollectionItemFieldProperty(BeanPathAdapter.FieldBean<java.lang.Void,java.lang.Object> fieldBean)

Extracts the collections BeanPathAdapter.FieldProperty from an associated BeanPathAdapter.FieldBean

Parameters:

fieldBean - the BeanPathAdapter.FieldBean to extract from

Returns:

the extracted BeanPathAdapter.FieldProperty

hasCollectionItemPath

public boolean hasCollectionItemPath()

Returns:

true when each item in the underlying collection has a path to it's own field value

getCollectionItemPath

public java.lang.String getCollectionItemPath()

Returns:

a . separated field name that represents each item in the underlying collection

getCollectionSelectionModel

protected javafx.scene.control.SelectionModel<java.lang.Object> getCollectionSelectionModel()

Returns:

a <code>SelectionModel</code> for the BeanPathAdapter.FieldProperty when the field references a collection/map for item selection or null when not a selection BeanPathAdapter.FieldProperty

getCollectionObservable

protected javafx.beans.Observable getCollectionObservable()

Returns:

an <code>Observable</code> used to represent an <code>ObservableList</code>, <code>ObservableSet</code>, or <code>ObservableMap</code> (null when either the observable collection has been garbage collected or the BeanPathAdapter.FieldProperty does not represent a collection)

hasItemMaster

public boolean hasItemMaster()

Returns:

true when the BeanPathAdapter.FieldProperty has an item master that it's using to reference get() for