APIdia Launch Partner
Top Description Inners Fields Constructors Methods
javafx.beans.property

public abstract Class ListPropertyBase<E>

extends ListProperty<E>
Class Inheritance
Known Direct Subclasses
javafx.beans.property.SimpleListProperty
Type Parameters
<E>
the type of the List elements
Imports
com.sun.javafx.binding.ListExpressionHelper, java.lang.ref.WeakReference, javafx.beans.InvalidationListener, .Observable, .WeakListener, javafx.beans.value.ChangeListener, .ObservableValue, javafx.collections.ListChangeListener, .ObservableList
The class ListPropertyBase is the base class for a property wrapping an javafx.collections.ObservableList. It provides all the functionality required for a property except for the getBean() and getName() methods, which must be implemented by extending classes.
Since
JavaFX 2.1
See Also
javafx.collections.ObservableList, ListProperty

Nested and Inner Type Summary

Modifier and TypeClass and Description
private class
ListPropertyBase.EmptyProperty

private static class
ListPropertyBase.Listener<E>

private class
ListPropertyBase.SizeProperty

Field Summary

Modifier and TypeField and Description
private ListPropertyBase<E>.EmptyProperty
empty0

private ListExpressionHelper<E>
helper

private final ListChangeListener<E>
listChangeListener

private InvalidationListener
listener

private ObservableValue<? extends ObservableList<E>>
observable

private ListPropertyBase<E>.SizeProperty
size0

private boolean
valid

private ObservableList<E>
value

Constructor Summary

AccessConstructor and Description
public
ListPropertyBase()

The Constructor of ListPropertyBase

public
ListPropertyBase(ObservableList<E>
the initial value of the wrapped value
initialValue)

The constructor of the ListPropertyBase.

Method Summary

Modifier and TypeMethod and Description
public void
addListener(InvalidationListener listener)

Implements javafx.beans.Observable.addListener.

Adds an InvalidationListener which will be notified whenever the Observable becomes invalid.

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

Implements javafx.beans.value.ObservableValue.addListener.

Adds a ChangeListener which will be notified whenever the value of the ObservableValue changes.

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

Implements javafx.collections.ObservableList.addListener.

Add a listener to this observable list.

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

Implements javafx.beans.property.Property.bind.

Create a unidirection binding for this Property.

public ReadOnlyBooleanProperty
emptyProperty()

Implements abstract javafx.beans.binding.ListExpression.emptyProperty.

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

protected void
fireValueChangedEvent()

Sends notifications to all attached InvalidationListeners, ChangeListeners, and javafx.collections.ListChangeListener.

protected void
fireValueChangedEvent(ListChangeListener.Change<? extends E>
the change that needs to be propagated
change)

Sends notifications to all attached InvalidationListeners, ChangeListeners, and javafx.collections.ListChangeListener.

public ObservableList<E>
get()

Implements javafx.beans.value.WritableObjectValue.get, javafx.beans.value.ObservableObjectValue.get.

Get the wrapped value.

protected void
invalidated()

The method invalidated() can be overridden to receive invalidation notifications.

private void
invalidateProperties()

public boolean
isBound()

Implements javafx.beans.property.Property.isBound.

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

private void
markInvalid(ObservableList<E> oldValue)

public void
removeListener(InvalidationListener listener)

Implements javafx.beans.Observable.removeListener.

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

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

Implements javafx.beans.value.ObservableValue.removeListener.

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

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

Implements javafx.collections.ObservableList.removeListener.

Tries to remove a listener from this observable list.

public void
set(ObservableList<E> newValue)

Implements javafx.beans.value.WritableObjectValue.set.

Set the wrapped value.

public ReadOnlyIntegerProperty
sizeProperty()

Implements abstract javafx.beans.binding.ListExpression.sizeProperty.

An integer property that represents the size of the list.

public String

Returns:

a string representation of this ListPropertyBase object.
toString()

Overrides javafx.beans.property.ListProperty.toString.

Returns a string representation of this ListPropertyBase object.

public void
unbind()

Implements javafx.beans.property.Property.unbind.

Remove the unidirectional binding for this Property.

Inherited from javafx.beans.property.ListProperty:
bindBidirectionalsetValueunbindBidirectional

Field Detail

empty0back to summary
private ListPropertyBase<E>.EmptyProperty empty0
helperback to summary
private ListExpressionHelper<E> helper
listChangeListenerback to summary
private final ListChangeListener<E> listChangeListener
listenerback to summary
private InvalidationListener listener
observableback to summary
private ObservableValue<? extends ObservableList<E>> observable
size0back to summary
private ListPropertyBase<E>.SizeProperty size0
validback to summary
private boolean valid
valueback to summary
private ObservableList<E> value

Constructor Detail

ListPropertyBaseback to summary
public ListPropertyBase()

The Constructor of ListPropertyBase

ListPropertyBaseback to summary
public ListPropertyBase(ObservableList<E> initialValue)

The constructor of the ListPropertyBase.

Parameters
initialValue:ObservableList<E>

the initial value of the wrapped value

Method Detail

addListenerback to summary
public void addListener(InvalidationListener listener)

