SHOW Signed

net.rim.device.api.system
Class EventInjector.TrackwheelEvent

java.lang.Object
  |
  +--net.rim.device.api.system.EventInjector.Event
        |
        +--net.rim.device.api.system.EventInjector.TrackwheelEvent
Enclosing class:
EventInjector

public static class EventInjector.TrackwheelEvent
extends EventInjector.Event

The event class that defines a Trackwheel event.

Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

Since:
3.6
See Also:
EventInjector, EventInjector.KeyEvent

Field Summary
 Category: Signed static int THUMB_CLICK
          A constant representing a track wheel thumb click.
 Category: Signed static int THUMB_ROLL_DOWN
          A constant representing a track wheel thumb click.
 Category: Signed static int THUMB_ROLL_UP
          A constant representing a track wheel roll up.
 Category: Signed static int THUMB_UNCLICK
          A constant representing a track wheel thumb click released.
   
Constructor Summary
 Category: Signed EventInjector.TrackwheelEvent(int event, int amount, int status)
          Constructs a new TrackwheelEvent instance.
 
Method Summary
 Category: Signed  int getAmount()
          Returns the number of lines to roll before the event will occur.
 Category: Signed  void setAmount(int amount)
          Sets the amount to roll for the event to occur.
 
Methods inherited from class net.rim.device.api.system.EventInjector.Event
getEvent, getStatus, post, setEvent, setStatus
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

THUMB_CLICK

public static final int THUMB_CLICK
A constant representing a track wheel thumb click.
Since:
JDE 3.6.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

THUMB_UNCLICK

public static final int THUMB_UNCLICK
A constant representing a track wheel thumb click released.
Since:
JDE 3.6.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

THUMB_ROLL_UP

public static final int THUMB_ROLL_UP
A constant representing a track wheel roll up.
Since:
JDE 3.6.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

THUMB_ROLL_DOWN

public static final int THUMB_ROLL_DOWN
A constant representing a track wheel thumb click.
Since:
JDE 3.6.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.
Constructor Detail

EventInjector.TrackwheelEvent

public EventInjector.TrackwheelEvent(int event,
                                     int amount,
                                     int status)
Constructs a new TrackwheelEvent instance.

Parameters:
event - One of THUMB_CLICK, THUMB_UNCLICK, THUMB_ROLL_UP or THUMB_ROLL_DOWN.
amount - The amount by which to roll, a value of '1' indicates one 'line'.
status - Any status flags (as defined by KeypadListener).
Since:
JDE 3.6.0
See Also:
Characters
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.
Method Detail

setAmount

public void setAmount(int amount)
Sets the amount to roll for the event to occur.

Parameters:
amount - The number of lines to roll.
Since:
JDE 4.0.2
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

getAmount

public int getAmount()
Returns the number of lines to roll before the event will occur.

Returns:
The number of lines to roll.
Since:
JDE 3.6.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.


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.