ScrollAction class

An Action that scrolls the relevant Scrollable by the amount configured in the ScrollIntent given to it.

If a Scrollable cannot be found above the given BuildContext, the PrimaryScrollController will be considered for default handling of ScrollActions.

If Scrollable.incrementCalculator is null for the scrollable, the default for a ScrollIntent.type set to ScrollIncrementType.page is 80% of the size of the scroll window, and for ScrollIncrementType.line, 50 logical pixels.

Inheritance

Constructors

ScrollAction()

Properties

callingAction → Action<ScrollIntent>?: The Action overridden by this Action.
no setterinherited
hashCode → int: The hash code for this object.
no setterinherited
intentType → Type: Gets the type of intent this action responds to.
no setterinherited
isActionEnabled → bool: Whether this Action is inherently enabled.
no setterinherited
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited

Methods

addActionListener(ActionListenerCallback listener) → void: Register a callback to listen for changes to the state of this action.
inherited
consumesKey(ScrollIntent intent) → bool: Indicates whether this action should treat key events mapped to this action as being "handled" when it is invoked via the key event.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void: Add additional properties associated with the node.
inherited
invoke(ScrollIntent intent, [BuildContext? context]) → void: Called when the action is to be performed.
override
isEnabled(ScrollIntent intent, [BuildContext? context]) → bool: Returns true if the action is enabled and is ready to be invoked.
override
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
notifyActionListeners() → void: Call all the registered listeners.
inherited
removeActionListener(ActionListenerCallback listener) → void: Remove a previously registered closure from the list of closures that are notified when the object changes.
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
toKeyEventResult(ScrollIntent intent, covariant Object? invokeResult) → KeyEventResult: Converts the result of invoke of this action to a KeyEventResult.
inherited
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) → String: A string representation of this object.
inherited
toStringShort() → String: A brief description of this object, usually just the runtimeType and the hashCode.
inherited

Operators

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

Static Methods

getDirectionalIncrement(ScrollableState state, ScrollIntent intent) → double: Find out how much of an increment to move by, taking the different directions into account.