ScrollIncrementType enum

Describes the type of scroll increment that will be performed by a ScrollAction on a Scrollable.

This is used to configure a ScrollIncrementDetails object to pass to a ScrollIncrementCalculator function on a Scrollable.

This indicates the intent of the scroll, not necessarily the size. Not all scrollable areas will have the concept of a "line" or "page", but they can respond to the different standard key bindings that cause scrolling, which are bound to keys that people use to indicate a "line" scroll (e.g. control-arrowDown keys) or a "page" scroll (e.g. pageDown key). It is recommended that at least the relative magnitudes of the scrolls match expectations.

Constants

line → const ScrollIncrementType

Indicates that the ScrollIncrementCalculator should return the scroll distance it should move when the user requests to scroll by a "line".

The distance a "line" scrolls refers to what should happen when the key binding for "scroll down/up by a line" is triggered. It's up to the ScrollIncrementCalculator function to decide what that means for a particular scrollable.

const ScrollIncrementType(0)
page → const ScrollIncrementType

Indicates that the ScrollIncrementCalculator should return the scroll distance it should move when the user requests to scroll by a "page".

The distance a "page" scrolls refers to what should happen when the key binding for "scroll down/up by a page" is triggered. It's up to the ScrollIncrementCalculator function to decide what that means for a particular scrollable.

const ScrollIncrementType(1)
values → const List<ScrollIncrementType>

A constant List of the values in this enum, in order of their declaration.

const List<ScrollIncrementType>

Properties

hashCode int
The hash code for this object. [...]
read-only, inherited
index int

The integer index of this enum.

final
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
inherited
toString() String
Returns a string representation of this object.
override

Operators

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