Package | mx.events |
Class | public class ScrollEvent |
Inheritance | ScrollEvent flash.events.Event |
See also
Property | Defined by | ||
---|---|---|---|
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 | ||
position : Number
The new scroll position.
| ScrollEvent |
Method | Defined by | ||
---|---|---|---|
ScrollEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, detail:String = null, position:Number, direction:String = null, delta:Number)
Constructor.
| ScrollEvent |
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 |
delta | property |
public var delta:Number
The change in the scroll position value that resulted from the scroll. The value is 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.
detail | property |
public var detail:String
Provides the details of the scroll activity. Constants for the possible values are provided in the ScrollEventDetail class.
See also
direction | property |
public var direction:String
The direction of motion.
The possible values are ScrollEventDirection.VERTICAL
or ScrollEventDirection.HORIZONTAL
.
See also
position | property |
public var position:Number
The new scroll position.
ScrollEvent | () | constructor |
public function ScrollEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, detail:String = null, position:Number, direction:String = null, delta:Number)
Constructor.
Parameterstype: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 — The new scroll position.
|
|
direction:String (default = null ) — The scroll direction,
either ScrollEventDirection.HORIZONTAL or
ScrollEventDirection.VERTICAL .
|
|
delta:Number — The change in scroll position, expressed in pixels.
|
SCROLL | constant |
public static const SCROLL:String = "scroll"
The ScrollEvent.SCROLL
constant defines the value of the
type
property of the event object for a scroll event.
The properties of the event object have the following values:
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. |