IndicatorState enum

Describes state of CustomRefreshIndicator widget.

Inheritance

Constructors

IndicatorState()
const

Values

idle → const IndicatorState

In this state, the indicator is not visible. No user action is performed. Value remains at 0.0.

dragging → const IndicatorState

The user starts scrolling/dragging the pointer to refresh. Releasing the pointer in this state will not trigger the onRefresh function. The controller value changes from 0.0 to 1.0.

canceling → const IndicatorState

The function onRefresh has not been executed, and the indicator is hidding from its current value that is lower than 1.0 to 0.0.

armed → const IndicatorState

The user has dragged the pointer further than the distance declared by containerExtentPercentageToArmed or offsetToArmed (over the value of 1.0). Releasing the pointer in this state will trigger the onRefresh function.

settling → const IndicatorState

The user has released the indicator in the armed state. The indicator settles on its target value 1.0.

loading → const IndicatorState

The indicator is in its target value 1.0. The onRefresh function is triggered.

complete → const IndicatorState

OPTIONAL - Provide completeStateDuration argument to enable it. The onRefresh callback has completed and the pointer remains at value 1.0 for the specified duration.

finalizing → const IndicatorState

The onRefresh function has been executed, and the indicator hides from the value 1.0 to 0.0.

Properties

hashCode → int
The hash code for this object.
no setterinherited
index → int
A numeric identifier for the enumerated value.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Constants

values → const List<IndicatorState>
A constant List of the values in this enum, in order of their declaration.