HeaderNotifier class

Header notifier Header status and Notifications

Inheritance

Constructors

HeaderNotifier({required Header header, required ValueNotifier<bool> userOffsetNotifier, required TickerProviderStateMixin<StatefulWidget> vsync, required CanProcessCallBack onCanRefresh, bool canProcessAfterNoMore = false, bool canProcessAfterFail = true, Axis? triggerAxis, FutureOr onRefresh()?, bool waitRefreshResult = true})

Properties

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

Methods

addListener(VoidCallback listener) → void
Register a closure to be called when the object changes.
inherited
addModeChangeListener(ModeChangeListener listener) → void
Add mode change listener.
inherited
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.
override
calculateOffsetWithPixels(ScrollMetrics position, double pixels) double
See IndicatorNotifier.calculateOffsetWithPixels.
override
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.
inherited
createBallisticSimulation(ScrollMetrics position, double velocity) Simulation?
See IndicatorNotifier.createBallisticSimulation.
override
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
listenable() ValueListenable<IndicatorNotifier>
Indicator listenable.
inherited
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.
inherited
toString() String
A string representation of this object.
inherited

Operators

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