跳到主要内容

ScrollPane

命名空间：FairyGUI
源码：Assets/Scripts/UI/ScrollPane.cs (行 10)

public class ScrollPane : EventDispatcher

继承：EventDispatcher → ScrollPane

继承成员​

EventDispatcher

AddCapture, AddEventListener, BroadcastEvent, BubbleEvent, DispatchEvent, RemoveCapture, RemoveEventListener, RemoveEventListeners, hasEventListeners, isDispatching

构造函数​

ScrollPane(GComponent)​

public ScrollPane(GComponent owner);
参数类型说明
ownerGComponent

源码：UI/ScrollPane.cs (行 92)

字段​

PULL_RATIO​

public static float PULL_RATIO;

源码：UI/ScrollPane.cs (行 90)

TWEEN_TIME_DEFAULT​

public static float TWEEN_TIME_DEFAULT;

源码：UI/ScrollPane.cs (行 89)

TWEEN_TIME_GO​

public static float TWEEN_TIME_GO;

源码：UI/ScrollPane.cs (行 88)

方法​

CancelDragging()​

public void CancelDragging();

当滚动面板处于拖拽滚动状态或即将进入拖拽状态时，可以调用此方法停止或禁止本次拖拽。

源码：UI/ScrollPane.cs (行 959)

Dispose()​

public void Dispose();

源码：UI/ScrollPane.cs (行 242)

IsChildInView(GObject)​

public bool IsChildInView(GObject obj);
参数类型说明
objGObjectobj must be the direct child of this container

源码：UI/ScrollPane.cs (行 938)

LockFooter(int)​

public void LockFooter(int size);

设置Footer固定显示。如果size为0，则取消固定显示。

参数类型说明
sizeint

源码：UI/ScrollPane.cs (行 994)

LockHeader(int)​

public void LockHeader(int size);

设置Header固定显示。如果size为0，则取消固定显示。

参数类型说明
sizeintHeader显示的大小

源码：UI/ScrollPane.cs (行 974)

ScrollBottom()​

public void ScrollBottom();

源码：UI/ScrollPane.cs (行 736)

ScrollBottom(bool)​

public void ScrollBottom(bool ani);
参数类型说明
anibool

源码：UI/ScrollPane.cs (行 745)

ScrollDown()​

public void ScrollDown();

源码：UI/ScrollPane.cs (行 774)

ScrollDown(float, bool)​

public void ScrollDown(float ratio, bool ani);
参数类型说明
ratiofloat
anibool

源码：UI/ScrollPane.cs (行 784)

ScrollLeft()​

public void ScrollLeft();

源码：UI/ScrollPane.cs (行 795)

ScrollLeft(float, bool)​

public void ScrollLeft(float ratio, bool ani);
参数类型说明
ratiofloat
anibool

源码：UI/ScrollPane.cs (行 805)

ScrollRight()​

public void ScrollRight();

源码：UI/ScrollPane.cs (行 816)

ScrollRight(float, bool)​

public void ScrollRight(float ratio, bool ani);
参数类型说明
ratiofloat
anibool

源码：UI/ScrollPane.cs (行 826)

ScrollToView(GObject)​

public void ScrollToView(GObject obj);
参数类型说明
objGObjectobj can be any object on stage, not limited to the direct child of this container.

源码：UI/ScrollPane.cs (行 838)

ScrollToView(GObject, bool)​

public void ScrollToView(GObject obj, bool ani);
参数类型说明
objGObjectobj can be any object on stage, not limited to the direct child of this container.
aniboolIf moving to target position with animation

源码：UI/ScrollPane.cs (行 848)

ScrollToView(GObject, bool, bool)​

public void ScrollToView(GObject obj, bool ani, bool setFirst);
参数类型说明
objGObjectobj can be any object on stage, not limited to the direct child of this container.
aniboolIf moving to target position with animation
setFirstboolIf true, scroll to make the target on the top/left; If false, scroll to make the target any position in view.

源码：UI/ScrollPane.cs (行 859)

ScrollToView(Rect, bool, bool)​

