- 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 theListelements
- All Implemented Interfaces:
Iterable<E>,Collection<E>,List<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 classListPropertyBaseis the base class for a property wrapping anObservableList. It provides all the functionality required for a property except for theReadOnlyProperty.getBean()andReadOnlyProperty.getName()methods, which must be implemented by extending classes.- Since:
- JavaFX 2.1
- See Also:
ObservableList,ListProperty
-
-
Property Summary
Properties Type Property Description ReadOnlyBooleanPropertyemptyA boolean property that istrue, if the list is empty.ReadOnlyIntegerPropertysizeAn integer property that represents the size of the list.
-
Constructor Summary
Constructors Constructor Description ListPropertyBase()The Constructor ofListPropertyBaseListPropertyBase(ObservableList<E> initialValue)The constructor of theListPropertyBase.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddListener(InvalidationListener listener)Adds anInvalidationListenerwhich will be notified whenever theObservablebecomes invalid.voidaddListener(ChangeListener<? super ObservableList<E>> listener)Adds aChangeListenerwhich will be notified whenever the value of theObservableValuechanges.voidaddListener(ListChangeListener<? super E> listener)Add a listener to this observable list.voidbind(ObservableValue<? extends ObservableList<E>> newObservable)Create a unidirection binding for thisProperty.ReadOnlyBooleanPropertyemptyProperty()A boolean property that istrue, if the list is empty.protected voidfireValueChangedEvent()protected voidfireValueChangedEvent(ListChangeListener.Change<? extends E> change)ObservableList<E>get()Get the wrapped value.protected voidinvalidated()The methodinvalidated()can be overridden to receive invalidation notifications.booleanisBound()Can be used to check, if aPropertyis bound.voidremoveListener(InvalidationListener listener)Removes the given listener from the list of listeners, that are notified whenever the value of theObservablebecomes invalid.voidremoveListener(ChangeListener<? super ObservableList<E>> listener)Removes the given listener from the list of listeners that are notified whenever the value of theObservableValuechanges.voidremoveListener(ListChangeListener<? super E> listener)Tries to remove a listener from this observable list.voidset(ObservableList<E> newValue)Set the wrapped value.ReadOnlyIntegerPropertysizeProperty()An integer property that represents the size of the list.StringtoString()Returns a string representation of thisListPropertyBaseobject.voidunbind()Remove the unidirectional binding for thisProperty.-
Methods inherited from class javafx.beans.property.ListProperty
bindBidirectional, setValue, unbindBidirectional
-
Methods inherited from class javafx.beans.property.ReadOnlyListProperty
bindContent, bindContentBidirectional, equals, hashCode, unbindContent, unbindContentBidirectional
-
Methods inherited from class javafx.beans.binding.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
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface java.util.Collection
parallelStream, removeIf, stream, toArray
-
Methods inherited from interface java.util.List
add, add, addAll, addAll, clear, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray
-
Methods inherited from interface javafx.collections.ObservableList
addAll, filtered, remove, removeAll, retainAll, setAll, setAll, sorted, sorted
-
Methods inherited from interface javafx.beans.value.ObservableValue
getValue
-
Methods inherited from interface javafx.beans.property.ReadOnlyProperty
getBean, getName
-
Methods inherited from interface javafx.beans.value.WritableValue
getValue
-
-
-
-
Property Detail
-
size
public ReadOnlyIntegerProperty sizeProperty
- Specified by:
sizePropertyin classListExpression<E>- See Also:
ListExpression.getSize()
-
empty
public ReadOnlyBooleanProperty emptyProperty
- Specified by:
emptyPropertyin classListExpression<E>- See Also:
ListExpression.isEmpty()
-
-
Constructor Detail
-
ListPropertyBase
public ListPropertyBase()
The Constructor ofListPropertyBase
-
ListPropertyBase
public ListPropertyBase(ObservableList<E> initialValue)
The constructor of theListPropertyBase.- Parameters:
initialValue- the initial value of the wrapped value
-
-
Method Detail
-
sizeProperty
public ReadOnlyIntegerProperty sizeProperty()
Description copied from class:ListExpressionAn integer property that represents the size of the list.- Specified by:
sizePropertyin classListExpression<E>- See Also:
ListExpression.getSize()
-
emptyProperty
public ReadOnlyBooleanProperty emptyProperty()
Description copied from class:ListExpressionA boolean property that istrue, if the list is empty.- Specified by:
emptyPropertyin classListExpression<E>- See Also:
ListExpression.isEmpty()
-
addListener
public void addListener(InvalidationListener listener)
Description copied from interface:ObservableAdds anInvalidationListenerwhich will be notified whenever theObservablebecomes 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
InvalidationListenerinstance may be safely registered for differentObservables.The
Observablestores 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 callingremoveListenerafter use or to use an instance ofWeakInvalidationListeneravoid this situation.- Parameters:
listener- The listener to register- See Also:
Observable.removeListener(InvalidationListener)
-
removeListener
public void removeListener(InvalidationListener listener)
Description copied from interface:ObservableRemoves the given listener from the list of listeners, that are notified whenever the value of theObservablebecomes 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:ObservableValueAdds aChangeListenerwhich will be notified whenever the value of theObservableValuechanges. 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
ChangeListenerinstance may be safely registered for differentObservableValues.The
ObservableValuestores 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 callingremoveListenerafter use or to use an instance ofWeakChangeListeneravoid 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:ObservableValueRemoves the given listener from the list of listeners that are notified whenever the value of theObservableValuechanges.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:ObservableListAdd 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:ObservableListTries 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 attachedInvalidationListeners,ChangeListeners, andListChangeListener. This method is called when the value is changed, either manually by callingset(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 attachedInvalidationListeners,ChangeListeners, andListChangeListener. 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 methodinvalidated()can be overridden to receive invalidation notifications. This is the preferred option inObjectsdefining the property, because it requires less memory. The default implementation is empty.
-
get
public ObservableList<E> get()
Description copied from interface:WritableObjectValueGet the wrapped value. This must be identical to the value returned fromWritableValue.getValue().This method exists only to align WritableObjectValue API with
WritableBooleanValueand subclasses ofWritableNumberValue- Returns:
- The current value
-
set
public void set(ObservableList<E> newValue)
Description copied from interface:WritableObjectValueSet the wrapped value. Should be equivalent toWritableValue.setValue(java.lang.Object)- Parameters:
newValue- The new value- See Also:
WritableObjectValue.get()
-
isBound
public boolean isBound()
Description copied from interface:PropertyCan be used to check, if aPropertyis bound.- Returns:
trueif thePropertyis bound,falseotherwise- See Also:
Property.bind(javafx.beans.value.ObservableValue)
-
bind
public void bind(ObservableValue<? extends ObservableList<E>> newObservable)
Description copied from interface:PropertyCreate a unidirection binding for thisProperty.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 thisPropertyshould be bound to.
-
unbind
public void unbind()
Description copied from interface:PropertyRemove the unidirectional binding for thisProperty. If thePropertyis not bound, calling this method has no effect.
-
toString
public String toString()
Returns a string representation of thisListPropertyBaseobject.- Overrides:
toStringin classListProperty<E>- Returns:
- a string representation of this
ListPropertyBaseobject.
-
-