Class ScrollPositionWithSingleContext | UIWidgets | 1.5.4-preview.12
docs.unity3d.com
    Show / Hide Table of Contents

    Class ScrollPositionWithSingleContext

    Inheritance
    Object
    ChangeNotifier
    ViewportOffset
    ScrollPosition
    ScrollPositionWithSingleContext
    Inherited Members
    ScrollPosition.physics
    ScrollPosition.context
    ScrollPosition.keepScrollOffset
    ScrollPosition.debugLabel
    ScrollPosition.minScrollExtent
    ScrollPosition.maxScrollExtent
    ScrollPosition.hasMinScrollExtent
    ScrollPosition.hasMaxScrollExtent
    ScrollPosition.pixels
    ScrollPosition.havePixels
    ScrollPosition.viewportDimension
    ScrollPosition.haveDimensions
    ScrollPosition.correctPixels(Single)
    ScrollPosition.correctBy(Single)
    ScrollPosition.forcePixels(Single)
    ScrollPosition.saveScrollOffset()
    ScrollPosition.restoreScrollOffset()
    ScrollPosition.applyBoundaryConditions(Single)
    ScrollPosition.applyViewportDimension(Single)
    ScrollPosition.applyContentDimensions(Single, Single)
    ScrollPosition.ensureVisible(RenderObject, Single, Nullable<TimeSpan>, Curve)
    ScrollPosition.isScrollingNotifier
    ScrollPosition.moveTo(Single, Nullable<TimeSpan>, Curve, Boolean)
    ScrollPosition.allowImplicitScrolling
    ScrollPosition.activity
    ScrollPosition.didStartScroll()
    ScrollPosition.didUpdateScrollPositionBy(Single)
    ScrollPosition.didEndScroll()
    ScrollPosition.didOverscrollBy(Single)
    ScrollPosition.didUpdateScrollDirection(ScrollDirection)
    ViewportOffset.fixed(Single)
    ViewportOffset.zero()
    ViewportOffset.ToString()
    ChangeNotifier.hasListeners
    ChangeNotifier.addListener(VoidCallback)
    ChangeNotifier.removeListener(VoidCallback)
    ChangeNotifier.notifyListeners()
    Namespace: Unity.UIWidgets.widgets
    Syntax
    public class ScrollPositionWithSingleContext : ScrollPosition, Listenable, ScrollMetrics, ScrollActivityDelegate

    Constructors

    ScrollPositionWithSingleContext(ScrollPhysics, ScrollContext, Nullable<Single>, Boolean, ScrollPosition, String)

    Declaration
    public ScrollPositionWithSingleContext(ScrollPhysics physics = null, ScrollContext context = null, float? initialPixels, bool keepScrollOffset = true, ScrollPosition oldPosition = null, string debugLabel = null)
    Parameters
    Type Name Description
    ScrollPhysics physics
    ScrollContext context
    Nullable<Single> initialPixels
    Boolean keepScrollOffset
    ScrollPosition oldPosition
    String debugLabel

    Properties

    axisDirection

    Declaration
    public override AxisDirection axisDirection { get; }
    Property Value
    Type Description
    AxisDirection
    Overrides
    ScrollPosition.axisDirection
    Implements
    ScrollActivityDelegate.axisDirection

    userScrollDirection

    Declaration
    public override ScrollDirection userScrollDirection { get; }
    Property Value
    Type Description
    ScrollDirection
    Overrides
    ViewportOffset.userScrollDirection

    Methods

    absorb(ScrollPosition)

    Declaration
    protected override void absorb(ScrollPosition other)
    Parameters
    Type Name Description
    ScrollPosition other
    Overrides
    ScrollPosition.absorb(ScrollPosition)

    animateTo(Single, TimeSpan, Curve)

    Declaration
    public override IPromise animateTo(float to, TimeSpan duration, Curve curve)
    Parameters
    Type Name Description
    Single to
    TimeSpan duration
    Curve curve
    Returns
    Type Description
    IPromise
    Overrides
    ViewportOffset.animateTo(Single, TimeSpan, Curve)

    applyNewDimensions()

    Declaration
    protected override void applyNewDimensions()
    Overrides
    ScrollPosition.applyNewDimensions()

    applyUserOffset(Single)

    Declaration
    public virtual void applyUserOffset(float delta)
    Parameters
    Type Name Description
    Single delta
    Implements
    ScrollActivityDelegate.applyUserOffset(Single)

    applyUserScrollOffset(Single)

    Declaration
    public virtual void applyUserScrollOffset(float delta)
    Parameters
    Type Name Description
    Single delta
    Implements
    ScrollActivityDelegate.applyUserScrollOffset(Single)

    beginActivity(ScrollActivity)

    Declaration
    public override void beginActivity(ScrollActivity newActivity)
    Parameters
    Type Name Description
    ScrollActivity newActivity
    Overrides
    ScrollPosition.beginActivity(ScrollActivity)

    debugFillDescription(List<String>)

    Declaration
    protected override void debugFillDescription(List<string> description)
    Parameters
    Type Name Description
    List<String> description
    Overrides
    ScrollPosition.debugFillDescription(List<String>)

    dispose()

    Declaration
    public override void dispose()
    Overrides
    ScrollPosition.dispose()

    drag(DragStartDetails, VoidCallback)

    Declaration
    public override Drag drag(DragStartDetails details, VoidCallback dragCancelCallback)
    Parameters
    Type Name Description
    DragStartDetails details
    VoidCallback dragCancelCallback
    Returns
    Type Description
    Drag
    Overrides
    ScrollPosition.drag(DragStartDetails, VoidCallback)

    goBallistic(Single)

    Declaration
    public void goBallistic(float velocity)
    Parameters
    Type Name Description
    Single velocity
    Implements
    ScrollActivityDelegate.goBallistic(Single)

    goIdle()

    Declaration
    public void goIdle()
    Implements
    ScrollActivityDelegate.goIdle()

    hold(VoidCallback)

    Declaration
    public override ScrollHoldController hold(VoidCallback holdCancelCallback)
    Parameters
    Type Name Description
    VoidCallback holdCancelCallback
    Returns
    Type Description
    ScrollHoldController
    Overrides
    ScrollPosition.hold(VoidCallback)

    jumpTo(Single)

    Declaration
    public override void jumpTo(float value)
    Parameters
    Type Name Description
    Single value
    Overrides
    ViewportOffset.jumpTo(Single)

    setPixels(Single)

    Declaration
    public override float setPixels(float newPixels)
    Parameters
    Type Name Description
    Single newPixels
    Returns
    Type Description
    Single
    Overrides
    ScrollPosition.setPixels(Single)
    Implements
    ScrollActivityDelegate.setPixels(Single)

    updateUserScrollDirection(ScrollDirection)

    Declaration
    protected void updateUserScrollDirection(ScrollDirection value)
    Parameters
    Type Name Description
    ScrollDirection value

    Extension Methods

    ScrollMetricsUtils.axis(ScrollMetrics)
    ScrollMetricsUtils.outOfRange(ScrollMetrics)
    ScrollMetricsUtils.atEdge(ScrollMetrics)
    ScrollMetricsUtils.extentBefore(ScrollMetrics)
    ScrollMetricsUtils.extentInside(ScrollMetrics)
    ScrollMetricsUtils.extentAfter(ScrollMetrics)
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023