Class ScrollPosition

Inheritance

Object

ChangeNotifier

ViewportOffset

ScrollPosition

ScrollPositionWithSingleContext

Inherited Members

ViewportOffset.fixed(Single)

ViewportOffset.zero()

ViewportOffset.jumpTo(Single)

ViewportOffset.animateTo(Single, TimeSpan, Curve)

ViewportOffset.userScrollDirection

ViewportOffset.ToString()

ChangeNotifier.hasListeners

ChangeNotifier.addListener(VoidCallback)

ChangeNotifier.removeListener(VoidCallback)

ChangeNotifier.notifyListeners()

Namespace: Unity.UIWidgets.widgets

Syntax

public abstract class ScrollPosition : ViewportOffset, Listenable, ScrollMetrics

Constructors

ScrollPosition(ScrollPhysics, ScrollContext, Boolean, ScrollPosition, String, Object)

Declaration

protected ScrollPosition(ScrollPhysics physics = null, ScrollContext context = null, bool keepScrollOffset = true, ScrollPosition oldPosition = null, string debugLabel = null, object coordinator = null)

Parameters

Type	Name	Description
ScrollPhysics	physics
ScrollContext	context
Boolean	keepScrollOffset
ScrollPosition	oldPosition
String	debugLabel
Object	coordinator

Fields

context

Declaration

public readonly ScrollContext context

Field Value

Type	Description
ScrollContext

debugLabel

Declaration

public readonly string debugLabel

Field Value

Type	Description
String

isScrollingNotifier

Declaration

public readonly ValueNotifier<bool> isScrollingNotifier

Field Value

Type	Description
ValueNotifier<Boolean>

keepScrollOffset

Declaration

public readonly bool keepScrollOffset

Field Value

Type	Description
Boolean

physics

Declaration

public readonly ScrollPhysics physics

Field Value

Type	Description
ScrollPhysics

Properties

activity

Declaration

protected ScrollActivity activity { get; }

Property Value

Type	Description
ScrollActivity

allowImplicitScrolling

Declaration

public override bool allowImplicitScrolling { get; }

Property Value

Type	Description
Boolean

Overrides

ViewportOffset.allowImplicitScrolling

axisDirection

Declaration

public abstract AxisDirection axisDirection { get; }

Property Value

Type	Description
AxisDirection

Implements

ScrollMetrics.axisDirection

hasMaxScrollExtent

Declaration

public bool hasMaxScrollExtent { get; }

Property Value

Type	Description
Boolean

hasMinScrollExtent

Declaration

public bool hasMinScrollExtent { get; }

Property Value

Type	Description
Boolean

haveDimensions

Declaration

public bool haveDimensions { get; }

Property Value

Type	Description
Boolean

havePixels

Declaration

public bool havePixels { get; }

Property Value

Type	Description
Boolean

maxScrollExtent

Declaration

public float maxScrollExtent { get; }

Property Value

Type	Description
Single

Implements

ScrollMetrics.maxScrollExtent

minScrollExtent

Declaration

public float minScrollExtent { get; }

Property Value

Type	Description
Single

Implements

ScrollMetrics.minScrollExtent

pixels

Declaration

public override float pixels { get; }

Property Value

Type	Description
Single

Overrides

ViewportOffset.pixels

Implements

ScrollMetrics.pixels

viewportDimension

Declaration

public float viewportDimension { get; }

Property Value

Type	Description
Single

Implements

ScrollMetrics.viewportDimension

Methods

absorb(ScrollPosition)

Declaration

protected virtual void absorb(ScrollPosition other)

Parameters

Type	Name	Description
ScrollPosition	other

applyBoundaryConditions(Single)

Declaration

protected float applyBoundaryConditions(float value)

Parameters

Type	Name	Description
Single	value

Returns

Type	Description
Single

applyContentDimensions(Single, Single)

Declaration

public override bool applyContentDimensions(float minScrollExtent, float maxScrollExtent)

Parameters

Type	Name	Description
Single	minScrollExtent
Single	maxScrollExtent

Returns

Type	Description
Boolean

Overrides

