RxList<E> class
A reactive list that extends functionality similar to List<T>
and provides automatic notifications on changes.
- Inheritance
-
- Object
- Listenable
- ListNotifier
- ListNotifierSingle
- GetListenable<
List< E> > - RxList
- Mixed-in types
-
- ListMixin<
E> - RxObjectMixin<
List< E> >
- ListMixin<
- Available extensions
Constructors
-
RxList([List<
E> initial = const []]) - Constructs an RxList.
- RxList.empty({bool growable = false})
-
Constructs an empty RxList.
factory
- RxList.filled(int length, E fill, {bool growable = false})
-
Constructs an RxList filled with a
fill
value.factory - RxList.from(Iterable elements, {bool growable = true})
-
Constructs an RxList containing all
elements
.factory - RxList.generate(int length, E generator(int index), {bool growable = true})
-
Constructs an RxList by generating values.
factory
-
RxList.of(Iterable<
E> elements, {bool growable = true}) -
Constructs an RxList from
elements
.factory -
RxList.unmodifiable(Iterable<
E> elements) -
Constructs an unmodifiable RxList containing all
elements
.factory
Properties
- first ↔ E
-
The first element.
getter/setter pairinherited
- firstRebuild ↔ bool
-
getter/setter pairinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- isDisposed → bool
-
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<
E> -
A new
Iterator
that allows iterating the elements of thisIterable
.no setteroverride - last ↔ E
-
The last element.
getter/setter pairinherited
- length ↔ int
-
The number of objects in this list.
getter/setter pairoverride
- listenersLength → int
-
no setterinherited
-
reversed
→ Iterable<
E> -
An Iterable of the objects in this list in reverse order.
no setteroverride
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- sentToStream ↔ bool
-
getter/setter pairinherited
- single → E
-
Checks that this iterable has only one element, and returns that element.
no setterinherited
-
stream
→ Stream<
List< E> > -
The stream of values.
no setterinherited
- string → String
-
Same as
toString()
but using a getter.no setterinherited -
subject
→ StreamController<
List< E> > -
The subject stream controller for broadcasting updates.
no setterinherited
-
value
↔ List<
E> -
The current value of the object. When the value changes, the callbacks
registered with addListener will be invoked.
getter/setter pairinherited
Methods
-
add(
E element) → void -
Adds
value
to the end of this list, extending the length by one.override -
addAll(
Iterable< E> iterable) → void -
Appends all objects of
iterable
to the end of this list.override -
addListener(
GetStateUpdate listener) → Disposer -
Register a closure to be called when the object notifies its listeners.
inherited
-
addListenerId(
Object? key, GetStateUpdate listener) → Disposer -
inherited
-
any(
bool test(E element)) → bool -
Checks whether any element of this iterable satisfies
test
.inherited -
asMap(
) → Map< int, E> -
An unmodifiable Map view of this list.
inherited
-
bindStream(
Stream< List< stream) → voidE> > -
Binds an existing
Stream<T>
to this Rxinherited -
call(
[List< E> ? v]) → List<E> -
Makes a direct update of value adding it to the Stream
useful when you make use of Rx for custom Types to refresh your UI.
inherited
-
cast<
R> () → List< R> -
Returns a view of this list as a list of
R
instances.inherited -
clear(
) → void -
Removes all objects from this list; the length of the list becomes zero.
inherited
-
close(
) → void -
Close the Rx Variable
inherited
-
contains(
Object? element) → bool -
Whether the collection contains an element equal to
element
.inherited -
containsId(
Object id) → bool -
inherited
-
containsListener(
GetStateUpdate listener) → bool -
inherited
-
dispose(
) → void -
inherited
-
disposeId(
Object id) → void -
To dispose an
id
from future updates(), this ids are registered byGetBuilder()
or similar, so is a way to unlink the state change with the Widget from the Controller.inherited -
elementAt(
int index) → E -
Returns the
index
th element.inherited -
every(
bool test(E element)) → bool -
Checks whether every element of this iterable satisfies
test
.inherited -
expand<
T> (Iterable< T> f(E element)) → Iterable<T> -
Expands each element of this Iterable into zero or more elements.
inherited
-
fillRange(
int start, int end, [E? fill]) → void -
Overwrites a range of elements with
fillValue
.inherited -
firstWhere(
bool test(E element), {E orElse()?}) → E -
The first element that satisfies the given predicate
test
.inherited -
fold<
T> (T initialValue, T combine(T previousValue, E element)) → T -
Reduces a collection to a single value by iteratively combining each
element of the collection with an existing value
inherited
-
followedBy(
Iterable< E> other) → Iterable<E> -
Creates the lazy concatenation of this iterable and
other
.inherited -
forEach(
void action(E element)) → void -
Invokes
action
on each element of this iterable in iteration order.inherited -
getRange(
int start, int end) → Iterable< E> -
Creates an Iterable that iterates over a range of elements.
inherited
-
indexOf(
Object? element, [int start = 0]) → int -
The first index of
element
in this list.inherited -
indexWhere(
bool test(E element), [int start = 0]) → int -
The first index in the list that satisfies the provided
test
.inherited -
insert(
int index, E element) → void -
Inserts
element
at positionindex
in this list.inherited -
insertAll(
int index, Iterable< E> 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(
Object? element, [int? start]) → int -
The last index of
element
in this list.inherited -
lastIndexWhere(
bool test(E element), [int? start]) → int -
The last index in the list that satisfies the provided
test
.inherited -
lastWhere(
bool test(E element), {E orElse()?}) → E -
The last element that satisfies the given predicate
test
.inherited -
listen(
void onData(List< E> )?, {Function? onError, void onDone()?, bool? cancelOnError}) → StreamSubscription<List< E> > -
Calls
callback
with current value, when the value changes.inherited -
listenAndPump(
void onData(List< E> event), {Function? onError, void onDone()?, bool? cancelOnError}) → StreamSubscription<List< E> > -
Returns a StreamSubscription similar to listen, but with the
added benefit that it primes the stream with the current value, rather
than waiting for the next value. This should not be called in
onInit
or anywhere else during the build process.inherited -
map<
T> (T f(E element)) → 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
-
notifyGroupChildrens(
Object id) → void -
inherited
-
reduce(
E combine(E previousValue, E element)) → E -
Reduces a collection to a single value by iteratively combining elements
of the collection using the provided function.
inherited
-
refresh(
) → void -
inherited
-
refreshGroup(
Object id) → void -
inherited
-
remove(
Object? element) → bool -
Removes the first occurrence of
value
from this list.override -
removeAt(
int index) → E -
Removes the object at position
index
from this list.inherited -
removeLast(
) → E -
Removes and returns the last object in this list.
inherited
-
removeListener(
VoidCallback listener) → void -
Remove a previously registered closure from the list of closures that the
object notifies.
inherited
-
removeListenerId(
Object id, VoidCallback listener) → void -
inherited
-
removeRange(
int start, int end) → void -
Removes a range of elements from the list.
inherited
-
removeWhere(
bool test(E element)) → void -
Removes all objects from this list that satisfy
test
.override -
replaceRange(
int start, int end, Iterable< E> newContents) → void -
Replaces a range of elements with the elements of
replacements
.inherited -
reportAdd(
VoidCallback disposer) → void -
inherited
-
reportRead(
) → void -
inherited
-
retainWhere(
bool test(E element)) → void -
Removes all objects from this list that fail to satisfy
test
.override -
setAll(
int index, Iterable< E> iterable) → void -
Overwrites elements with the objects of
iterable
.inherited -
setRange(
int start, int end, Iterable< E> iterable, [int skipCount = 0]) → void -
Writes some elements of
iterable
into a range of this list.inherited -
shuffle(
[Random? random]) → void -
Shuffles the elements of this list randomly.
inherited
-
singleWhere(
bool test(E element), {E orElse()?}) → E -
The single element that satisfies
test
.inherited -
skip(
int count) → Iterable< E> -
Creates an Iterable that provides all but the first
count
elements.inherited -
skipWhile(
bool test(E element)) → Iterable< E> -
Creates an
Iterable
that skips leading elements whiletest
is satisfied.inherited -
sort(
[int compare(E a, E b)?]) → void -
Sorts this list according to the order specified by the
compare
function.override -
sublist(
int start, [int? end]) → List< E> -
Returns a new list containing the elements between
start
andend
.inherited -
take(
int count) → Iterable< E> -
Creates a lazy iterable of the
count
first elements of this iterable.inherited -
takeWhile(
bool test(E element)) → Iterable< E> -
Creates a lazy iterable of the leading elements satisfying
test
.inherited -
toJson(
) → dynamic -
Returns the json representation of
value
.inherited -
toList(
{bool growable = true}) → List< E> -
Creates a List containing the elements of this Iterable.
inherited
-
toSet(
) → Set< E> -
Creates a Set containing the same elements as this iterable.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
-
where(
bool test(E)) → Iterable< E> -
Creates a new lazy Iterable with all elements that satisfy the
predicate
test
.override -
whereType<
T> () → Iterable< T> -
Creates a new lazy Iterable with all elements that have type
T
.override
Operators
-
operator +(
Iterable< E> val) → RxList<E> -
Special override to push element(s) in a reactive way inside the list.
override
-
operator ==(
Object o) → bool -
This equality override works for _RxImpl instances and the internal
values.
inherited
-
operator [](
int index) → E -
The object at the given
index
in the list.override -
operator []=(
int index, E val) → void -
Sets the value at the given
index
in the list tovalue
.override