ScrollPane class

A layout container that provides a scrollable viewport into which a child view widget is rendered.

Inheritance

Constructors

ScrollPane({Key? key, ScrollBarPolicy horizontalScrollBarPolicy = ScrollBarPolicy.auto, ScrollBarPolicy verticalScrollBarPolicy = ScrollBarPolicy.auto, Clip clipBehavior = Clip.hardEdge, ScrollPaneController? controller, Widget? rowHeader, Widget? columnHeader, Widget topLeftCorner = const _EmptyCorner(), Widget bottomLeftCorner = const _EmptyCorner(), Widget bottomRightCorner = const _EmptyCorner(), Widget topRightCorner = const _EmptyCorner(), required Widget view})
const

Properties

bottomLeftCorner Widget
Optional widget that will be laid out in the bottom left corner (below the row header and to the left of the horizontal scroll bar).
final
bottomRightCorner Widget
Optional widget that will be laid out in the bottom right corner (below the vertical scroll bar and to the right of the horizontal scroll bar).
final
clipBehavior Clip
The way in which view, rowHeader, and columnHeader will be clipped.
final
columnHeader Widget?
Optional widget that will be laid out to the top of the view, horizontally aligned with the left of the view.
final
controller ScrollPaneController?
The controller responsible for managing the scroll offset of this widget.
final
hashCode int
The hash code for this object.
no setterinherited
horizontalScrollBarPolicy ScrollBarPolicy
The policy for how to lay the view out and show a scroll bar in the horizontal axis.
final
key Key?
Controls how one widget replaces another widget in the tree.
finalinherited
rowHeader Widget?
Optional widget that will be laid out to the left of the view, vertically aligned with the top of the view.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
topLeftCorner Widget
Optional widget that will be laid out in the top left corner (above the row header and to the left of the column header).
final
topRightCorner Widget
Optional widget that will be laid out in the top right corner (above the vertical scroll bar and to the right of the column header).
final
verticalScrollBarPolicy ScrollBarPolicy
The policy for how to lay the view out and show a scroll bar in the vertical axis.
final
view Widget
The main scrollable widget to be shown in the viewport of this scroll pane.
final

Methods

createElement() StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() ScrollPaneState
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.
inherited
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

Static Methods

of(BuildContext context) ScrollPaneState?
Gets the nearest scroll pane ancestor of the specified build context, or null if the context doesn't have a scroll pane ancestor.