Class ListPropertyBase<E>

java.lang.Object

javafx.beans.binding.ListExpression<E>

javafx.beans.property.ReadOnlyListProperty<E>

javafx.beans.property.ListProperty<E>

javafx.beans.property.ListPropertyBase<E>

Type Parameters:

E - the type of the List elements

All Implemented Interfaces:

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

Direct Known Subclasses:

SimpleListProperty

public abstract class ListPropertyBase<E>
extends ListProperty<E>

The class ListPropertyBase is the base class for a property wrapping an ObservableList. It provides all the functionality required for a property except for the ReadOnlyProperty.getBean() and ReadOnlyProperty.getName() methods, which must be implemented by extending classes.

Since:

JavaFX 2.1

See Also:

• ObservableList
• ListProperty

Property Summary

Properties

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

Constructor Summary

Constructors

Constructor	Description
ListPropertyBase()	The Constructor of ListPropertyBase
ListPropertyBase(ObservableList<E> initialValue)	The constructor of the ListPropertyBase.

Method Summary

Modifier and Type	Method	Description
void	addListener(InvalidationListener listener)	Adds an InvalidationListener which will be notified whenever the Observable becomes invalid.
void	addListener(ChangeListener<? super ObservableList<E>> listener)	Adds a ChangeListener which will be notified whenever the value of the ObservableValue changes.
void	addListener(ListChangeListener<? super E> listener)	Add a listener to this observable list.
void	bind(ObservableValue<? extends ObservableList<E>> newObservable)	Create a unidirection binding for this Property.
ReadOnlyBooleanProperty	emptyProperty()	A boolean property that is true, if the list is empty.
protected void	fireValueChangedEvent()	Sends notifications to all attached InvalidationListeners, ChangeListeners, and ListChangeListener.
protected void	fireValueChangedEvent(ListChangeListener.Change<? extends E> change)	Sends notifications to all attached InvalidationListeners, ChangeListeners, and ListChangeListener.
ObservableList<E>	get()	Returns the current value of this ObservableObjectValue<T>.
protected void	invalidated()	The method invalidated() can be overridden to receive invalidation notifications.
boolean	isBound()	Can be used to check, if a Property is bound.
void	removeListener(InvalidationListener listener)	Removes the given listener from the list of listeners, that are notified whenever the value of the Observable becomes invalid.
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.
void	removeListener(ListChangeListener<? super E> listener)	Tries to remove a listener from this observable list.
void	set(ObservableList<E> newValue)	Set the wrapped value.
ReadOnlyIntegerProperty	sizeProperty()	An integer property that represents the size of the list.
String	toString()	Returns a string representation of this ListPropertyBase object.
void	unbind()	Remove the unidirectional binding for this Property.

Methods declared in class ListProperty

bindBidirectional, setValue, unbindBidirectional

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.
void	unbindBidirectional(Property<ObservableList<E>> other)	Removes a bidirectional binding between this Property and another one.

Methods declared in class ReadOnlyListProperty

bindContent, bindContentBidirectional, equals, hashCode, unbindContent, unbindContentBidirectional

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()
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, 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, 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)
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()
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

subscribe

Modifier and Type	Method	Description
default Subscription	subscribe(Runnable invalidationSubscriber)	Creates a Subscription on this Observable which calls invalidationSubscriber whenever it becomes invalid.

Methods declared in interface ObservableList

filtered, replaceRange, sorted, sorted

Modifier and Type	Method	Description
default FilteredList<E>	filtered(Predicate<E> predicate)	Creates a FilteredList wrapper of this list using the specified predicate.
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 ObservableValue

flatMap, map, orElse, subscribe, subscribe, when

Modifier and Type	Method	Description
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.
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.

Methods declared in interface WritableValue

getValue

Modifier and Type	Method	Description
ObservableList<E>	getValue()	Get the wrapped value.

Property Details

size

public ReadOnlyIntegerProperty sizeProperty

Specified by:

sizeProperty in class ListExpression<E>

Returns:

the property

See Also:

• sizeProperty()

empty

public ReadOnlyBooleanProperty emptyProperty

Specified by:

emptyProperty in class ListExpression<E>

Returns:

the ReadOnlyBooleanProperty

See Also:

• emptyProperty()

Constructor Details

ListPropertyBase

public ListPropertyBase()

The Constructor of ListPropertyBase

ListPropertyBase

public ListPropertyBase(ObservableList<E> initialValue)

The constructor of the ListPropertyBase.

Parameters:

initialValue - the initial value of the wrapped value

Method Details

sizeProperty

public ReadOnlyIntegerProperty sizeProperty()

Description copied from class: ListExpression

An integer property that represents the size of the list.

Specified by:

sizeProperty in class ListExpression<E>

Returns:

the size property

See Also:

• ListExpression.getSize()

emptyProperty

public ReadOnlyBooleanProperty emptyProperty()

Description copied from class: ListExpression

A boolean property that is true, if the list is empty.

