qnx.fuse.ui.events.ScrollEvent

ScrollEvent

Properties | Methods | Constants


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

A ScrollEvent object is dispatched by scrollable objects.

Class information:
BlackBerry 10 Version:   10.0.0
Found in:  qnxui.swc

See also

qnx.fuse.ui.core.Container
qnx.fuse.ui.listClasses.List



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

deltaX


deltaX:Number  [read-only]

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


Implementation

public function get deltaX():Number

deltaY


deltaY:Number  [read-only]

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


Implementation

public function get deltaY():Number

phase


phase:String  [read-only]

Gets the phase of the scroll event.


Implementation

public function get phase():String

Constructor Detail

ScrollEvent()


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_BEGIN


public static const SCROLL_BEGIN:String = scrollBegin

Dispatched when scrolling begins.

The ScrollEvent.SCROLL_BEGIN constant defines the value of the type property of the event object for an scrollBegin event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe object that is actively processing the Event object with an event listener.
typeScrollEvent.SCROLL_BEGIN
deltaXThe delta of the x property of the control from its previous location.
deltaYThe delta of the y property of the control from its previous location.
phaseThe phase of the scroll event.

SCROLL_END


public static const SCROLL_END:String = scrollEnd

Dispatched when scrolling ends.

The ScrollEvent.SCROLL_END constant defines the value of the type property of the event object for an scrollEnd event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe object that is actively processing the Event object with an event listener.
typeScrollEvent.SCROLL_END
deltaXThe delta of the x property of the control from its previous location.
deltaYThe delta of the y property of the control from its previous location.
phaseThe phase of the scroll event.

SCROLL_MOVE


public static const SCROLL_MOVE:String = scrollMove

Dispatched when scrolling occurs.

The ScrollEvent.SCROLL_MOVE constant defines the value of the type property of the event object for an scrollMove event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe object that is actively processing the Event object with an event listener.
typeScrollEvent.SCROLL_MOVE
deltaXThe delta of the x property of the control from its previous location.
deltaYThe delta of the y property of the control from its previous location.
phaseThe phase of the scroll event.





comments powered by Disqus