Click or drag to resize

ScrollPane Class

Inheritance Hierarchy
SystemObject
  FairyGUIEventDispatcher
    FairyGUIScrollPane

Namespace:  FairyGUI
Assembly:  FairyGUI (in FairyGUI.dll) Version: 1.0.0.0 (1.0.0.0)
Syntax
C#
public class ScrollPane : EventDispatcher

The ScrollPane type exposes the following members.

Constructors
  NameDescription
Public methodScrollPane
Initializes a new instance of the ScrollPane class
Top
Properties
  NameDescription
Public propertybouncebackEffect
滚动到达边缘时是否允许回弹效果。
Public propertycontentHeight
显示内容高度。
Public propertycontentWidth
显示内容宽度。
Public propertycurrentPageX
如果处于分页模式,返回当前在X轴的页码。
Public propertycurrentPageY
如果处于分页模式,返回当前在Y轴的页码。
Public propertydecelerationRate
当处于惯性滚动时减速的速率。默认值是UIConfig.defaultScrollDecelerationRate。 越接近1,减速越慢,意味着滑动的时间和距离更长。
Public propertyStatic memberdraggingPane
当前被拖拽的滚动面板。同一时间只能有一个在进行此操作。
Public propertyfooter
Public propertyheader
Public propertyhzScrollBar
Public propertyinertiaDisabled
是否允许惯性滚动。
Public propertyisBottomMost
返回当前滚动位置是否在最下边。
Public propertyisRightMost
返回当前滚动位置是否在最右边。
Public propertymouseWheelEnabled
是否允许使用鼠标滚轮进行滚动。
Public propertyonPullDownRelease
向下拉过上边缘后释放则派发该事件。
Public propertyonPullUpRelease
向上拉过下边缘后释放则派发该事件。
Public propertyonScroll
Dispatched when scrolling. 在滚动时派发该事件。
Public propertyonScrollEnd
在滚动结束时派发该事件。
Public propertyowner
Public propertypageController
Public propertypageMode
是否页面滚动模式。
Public propertypercX
当前X轴滚动位置百分比,0~1(包含)。
Public propertypercY
当前Y轴滚动位置百分比,0~1(包含)。
Public propertyposX
当前X轴滚动位置,值范围是viewWidth与contentWidth之差。
Public propertyposY
当前Y轴滚动位置,值范围是viewHeight与contentHeight之差。
Public propertyscrollingPosX
这个值与PosX不同在于,他反映的是实时位置,而PosX在有缓动过程的情况下只是终值。
Public propertyscrollingPosY
这个值与PosY不同在于,他反映的是实时位置,而PosY在有缓动过程的情况下只是终值。
Public propertyscrollStep
当调用ScrollPane.scrollUp/Down/Left/Right时,或者点击滚动条的上下箭头时,滑动的距离。 鼠标滚轮触发一次滚动的距离设定为defaultScrollStep*2
Public propertysnapToItem
滚动位置是否保持贴近在某个元件的边缘。
Public propertysoftnessOnTopOrLeftSide
是否允许在左/上边缘显示虚化效果。
Public propertytouchEffect
是否允许拖拽内容区域进行滚动。
Public propertyviewHeight
显示区域高度。
Public propertyviewWidth
显示区域宽度。
Public propertyvtScrollBar
Top
Methods
  NameDescription
Public methodAddEventListener(String, EventCallback0)
(Inherited from EventDispatcher.)
Public methodAddEventListener(String, EventCallback1)
(Inherited from EventDispatcher.)
Public methodBroadcastEvent
(Inherited from EventDispatcher.)
Public methodBubbleEvent
(Inherited from EventDispatcher.)
Public methodCancelDragging
当滚动面板处于拖拽滚动状态或即将进入拖拽状态时,可以调用此方法停止或禁止本次拖拽。
Public methodDispatchEvent(String)
(Inherited from EventDispatcher.)
Public methodDispatchEvent(EventContext)
(Inherited from EventDispatcher.)
Public methodDispatchEvent(String, Object)
(Inherited from EventDispatcher.)
Public methodDispatchEvent(String, Object, Object) (Inherited from EventDispatcher.)
Public methodDispose
Releases all resources used by the ScrollPane
Public methodIsChildInView
Public methodLockFooter
设置Footer固定显示。如果size为0,则取消固定显示。
Public methodLockHeader
设置Header固定显示。如果size为0,则取消固定显示。
Public methodRemoveEventListener(String, EventCallback0)
(Inherited from EventDispatcher.)
Public methodRemoveEventListener(String, EventCallback1)
(Inherited from EventDispatcher.)
Public methodRemoveEventListeners
(Inherited from EventDispatcher.)
Public methodRemoveEventListeners(String)
(Inherited from EventDispatcher.)
Public methodScrollBottom
Public methodScrollBottom(Boolean)
Public methodScrollDown
Public methodScrollDown(Single, Boolean)
Public methodScrollLeft
Public methodScrollLeft(Single, Boolean)
Public methodScrollRight
Public methodScrollRight(Single, Boolean)
Public methodScrollTop
Public methodScrollTop(Boolean)
Public methodScrollToView(GObject)
Public methodScrollToView(GObject, Boolean)
Public methodScrollToView(Rect, Boolean, Boolean)
Public methodScrollToView(GObject, Boolean, Boolean)
Public methodScrollUp
Public methodScrollUp(Single, Boolean)
Public methodSetCurrentPageX
如果处于分页模式,可设置X轴的页码。
Public methodSetCurrentPageY
如果处于分页模式,可设置Y轴的页码。
Public methodSetPercX
设置当前X轴滚动位置百分比,0~1(包含)。
Public methodSetPercY
设置当前Y轴滚动位置百分比,0~1(包含)。
Public methodSetPosX
设置当前X轴滚动位置。
Public methodSetPosY
设置当前Y轴滚动位置。
Public methodSetup
Top
See Also