Main Page | Packages | Class Tree | Index | Help

xp.events

class MouseWheelEvent

Object
  |
  +--xp.events.Event
        |
        +--xp.events.MouseWheelEvent


class MouseWheelEvent
extends Event

An event broadcast when some action is taken in relation to a cell


Author:
ProWin Computers Ltd. - Rob Edgar

Version:
3.0.0.000

See also:


Field Summary


delta: Number
An optional number indicating how many lines should be scrolled for each notch the user rolls the mouse wheel. A positive delta value indicates an upward scroll; a negative value indicates a downward scroll. Typical values are from 1 to 3; faster scrolling can produce larger values.


scrollTarget: MovieClip
An optional parameter that indicates the topmost movie clip instance under the mouse pointer when the mouse wheel is rolled. If you want to specify a value for scrollTarget but don’t want to specify a value for delta, pass null for delta.

Fields inherited from class xp.events.Event

bubbles, cancel, currentTarget, handled, target, type

Constructor

public
MouseWheelEvent ( delta: Number, scrollTarget: MovieClip)
Constructs a new mouse wheel event



Field Documentation

delta

var delta: Number
An optional number indicating how many lines should be scrolled for each notch the user rolls the mouse wheel. A positive delta value indicates an upward scroll; a negative value indicates a downward scroll. Typical values are from 1 to 3; faster scrolling can produce larger values.

scrollTarget

var scrollTarget: MovieClip
An optional parameter that indicates the topmost movie clip instance under the mouse pointer when the mouse wheel is rolled. If you want to specify a value for scrollTarget but don’t want to specify a value for delta, pass null for delta.


Constructor Documentation

MouseWheelEvent

public function MouseWheelEvent(delta: Number,
 scrollTarget: MovieClip)
Constructs a new mouse wheel event

Parameters:
delta
An optional number indicating how many lines should be scrolled for each notch the user rolls the mouse wheel.
scrollTarget
Indicates the topmost movie clip instance under the mouse

The documentation was generated from the following file:


Generated on 10/30/2005 9:34:02 PM by AS2Doc