|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Object | +--net.rim.device.api.system.LED
Contains LED API constants and methods.
| Field Summary | ||
static int |
BRIGHTNESS_100
LED 100% brightness. |
|
static int |
BRIGHTNESS_12
LED 12% brightness. |
|
static int |
BRIGHTNESS_25
LED 25% brightness. |
|
static int |
BRIGHTNESS_50
LED 50% brightness. |
|
static int |
LED_TYPE_STATUS
Status LED |
|
static int |
STATE_AUDIO_SYNC
LED is synchronized to the active audio output. |
|
static int |
STATE_BLINKING
LED is blinking. |
|
static int |
STATE_OFF
LED is off. |
|
static int |
STATE_ON
LED is on solid. |
|
static int |
STATE_PATTERN
LED is in pattern mode. |
|
| Method Summary | ||
static boolean |
isPolychromatic()
Returns true if the status LED is capable of displaying multiple colors. |
|
static boolean |
isPolychromatic(int type)
Returns true if the specified LED is capable of displaying multiple colors. |
|
static void |
setColorConfiguration(int onTime,
int offTime,
int color)
Configures the status LED. |
|
static void |
setColorConfiguration(int type,
int onTime,
int offTime,
int color)
Configures the specified LED. |
|
static void |
setColorPattern(int[] pattern,
boolean repeat)
Configures the status LED to light using the pattern provided. |
|
static void |
setColorPattern(int type,
int[] pattern,
boolean repeat)
Configures the specified LED to light using the pattern provided. |
|
static void |
setConfiguration(int onTime,
int offTime,
int brightness)
Configures the status LED. |
|
static void |
setConfiguration(int type,
int onTime,
int offTime,
int brightness)
Configures the specified LED. |
|
static void |
setState(int state)
Sets the status LED state. |
|
static void |
setState(int type,
int state)
Sets the specified LED state. |
|
| Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
public static final int STATE_AUDIO_SYNC
| Method Detail |
public static boolean isPolychromatic()
public static boolean isPolychromatic(int type)
type - One of the LED_TYPE_ defines.
public static void setConfiguration(int onTime,
int offTime,
int brightness)
If the LED is capable of displaying multiple colors, calling this method will display red at the specified brightness.
onTime - Time in milliseconds the LED should turn on for if blinking.offTime - Time in milliseconds the LED should turn off for if blinking.brightness - One of
BRIGHTNESS_12,
BRIGHTNESS_25,
BRIGHTNESS_50,
BRIGHTNESS_100.
public static void setConfiguration(int type,
int onTime,
int offTime,
int brightness)
If the LED is capable of displaying multiple colors, calling this method will display red at the specified brightness.
type - One of the LED_TYPE_ defines.onTime - Time in milliseconds the LED should turn on for if blinking.offTime - Time in milliseconds the LED should turn off for if blinking.brightness - One of
BRIGHTNESS_12,
BRIGHTNESS_25,
BRIGHTNESS_50,
BRIGHTNESS_100.
public static void setColorConfiguration(int onTime,
int offTime,
int color)
If the LED is not capable of displaying multiple colors, the color parameter
will be ignored, and the LED will display at BRIGHTNESS_25.
onTime - Time in milliseconds the LED should turn on for if blinking.offTime - Time in milliseconds the LED should turn off for if blinking.color - Color to use, of the form 0x00RRGGBB.
public static void setColorConfiguration(int type,
int onTime,
int offTime,
int color)
If the LED is not capable of displaying multiple colors, the color parameter
will be ignored, and the LED will display at BRIGHTNESS_25.
type - One of the LED_TYPE_ defines.onTime - Time in milliseconds the LED should turn on for if blinking.offTime - Time in milliseconds the LED should turn off for if blinking.color - Color to use, of the form 0x00RRGGBB.public static void setState(int state)
state - One of
STATE_ON,
STATE_OFF,
STATE_BLINKING,
STATE_AUDIO_SYNC.
public static void setState(int type,
int state)
type - One of the LED_TYPE_ defines.state - One of
STATE_ON,
STATE_OFF,
STATE_BLINKING,
STATE_AUDIO_SYNC.
public static void setColorPattern(int[] pattern,
boolean repeat)
This method is only supported if the LED is capable of displaying multiple colors.
The LED pattern is an int array consisting of color/duration/transition
tuples. The color is the RGB color (in the form 0x00RRGGBB), the duration is the
duration in milliseconds for this color, and the transition is the time to transistion
to the next color in milliseconds. So, a pattern to make the LED blink red would look
like this:
int[] pattern = { 0x007f0000, 150, 50,
0x00000000, 5850, 50 };
pattern - The LED pattern.repeat - If true, the pattern is repeated continuously. The pattern can be stopped
by calling setState( STATE_OFF ).
public static void setColorPattern(int type,
int[] pattern,
boolean repeat)
This method is only supported if the LED is capable of displaying multiple colors.
The LED pattern is an int array consisting of color/duration/transition
tuples. The color is the RGB color (in the form 0x00RRGGBB), the duration is the
duration in milliseconds for this color, and the transition is the time to transistion
to the next color in milliseconds. So, a pattern to make the LED blink red would look
like this:
int[] pattern = { 0x007f0000, 150, 50,
0x00000000, 5850, 50 };
type - One of the LED_TYPE_ defines.pattern - The LED pattern.repeat - If true, the pattern is repeated continuously. The pattern can be stopped
by calling setState( STATE_OFF ).
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
Copyright 1999-2006 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.