User Guide

TextField.onScroller 903
TextField.onScroller
Availability
Flash Player 6.
Usage
my_txt.onScroller = function(textFieldInstance:TextField){
// your statements here
}
myListenerObj.onScroller = function(textFieldInstance:TextField){
// your statements here
}
Parameters
textFieldInstance
A reference to the TextField object whose scroll position was changed.
Returns
Nothing.
Description
Event handler/listener; invoked when one of the text field scroll properties changes.
A reference to the text field instance is passed as a parameter to the
onScroller handler. You can
capture this data by putting a parameter in the event handler method. For example, the following
code uses
my_txt as the parameter that is passed to the onScroller event handler. The parameter
is then used in a
trace() statement to send the instance name of the text field to the Output
panel.
myTextField.onScroller = function (my_txt:TextField) {
trace (my_txt._name + " scrolled");
};
The TextField.onScroller event handler is commonly used to implement scroll bars. Scroll
bars typically have a thumb or other indicator that shows the current horizontal or vertical
scrolling position in a text field. Text fields can be navigated using the mouse and keyboard,
which causes the scroll position to change. The scroll bar code needs to be notified if the scroll
position changes because of such user interaction, which is what
TextField.onScroller is used
for.
onScroller is called whether the scroll position changed because of a users interaction with the
text field, or programmatic changes. The
onChanged handler fires only if a user interaction causes
the change. These two options are necessary because often one piece of code changes the scrolling
position, while the scroll bar code is unrelated and won't know that the scroll position changed
without being notified.