Packagefl.events
Classpublic class ScrollEvent
InheritanceScrollEvent Inheritance Event Inheritance Object

Language Version : ActionScript 3.0
Player Version : Flash Player 9.0.28.0

The ScrollEvent class defines the scroll event that is associated with the ScrollBar component.

See also

ScrollBar
ScrollBarDirection
UIComponent


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
[read-only] Gets the size of the change in scroll position, in pixels.
ScrollEvent
  direction : String
[read-only] Gets a constant value that indicates the direction of movement associated with the event.
ScrollEvent
 InheritedeventPhase : uint
[read-only] The current phase in the event flow.
Event
  position : Number
[read-only] Gets the current scroll position, in pixels.
ScrollEvent
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
 Inheritedtarget : Object
[read-only] The event target.
Event
 Inheritedtype : String
[read-only] The type of event.
Event
Public Methods
 MethodDefined By
  
ScrollEvent(direction:String, delta:Number, position:Number)
Creates a new ScrollEvent object with the specified parameters.
ScrollEvent
  
Creates a copy of the ScrollEvent object and sets the value of each parameter to match the original.
ScrollEvent
 Inherited
formatToString(className:String, ... arguments):String
A utility function for implementing the toString() method in your custom Event class.
Event
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Checks whether preventDefault() has been called on the event.
Event
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Cancels an event's default behavior if that behavior can be canceled.
Event
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.
Event
 Inherited
Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.
Event
  
Returns a string that contains all the properties of the ScrollEvent object.
ScrollEvent
 Inherited
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined By
 InheritedACTIVATE : String = "activate"
[static] Defines the value of the type property of an activate event object.
Event
 InheritedADDED : String = "added"
[static] Defines the value of the type property of an added event object.
Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] Defines the value of the type property of an addedToStage event object.
Event
 InheritedCANCEL : String = "cancel"
[static] Defines the value of the type property of a cancel event object.
Event
 InheritedCHANGE : String = "change"
[static] Defines the value of the type property of a change event object.
Event
 InheritedCLOSE : String = "close"
[static] Defines the value of the type property of a close event object.
Event
 InheritedCOMPLETE : String = "complete"
[static] Defines the value of the type property of a complete event object.
Event
 InheritedCONNECT : String = "connect"
[static] Defines the value of the type property of a connect event object.
Event
 InheritedDEACTIVATE : String = "deactivate"
[static] Defines the value of the type property of a deactivate event object.
Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] Defines the value of the type property of an enterFrame event object.
Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] Defines the value of the type property of a fullScreen event object.
Event
 InheritedID3 : String = "id3"
[static] Defines the value of the type property of an id3 event object.
Event
 InheritedINIT : String = "init"
[static] Defines the value of the type property of an init event object.
Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] Defines the value of the type property of a mouseLeave event object.
Event
 InheritedOPEN : String = "open"
[static] Defines the value of the type property of an open event object.
Event
 InheritedREMOVED : String = "removed"
[static] Defines the value of the type property of a removed event object.
Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] Defines the value of the type property of a removedFromStage event object.
Event
 InheritedRENDER : String = "render"
[static] Defines the value of the type property of a render event object.
Event
 InheritedRESIZE : String = "resize"
[static] Defines the value of the type property of a resize event object.
Event
  SCROLL : String = "scroll"
[static] Defines the value of the type property of a scroll event object.
ScrollEvent
 InheritedSELECT : String = "select"
[static] Defines the value of the type property of a select event object.
Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] Defines the value of the type property of a soundComplete event object.
Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] Defines the value of the type property of a tabChildrenChange event object.
Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] Defines the value of the type property of a tabEnabledChange event object.
Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] Defines the value of the type property of a tabIndexChange event object.
Event
 InheritedUNLOAD : String = "unload"
[static] Defines the value of the type property of an unload event object.
Event
Property Detail
deltaproperty
delta:Number  [read-only]

Language Version : ActionScript 3.0
Player Version : Flash Player 9.0.28.0

Gets the size of the change in scroll position, in pixels. A positive value indicates that the direction of the scroll was down or to the right. A negative value indicates that the direction of the scroll was up or to the left.


Implementation
    public function get delta():Number
directionproperty 
direction:String  [read-only]

Language Version : ActionScript 3.0
Player Version : Flash Player 9.0.28.0

Gets a constant value that indicates the direction of movement associated with the event. A value of ScrollBarDirection.HORIZONTAL indicates horizontal movement; a value of ScrollBarDirection.VERTICAL indicates vertical movement.


Implementation
    public function get direction():String

See also

positionproperty 
position:Number  [read-only]

Language Version : ActionScript 3.0
Player Version : Flash Player 9.0.28.0

Gets the current scroll position, in pixels.


Implementation
    public function get position():Number
Constructor Detail
ScrollEvent()Constructor
public function ScrollEvent(direction:String, delta:Number, position:Number)

Language Version : ActionScript 3.0
Player Version : Flash Player 9.0.28.0

Creates a new ScrollEvent object with the specified parameters.

Parameters
direction:String — The direction of movement associated with the event. A value of ScrollBarDirection.HORIZONTAL indicates horizontal movement; a value of ScrollBarDirection.VERTICAL indicates vertical movement.
 
delta:Number — The change in scroll position, in pixels. A positive value indicates that the direction of the scroll was down or to the right. A negative value indicates that the direction of the scroll was up or to the left.
 
position:Number — The current scroll position.
Method Detail
clone()method
public override function clone():Event

Language Version : ActionScript 3.0
Player Version : Flash Player 9.0.28.0

Creates a copy of the ScrollEvent object and sets the value of each parameter to match the original.

Returns
Event — A new ScrollEvent object with parameter values that match the original.
toString()method 
public override function toString():String

Language Version : ActionScript 3.0
Player Version : Flash Player 9.0.28.0

Returns a string that contains all the properties of the ScrollEvent object. The string has the following format:

[ScrollEvent type=value bubbles=value cancelable=value direction=value delta=value position=value]

Returns
String — A string representation of the ScrollEvent object.
Constant Detail
SCROLLConstant
public static const SCROLL:String = "scroll"

Language Version : ActionScript 3.0
Player Version : Flash Player 9.0.28.0

Defines the value of the type property of a scroll event object.

This event has the following properties:

PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the event object with an event listener.
delta1; a value that indicates how much scrolling was done.
directionvertical; the direction of the ScrollBar.
position0; the position of the Scrollbar thumb after it was moved.
targetThe object that dispatched the event. The target is not always the object listening for the event. Use the currentTarget property to access the object that is listening for the event.


Example

The following example listens for the scroll event and uses the direction property of the ScrollEvent class to determine if the content was scrolled horizontally or vertically:

import fl.containers.ScrollPane;
import fl.events.ScrollEvent;
import fl.controls.ScrollBarDirection;

var myScrollPane:ScrollPane = new ScrollPane();
myScrollPane.scrollDrag = true;
myScrollPane.source = "http://www.helpexamples.com/flash/images/image1.jpg";
myScrollPane.addEventListener(ScrollEvent.SCROLL, scrollHandler);
addChild(myScrollPane);

function scrollHandler(event:ScrollEvent):void {
    switch (event.direction) {
        case ScrollBarDirection.HORIZONTAL:
            trace("horizontal scroll", event.position, "of", event.currentTarget.maxHorizontalScrollPosition);
            break;
        case ScrollBarDirection.VERTICAL:
            trace("vertical scroll", event.position, "of", event.currentTarget.maxVerticalScrollPosition);
            break;
    }
}