Package | fl.events |
Class | public class ScrollEvent |
Inheritance | ScrollEvent Event Object |
Language Version: | ActionScript 3.0 |
Product Version: | Flash CS3 |
Runtime Versions: | Flash Player 9.0.28.0, AIR 1.0 |
Related API Elements
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 [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 | ||
eventPhase : uint [read-only]
The current phase in the event flow. | Event | ||
position : Number [read-only]
Gets the current scroll position, in pixels. | ScrollEvent | ||
target : Object [read-only]
The event target. | Event | ||
type : String [read-only]
The type of event. | Event |
Method | Defined By | ||
---|---|---|---|
Creates a new ScrollEvent object with the specified parameters. | ScrollEvent | ||
[override]
Creates a copy of the ScrollEvent object and sets the value of each parameter to
match the original. | ScrollEvent | ||
A utility function for implementing the toString() method in custom
ActionScript 3.0 Event classes. | Event | ||
Indicates whether an object has a specified property defined. | Object | ||
Checks whether the preventDefault() method has been called on the event. | Event | ||
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | ||
Cancels an event's default behavior if that behavior can be canceled. | Event | ||
Indicates whether the specified property exists and is enumerable. | Object | ||
Sets the availability of a dynamic property for loop operations. | Object | ||
Prevents processing of any event listeners in the current node and any subsequent nodes in
the event flow. | Event | ||
Prevents processing of any event listeners in nodes subsequent to the current node in the
event flow. | Event | ||
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | ||
[override]
Returns a string that contains all the properties of the ScrollEvent object. | ScrollEvent | ||
Returns the primitive value of the specified object. | Object |
Constant | Defined By | ||
---|---|---|---|
SCROLL : String = "scroll" [static]
Defines the value of the type property of a scroll
event object. | ScrollEvent |
delta | property |
delta:Number
[read-only] Language Version: | ActionScript 3.0 |
Product Version: | Flash CS3 |
Runtime Versions: | Flash Player 9.0.28.0, AIR 1.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
direction | property |
direction:String
[read-only] Language Version: | ActionScript 3.0 |
Product Version: | Flash CS3 |
Runtime Versions: | Flash Player 9.0.28.0, AIR 1.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
Related API Elements
position | property |
ScrollEvent | () | Constructor |
public function ScrollEvent(direction:String, delta:Number, position:Number)
Language Version: | ActionScript 3.0 |
Product Version: | Flash CS3 |
Runtime Versions: | Flash Player 9.0.28.0, AIR 1.0 |
Creates a new ScrollEvent object with the specified parameters.
Parametersdirection: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.
|
clone | () | method |
override public function clone():Event
Language Version: | ActionScript 3.0 |
Product Version: | Flash CS3 |
Runtime Versions: | Flash Player 9.0.28.0, AIR 1.0 |
Creates a copy of the ScrollEvent object and sets the value of each parameter to match the original.
ReturnsEvent — A new ScrollEvent object with parameter values that match the original.
|
toString | () | method |
override public function toString():String
Language Version: | ActionScript 3.0 |
Product Version: | Flash CS3 |
Runtime Versions: | Flash Player 9.0.28.0, AIR 1.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
]
String — A string representation of the ScrollEvent object.
|
SCROLL | Constant |
public static const SCROLL:String = "scroll"
Language Version: | ActionScript 3.0 |
Product Version: | Flash CS3 |
Runtime Versions: | Flash Player 9.0.28.0, AIR 1.0 |
Defines the value of the type
property of a scroll
event object.
This event has the following properties:
Property | Value |
---|---|
bubbles | false |
cancelable | false ; there is no default
behavior to cancel. |
currentTarget | The object that is actively processing the event object with an event listener. |
delta | 1 ; a value that indicates
how much scrolling was done.
|
direction | vertical ; the direction of the
ScrollBar. |
position | 0 ; the position of the
Scrollbar thumb after it was moved. |
target | The 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 ( How to use this example )
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; } }
Thu Dec 6 2018, 01:12 PM -08:00