net.rim.device.api.system
Interface TrackwheelListener

All Superinterfaces:
KeypadListener

public interface TrackwheelListener
extends KeypadListener

The listener interface for receiving trackwheel events.


Fields inherited from interface net.rim.device.api.system.KeypadListener
STATUS_ALT, STATUS_ALT_LOCK, STATUS_CAPS_LOCK, STATUS_KEY_HELD_WHILE_ROLLING, STATUS_NOT_FROM_KEYPAD, STATUS_SHIFT, STATUS_SHIFT_LEFT, STATUS_SHIFT_RIGHT
 
Method Summary
 boolean trackwheelClick(int status, int time)
          Invoked when the trackwheel is clicked.
 boolean trackwheelRoll(int amount, int status, int time)
          Invoked when the trackwheel is rolled.
 boolean trackwheelUnclick(int status, int time)
          Invoked when the trackwheel is released
 

Method Detail

trackwheelClick

public boolean trackwheelClick(int status,
                               int time)
Invoked when the trackwheel is clicked.

Parameters:
status - Modifier key status.
time - Ticks since device reset.
Returns:
True if the event was consumed; otherwise, false.
Since:
JDE 4.0.2

trackwheelUnclick

public boolean trackwheelUnclick(int status,
                                 int time)
Invoked when the trackwheel is released
Parameters:
status - Modifier key status.
time - Ticks since device reset.
Returns:
True if the event was consumed; otherwise, false.
Since:
JDE 4.0.2

trackwheelRoll

public boolean trackwheelRoll(int amount,
                              int status,
                              int time)
Invoked when the trackwheel is rolled.

The parameter amount is negative for a upwards roll, and positive for a downwards roll.

Parameters:
status - Modifier key status.
time - Ticks since device reset.
amount - Amount by which the trackwheel has rotated since the last event; negative values indicate an upwards (or backwards) roll, and positive values indicate a downwards (or fowards) roll.
Returns:
True if the event was consumed; otherwise, false.
Since:
JDE 4.0.2


Copyright 1999-2004 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Copyright 1993-2003 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.