ScrollPane.scroll

Availability

Flash Player 6.0.79.

Edition

Flash MX 2004.

Usage

Usage 1:

on(scroll){
  ...
}

Usage 2:'

listenerObject = new Object();
listenerObject.scroll = function(eventObject){
  ...
}
scrollPaneInstance.addEventListener("scroll", listenerObject)

Event Object

In addition to the standard event object properties, there is a type property defined for the scroll event, the value is "scroll". There is also a direction property with the possible values "vertical" and "horizontal".

Description

Event; broadcast to all registered listeners when a user presses the scroll bar buttons, thumb, or track. Unlike other events, the scroll event is broadcast when a user presses on the scroll bar and continues broadcasting until the scroll bar is released.

The first usage example uses an on() handler and must be attached directly to a ScrollPane component instance. The keyword this, used inside an on() handler attached to a component, refers to the component instance. For example, the following code, attached to the instance sp, sends "_level0.sp" to the Output panel:

on(scroll){
  trace(this);
}

The second usage example uses a dispatcher/listener event model. A component instance (scrollPaneInstance) dispatches an event (in this case, scroll) and the event is handled by a function attached to a listener object (listenerObject) that you create. You define a method with the same name as the event on the listener object; the method is called when the event is triggered. When the event is triggered, it automatically passes an event object (eventObject) to the listener object method. Each event object has a set of properties that contains information about the event. You can use these properties to write code that handles the event. Finally, you call the UIEventDispatcher.addEventListener() method on the component instance that broadcasts the event to register the listener with the instance. When the instance dispatches the event, the listener is called.

For more information about event objects, see Event Objects.

Example

This example creates a form listener object with a scroll callback function that's registered to the spInstance instance. You must fill spInstance with content, as in the following:

spInstance.contentPath = "mouse3.jpg";
form = new Object();
form.scroll = function(eventObj){
  trace("ScrollPane scrolled");
}
spInstance.addEventListener("scroll", form);

See also

UIEventDispatcher.addEventListener()