Specified by:

emptyProperty in class ListExpression<E>

Returns:

the empty property

See Also:

• ListExpression.isEmpty()

addListener

public void addListener(InvalidationListener listener)

Description copied from interface: Observable

Adds an InvalidationListener which will be notified whenever the Observable becomes invalid. If the same listener is added more than once, then it will be notified more than once. That is, no check is made to ensure uniqueness.

Note that the same actual InvalidationListener instance may be safely registered for different Observables.

The Observable stores a strong reference to the listener which will prevent the listener from being garbage collected and may result in a memory leak. It is recommended to either unregister a listener by calling removeListener after use or to use an instance of WeakInvalidationListener avoid this situation.

Parameters:

listener - The listener to register

See Also:

• Observable.removeListener(InvalidationListener)

removeListener

public void removeListener(InvalidationListener listener)

Description copied from interface: Observable

Removes the given listener from the list of listeners, that are notified whenever the value of the Observable becomes invalid.

If the given listener has not been previously registered (i.e. it was never added) then this method call is a no-op. If it had been previously added then it will be removed. If it had been added more than once, then only the first occurrence will be removed.

Parameters:

listener - The listener to remove

See Also:

• Observable.addListener(InvalidationListener)

addListener

public void addListener(ChangeListener<? super ObservableList<E>> listener)

Description copied from interface: ObservableValue

Adds a ChangeListener which will be notified whenever the value of the ObservableValue changes. If the same listener is added more than once, then it will be notified more than once. That is, no check is made to ensure uniqueness.

Note that the same actual ChangeListener instance may be safely registered for different ObservableValues.

The ObservableValue stores a strong reference to the listener which will prevent the listener from being garbage collected and may result in a memory leak. It is recommended to either unregister a listener by calling removeListener after use or to use an instance of WeakChangeListener avoid this situation.

Parameters:

listener - The listener to register

See Also:

• ObservableValue.removeListener(ChangeListener)

removeListener

public void removeListener(ChangeListener<? super ObservableList<E>> listener)

Description copied from interface: ObservableValue

Removes the given listener from the list of listeners that are notified whenever the value of the ObservableValue changes.

If the given listener has not been previously registered (i.e. it was never added) then this method call is a no-op. If it had been previously added then it will be removed. If it had been added more than once, then only the first occurrence will be removed.

Parameters:

listener - The listener to remove

See Also:

• ObservableValue.addListener(ChangeListener)

addListener

public void addListener(ListChangeListener<? super E> listener)

Description copied from interface: ObservableList

Add a listener to this observable list.

Parameters:

listener - the listener for listening to the list changes

removeListener

public void removeListener(ListChangeListener<? super E> listener)

Description copied from interface: ObservableList

Tries to remove a listener from this observable list. If the listener is not attached to this list, nothing happens.

Parameters:

listener - a listener to remove

fireValueChangedEvent

protected void fireValueChangedEvent()

Sends notifications to all attached InvalidationListeners, ChangeListeners, and ListChangeListener. This method is called when the value is changed, either manually by calling set(ObservableList) or in case of a bound property, if the binding becomes invalid.

fireValueChangedEvent

protected void fireValueChangedEvent(ListChangeListener.Change<? extends E> change)

Sends notifications to all attached InvalidationListeners, ChangeListeners, and ListChangeListener. This method is called when the content of the list changes.

Parameters:

change - the change that needs to be propagated

invalidated

protected void invalidated()

The method invalidated() can be overridden to receive invalidation notifications. This is the preferred option in Objects defining the property, because it requires less memory. The default implementation is empty.

get

public ObservableList<E> get()

Description copied from interface: ObservableObjectValue

Returns the current value of this ObservableObjectValue<T>.

Returns:

The current value

set

public void set(ObservableList<E> newValue)

Description copied from interface: WritableObjectValue

Set the wrapped value. Should be equivalent to WritableValue.setValue(java.lang.Object)

Parameters:

newValue - The new value

See Also:

• WritableObjectValue.get()

isBound

public boolean isBound()

Description copied from interface: Property

Can be used to check, if a Property is bound.

Returns:

true if the Property is bound, false otherwise

See Also:

• Property.bind(javafx.beans.value.ObservableValue)

bind

public void bind(ObservableValue<? extends ObservableList<E>> newObservable)

Description copied from interface: Property

Create a unidirection binding for this Property.

Note that JavaFX has all the bind calls implemented through weak listeners. This means the bound property can be garbage collected and stopped from being updated.

Parameters:

newObservable - The observable this Property should be bound to.

unbind

public void unbind()

Description copied from interface: Property

Remove the unidirectional binding for this Property. If the Property is not bound, calling this method has no effect.

See Also:

• Property.bind(javafx.beans.value.ObservableValue)

toString

public String toString()

Returns a string representation of this ListPropertyBase object.

Overrides:

toString in class ListProperty<E>

Returns:

a string representation of this ListPropertyBase object.