java.lang.Object
javafx.beans.binding.ListExpression<E>
- Type Parameters:
E- the type of theListelements.
- All Implemented Interfaces:
Iterable<E>,Collection<E>,List<E>,Observable,ObservableListValue<E>,ObservableObjectValue<ObservableList<E>>,ObservableValue<ObservableList<E>>,ObservableList<E>
- Direct Known Subclasses:
ListBinding,ReadOnlyListProperty
public abstract class ListExpression<E> extends Object implements ObservableListValue<E>
ListExpression is an
ObservableListValue plus additional convenience
methods to generate bindings in a fluent style.
A concrete sub-class of ListExpression has to implement the method
ObservableObjectValue.get(), which provides the
actual value of this expression.
If the wrapped list of a ListExpression is null, all methods implementing the List
interface will behave as if they were applied to an immutable empty list.
- Since:
- JavaFX 2.1
-
Property Summary
Properties Type Property Description abstract ReadOnlyBooleanPropertyemptyA boolean property that istrue, if the list is empty.abstract ReadOnlyIntegerPropertysizeAn integer property that represents the size of the list. -
Constructor Summary
Constructors Constructor Description ListExpression()Creates a defaultListExpression. -
Method Summary
Modifier and Type Method Description voidadd(int i, E element)booleanadd(E element)booleanaddAll(int i, Collection<? extends E> elements)booleanaddAll(E... elements)A convenience method for var-arg addition of elements.booleanaddAll(Collection<? extends E> elements)StringBindingasString()voidclear()booleancontains(Object obj)booleancontainsAll(Collection<?> objects)abstract ReadOnlyBooleanPropertyemptyProperty()A boolean property that istrue, if the list is empty.Eget(int i)intgetSize()The size of the listObservableList<E>getValue()Returns the current value of thisObservableValueintindexOf(Object obj)booleanisEmpty()Gets the value of the property empty.BooleanBindingisEqualTo(ObservableList<?> other)BooleanBindingisNotEqualTo(ObservableList<?> other)BooleanBindingisNotNull()BooleanBindingisNull()Iterator<E>iterator()intlastIndexOf(Object obj)static <E> ListExpression<E>listExpression(ObservableListValue<E> value)Returns aListExpressionthat wraps aObservableListValue.ListIterator<E>listIterator()ListIterator<E>listIterator(int i)Eremove(int i)voidremove(int from, int to)A simplified way of callingsublist(from, to).clear().booleanremove(Object obj)booleanremoveAll(E... elements)A convenience method for var-arg usage of theremoveAllmethod.booleanremoveAll(Collection<?> objects)booleanretainAll(E... elements)A convenience method for var-arg usage of theretainAllmethod.booleanretainAll(Collection<?> objects)Eset(int i, E element)booleansetAll(E... elements)Clears the ObservableList and adds all the elements passed as var-args.booleansetAll(Collection<? extends E> elements)Clears the ObservableList and adds all elements from the collection.intsize()abstract ReadOnlyIntegerPropertysizeProperty()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 newObjectBindingthat contains the element at the specified position.ObjectBinding<E>valueAt(ObservableIntegerValue index)Creates a newObjectBindingthat contains the element at the specified position.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface javafx.collections.ObservableList
addListener, filtered, removeListener, sorted, sorted
-
Property Details
-
Constructor Details
-
ListExpression
public ListExpression()Creates a defaultListExpression.
-
-
Method Details
-
getValue
Description copied from interface:ObservableValueReturns the current value of thisObservableValue- Specified by:
getValuein interfaceObservableValue<E>- Returns:
- The current value
-
listExpression
Returns aListExpressionthat wraps aObservableListValue. If theObservableListValueis already aListExpression, it will be returned. Otherwise a newListBindingis created that is bound to theObservableListValue.- Type Parameters:
E- the type of the wrappedList- Parameters:
value- The sourceObservableListValue- Returns:
- A
ListExpressionthat wraps theObservableListValueif necessary - Throws:
NullPointerException- ifvalueisnull
-
getSize
public int getSize()The size of the list- Returns:
- the size
-
sizeProperty
An integer property that represents the size of the list.- See Also:
getSize()
-
emptyProperty
A boolean property that istrue, if the list is empty.- See Also:
isEmpty()
-
valueAt
Creates a newObjectBindingthat contains the element at the specified position. Ifindexpoints behind the list, theObjectBindingcontainsnull.- Parameters:
index- the index of the element- Returns:
- the
ObjectBinding - Throws:
IllegalArgumentException- ifindex < 0
-
valueAt
Creates a newObjectBindingthat contains the element at the specified position. Ifindexpoints outside of the list, theObjectBindingcontainsnull.- Parameters:
index- the index of the element- Returns:
- the
ObjectBinding - Throws:
NullPointerException- ifindexisnull
-
isEqualTo
- Parameters:
other- the otherObservableList- Returns:
- the new
BooleanBinding - Throws:
NullPointerException- ifotherisnull
-
isNotEqualTo
- Parameters:
other- the otherObservableList- Returns:
- the new
BooleanBinding - Throws:
NullPointerException- ifotherisnull
-
isNull
- Returns:
- the new
BooleanBinding
-
isNotNull
- Returns:
- the new
BooleanBinding
-
asString
Creates aStringBindingthat holds the value of theListExpressionturned into aString. If the value of thisListExpressionchanges, the value of theStringBindingwill be updated automatically.- Returns:
- the new
StringBinding
-
size
public int size() -
isEmpty
public boolean isEmpty()Gets the value of the property empty. -
contains
-
iterator
-
toArray
-
toArray
public <T> T[] toArray(T[] array) -
add
-
remove
-
containsAll
- Specified by:
containsAllin interfaceCollection<E>- Specified by:
containsAllin interfaceList<E>
-
addAll
-
addAll
-
removeAll
-
retainAll
-
clear
public void clear() -
get
-
set
-
add
-
remove
-
indexOf
-
lastIndexOf
- Specified by:
lastIndexOfin interfaceList<E>
-
listIterator
- Specified by:
listIteratorin interfaceList<E>
-
listIterator
- Specified by:
listIteratorin interfaceList<E>
-
subList
-
addAll
Description copied from interface:ObservableListA convenience method for var-arg addition of elements.- Specified by:
addAllin interfaceObservableList<E>- Parameters:
elements- the elements to add- Returns:
- true (as specified by Collection.add(E))
-
setAll
Description copied from interface:ObservableListClears the ObservableList and adds all the elements passed as var-args.- Specified by:
setAllin interfaceObservableList<E>- Parameters:
elements- the elements to set- Returns:
- true (as specified by Collection.add(E))
-
setAll
Description copied from interface:ObservableListClears the ObservableList and adds all elements from the collection.- Specified by:
setAllin interfaceObservableList<E>- Parameters:
elements- the collection with elements that will be added to this observableArrayList- Returns:
- true (as specified by Collection.add(E))
-
removeAll
Description copied from interface:ObservableListA convenience method for var-arg usage of theremoveAllmethod.- Specified by:
removeAllin interfaceObservableList<E>- Parameters:
elements- the elements to be removed- Returns:
- true if list changed as a result of this call
-
retainAll
Description copied from interface:ObservableListA convenience method for var-arg usage of theretainAllmethod.- Specified by:
retainAllin interfaceObservableList<E>- Parameters:
elements- the elements to be retained- Returns:
- true if list changed as a result of this call
-
remove
public void remove(int from, int to)Description copied from interface:ObservableListA simplified way of callingsublist(from, to).clear(). As this is a common operation, ObservableList has this method for convenient usage.- Specified by:
removein interfaceObservableList<E>- Parameters:
from- the start of the range to remove (inclusive)to- the end of the range to remove (exclusive)
-