ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
flashx.textLayout.events 

ScrollEvent  - AS3

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

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

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


Public Properties
 PropertyDefined By
 Inheritedbubbles : Boolean
[read-only] Indicates whether an event is a bubbling event.
Event
 Inheritedcancelable : Boolean
[read-only] Indicates whether the behavior associated with the event can be prevented.
Event
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 InheritedcurrentTarget : Object
[read-only] The object that is actively processing the Event object with an event listener.
Event
  delta : Number
The change in the scroll position value that resulted from the scroll.
ScrollEvent
  direction : String
The direction of motion.
ScrollEvent
 InheritedeventPhase : uint
[read-only] The current phase in the event flow.
Event
 Inheritedtarget : Object
[read-only] The event target.
Event
 Inheritedtype : String
[read-only] The type of event.
Event
Public Methods
 MethodDefined By
  
ScrollEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, direction:String = null, delta:Number = NaN)
Constructor.
ScrollEvent
 Inherited
clone():Event
Duplicates an instance of an Event subclass.
Event
 Inherited
formatToString(className:String, ... arguments):String
A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes.
Event
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
isDefaultPrevented():Boolean
Checks whether the preventDefault() method has been called on the event.
Event
 Inherited
isPrototypeOf(theClass:Object):Boolean
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
preventDefault():void
Cancels an event's default behavior if that behavior can be canceled.
Event
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
stopImmediatePropagation():void
Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.
Event
 Inherited
stopPropagation():void
Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.
Event
 Inherited
toLocaleString():String
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
toString():String
Returns a string containing all the properties of the Event object.
Event
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined By
Property Detail

delta

property
public var delta:Number

Language Version: ActionScript 3.0
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.

direction

property 
public var direction:String

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

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

Related API Elements

flashx.textLayout.events.ScrollEventDirection
Constructor Detail

ScrollEvent

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

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)



© 2014 Adobe Systems Incorporated. All rights reserved.
Thu Dec 4 2014, 05:50 PM -08:00
 

 

Legal Notices | Online Privacy Policy