Main Page | Packages | Class Tree | Index | Help
Previous | NextFrames | No Frames
Summary: Field | Property | Contructor | MethodDetail: Field | Property | Contructor | Method
xp.util

class MouseDownRepeater

Object
  |
  +--xp.util.Repeater
        |
        +--xp.util.MouseDownRepeater

class MouseDownRepeater
extends Repeater

An object that repeatedly makes a callback to a target as long as the mouse is down

The repeater can be used to repeatedly call a method of an object passing in params. It will automatically stop when the mouse button is up.


Author:
ProWin Computers Ltd. - Rob Edgar

Version:
3.0.0.000

See also:
support@epresenterplus.com

Constructor

public
MouseDownRepeater ( target: Object, functionName: String, params: Array, delay: Number, repeat: Number, autoStart: Boolean)
Constructs a Repeater

Method Summary

public
onMouseUp ( )
MouseUp event handler

public
start ( ): Boolean
Starts the repeater

public
stop ( ): Boolean
Stops the repeater

Methods inherited from class xp.util.Repeater

onDelay, onRepeat, start, stop


Constructor Documentation

MouseDownRepeater

public function MouseDownRepeater(target: Object,
 functionName: String,
 params: Array,
 delay: Number,
 repeat: Number,
 autoStart: Boolean)
Constructs a Repeater

Parameters:
target
The target object to call
functionName
The function to call on each loop
params
Params to be passed on the call
delay
The intial delay befoer the first event firing
repeat
The timer interval between each loop
autoStart
Controls whether the repeater starts immeditely on creation or requires a manual call to start

Method Documentation

onMouseUp

public function onMouseUp()
MouseUp event handler

Part of the MouseListener interface - stops the repeater.

start

public function start(): Boolean
Starts the repeater

Overrides:
Repeater.start in class Repeater

stop

public function stop(): Boolean
Stops the repeater

Overrides:
Repeater.stop in class Repeater

The documentation was generated from the following file:

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