public void ScrollToView(Rect rect, bool ani, bool setFirst);
参数类型说明
rectRectRect in local coordinates
aniboolIf moving to target position with animation
setFirstboolIf true, scroll to make the target on the top/left; If false, scroll to make the target any position in view.

源码：UI/ScrollPane.cs (行 877)

ScrollTop()​

public void ScrollTop();

源码：UI/ScrollPane.cs (行 719)

ScrollTop(bool)​

public void ScrollTop(bool ani);
参数类型说明
anibool

源码：UI/ScrollPane.cs (行 728)

ScrollUp()​

public void ScrollUp();

源码：UI/ScrollPane.cs (行 753)

ScrollUp(float, bool)​

public void ScrollUp(float ratio, bool ani);
参数类型说明
ratiofloat
anibool

源码：UI/ScrollPane.cs (行 763)

SetCurrentPageX(int, bool)​

public void SetCurrentPageX(int value, bool ani);

如果处于分页模式，可设置X轴的页码。

参数类型说明
valueint
anibool是否使用缓动到达目标。

源码：UI/ScrollPane.cs (行 587)

SetCurrentPageY(int, bool)​

public void SetCurrentPageY(int value, bool ani);

如果处于分页模式，可设置Y轴的页码。

参数类型说明
valueint
anibool是否使用缓动到达目标。

源码：UI/ScrollPane.cs (行 631)

SetPercX(float, bool)​

public void SetPercX(float value, bool ani);

设置当前X轴滚动位置百分比，0~1（包含）。

参数类型说明
valuefloat
anibool是否使用缓动到达目标。

源码：UI/ScrollPane.cs (行 454)

SetPercY(float, bool)​

public void SetPercY(float value, bool ani);

设置当前Y轴滚动位置百分比，0~1（包含）。

参数类型说明
valuefloat
anibool是否使用缓动到达目标。

源码：UI/ScrollPane.cs (行 474)

SetPosX(float, bool)​

public void SetPosX(float value, bool ani);

设置当前X轴滚动位置。

参数类型说明
valuefloat
anibool是否使用缓动到达目标。

源码：UI/ScrollPane.cs (行 494)

SetPosY(float, bool)​

public void SetPosY(float value, bool ani);

设置当前Y轴滚动位置。

参数类型说明
valuefloat
anibool是否使用缓动到达目标。

源码：UI/ScrollPane.cs (行 523)

Setup(ByteBuffer)​

public void Setup(ByteBuffer buffer);
参数类型说明
bufferByteBuffer

源码：UI/ScrollPane.cs (行 124)

UpdateScrollBarVisible()​

public void UpdateScrollBarVisible();

源码：UI/ScrollPane.cs (行 1775)

属性​

bouncebackEffect​

public bool bouncebackEffect { get; set; }

滚动到达边缘时是否允许回弹效果。

源码：UI/ScrollPane.cs (行 340)

contentHeight​

public float contentHeight { get; }

显示内容高度。

源码：UI/ScrollPane.cs (行 678)

contentWidth​

public float contentWidth { get; }

显示内容宽度。

源码：UI/ScrollPane.cs (行 667)

currentPageX​

public int currentPageX { get; set; }

如果处于分页模式，返回当前在X轴的页码。

源码：UI/ScrollPane.cs (行 557)

currentPageY​

public int currentPageY { get; set; }

如果处于分页模式，返回当前在Y轴的页码。

源码：UI/ScrollPane.cs (行 601)

decelerationRate​

public float decelerationRate { get; set; }

当处于惯性滚动时减速的速率。默认值是UIConfig.defaultScrollDecelerationRate。 越接近1，减速越慢，意味着滑动的时间和距离更长。

源码：UI/ScrollPane.cs (行 427)

draggingPane​

public static ScrollPane draggingPane { get; private set; }

当前被拖拽的滚动面板。同一时间只能有一个在进行此操作。

源码：UI/ScrollPane.cs (行 15)

footer​

public GComponent footer { get; }

源码：UI/ScrollPane.cs (行 332)

header​

public GComponent header { get; }

源码：UI/ScrollPane.cs (行 324)

