SHOW Signed SHOW Colour

net.rim.device.api.system
Class Display

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

public final class Display
extends Object

Provides access to the device's display.

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

Field Summary
 Category: Signed static int DISPLAY_PROPERTY_NO_SUBPIXELS
          The display does not contain subpixels.
 Category: Signed static int DISPLAY_PROPERTY_REQUIRES_BACKLIGHT
          The display requires the backlight to be on.
 
Method Summary
 Category: Signed static int getContrast()
          Retrieves the screen's current contrast setting.
 Category: Signed static int getContrastIncrement()
          Retrieves the recommended percentage increment for display contrast.
 Category: Signed static int getHeight()
          Retrieves total drawing height of the display.
 Category: Signed static int getHorizontalResolution()
          Retrieve display's horizontal resolution in pixels per meter (PPM).
 Category: Colour Category: Signed static int getNumColors()
          Retrieve the number of colors that the device's screen can display.
 Category: Signed static int getProperties()
          Retrieve the display properties.
 Category: Signed static int getVerticalResolution()
          Retrieve display's vertical resolution in pixels per meter (PPM).
 Category: Signed static int getWidth()
          Retrieves total drawing width of the display.
 Category: Colour Category: Signed static boolean isColor()
          Determines if the device has a color display.
 Category: Signed static boolean isContrastConfigurable()
          Retrieves whether or not the screen's contrast is configurable.
 Category: Signed static boolean isRowwise()
          Determines if the device's display has rowwise orientation.
 Category: Signed static void setContrast(int contrast)
          Sets the display's current contrast setting.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DISPLAY_PROPERTY_NO_SUBPIXELS

public static final int DISPLAY_PROPERTY_NO_SUBPIXELS
The display does not contain subpixels.
Since:
JDE 4.1.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.

DISPLAY_PROPERTY_REQUIRES_BACKLIGHT

public static final int DISPLAY_PROPERTY_REQUIRES_BACKLIGHT
The display requires the backlight to be on.
Since:
JDE 4.1.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

getContrast

public static int getContrast()
Retrieves the screen's current contrast setting.

Use this method to retrieve the screen's contrast setting. The returned value ranges from 0 (lightest / least) to 100 (darkest / most).

Returns:
Current contrast setting of the screen.
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.

getContrastIncrement

public static int getContrastIncrement()
Retrieves the recommended percentage increment for display contrast.

Externally, we show display contrast as a percentage, but internally the range will vary 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.

getHeight

public static int getHeight()
Retrieves total drawing height of the display.
Returns:
Height in pixels of the display's drawable area.
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.

getHorizontalResolution

public static int getHorizontalResolution()
Retrieve display's horizontal resolution in pixels per meter (PPM).
Returns:
Horizontal resolution (PPM) of the display.
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.

getNumColors

public static int getNumColors()
Retrieve the number of colors that the device's screen can display.
Returns:
Number of colors the screen can display.
Since:
JDE 4.0.0
Category:
Colour: Pertains to devices' ability to display colour. May only be applicable on colour devices.
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.

getProperties

public static int getProperties()
Retrieve the display properties.
Returns:
A combination of the DISPLAY_PROPERTY_* values.
Since:
JDE 4.1.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.

getVerticalResolution

public static int getVerticalResolution()
Retrieve display's vertical resolution in pixels per meter (PPM).
Returns:
Vertical resolution (PPM) of screen.
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.

getWidth

public static int getWidth()
Retrieves total drawing width of the display.
Returns:
Width in pixels of the display's drawable area.
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.

isColor

public static boolean isColor()
Determines if the device has a color display.
Returns:
True if the device has a color display; otherwise, false.
Since:
JDE 4.0.0
Category:
Colour: Pertains to devices' ability to display colour. May only be applicable on colour devices.
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.

isContrastConfigurable

public static boolean isContrastConfigurable()
Retrieves whether or not the screen's contrast is configurable.
Returns:
whether or not the screen's contrast can be set
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.

isRowwise

public static boolean isRowwise()
Determines if the device's display has rowwise orientation.
Returns:
True if the device has a rowwise display; otherwise, false.
Since:
JDE 4.1.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.

setContrast

public static void setContrast(int contrast)
Sets the display's current contrast setting.
Parameters:
contrast - New contrast value for screen.
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.


Copyright 1999-2007 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.