Class ReadOnlyListProperty<E>

java.lang.Object

javafx.beans.binding.ListExpression<E>

javafx.beans.property.ReadOnlyListProperty<E>

Type Parameters:

E - the type of the List elements

All Implemented Interfaces:

Iterable<E>, Collection<E>, List<E>, SequencedCollection<E>, Observable, ReadOnlyProperty<ObservableList<E>>, ObservableListValue<E>, ObservableObjectValue<ObservableList<E>>, ObservableValue<ObservableList<E>>, ObservableList<E>

Direct Known Subclasses:

ListProperty, ReadOnlyListPropertyBase

public abstract class ReadOnlyListProperty<E>
extends ListExpression<E>
implements ReadOnlyProperty<ObservableList<E>>

Superclass for all readonly properties wrapping an ObservableList.

Since:

JavaFX 2.1

See Also:

• ObservableList
• ObservableListValue
• ListExpression
• ReadOnlyProperty

Property Summary

Properties declared in class ListExpression

empty, size

Type	Property	Description
abstract ReadOnlyBooleanProperty	empty	A boolean property that is true, if the list is empty.
abstract ReadOnlyIntegerProperty	size	An integer property that represents the size of the list.

Constructor Summary

Constructors

Constructor	Description
ReadOnlyListProperty()	The constructor of ReadOnlyListProperty.

Method Summary

Modifier and Type	Method	Description
void	bindContent(ObservableList<E> list)	Creates a content binding between the ObservableList, that is wrapped in this ReadOnlyListProperty, and another ObservableList.
void	bindContentBidirectional(ObservableList<E> list)	Creates a bidirectional content binding of the ObservableList, that is wrapped in this ReadOnlyListProperty, and another ObservableList.
boolean	equals(Object obj)
int	hashCode()
String	toString()	Returns a string representation of this ReadOnlyListProperty object.
void	unbindContent(Object object)	Deletes a content binding between the ObservableList, that is wrapped in this ReadOnlyListProperty, and another Object.
void	unbindContentBidirectional(Object object)	Deletes a bidirectional content binding between the ObservableList, that is wrapped in this ReadOnlyListProperty, and another Object.

Methods declared in class 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

Modifier and Type	Method	Description
void	add(int i, E element)
boolean	add(E element)
boolean	addAll(int i, Collection<? extends E> elements)
boolean	addAll(E... elements)	A convenience method for var-arg addition of elements.
boolean	addAll(Collection<? extends E> elements)
StringBinding	asString()	Creates a StringBinding that holds the value of the ListExpression turned into a String.
void	clear()
boolean	contains(Object obj)
boolean	containsAll(Collection<?> objects)
abstract ReadOnlyBooleanProperty	emptyProperty()	A boolean property that is true, if the list is empty.
E	get(int i)
int	getSize()	The size of the list
ObservableList<E>	getValue()	Returns the current value of this ObservableValue
int	indexOf(Object obj)
boolean	isEmpty()	Gets the value of the empty property.
BooleanBinding	isEqualTo(ObservableList<?> other)	Creates a new BooleanBinding that holds true if this list is equal to another ObservableList.
BooleanBinding	isNotEqualTo(ObservableList<?> other)	Creates a new BooleanBinding that holds true if this list is not equal to another ObservableList.
BooleanBinding	isNotNull()	Creates a new BooleanBinding that holds true if the wrapped list is not null.
BooleanBinding	isNull()	Creates a new BooleanBinding that holds true if the wrapped list is null.
Iterator<E>	iterator()
int	lastIndexOf(Object obj)
static <E> ListExpression<E>	listExpression(ObservableListValue<E> value)	Returns a ListExpression that wraps a ObservableListValue.
ListIterator<E>	listIterator()
ListIterator<E>	listIterator(int i)
E	remove(int i)
void	remove(int from, int to)	A simplified way of calling sublist(from, to).clear().
boolean	remove(Object obj)
boolean	removeAll(E... elements)	A convenience method for var-arg usage of the removeAll method.
boolean	removeAll(Collection<?> objects)
boolean	retainAll(E... elements)	A convenience method for var-arg usage of the retainAll method.
boolean	retainAll(Collection<?> objects)
E	set(int i, E element)
boolean	setAll(E... elements)	Clears the ObservableList and adds all the elements passed as var-args.
boolean	setAll(Collection<? extends E> elements)	Clears the ObservableList and adds all elements from the collection.
int	size()
abstract ReadOnlyIntegerProperty	sizeProperty()	An integer property that represents the size of the list.
List<E>	subList(int from, int to)
Object[]	toArray()
<T> T[]	toArray(T[] array)
ObjectBinding<E>	valueAt(int index)	Creates a new ObjectBinding that contains the element at the specified position.
ObjectBinding<E>	valueAt(ObservableIntegerValue index)	Creates a new ObjectBinding that contains the element at the specified position.

Methods declared in class Object

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

Methods declared in interface Collection

parallelStream, removeIf, stream, toArray

Methods declared in interface Iterable

forEach

Methods declared in interface List

addFirst, addLast, getFirst, getLast, removeFirst, removeLast, replaceAll, reversed, sort, spliterator

Methods declared in interface Observable

addListener, removeListener, subscribe

Modifier and Type	Method	Description
void	addListener(InvalidationListener listener)	Adds an InvalidationListener which will be notified whenever the Observable becomes invalid.
void	removeListener(InvalidationListener listener)	Removes the given listener from the list of listeners, that are notified whenever the value of the Observable becomes invalid.
default Subscription	subscribe(Runnable invalidationSubscriber)	Creates a Subscription on this Observable which calls invalidationSubscriber whenever it becomes invalid.

