ListNotifier<T> class
A List that behaves like ValueNotifier
if its data changes.
it does not compare the elements on bulk operations
If you set notifyIfEqual
to false
it will compare if a value passed value
passed is equal to the existing value.
like list[5]=4
if the content at index 4 is equal to 4 and only call
notifyListeners
if they are not equal.
To allow atomic changes ListNotifier
supports a single level of transactions
- Inheritance
-
- Object
- DelegatingList<
T> - ListNotifier
- Implemented types
-
- ValueListenable<
List< T> > - Iterable<
E>
- ValueListenable<
- Mixed-in types
- Available extensions
- EnumByName
- FutureIterable
- IterableComparableExtension
- IterableDoubleExtension
- IterableExtension
- IterableExtensions
- IterableIntegerExtension
- IterableIterableExtension
- IterableNullableExtension
- IterableNumberExtension
- ListComparableExtensions
- ListExtensions
- ListToJSArray
- NullableIterableExtensions
- RecordSnapshotIterableExtension
Constructors
-
ListNotifier({List<
T> ? data, bool notifyIfEqual = true, bool customEquality(T x, T y)?}) -
Creates a new listenable List
data
optional list that should be used as initial value ifnotifyIfEqual
isfalse
ListNotifier
will compare if a value passed is equal to the existing value. likelist[5]=4
if the content at index 4 is equal to 4 and only callnotifyListeners
if they are not equal. To prevent users from wondering why their UI doesn't update if they haven't overritten the equality operator the default istrue
. Alternatively you can pass in acustomEquality
function that is then used instead of==
Properties
- customEquality → bool Function(T x, T y)?
-
final
- first ↔ T
-
The first element.
getter/setter pairinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- hasListeners → bool
-
Whether any listeners are currently registered.
no setterinherited
- isEmpty → bool
-
Whether this collection has no elements.
no setterinherited
- isNotEmpty → bool
-
Whether this collection has at least one element.
no setterinherited
-
iterator
→ Iterator<
T> -
A new
Iterator
that allows iterating the elements of thisIterable
.no setterinherited - last ↔ T
-
The last element.
getter/setter pairinherited
- length ↔ int
-
The number of elements in this Iterable.
getter/setter pairinherited-getteroverride-setter
-
reversed
→ Iterable<
T> -
An Iterable of the objects in this list in reverse order.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- single → T
-
Checks that this iterable has only one element, and returns that element.
no setterinherited
-
value
→ List<
T> -
returns an unmodifiable view on the lists data.
no setteroverride
Methods
-
add(
T value) → void -
Adds
value
to the end of this list, extending the length by one.override -
addAll(
Iterable< T> iterable) → void -
Appends all objects of
iterable
to the end of this list.override -
addListener(
VoidCallback listener) → void -
Register a closure to be called when the object changes.
inherited
-
any(
bool test(T)) → bool -
Checks whether any element of this iterable satisfies
test
.inherited -
asMap(
) → Map< int, T> -
An unmodifiable Map view of this list.
inherited
-
cast<
T> () → List< T> -
A view of this iterable as an iterable of
R
instances.inherited -
clear(
) → void -
Removes all objects from this list; the length of the list becomes zero.
override
-
contains(
Object? element) → bool -
Whether the collection contains an element equal to
element
.inherited -
dispose(
) → void -
Discards any resources used by the object. After this is called, the
object is not in a usable state and should be discarded (calls to
addListener will throw after the object is disposed).
inherited
-
elementAt(
int index) → T -
Returns the
index
th element.inherited -
endTransAction(
) → void - Ends a transaction
-
every(
bool test(T)) → bool -
Checks whether every element of this iterable satisfies
test
.inherited -
expand<
T> (Iterable< T> f(T)) → Iterable<T> -
Expands each element of this Iterable into zero or more elements.
inherited
-
fillRange(
int start, int end, [T? fillValue]) → void -
Overwrites a range of elements with
fillValue
.override -
firstWhere(
bool test(T), {T orElse()?}) → T -
The first element that satisfies the given predicate
test
.inherited -
fold<
T> (T initialValue, T combine(T previousValue, T element)) → T -
Reduces a collection to a single value by iteratively combining each
element of the collection with an existing value
inherited
-
followedBy(
Iterable< T> other) → Iterable<T> -
Creates the lazy concatenation of this iterable and
other
.inherited -
forEach(
void f(T)) → void -
Invokes
action
on each element of this iterable in iteration order.inherited -
getRange(
int start, int end) → Iterable< T> -
Creates an Iterable that iterates over a range of elements.
inherited
-
indexOf(
T element, [int start = 0]) → int -
The first index of
element
in this list.inherited -
indexWhere(
bool test(T), [int start = 0]) → int -
The first index in the list that satisfies the provided
test
.inherited -
insert(
int index, T element) → void -
Inserts
element
at positionindex
in this list.override -
insertAll(
int index, Iterable< T> iterable) → void -
Inserts all objects of
iterable
at positionindex
in this list.override -
join(
[String separator = '']) → String -
Converts each element to a String and concatenates the strings.
inherited
-
lastIndexOf(
T element, [int? start]) → int -
The last index of
element
in this list.inherited -
lastIndexWhere(
bool test(T), [int? start]) → int -
The last index in the list that satisfies the provided
test
.inherited -
lastWhere(
bool test(T), {T orElse()?}) → T -
The last element that satisfies the given predicate
test
.inherited -
map<
T> (T f(T)) → Iterable< T> -
The current elements of this iterable modified by
toElement
.inherited -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
notifyListeners(
) → void -
If needed you can notifiy all listeners manually
override
-
reduce(
T combine(T value, T element)) → T -
Reduces a collection to a single value by iteratively combining elements
of the collection using the provided function.
inherited
-
remove(
Object? value) → bool -
Removes the first occurrence of
value
from this list.override -
removeAt(
int index) → T -
Removes the object at position
index
from this list.override -
removeLast(
) → T -
Removes and returns the last object in this list.
override
-
removeListener(
VoidCallback listener) → void -
Remove a previously registered closure from the list of closures that are
notified when the object changes.
inherited
-
removeRange(
int start, int end) → void -
Removes a range of elements from the list.
override
-
removeWhere(
bool test(T)) → void -
Removes all objects from this list that satisfy
test
.override -
replaceRange(
int start, int end, Iterable< T> iterable) → void -
Replaces a range of elements with the elements of
replacements
.override -
retainWhere(
bool test(T)) → void -
Removes all objects from this list that fail to satisfy
test
.override -
retype<
T> () → List< T> -
inherited
-
setAll(
int index, Iterable< T> iterable) → void -
Overwrites elements with the objects of
iterable
.override -
setRange(
int start, int end, Iterable< T> iterable, [int skipCount = 0]) → void -
Writes some elements of
iterable
into a range of this list.override -
shuffle(
[Random? random]) → void -
Shuffles the elements of this list randomly.
override
-
singleWhere(
bool test(T), {T orElse()?}) → T -
The single element that satisfies
test
.inherited -
skip(
int n) → Iterable< T> -
Creates an Iterable that provides all but the first
count
elements.inherited -
skipWhile(
bool test(T)) → Iterable< T> -
Creates an
Iterable
that skips leading elements whiletest
is satisfied.inherited -
sort(
[int compare(T, T)?]) → void -
Sorts this list according to the order specified by the
compare
function.override -
startTransAction(
) → void - Starts a transaction that allows to make multiple changes to the List with only one notification at the end.
-
sublist(
int start, [int? end]) → List< T> -
Returns a new list containing the elements between
start
andend
.inherited -
swap(
int index1, int index2) → void -
swaps elements on
index1
withindex2
-
take(
int n) → Iterable< T> -
Creates a lazy iterable of the
count
first elements of this iterable.inherited -
takeWhile(
bool test(T)) → Iterable< T> -
Creates a lazy iterable of the leading elements satisfying
test
.inherited -
toList(
{bool growable = true}) → List< T> -
Creates a List containing the elements of this Iterable.
inherited
-
toSet(
) → Set< T> -
Creates a Set containing the same elements as this iterable.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
-
where(
bool test(T)) → Iterable< T> -
Creates a new lazy Iterable with all elements that satisfy the
predicate
test
.inherited -
whereType<
T> () → Iterable< T> -
Creates a new lazy Iterable with all elements that have type
T
.inherited
Operators
-
operator +(
List< T> other) → List<T> -
Returns the concatenation of this list and
other
.inherited -
operator ==(
Object other) → bool -
The equality operator.
inherited
-
operator [](
int index) → T -
The object at the given
index
in the list.override -
operator []=(
int index, T value) → void -
Sets the value at the given
index
in the list tovalue
.override