ListObs<E> class

实现了 List 集合所有方法的响应式变量

Inheritance
Implemented types
Available extensions

Constructors

ListObs(List<E> value, {bool autoNotify = true, ValueChanged<List<E>>? onChanged, bool? immediate, String? cacheKey, ElSerialize? serialize, ElStorage? storage})

Properties

autoNotify bool
变量发生更新时自动通知 UI 更新,若你想手动执行 notify 通知 UI 更新,可以将其设置为 false。 此属性允许在任意地方动态修改它。
getter/setter pairinherited
cacheKey String?
本地缓存 key,如果不为 null,每次更新变量时会将值缓存到本地,请保证 key 唯一
finalinherited
expire Duration?
设置本地持久化的过期时间
finalinherited
first ↔ E
The first element.
getter/setter pairoverride
firstOrNull → T?

Available on Iterable<T>, provided by the IterableExtensions extension

The first element of this iterator, or null if the iterable is empty.
no setter
hashCode int
The hash code for this object.
no setterinherited
hasListeners bool
Whether any listeners are currently registered.
no setterinherited
immediate bool?
是否立即执行一次 onChanged 监听函数
finalinherited
indexed Iterable<(int, T)>

Available on Iterable<T>, provided by the IterableExtensions extension

Pairs of elements of the indices and elements of this iterable.
no setter
isEmpty bool
Whether this collection has no elements.
no setteroverride
isNotEmpty bool
Whether this collection has at least one element.
no setteroverride
iterator Iterator<E>
A new Iterator that allows iterating the elements of this Iterable.
no setteroverride
keepAliveTime Duration?
getter/setter pairinherited
last ↔ E
The last element.
getter/setter pairoverride
lastOrNull → T?

Available on Iterable<T>, provided by the IterableExtensions extension

The last element of this iterable, or null if the iterable is empty.
no setter
length int
The number of objects in this list.
getter/setter pairoverride
nonNulls Iterable<T>

Available on Iterable<T?>, provided by the NullableIterableExtensions extension

The non-null elements of this iterable.
no setter
obsBuilders Set<VoidCallback>
记录已绑定的 ObsBuilder 小部件的刷新方法
finalinherited
onChanged ValueChanged<List<E>>?
创建响应式变量时立即绑定监听函数
finalinherited
rawValue List<E>
直接访问原始 _value 避免触发副作用函数
getter/setter pairinherited
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
serialize → ElSerialize?
对象序列化接口,本地储存只允许基本数据类型,当响应式变量类型为对象时,你需要提供一个转换器,否则持久化时会抛出异常, 不过,如果对象实现了 ElSerializeElSerializeModel 接口,那么你无需指定此参数。
finalinherited
single → E
Checks that this iterable has only one element, and returns that element.
no setteroverride
singleOrNull → T?

Available on Iterable<T>, provided by the IterableExtensions extension

The single element of this iterator, or null.
no setter
storage ElStorage
如果自定义本地存储为 null,那么将使用响应式变量默认的本地存储对象
no setterinherited
toEdgeInsets EdgeInsets?

Available on List<double>, provided by the FlutterListDoubleExt extension

将数组转为内边距对象,其数组结构与 CSS 一致:
no setter
toEdgeInsets EdgeInsets?

Available on List<int>, provided by the FlutterListIntExt extension

no setter
toJS JSArray<T>

Available on List<T>, provided by the ListToJSArray extension

Converts this List to a JSArray by either casting, unwrapping, or cloning the List.
no setter
toJSProxyOrRef JSArray<T>

Available on List<T>, provided by the ListToJSArray extension

Converts this List to a JSArray by either casting, unwrapping, or proxying the List.
no setter
value List<E>
访问响应式变量,它会与 ObsBuilder 自动进行绑定
getter/setter pairinherited
wait Future<List<T>>

Available on Iterable<Future<T>>, provided by the FutureIterable extension

Waits for futures in parallel.
no setter

Methods

add(E value) → void
Adds value to the end of this list, extending the length by one.
override
addAll(Iterable<E> elements) → 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(E element)) bool
Checks whether any element of this iterable satisfies test.
override
asMap() Map<int, E>
An unmodifiable Map view of this list.
override
asNameMap() Map<String, T>

Available on Iterable<T>, provided by the EnumByName extension

