Packageflashx.textLayout.events
Classpublic class ScrollEvent
InheritanceScrollEvent Inheritance TextLayoutEvent Inheritance flash.events.Event

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

Represents events that are dispatched when the TextFlow does automatic scrolling.



Public Properties
 PropertyDefined By
  delta : Number
The change in the scroll position value that resulted from the scroll.
ScrollEvent
  direction : String
The direction of motion.
ScrollEvent
Public Methods
 MethodDefined By
  
ScrollEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, direction:String = null, delta:Number)
Constructor.
ScrollEvent
Public Constants
 ConstantDefined By
 InheritedSCROLL : String = scroll
[static] The TextLayoutEvent.SCROLL constant defines the value of the type property of the event object for a scroll event.
TextLayoutEvent
Property Detail
deltaproperty
public var delta:Number

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

The change in the scroll position value that resulted from the scroll. The value is expressed in pixels. A positive value indicates the scroll was down or to the right. A negative value indicates the scroll was up or to the left.

directionproperty 
public var direction:String

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

The direction of motion. The possible values are ScrollEventDirection.VERTICAL or ScrollEventDirection.HORIZONTAL.

See also

Constructor Detail
ScrollEvent()Constructor
public function ScrollEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, direction:String = null, delta:Number)

Constructor. Scroll events are dispatched when a container has scrolled.

Parameters
type:String — The event type; indicates the action that caused the event.
 
bubbles:Boolean (default = false) — Specifies whether the event can bubble up the display list hierarchy.
 
cancelable:Boolean (default = false) — Specifies whether the behavior associated with the event can be prevented.
 
direction:String (default = null) — The change in scroll position, expressed in pixels.
 
delta:Number (default = NaN)