StretchingOverscrollIndicator class
A Material Design visual indication that a scroll view has overscrolled.
A StretchingOverscrollIndicator listens for ScrollNotifications in order to stretch the content of the Scrollable. These notifications are typically generated by a ScrollView, such as a ListView or a GridView.
When triggered, the StretchingOverscrollIndicator generates an OverscrollIndicatorNotification before showing an overscroll indication. To prevent the indicator from showing the indication, call OverscrollIndicatorNotification.disallowIndicator on the notification.
Created by MaterialScrollBehavior.buildOverscrollIndicator on platforms (e.g., Android) that commonly use this type of overscroll indication when ThemeData.useMaterial3 is true. Otherwise, when ThemeData.useMaterial3 is false, a GlowingOverscrollIndicator is used instead.=
See also:
- OverscrollIndicatorNotification, which can be used to prevent the stretch effect from being applied at all.
- NotificationListener, to listen for the OverscrollIndicatorNotification.
- GlowingOverscrollIndicator, the default overscroll indicator for TargetPlatform.android and TargetPlatform.fuchsia.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- StretchingOverscrollIndicator
Constructors
- StretchingOverscrollIndicator({Key? key, required AxisDirection axisDirection, ScrollNotificationPredicate notificationPredicate = defaultScrollNotificationPredicate, Clip clipBehavior = Clip.hardEdge, Widget? child})
-
Creates a visual indication that a scroll view has overscrolled by
applying a stretch transformation to the content.
const
Properties
- axis → Axis
-
The axis along which scrolling occurs in the Scrollable whose
overscrolls are to be visualized.
no setter
- axisDirection → AxisDirection
-
The direction of positive scroll offsets in the Scrollable whose
overscrolls are to be visualized.
final
- child → Widget?
-
The widget below this widget in the tree.
final
- clipBehavior → Clip
-
The content will be clipped (or not) according to this option.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- notificationPredicate → ScrollNotificationPredicate
-
A check that specifies whether a ScrollNotification should be
handled by this widget.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → State< StretchingOverscrollIndicator> -
Creates the mutable state for this widget at a given location in the tree.
override
-
debugDescribeChildren(
) → List< DiagnosticsNode> -
Returns a list of DiagnosticsNode objects describing this node's
children.
inherited
-
debugFillProperties(
DiagnosticPropertiesBuilder properties) → void -
Add additional properties associated with the node.
override
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toDiagnosticsNode(
{String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode -
Returns a debug representation of the object that is used by debugging
tools and by DiagnosticsNode.toStringDeep.
inherited
-
toString(
{DiagnosticLevel minLevel = DiagnosticLevel.info}) → String -
A string representation of this object.
inherited
-
toStringDeep(
{String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String -
Returns a string representation of this node and its descendants.
inherited
-
toStringShallow(
{String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String -
Returns a one-line detailed description of the object.
inherited
-
toStringShort(
) → String -
A short, textual description of this widget.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited