SHOW Signed

net.rim.device.api.system
Class Backlight

java.lang.Object
  |
  +--net.rim.device.api.system.Backlight

public final class Backlight
extends Object

Provides access to the device's backlight(s).

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:
JDE 4.0.0

Constructor Summary
 Category: Signed Backlight()
           
 
Method Summary
 Category: Signed static void enable(boolean enable)
          Turns the backlight on or off.
 Category: Signed static void enable(boolean enable, int seconds)
          Turns the backlight on or off.
 Category: Signed static int getBrightness()
          Gets the brightness of the backlight.
 Category: Signed static int getBrightnessDefault()
          Gets the default brightness of the backlight.
 Category: Signed static int getBrightnessIncrement()
          Retrieves the recommended percentage increment for backlight brightness.
 Category: Signed static int getTimeoutDefault()
          Gets the backlight default timeout.
 Category: Signed static boolean isBrightnessConfigurable()
          Determines if the brightness of the backlight is configurable.
 Category: Signed static boolean isEnabled()
          Determines if the backlight is currently enabled.
 Category: Signed static void setBrightness(int brightness)
          Sets the brightness of the backlight.
 Category: Signed static void setTimeout(int seconds)
          Sets the backlight timeout.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Backlight

public Backlight()
Since:
JDE 4.0.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.
Method Detail

enable

public static void enable(boolean enable)
Turns the backlight on or off.
Parameters:
enable - If true, turn the backlight on. The backlight remains on for the duration specified by setTimeout(int). User activity while the backlight is on causes the timer to reset.
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.

enable

public static void enable(boolean enable,
                          int seconds)
Turns the backlight on or off.
Parameters:
enable - If true, turn the backlight on. The backlight remains on for the duration specified. User activity while the backlight is on causes the timer to reset to the value specified in setTimeout(int).
seconds - Number of seconds to leave the backlight on for.
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.

isEnabled

public static boolean isEnabled()
Determines if the backlight is currently enabled.
Returns:
True if the backlight is currently enabled; otherwise, false.
Since:
JDE 4.0.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.

getTimeoutDefault

public static int getTimeoutDefault()
Gets the backlight default timeout.
Parameters:
seconds - Default timeout value (255 seconds is the maximum allowed value).
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.

setTimeout

public static void setTimeout(int seconds)
Sets the backlight timeout.
Parameters:
seconds - Timeout value (255 seconds is the maximum allowed value).
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.

getBrightness

public static int getBrightness()
Gets the brightness of the backlight.
Returns:
Percentage of maximum capable brightness (i.e. a number between 0 and 100).
Since:
JDE 4.0.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.

isBrightnessConfigurable

public static boolean isBrightnessConfigurable()
Determines if the brightness of the backlight is configurable.
Returns:
True if the brightness of the backlight is configurable; otherwise, false.
Since:
JDE 4.0.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.

getBrightnessIncrement

public static int getBrightnessIncrement()
Retrieves the recommended percentage increment for backlight brightness.

Note while the the backlight's brightness is a percentage, the range varies between device types. The increment is rounded down to the nearest integer. For example, if the device range is 7, the increment would be 14

Returns:
An increment between 1 and 100.
Since:
JDE 4.0.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.

getBrightnessDefault

public static int getBrightnessDefault()
Gets the default brightness of the backlight.
Returns:
Percentage of default brightness (i.e. a number between 1 and 100).
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.

setBrightness

public static void setBrightness(int brightness)
Sets the brightness of the backlight.
Parameters:
brightness - Percentage of maximum capable brightness (i.e. a number between 0 and 100).
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.


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.