hzScrollBar​

public GScrollBar hzScrollBar { get; }

源码：UI/ScrollPane.cs (行 308)

inertiaDisabled​

public bool inertiaDisabled { get; set; }

是否允许惯性滚动。

源码：UI/ScrollPane.cs (行 358)

isBottomMost​

public bool isBottomMost { get; }

返回当前滚动位置是否在最下边。

源码：UI/ScrollPane.cs (行 541)

isDragged​

public bool isDragged { get; }

源码：UI/ScrollPane.cs (行 435)

isRightMost​

public bool isRightMost { get; }

返回当前滚动位置是否在最右边。

源码：UI/ScrollPane.cs (行 549)

mouseWheelEnabled​

public bool mouseWheelEnabled { get; set; }

是否允许使用鼠标滚轮进行滚动。

源码：UI/ScrollPane.cs (行 417)

onPullDownRelease​

public EventListener onPullDownRelease { get; }

向下拉过上边缘后释放则派发该事件。

源码：UI/ScrollPane.cs (行 284)

onPullUpRelease​

public EventListener onPullUpRelease { get; }

向上拉过下边缘后释放则派发该事件。

源码：UI/ScrollPane.cs (行 292)

onScroll​

public EventListener onScroll { get; }

Dispatched when scrolling. 在滚动时派发该事件。

源码：UI/ScrollPane.cs (行 268)

onScrollEnd​

public EventListener onScrollEnd { get; }

在滚动结束时派发该事件。

源码：UI/ScrollPane.cs (行 276)

owner​

public GComponent owner { get; }

源码：UI/ScrollPane.cs (行 300)

pageController​

public Controller pageController { get; set; }

源码：UI/ScrollPane.cs (行 408)

pageMode​

public bool pageMode { get; set; }

是否页面滚动模式。

源码：UI/ScrollPane.cs (行 399)

percX​

public float percX { get; set; }

当前X轴滚动位置百分比，0~1（包含）。

源码：UI/ScrollPane.cs (行 443)

percY​

public float percY { get; set; }

当前Y轴滚动位置百分比，0~1（包含）。

源码：UI/ScrollPane.cs (行 463)

posX​

public float posX { get; set; }

当前X轴滚动位置，值范围是viewWidth与contentWidth之差。

源码：UI/ScrollPane.cs (行 483)

posY​

public float posY { get; set; }

当前Y轴滚动位置，值范围是viewHeight与contentHeight之差。

源码：UI/ScrollPane.cs (行 512)

scrollStep​

public float scrollStep { get; set; }

当调用ScrollPane.scrollUp/Down/Left/Right时，或者点击滚动条的上下箭头时，滑动的距离。

源码：UI/ScrollPane.cs (行 376)

scrollingPosX​

public float scrollingPosX { get; }

这个值与PosX不同在于，他反映的是实时位置，而PosX在有缓动过程的情况下只是终值。

源码：UI/ScrollPane.cs (行 645)

scrollingPosY​

public float scrollingPosY { get; }

这个值与PosY不同在于，他反映的是实时位置，而PosY在有缓动过程的情况下只是终值。

源码：UI/ScrollPane.cs (行 656)

snapToItem​

public bool snapToItem { get; set; }

滚动位置是否保持贴近在某个元件的边缘。

源码：UI/ScrollPane.cs (行 390)

softnessOnTopOrLeftSide​

public bool softnessOnTopOrLeftSide { get; set; }

是否允许在左/上边缘显示虚化效果。

源码：UI/ScrollPane.cs (行 367)

touchEffect​

public bool touchEffect { get; set; }

是否允许拖拽内容区域进行滚动。

源码：UI/ScrollPane.cs (行 349)

viewHeight​

public float viewHeight { get; set; }

显示区域高度。

源码：UI/ScrollPane.cs (行 704)

viewWidth​

public float viewWidth { get; set; }

显示区域宽度。

源码：UI/ScrollPane.cs (行 689)

vtScrollBar​

public GScrollBar vtScrollBar { get; }

源码：UI/ScrollPane.cs (行 316)