Module javafx.base

Package javafx.beans.property

Class ListProperty<E>

java.lang.Object

javafx.beans.binding.ListExpression<E>

javafx.beans.property.ReadOnlyListProperty<E>

javafx.beans.property.ListProperty<E>

Type Parameters:

E - the type of the List elements

All Implemented Interfaces:

Iterable<E>, Collection<E>, List<E>, Observable, Property<ObservableList<E>>, ReadOnlyProperty<E>, ObservableListValue<E>, ObservableObjectValue<E>, ObservableValue<E>, WritableListValue<E>, WritableObjectValue<E>, WritableValue<E>, ObservableList<E>

Direct Known Subclasses:

ListPropertyBase

public abstract class ListProperty<E>
extends ReadOnlyListProperty<E>
implements Property<ObservableList<E>>, WritableListValue<E>

This class provides a full implementation of a Property wrapping an ObservableList. The value of a ListProperty can be get and set with ObservableObjectValue.get(), ListExpression.getValue(), WritableObjectValue.set(Object), and setValue(ObservableList). A property can be bound and unbound unidirectional with Property.bind(javafx.beans.value.ObservableValue) and Property.unbind(). Bidirectional bindings can be created and removed with bindBidirectional(Property) and unbindBidirectional(Property). The context of a ListProperty can be read with ReadOnlyProperty.getBean() and ReadOnlyProperty.getName().

Since:

JavaFX 2.1

See Also:

ObservableList, ObservableListValue, WritableListValue, ReadOnlyListProperty, Property

Property Summary

Properties inherited from class javafx.beans.binding.ListExpression

empty, size

Constructor Summary

Constructors

Constructor	Description
ListProperty()

Method Summary

Modifier and Type	Method	Description
void	bindBidirectional(Property<ObservableList<E>> other)	Create a bidirectional binding between this Property and another one.
void	setValue(ObservableList<E> v)	Set the wrapped value.
String	toString()	Returns a string representation of this ListProperty object.
void	unbindBidirectional(Property<ObservableList<E>> other)	Remove a bidirectional binding between this Property and another one.

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.List

add, add, addAll, addAll, clear, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, of, of, of, of, of, of, of, of, of, of, of, of, remove, remove, removeAll, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray

Methods inherited from class javafx.beans.binding.ListExpression

add, add, addAll, addAll, addAll, asString, clear, contains, containsAll, emptyProperty, get, getSize, getValue, indexOf, isEmpty, isEqualTo, isNotEqualTo, isNotNull, isNull, iterator, lastIndexOf, listExpression, listIterator, listIterator, remove, remove, remove, removeAll, removeAll, retainAll, retainAll, set, setAll, setAll, size, sizeProperty, subList, toArray, toArray, valueAt, valueAt

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface javafx.beans.Observable

addListener, removeListener

Methods inherited from interface javafx.collections.ObservableList

addAll, addListener, filtered, remove, removeAll, removeListener, retainAll, setAll, setAll, sorted, sorted

Methods inherited from interface javafx.beans.value.ObservableObjectValue

get

Methods inherited from interface javafx.beans.value.ObservableValue

addListener, getValue, removeListener

Methods inherited from interface javafx.beans.property.Property

bind, isBound, unbind

Methods inherited from class javafx.beans.property.ReadOnlyListProperty

bindContent, bindContentBidirectional, equals, hashCode, unbindContent, unbindContentBidirectional

Methods inherited from interface javafx.beans.property.ReadOnlyProperty

getBean, getName

Methods inherited from interface javafx.beans.value.WritableObjectValue

get, set

Methods inherited from interface javafx.beans.value.WritableValue

getValue

Constructor Detail

ListProperty

public ListProperty()

Method Detail

setValue

public void setValue(ObservableList<E> v)

Set the wrapped value.

Specified by:

setValue in interface WritableValue<E>

Parameters:

v - The new value

bindBidirectional

public void bindBidirectional(Property<ObservableList<E>> other)

Create a bidirectional binding between this Property and another one. Bidirectional bindings exists independently of unidirectional bindings. So it is possible to add unidirectional binding to a property with bidirectional binding and vice-versa. However, this practice is discouraged.

It is possible to have multiple bidirectional bindings of one Property.

JavaFX bidirectional binding implementation use weak listeners. This means bidirectional binding does not prevent properties from being garbage collected.

Specified by:

bindBidirectional in interface Property<E>

Parameters:

other - the other Property

unbindBidirectional

public void unbindBidirectional(Property<ObservableList<E>> other)

Remove a bidirectional binding between this Property and another one. If no bidirectional binding between the properties exists, calling this method has no effect. It is possible to unbind by a call on the second property. This code will work:

     property1.bindBirectional(property2);
     property2.unbindBidirectional(property1);
 

Specified by:

unbindBidirectional in interface Property<E>

Parameters:

other - the other Property

toString

public String toString()

Returns a string representation of this ListProperty object.

Overrides:

toString in class ReadOnlyListProperty<E>

Returns:

a string representation of this ListProperty object.