ScrollEvent

(Preview)

Package	mx.events
Class	public class ScrollEvent
Inheritance	ScrollEvent Event Object

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Represents events that are dispatched by the ScrollBar class.

Related API Elements

mx.core.UIComponent

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		bubbles : Boolean [read-only] Indicates whether an event is a bubbling event.	Event
		cancelable : Boolean [read-only] Indicates whether the behavior associated with the event can be prevented.	Event
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		currentTarget : 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
		detail : String Provides the details of the scroll activity.	ScrollEvent
		direction : String The direction of motion.	ScrollEvent
		eventPhase : uint [read-only] The current phase in the event flow.	Event
		position : Number The new scroll position.	ScrollEvent
		target : Object [read-only] The event target.	Event
		type : String [read-only] The type of event.	Event

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		ScrollEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, detail:String = null, position:Number = NaN, direction:String = null, delta:Number = NaN) Constructor.	ScrollEvent
		clone():Event Duplicates an instance of an Event subclass.	Event
		formatToString(className:String, ... arguments):String A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes.	Event
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		isDefaultPrevented():Boolean Checks whether the preventDefault() method has been called on the event.	Event
		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
		preventDefault():void Cancels an event's default behavior if that behavior can be canceled.	Event
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		stopImmediatePropagation():void Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.	Event
		stopPropagation():void Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.	Event
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns a string containing all the properties of the Event object.	Event
		valueOf():Object Returns the primitive value of the specified object.	Object

Public Constants

Hide Inherited Public Constants

Show Inherited Public Constants

	Constant		Defined By
		SCROLL : String = "scroll" [static] The ScrollEvent.SCROLL constant defines the value of the type property of the event object for a scroll event.	ScrollEvent

Property Detail

Constructor Detail

Constant Detail

Property	Value
`bubbles`	false
`cancelable`	false
`currentTarget`	The Object that defines the event listener that handles the event. For example, if you use `myButton.addEventListener()` to register an event listener, myButton is the value of the `currentTarget`.
`delta`	Contains the change in scroll position, 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`	Contains the scroll direction, either `ScrollEventDirection.HORIZONTAL` or `ScrollEventDirection.VERTICAL`.
`position`	Contains the new scroll position.
`target`	The Object that dispatched the event; it is not always the Object listening for the event. Use the `currentTarget` property to always access the Object listening for the event.

[an error occurred while processing this directive]

Legal Notices | Online Privacy Policy

	`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.

	`detail:String` (default = `null`) — Provides the specifics of the type of scroll activity. Constants for the possible values are provided in the ScrollEventDetail class.

	`position:Number` (default = `NaN`) — The new scroll position.

	`direction:String` (default = `null`) — The scroll direction, either `ScrollEventDirection.HORIZONTAL` or `ScrollEventDirection.VERTICAL`.

	`delta:Number` (default = `NaN`) — The change in scroll position, expressed in pixels.

ScrollEvent - AS3 Flex

Classes x

delta

detail

direction

position

SCROLL