Packageqnx.ui.events
Classpublic class ScrollEvent
InheritanceScrollEvent Inheritance flash.events.Event

A ScrollEvent object is dispatched by scrollable objects.



Public Properties
 PropertyDefined By
  deltaX : Number
[read-only] Gets the delta of the x property of the object from its previous position.
ScrollEvent
  deltaY : Number
[read-only] Gets the delta of the y property of the object from its previous position.
ScrollEvent
  phase : String
[read-only] Gets the phase of the scroll event.
ScrollEvent
Public Methods
 MethodDefined By
  
ScrollEvent(type:String, deltaX:Number = 0, deltaY:Number = 0, phase:String = null)
Creates a ScrollEvent instance that contains information about Scroll events.
ScrollEvent
Public Constants
 ConstantDefined By
  SCROLL_BEGIN : String = scrollBegin
[static] Dispatched when scrolling begins.
ScrollEvent
  SCROLL_END : String = scrollEnd
[static] Dispatched when scrolling ends.
ScrollEvent
  SCROLL_MOVE : String = scrollMove
[static] Dispatched when scrolling occurs.
ScrollEvent
Property Detail
deltaXproperty
deltaX:Number  [read-only]

Gets the delta of the x property of the object from its previous position.


Implementation
    public function get deltaX():Number
deltaYproperty 
deltaY:Number  [read-only]

Gets the delta of the y property of the object from its previous position.


Implementation
    public function get deltaY():Number
phaseproperty 
phase:String  [read-only]

Gets the phase of the scroll event.


Implementation
    public function get phase():String
Constructor Detail
ScrollEvent()Constructor
public function ScrollEvent(type:String, deltaX:Number = 0, deltaY:Number = 0, phase:String = null)

Creates a ScrollEvent instance that contains information about Scroll events.

Event objects are passed as parameters to event listeners.

Parameters
type:String — (String) The type of event.
 
deltaX:Number (default = 0) — The delta of the X axis.
 
deltaY:Number (default = 0) — The delta of the Y axis.
 
phase:String (default = null) — The phase of the scroll.
Constant Detail
SCROLL_BEGINConstant
public static const SCROLL_BEGIN:String = scrollBegin

Dispatched when scrolling begins.

SCROLL_ENDConstant 
public static const SCROLL_END:String = scrollEnd

Dispatched when scrolling ends.

SCROLL_MOVEConstant 
public static const SCROLL_MOVE:String = scrollMove

Dispatched when scrolling occurs.