Implements javafx.beans.Observable.addListener.

Doc from javafx.beans.Observable.addListener.

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.

Annotations
@Override
addListenerback to summary
public void addListener(ChangeListener<? super ObservableList<E>> listener)

Implements javafx.beans.value.ObservableValue.addListener.

Doc from javafx.beans.value.ObservableValue.addListener.

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.

Annotations
@Override
addListenerback to summary
public void addListener(ListChangeListener<? super E> listener)

Implements javafx.collections.ObservableList.addListener.

Doc from javafx.collections.ObservableList.addListener.

Add a listener to this observable list.

Annotations
@Override
bindback to summary
public void bind(final ObservableValue<? extends ObservableList<E>> newObservable)

Implements javafx.beans.property.Property.bind.

Doc from javafx.beans.property.Property.bind.

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.

Annotations
@Override
emptyPropertyback to summary
public ReadOnlyBooleanProperty emptyProperty()

Implements abstract javafx.beans.binding.ListExpression.emptyProperty.

Doc from javafx.beans.binding.ListExpression.emptyProperty.

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

Annotations
@Override
fireValueChangedEventback to summary
protected void fireValueChangedEvent()

Sends notifications to all attached InvalidationListeners, ChangeListeners, and javafx.collections.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.

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

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

Parameters
change:ListChangeListener.Change<? extends E>

the change that needs to be propagated

getback to summary
public ObservableList<E> get()

Implements javafx.beans.value.WritableObjectValue.get, javafx.beans.value.ObservableObjectValue.get.

Doc from javafx.beans.value.WritableObjectValue.get.

Get the wrapped value. This must be identical to the value returned from getValue().

This method exists only to align WritableObjectValue API with WritableBooleanValue and subclasses of WritableNumberValue

Annotations
@Override
invalidatedback to summary
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.

invalidatePropertiesback to summary
private void invalidateProperties()
isBoundback to summary
public boolean isBound()

Implements javafx.beans.property.Property.isBound.

Doc from javafx.beans.property.Property.isBound.

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

Annotations
@Override
markInvalidback to summary
private void markInvalid(ObservableList<E> oldValue)
removeListenerback to summary
public void removeListener(InvalidationListener listener)

Implements javafx.beans.Observable.removeListener.

Doc from javafx.beans.Observable.removeListener.

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.

Annotations
@Override
removeListenerback to summary
public void removeListener(ChangeListener<? super ObservableList<E>> listener)

Implements javafx.beans.value.ObservableValue.removeListener.

Doc from javafx.beans.value.ObservableValue.removeListener.

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.

Annotations
@Override
removeListenerback to summary
public void removeListener(ListChangeListener<? super E> listener)

Implements javafx.collections.ObservableList.removeListener.

Doc from javafx.collections.ObservableList.removeListener.

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

Annotations
@Override
setback to summary
public void set(ObservableList<E> newValue)

Implements javafx.beans.value.WritableObjectValue.set.

Doc from javafx.beans.value.WritableObjectValue.set.

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

Annotations
@Override
sizePropertyback to summary
public ReadOnlyIntegerProperty sizeProperty()

Implements abstract javafx.beans.binding.ListExpression.sizeProperty.

Doc from javafx.beans.binding.ListExpression.sizeProperty.

An integer property that represents the size of the list.

Annotations
@Override
toStringback to summary
public String toString()

Overrides javafx.beans.property.ListProperty.toString.

Returns a string representation of this ListPropertyBase object.

Returns:String

a string representation of this ListPropertyBase object.

Annotations
@Override
unbindback to summary
public void unbind()

Implements javafx.beans.property.Property.unbind.

Doc from javafx.beans.property.Property.unbind.

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

Annotations
@Override
javafx.beans.property back to summary

private Class ListPropertyBase.EmptyProperty

extends ReadOnlyBooleanPropertyBase
Class Inheritance

Field Summary

Inherited from javafx.beans.property.ReadOnlyBooleanPropertyBase:
helper

Constructor Summary

AccessConstructor and Description
private
EmptyProperty()

Method Summary

Modifier and TypeMethod and Description
protected void
fireValueChangedEvent()

Overrides javafx.beans.property.ReadOnlyBooleanPropertyBase.fireValueChangedEvent.

Sends notifications to all attached InvalidationListeners and ChangeListeners.

public boolean
get()

Implements javafx.beans.value.ObservableBooleanValue.get.

Returns the current value of this ObservableBooleanValue.

public Object
getBean()

Implements javafx.beans.property.ReadOnlyProperty.getBean.

Returns the Object that contains this property.

public String
getName()

Implements javafx.beans.property.ReadOnlyProperty.getName.

Returns the name of this property.

Inherited from javafx.beans.property.ReadOnlyBooleanPropertyBase:
addListeneraddListenerremoveListenerremoveListener

Constructor Detail

EmptyPropertyback to summary
private EmptyProperty()

Method Detail

fireValueChangedEventback to summary
protected void fireValueChangedEvent()

Overrides javafx.beans.property.ReadOnlyBooleanPropertyBase.fireValueChangedEvent.

