SnapControllerState class

Inheritance
Mixed in types

Constructors

SnapControllerState(bool useCache, GlobalKey<State<StatefulWidget>> viewKey, GlobalKey<State<StatefulWidget>> boundKey, Offset constraintsMin, Offset constraintsMax, Offset flexibilityMin, Offset flexibilityMax, List<SnapTarget> snapTargets, double minSnapDistance, bool animateSnap, bool useFlick, double flickSensitivity, MoveCallback onMove, DragCallback onDragStart, DragCallback onDragUpdate, DragCallback onDragEnd, SnapCallback onSnap)

Properties

animateSnap → bool
final
animation Animation<Offset>
read / write
animationController AnimationController
The AnimationController used to move the view during snapping if SnapController.animateSnap is set to true.
read / write
beginDragPosition Offset
read / write
boundHeight ↔ double
read / write
boundIsSet → bool
read-only
boundKey GlobalKey<State<StatefulWidget>>
final
boundOrigin Offset
read / write
boundRenderBox RenderBox
read / write
boundWidth ↔ double
read / write
canMove ↔ bool
read / write
constraintsMax Offset
read / write
constraintsMin Offset
read / write
delta Offset
read / write
deltaNotifier ValueNotifier<Offset>
final
flexibilityMax Offset
final
flexibilityMin Offset
final
flickController GlobalKey<FlickControllerState>
final
flickSensitivity → double
final
maxBottom → double
read-only
maxLeft → double
read-only
maxRight → double
read-only
maxTop → double
read-only
minSnapDistance → double
final
normalisedConstraintsMax Offset
read / write
normalisedConstraintsMin Offset
read / write
onDragEnd DragCallback
final
onDragStart DragCallback
final
onDragUpdate DragCallback
final
onMove MoveCallback
final
onSnap SnapCallback
final
overrideDelta Offset
read / write
snapTargets → List<SnapTarget>
final
uiChild Widget
read / write
updateDragPosition Offset
read / write
useCache → bool
final
useFlick ↔ bool
read / write
viewHeight ↔ double
read / write
viewIsSet → bool
read-only
viewKey GlobalKey<State<StatefulWidget>>
final
viewOrigin Offset
read / write
viewRenderBox RenderBox
read / write
viewWidth ↔ double
read / write
context BuildContext
The location in the tree where this widget builds.
read-only, inherited
hashCode → int
The hash code for this object.
read-only, inherited
mounted → bool
Whether this State object is currently in a tree.
read-only, inherited
runtimeType → Type
A representation of the runtime type of the object.
read-only, inherited
widget SnapController
The current configuration.
read-only, inherited

Methods

animationListener() → void
beginDrag(dynamic dragStartDetails) → void
build(BuildContext context) Widget
Describes the part of the user interface represented by this widget. [...]
override
checkBoundOrigin() → void
checkViewAndBound() → void
checkViewOrigin() → void
dispose() → void
Called when this object is removed from the tree permanently. [...]
override
endDrag(dynamic dragEndDetails) → void
getSnapTarget() Offset
initState() → void
Called when this object is inserted into the tree. [...]
override
isMoved(double treshold) → bool
Use this function to determine if the view is moved or not.
move(Offset snapTarget) → Future
normaliseConstraints() → void
onFlick(Offset offset) → void
reset() → void
setBound() → void
setDelta() → void
setView() → void
snap() → Future
softReset(Offset _constraintsMin, Offset _constraintsMax) → void
updateDrag(dynamic dragUpdateDetails) → void
wrapper() Widget
createTicker(TickerCallback onTick) Ticker
Creates a ticker with the given callback.
inherited
deactivate() → void
Called when this object is removed from the tree.
@mustCallSuper, @protected, inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
didChangeDependencies() → void
Called when a dependency of this State object changes.
inherited
didUpdateWidget(covariant SnapController oldWidget) → void
Called whenever the widget configuration changes.
@mustCallSuper, @protected, inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed.
inherited
reassemble() → void
Called whenever the application is reassembled during debugging, for example during hot reload.
@mustCallSuper, @protected, inherited
setState(VoidCallback fn) → void
Notify the framework that the internal state of this object has changed.
@protected, 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.debug}) → String
Returns 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 ==(dynamic other) → bool
The equality operator.
inherited