Methods declared in interface ObservableList

addListener, filtered, removeListener, replaceRange, sorted, sorted

Modifier and Type	Method	Description
void	addListener(ListChangeListener<? super E> listener)	Add a listener to this observable list.
default FilteredList<E>	filtered(Predicate<E> predicate)	Creates a FilteredList wrapper of this list using the specified predicate.
void	removeListener(ListChangeListener<? super E> listener)	Tries to remove a listener from this observable list.
default boolean	replaceRange(int from, int to, Collection<? extends E> col)	Replaces the elements in the range [from, to) with the elements from the given collection.
default SortedList<E>	sorted()	Creates a SortedList wrapper of this list with the natural ordering.
default SortedList<E>	sorted(Comparator<E> comparator)	Creates a SortedList wrapper of this list using the specified comparator.

Methods declared in interface ObservableObjectValue

get

Modifier and Type	Method	Description
ObservableList<E>	get()	Returns the current value of this ObservableObjectValue<T>.

Methods declared in interface ObservableValue

addListener, flatMap, map, orElse, removeListener, subscribe, subscribe, when

Modifier and Type	Method	Description
void	addListener(ChangeListener<? super ObservableList<E>> listener)	Adds a ChangeListener which will be notified whenever the value of the ObservableValue changes.
default <U> ObservableValue<U>	flatMap(Function<? super ObservableList<E>, ? extends ObservableValue<? extends U>> mapper)	Returns an ObservableValue that holds the value of an ObservableValue produced by applying the given mapping function on this value.
default <U> ObservableValue<U>	map(Function<? super ObservableList<E>, ? extends U> mapper)	Returns an ObservableValue that holds the result of applying the given mapping function on this value.
default ObservableValue<ObservableList<E>>	orElse(ObservableList<E> constant)	Returns an ObservableValue that holds this value, or the given constant if it is null.
void	removeListener(ChangeListener<? super ObservableList<E>> listener)	Removes the given listener from the list of listeners that are notified whenever the value of the ObservableValue changes.
default Subscription	subscribe(BiConsumer<? super ObservableList<E>, ? super ObservableList<E>> changeSubscriber)	Creates a Subscription on this ObservableValue which calls the given changeSubscriber with the old and new value whenever its value changes.
default Subscription	subscribe(Consumer<? super ObservableList<E>> valueSubscriber)	Creates a Subscription on this ObservableValue which immediately provides the current value to the given valueSubscriber, followed by any subsequent values whenever its value changes.
default ObservableValue<ObservableList<E>>	when(ObservableValue<Boolean> condition)	Returns an ObservableValue that holds this value and is updated only when condition holds true.

Methods declared in interface ReadOnlyProperty

getBean, getName

Modifier and Type	Method	Description
Object	getBean()	Returns the Object that contains this property.
String	getName()	Returns the name of this property.

Constructor Details

ReadOnlyListProperty

public ReadOnlyListProperty()

The constructor of ReadOnlyListProperty.

Method Details

bindContentBidirectional

public void bindContentBidirectional(ObservableList<E> list)

Creates a bidirectional content binding of the ObservableList, that is wrapped in this ReadOnlyListProperty, and another ObservableList.

A bidirectional content binding ensures that the content of two ObservableLists is the same. If the content of one of the lists changes, the other one will be updated automatically.

Parameters:

list - the ObservableList this property should be bound to

Throws:

NullPointerException - if list is null

IllegalArgumentException - if list is the same list that this ReadOnlyListProperty points to

unbindContentBidirectional

public void unbindContentBidirectional(Object object)

Deletes a bidirectional content binding between the ObservableList, that is wrapped in this ReadOnlyListProperty, and another Object.

Parameters:

object - the Object to which the bidirectional binding should be removed

Throws:

NullPointerException - if object is null

IllegalArgumentException - if object is the same list that this ReadOnlyListProperty points to

bindContent

public void bindContent(ObservableList<E> list)

Creates a content binding between the ObservableList, that is wrapped in this ReadOnlyListProperty, and another ObservableList.

A content binding ensures that the content of the wrapped ObservableLists is the same as that of the other list. If the content of the other list changes, the wrapped list will be updated automatically. Once the wrapped list is bound to another list, you must not change it directly.

Parameters:

list - the ObservableList this property should be bound to

Throws:

NullPointerException - if list is null

IllegalArgumentException - if list is the same list that this ReadOnlyListProperty points to

unbindContent

public void unbindContent(Object object)

Deletes a content binding between the ObservableList, that is wrapped in this ReadOnlyListProperty, and another Object.

Parameters:

object - the Object to which the binding should be removed

Throws:

NullPointerException - if object is null

IllegalArgumentException - if object is the same list that this ReadOnlyListProperty points to

equals

public boolean equals(Object obj)

Specified by:

equals in interface Collection<E>

Specified by:

equals in interface List<E>

Overrides:

equals in class Object

hashCode

public int hashCode()

Specified by:

hashCode in interface Collection<E>

Specified by:

hashCode in interface List<E>

Overrides:

hashCode in class Object

toString

public String toString()

Returns a string representation of this ReadOnlyListProperty object.

Overrides:

toString in class Object

Returns:

a string representation of this ReadOnlyListProperty object.