IndicatorController class - custom_refresh_indicator library

Constructors

IndicatorController({bool? refreshEnabled}): Creates CustomRefreshIndicator controller class
factory

Properties

direction → AxisDirection: The direction in which the list scrolls
no setter
edge → IndicatorEdge?: Whether the pull to refresh gesture is triggered from the start of the list or from the end.
no setter
hasEdge → bool: Whether the edge was determined by the CustomRefreshIndicator widget.
no setter
hashCode → int: The hash code for this object.
no setterinherited
hasListeners → bool: Whether any listeners are currently registered.
no setterinherited
isArmed → bool: 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.
no setter
isCanceling → bool: 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.
no setter
isComplete → bool: OPTIONAL - Provide completeStateDuration argument to enable it. The onRefresh callback has completed and the pointer remains at value 1.0 for the specified duration.
no setter
isDragging → bool: 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.
no setter
isFinalizing → bool: The onRefresh function has been executed, and the indicator hides from the value 1.0 to 0.0.
no setter
isHorizontalDirection → bool: Whether list scrolls horrizontally
no setter
isIdle → bool: In this state, the indicator is not visible. No user action is performed. Value remains at 0.0.
no setter
isLoading → bool: The indicator is in its target value 1.0. The onRefresh function is triggered.
no setter
isRefreshEnabled → bool: Whether custom refresh indicator can change IndicatorState from idle to dragging
no setter
isScrollIdle → bool: No scrolling is underway.
no setter
isScrollingForward → bool: Scrolling is happening in the positive scroll offset direction.
no setter
isScrollingReverse → bool: Scrolling is happening in the negative scroll offset direction.
no setter
isSettling → bool: The user has released the indicator in the armed state. The indicator settles on its target value 1.0.
no setter
isVerticalDirection → bool: Whether list scrolls vertically
no setter
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
scrollingDirection → ScrollDirection: The direction in which the user scrolls.
no setter
shouldStopDrag → bool: Should the dragging be stopped
no setter
side → IndicatorSide: The side of the scrollable on which the indicator should be displayed.
no setter
state → IndicatorState: Describes current CustomRefreshIndicator state
no setter
value → double: Current indicator value / progress
no setter

Methods

addListener(VoidCallback listener) → void: Register a closure to be called when the object changes.
inherited
disableRefresh() → void: Disables list pull to refresh
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
enableRefresh() → void: Enables list pull to refresh
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
notifyListeners() → void: Call all the registered listeners.
inherited
removeListener(VoidCallback listener) → void: Remove a previously registered closure from the list of closures that are notified when the object changes.
inherited
setAxisDirection(AxisDirection direction) → void: Sets the direction in which list scrolls
setIndicatorEdge(IndicatorEdge? edge) → void
setIndicatorState(IndicatorState newState) → void: sets indicator state and notifies listeners
setScrollingDirection(ScrollDirection userScrollDirection) → void
setValue(double value) → void
stopDrag() → void
toString() → String: A string representation of this object.
inherited

Operators

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