Creates a map from the names of enum values to the values.
bindBuilders() → void
将响应式变量与 ObsBuilder 进行绑定
inherited
byName(String name) → T

Available on Iterable<T>, provided by the EnumByName extension

Finds the enum value in this list with name name.
cast<R>() List<R>
Returns a view of this list as a list of R instances.
override
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.
override
dispose() → void
销毁响应式变量,如果 Obs 为局部状态(在 State 中创建),请在符合以下条件销毁它们:
inherited
elementAt(int index) → E
Returns the indexth element.
override
elementAtOrNull(int index) → T?

Available on Iterable<T>, provided by the IterableExtensions extension

The element at position index of this iterable, or null.
every(bool test(E element)) bool
Checks whether every element of this iterable satisfies test.
override
execAutoNotify() → void
执行通知副作用函数前判断是否启用了 autoNotify
inherited
expand<T>(Iterable<T> toElements(E element)) Iterable<T>
Expands each element of this Iterable into zero or more elements.
override
fillRange(int start, int end, [E? fillValue]) → void
Overwrites a range of elements with fillValue.
override
firstWhere(bool test(E element), {E orElse()?}) → E
The first element that satisfies the given predicate test.
override
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
override
followedBy(Iterable<E> other) Iterable<E>
Creates the lazy concatenation of this iterable and other.
override
forEach(void action(E element)) → void
Invokes action on each element of this iterable in iteration order.
override
getRange(int start, int end) Iterable<E>
Creates an Iterable that iterates over a range of elements.
override
indexOf(E element, [int start = 0]) int
The first index of element in this list.
override
indexWhere(bool test(E element), [int start = 0]) int
The first index in the list that satisfies the provided test.
override
initLocalValue() List<E>?
获取本地缓存值,这是一个默认实现,对于 ListMap 集合,其相应的 Obs 会覆写此方法
override
insert(int index, E element) → void
Inserts element at position index in this list.
override
insertAll(int index, Iterable<E> iterable) → void
Inserts all objects of iterable at position index in this list.
override
join([String separator = ""]) String
Converts each element to a String and concatenates the strings.
override
lastIndexOf(E element, [int? start]) int
The last index of element in this list.
override
lastIndexWhere(bool test(E element), [int? start]) int
The last index in the list that satisfies the provided test.
override
lastWhere(bool test(E element), {E orElse()?}) → E
The last element that satisfies the given predicate test.
override
map<T>(T toElement(E e)) Iterable<T>
The current elements of this iterable modified by toElement.
override
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
notify() → void
执行所有副作用监听函数、包括 UI 页面刷新
inherited
notifyChanged() → void
执行 onChanged 监听函数
inherited
notifyListeners() → void
Call all the registered listeners.
inherited
reduce(E combine(E value, E element)) → E
Reduces a collection to a single value by iteratively combining elements of the collection using the provided function.
override
remove(Object? value) bool
Removes the first occurrence of value from this list.
override
removeAt(int index) → E
Removes the object at position index from this list.
override
removeLast() → E
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(E element)) → void
Removes all objects from this list that satisfy test.
override
replaceRange(int start, int end, Iterable<E> replacements) → void
Replaces a range of elements with the elements of replacements.
override
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.
override
setRange(int start, int end, Iterable<E> 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(E element), {E orElse()?}) → E
The single element that satisfies test.
override
skip(int count) Iterable<E>
Creates an Iterable that provides all but the first count elements.
override
skipWhile(bool test(E value)) Iterable<E>
Creates an Iterable that skips leading elements while test is satisfied.
override
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 and end.
override
take(int count) Iterable<E>
Creates a lazy iterable of the count first elements of this iterable.
override
takeWhile(bool test(E value)) Iterable<E>
Creates a lazy iterable of the leading elements satisfying test.
override
toList({bool growable = true}) List<E>
Creates a List containing the elements of this Iterable.
override
toSet() Set<E>
Creates a Set containing the same elements as this iterable.
override
toString() String
当直接当作字符串插入时,无需指定 .value
inherited
where(bool test(E element)) 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 +(List<E> other) List<E>
Returns the concatenation of this list and other.
override
operator ==(Object other) bool
The equality operator.
inherited
operator [](int index) → E
The object at the given index in the list.
override
operator []=(int index, E value) → void
Sets the value at the given index in the list to value.
override