IndicatorNotifier class abstract

Indicator data and trigger notification.

Inheritance

Constructors

IndicatorNotifier({required Indicator indicator, required TickerProviderStateMixin<StatefulWidget> vsync, required ValueNotifier<bool> userOffsetNotifier, required CanProcessCallBack onCanProcess, required bool canProcessAfterNoMore, required bool isNested, Axis? triggerAxis, bool waitTaskResult = true, FutureOr task()?})

Properties

actualMaxOverOffset → double
no setter
actualSecondaryTriggerOffset → double
Actual secondary trigger offset. secondaryTriggerOffset + safeOffset
no setter
actualTriggerOffset → double
Actual trigger offset. triggerOffset + safeOffset
no setter
axis → Axis?
no setter
axisDirection → AxisDirection?
no setter
clamping → bool
no setter
edgeOffset → double
Calculate distance from edge.
no setter
frictionFactor → FrictionFactor
no setter
hapticFeedback → bool
no setter
hashCode → int
The hash code for this object.
no setterinherited
hasListeners → bool
Whether any listeners are currently registered.
no setterinherited
hasSecondary → bool
no setter
hitOver → bool
no setter
indicatorState → IndicatorState?
Get indicator state;
no setter
infiniteHitOver → bool
no setter
infiniteOffset → double?
no setter
iPosition → IndicatorPosition
no setter
isNested → bool
no setter
maxOverOffset → double
no setter
mode → IndicatorMode
no setter
modeLocked → bool
Is the state locked.
no setter
noMoreLocked → bool
State lock when no more.
no setter
offset → double
no setter
outOfRange → bool
Out of scroll area.
no setter
overExtent → double
Keep the extent of the Scrollable out of bounds.
no setter
position ↔ ScrollMetrics
The current scroll position.
getter/setter pair
processedDuration → Duration
no setter
readySpringBuilder → SpringBuilder?
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
safeArea → bool
no setter
safeOffset → double
no setter
secondaryCloseTriggerOffset → double
no setter
secondaryDimension → double
no setter
secondaryLocked → bool
no setter
secondaryTriggerOffset → double?
no setter
secondaryVelocity → double
no setter
spring → SpringDescription
no setter
triggerOffset → double
no setter
userOffsetNotifier → ValueNotifier<bool>
User triggered notifier. Record user triggers and releases.
final
velocity → double
no setter
viewportDimension → double
Scrollable viewport dimension.
no setter
vsync → TickerProviderStateMixin<StatefulWidget>
Used to provide clamping animation.
final

Methods

addListener(VoidCallback listener) → void
Register a closure to be called when the object changes.
inherited
addModeChangeListener(ModeChangeListener listener) → void
Add mode change listener.
animateToOffset({required double offset, required IndicatorMode mode, bool jumpToEdge = true, Duration? duration, Curve curve = Curves.linear, ScrollController? scrollController}) → Future
Animates the position from its current value to the given value. offset The offset to scroll to. mode When duration is null and clamping is true, set the state. jumpToEdge Whether to jump to the edge before scrolling. duration See ScrollPosition.animateTo. curve See ScrollPosition.animateTo. scrollController When position is not ScrollPosition, you can use ScrollController.
calculateOffsetWithPixels(ScrollMetrics position, double pixels) → double
Calculate the overscroll offset with pixels.
callTask({required double overOffset, Duration? duration, Curve curve = Curves.linear, ScrollController? scrollController, bool force = false}) → Future
Automatically trigger task. overOffset Offset beyond the trigger offset, must be greater than 0. duration See ScrollPosition.animateTo. curve See ScrollPosition.animateTo. scrollController When position is not ScrollPosition, you can use ScrollController. force Enforce execution even if the task is in progress. But you have to handle the completion event.
createBallisticSimulation(ScrollMetrics position, double velocity) → Simulation?
Create a ballistic simulation. Use for clamping.
dispose() → void
Discards any resources used by the object.
override
isNestedInnerPosition(ScrollMetrics position) → bool
isNestedOuterPosition(ScrollMetrics position) → bool
listenable() → ValueListenable<IndicatorNotifier>
Indicator listenable.
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
removeModeChangeListener(ModeChangeListener listener) → void
Remove mode change listener.
toString() → String
A string representation of this object.
inherited

Operators

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