AnimateList<T extends Widget> class
Applies animated effects to a list of widgets. It does this by wrapping each
widget in Animate, and then proxying calls to all instances. It can
also offset the timing of each widget's animation via interval
.
For example, this would fade and scale every item in the Column, offsetting the start of each by 100 milliseconds:
Column(children: [foo, bar, baz].animate(interval: 100.ms).fade().scale())
If specified, onPlay
and onComplete
will also be assigned to every instance
to enable looping or reversing via the AnimationController.
Like Animate, it can also be used declaratively. The following is equivalent to the above example.
Column(
children: AnimateList(
effects: [FadeEffect(), ScaleEffect()],
interval: 100.ms,
children: [foo, bar, baz],
)
)
- Inheritance
- Mixed-in types
- Available extensions
Constructors
-
AnimateList({required List<
Widget> children, List<Effect> ? effects, Duration? interval, AnimateCallback? onPlay, AnimateCallback? onComplete, Adapter? adapter}) - Creates an AnimateList instance that will wrap all children in an Animate instance, and proxy any added effects to each of them.
Properties
- first ↔ Widget
-
The first element.
getter/setter pairinherited
- hashCode → int
-
The hash code for this object.
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<
Widget> -
A new
Iterator
that allows iterating the elements of thisIterable
.no setterinherited - last ↔ Widget
-
The last element.
getter/setter pairinherited
- length ↔ int
-
The number of objects in this list.
getter/setter pairoverride
-
reversed
→ Iterable<
Widget> -
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 → Widget
-
Checks that this iterable has only one element, and returns that element.
no setterinherited
Methods
-
add(
Widget element) → void -
Adds
value
to the end of this list, extending the length by one.inherited -
addAll(
Iterable< Widget> iterable) → void -
Appends all objects of
iterable
to the end of this list.inherited -
addEffect(
Effect effect) → AnimateList< Widget> -
Adds an effect. This is mostly used by Effect extension methods to
append effects to an AnimateList instance.
override
-
addEffects(
List< Effect> effects) → AnimateList<Widget> -
inherited
-
any(
bool test(Widget element)) → bool -
Checks whether any element of this iterable satisfies
test
.inherited -
asMap(
) → Map< int, Widget> -
An unmodifiable Map view of this list.
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
-
contains(
Object? element) → bool -
Whether the collection contains an element equal to
element
.inherited -
elementAt(
int index) → Widget -
Returns the
index
th element.inherited -
every(
bool test(Widget element)) → bool -
Checks whether every element of this iterable satisfies
test
.inherited -
expand<
T> (Iterable< T> f(Widget element)) → Iterable<T> -
Expands each element of this Iterable into zero or more elements.
inherited
-
fillRange(
int start, int end, [Widget? fill]) → void -
Overwrites a range of elements with
fillValue
.inherited -
firstWhere(
bool test(Widget element), {Widget orElse()?}) → Widget -
The first element that satisfies the given predicate
test
.inherited -
fold<
T> (T initialValue, T combine(T previousValue, Widget element)) → T -
Reduces a collection to a single value by iteratively combining each
element of the collection with an existing value
inherited
-
followedBy(
Iterable< Widget> other) → Iterable<Widget> -
Creates the lazy concatenation of this iterable and
other
.inherited -
forEach(
void action(Widget element)) → void -
Invokes
action
on each element of this iterable in iteration order.inherited -
getRange(
int start, int end) → Iterable< Widget> -
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(Widget element), [int start = 0]) → int -
The first index in the list that satisfies the provided
test
.inherited -
insert(
int index, Widget element) → void -
Inserts
element
at positionindex
in this list.inherited -
insertAll(
int index, Iterable< Widget> iterable) → void -
Inserts all objects of
iterable
at positionindex
in this list.inherited -
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(Widget element), [int? start]) → int -
The last index in the list that satisfies the provided
test
.inherited -
lastWhere(
bool test(Widget element), {Widget orElse()?}) → Widget -
The last element that satisfies the given predicate
test
.inherited -
map<
T> (T f(Widget 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
-
reduce(
Widget combine(Widget previousValue, Widget element)) → Widget -
Reduces a collection to a single value by iteratively combining elements
of the collection using the provided function.
inherited
-
remove(
Object? element) → bool -
Removes the first occurrence of
value
from this list.inherited -
removeAt(
int index) → Widget -
Removes the object at position
index
from this list.inherited -
removeLast(
) → Widget -
Removes and returns the last object in this list.
inherited
-
removeRange(
int start, int end) → void -
Removes a range of elements from the list.
inherited
-
removeWhere(
bool test(Widget element)) → void -
Removes all objects from this list that satisfy
test
.inherited -
replaceRange(
int start, int end, Iterable< Widget> newContents) → void -
Replaces a range of elements with the elements of
replacements
.inherited -
retainWhere(
bool test(Widget element)) → void -
Removes all objects from this list that fail to satisfy
test
.inherited -
setAll(
int index, Iterable< Widget> iterable) → void -
Overwrites elements with the objects of
iterable
.inherited -
setRange(
int start, int end, Iterable< Widget> 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(Widget element), {Widget orElse()?}) → Widget -
The single element that satisfies
test
.inherited -
skip(
int count) → Iterable< Widget> -
Creates an Iterable that provides all but the first
count
elements.inherited -
skipWhile(
bool test(Widget element)) → Iterable< Widget> -
Creates an
Iterable
that skips leading elements whiletest
is satisfied.inherited -
sort(
[int compare(Widget a, Widget b)?]) → void -
Sorts this list according to the order specified by the
compare
function.inherited -
sublist(
int start, [int? end]) → List< Widget> -
Returns a new list containing the elements between
start
andend
.inherited -
take(
int count) → Iterable< Widget> -
Creates a lazy iterable of the
count
first elements of this iterable.inherited -
takeWhile(
bool test(Widget element)) → Iterable< Widget> -
Creates a lazy iterable of the leading elements satisfying
test
.inherited -
toList(
{bool growable = true}) → List< Widget> -
Creates a List containing the elements of this Iterable.
inherited
-
toSet(
) → Set< Widget> -
Creates a Set containing the same elements as this iterable.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
-
where(
bool test(Widget element)) → Iterable< Widget> -
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< Widget> other) → List<Widget> -
Returns the concatenation of this list and
other
.inherited -
operator ==(
Object other) → bool -
The equality operator.
inherited
-
operator [](
int index) → Widget -
The object at the given
index
in the list.override -
operator []=(
int index, Widget value) → void -
Sets the value at the given
index
in the list tovalue
.override
Static Properties
- defaultInterval ↔ Duration
-
Specifies a default interval to use for new
AnimateList
instances.getter/setter pair -
ignoreTypes
↔ Set<
Type> -
Widget types to ignore in a list. By default, includes Spacer.
You can modify this list as appropriate. For example, to ignore a
hypothetical "Gap" widget type:
getter/setter pair