ViewportOffset.applyContentDimensions(Single, Single)

applyNewDimensions()

Declaration

protected virtual void applyNewDimensions()

applyViewportDimension(Single)

Declaration

public override bool applyViewportDimension(float viewportDimension)

Parameters

Type	Name	Description
Single	viewportDimension

Returns

Type	Description
Boolean

Overrides

ViewportOffset.applyViewportDimension(Single)

beginActivity(ScrollActivity)

Declaration

public virtual void beginActivity(ScrollActivity newActivity)

Parameters

Type	Name	Description
ScrollActivity	newActivity

correctBy(Single)

Declaration

public override void correctBy(float correction)

Parameters

Type	Name	Description
Single	correction

Overrides

ViewportOffset.correctBy(Single)

correctPixels(Single)

Declaration

public void correctPixels(float value)

Parameters

Type	Name	Description
Single	value

debugFillDescription(List<String>)

Declaration

protected override void debugFillDescription(List<string> description)

Parameters

Type	Name	Description
List<String>	description

Overrides

ViewportOffset.debugFillDescription(List<String>)

didEndScroll()

Declaration

public void didEndScroll()

didOverscrollBy(Single)

Declaration

public void didOverscrollBy(float value)

Parameters

Type	Name	Description
Single	value

didStartScroll()

Declaration

public void didStartScroll()

didUpdateScrollDirection(ScrollDirection)

Declaration

public void didUpdateScrollDirection(ScrollDirection direction)

Parameters

Type	Name	Description
ScrollDirection	direction

didUpdateScrollPositionBy(Single)

Declaration

public void didUpdateScrollPositionBy(float delta)

Parameters

Type	Name	Description
Single	delta

dispose()

Declaration

public override void dispose()

Overrides

ChangeNotifier.dispose()

drag(DragStartDetails, VoidCallback)

Declaration

public abstract Drag drag(DragStartDetails details, VoidCallback dragCancelCallback)

Parameters

Type	Name	Description
DragStartDetails	details
VoidCallback	dragCancelCallback

Returns

Type	Description
Drag

ensureVisible(RenderObject, Single, Nullable<TimeSpan>, Curve)

Declaration

public IPromise ensureVisible(RenderObject renderObject, float alignment = 0F, TimeSpan? duration = default(TimeSpan? ), Curve curve = null)

Parameters

Type	Name	Description
RenderObject	renderObject
Single	alignment
Nullable<TimeSpan>	duration
Curve	curve

Returns

Type	Description
IPromise

forcePixels(Single)

Declaration

protected void forcePixels(float value)

Parameters

Type	Name	Description
Single	value

hold(VoidCallback)

Declaration

public abstract ScrollHoldController hold(VoidCallback holdCancelCallback)

Parameters

Type	Name	Description
VoidCallback	holdCancelCallback

Returns

Type	Description
ScrollHoldController

moveTo(Single, Nullable<TimeSpan>, Curve, Boolean)

Declaration

public override IPromise moveTo(float to, TimeSpan? duration, Curve curve = null, bool clamp = true)

Parameters

Type	Name	Description
Single	to
Nullable<TimeSpan>	duration
Curve	curve
Boolean	clamp

Returns

Type	Description
IPromise

Overrides

ViewportOffset.moveTo(Single, Nullable<TimeSpan>, Curve, Boolean)

restoreScrollOffset()

Declaration

protected virtual void restoreScrollOffset()

saveScrollOffset()

Declaration

protected virtual void saveScrollOffset()

setPixels(Single)

Declaration

public virtual float setPixels(float newPixels)

Parameters

Type	Name	Description
Single	newPixels

Returns

Type	Description
Single

Extension Methods

ScrollMetricsUtils.axis(ScrollMetrics)

ScrollMetricsUtils.outOfRange(ScrollMetrics)

ScrollMetricsUtils.atEdge(ScrollMetrics)

ScrollMetricsUtils.extentBefore(ScrollMetrics)

ScrollMetricsUtils.extentInside(ScrollMetrics)

ScrollMetricsUtils.extentAfter(ScrollMetrics)