Packagemx.events
Classpublic class ScrollEvent
InheritanceScrollEvent Inheritance flash.events.Event

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.

See also

mx.core.UIComponent

Public Properties
 PropertyDefined 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
Public Methods
 MethodDefined By
  
ScrollEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, detail:String = null, position:Number, direction:String = null, delta:Number)
Constructor.
ScrollEvent
Public Constants
 ConstantDefined 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
deltaproperty
public var delta:Number

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

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.

detailproperty 
public var detail:String

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

Provides the details of the scroll activity. Constants for the possible values are provided in the ScrollEventDetail class.

See also

mx.events.ScrollEventDetail
directionproperty 
public var direction:String

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

The direction of motion. The possible values are ScrollEventDirection.VERTICAL or ScrollEventDirection.HORIZONTAL.

See also

mx.events.ScrollEventDirection
positionproperty 
public var position:Number

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

The new scroll position.

Constructor Detail
ScrollEvent()Constructor
public function ScrollEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, detail:String = null, position:Number, direction:String = null, delta:Number)

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

Constructor.

Parameters
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.
Constant Detail
SCROLLConstant
public static const SCROLL:String = scroll

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

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:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe 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.
deltaContains 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.
directionContains the scroll direction, either ScrollEventDirection.HORIZONTAL or ScrollEventDirection.VERTICAL.
positionContains the new scroll position.
targetThe 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.





Mon Dec 24 2012, 01:18 PM +11:00