Doc from javafx.beans.property.ReadOnlyBooleanPropertyBase.fireValueChangedEvent.

Sends notifications to all attached InvalidationListeners and ChangeListeners. This method needs to be called, if the value of this property changes.

Annotations
@Override
getback to summary
public boolean get()

Implements javafx.beans.value.ObservableBooleanValue.get.

Doc from javafx.beans.value.ObservableBooleanValue.get.

Returns the current value of this ObservableBooleanValue.

Annotations
@Override
getBeanback to summary
public Object getBean()

Implements javafx.beans.property.ReadOnlyProperty.getBean.

Doc from javafx.beans.property.ReadOnlyProperty.getBean.

Returns the Object that contains this property. If this property is not contained in an Object, null is returned.

Annotations
@Override
getNameback to summary
public String getName()

Implements javafx.beans.property.ReadOnlyProperty.getName.

Doc from javafx.beans.property.ReadOnlyProperty.getName.

Returns the name of this property. If the property does not have a name, this method returns an empty String.

Annotations
@Override
javafx.beans.property back to summary

private Class ListPropertyBase.Listener<E>

extends Object
implements InvalidationListener, WeakListener
Class Inheritance
All Implemented Interfaces
javafx.beans.WeakListener, javafx.beans.InvalidationListener

Field Summary

Modifier and TypeField and Description
private final WeakReference<ListPropertyBase<E>>
wref

Constructor Summary

AccessConstructor and Description
public
Listener(ListPropertyBase<E> ref)

Method Summary

Modifier and TypeMethod and Description
public void
invalidated(Observable observable)

Implements javafx.beans.InvalidationListener.invalidated.

This method needs to be provided by an implementation of InvalidationListener.

public boolean
wasGarbageCollected()

Implements javafx.beans.WeakListener.wasGarbageCollected.

Returns true if the linked listener was garbage-collected.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

wrefback to summary
private final WeakReference<ListPropertyBase<E>> wref

Constructor Detail

Listenerback to summary
public Listener(ListPropertyBase<E> ref)

Method Detail

invalidatedback to summary
public void invalidated(Observable observable)

Implements javafx.beans.InvalidationListener.invalidated.

Doc from javafx.beans.InvalidationListener.invalidated.

This method needs to be provided by an implementation of InvalidationListener. It is called if an Observable becomes invalid.

In general, it is considered bad practice to modify the observed value in this method.

Annotations
@Override
wasGarbageCollectedback to summary
public boolean wasGarbageCollected()

Implements javafx.beans.WeakListener.wasGarbageCollected.

Doc from javafx.beans.WeakListener.wasGarbageCollected.

Returns true if the linked listener was garbage-collected. In this case, the listener can be removed from the observable.

Annotations
@Override
javafx.beans.property back to summary

private Class ListPropertyBase.SizeProperty

extends ReadOnlyIntegerPropertyBase
Class Inheritance

Field Summary

Inherited from javafx.beans.property.ReadOnlyIntegerPropertyBase:
helper

Constructor Summary

AccessConstructor and Description
private
SizeProperty()

Method Summary

Modifier and TypeMethod and Description
protected void
fireValueChangedEvent()

Overrides javafx.beans.property.ReadOnlyIntegerPropertyBase.fireValueChangedEvent.

Sends notifications to all attached InvalidationListeners and ChangeListeners.

public int
get()

Implements javafx.beans.value.ObservableIntegerValue.get.

Returns the current value of this ObservableIntegerValue.

public Object
getBean()

Implements javafx.beans.property.ReadOnlyProperty.getBean.

Returns the Object that contains this property.

public String
getName()

Implements javafx.beans.property.ReadOnlyProperty.getName.

Returns the name of this property.

Inherited from javafx.beans.property.ReadOnlyIntegerPropertyBase:
addListeneraddListenerremoveListenerremoveListener

Constructor Detail

SizePropertyback to summary
private SizeProperty()

Method Detail

fireValueChangedEventback to summary
protected void fireValueChangedEvent()

Overrides javafx.beans.property.ReadOnlyIntegerPropertyBase.fireValueChangedEvent.

Doc from javafx.beans.property.ReadOnlyIntegerPropertyBase.fireValueChangedEvent.

Sends notifications to all attached InvalidationListeners and ChangeListeners. This method needs to be called, if the value of this property changes.

Annotations
@Override
getback to summary
public int get()

Implements javafx.beans.value.ObservableIntegerValue.get.

Doc from javafx.beans.value.ObservableIntegerValue.get.

Returns the current value of this ObservableIntegerValue.

Annotations
@Override
getBeanback to summary
public Object getBean()

Implements javafx.beans.property.ReadOnlyProperty.getBean.

Doc from javafx.beans.property.ReadOnlyProperty.getBean.

Returns the Object that contains this property. If this property is not contained in an Object, null is returned.

Annotations
@Override
getNameback to summary
public String getName()

Implements javafx.beans.property.ReadOnlyProperty.getName.

Doc from javafx.beans.property.ReadOnlyProperty.getName.

Returns the name of this property. If the property does not have a name, this method returns an empty String.

Annotations
@Override