Provides access to the BlackBerry device’s screen properties. You can use this class to access information
such as screen size, dimensions, orientation, backlight, and subpixel support. To configure your
application to only allow specific screen properties, use the various methods available in Ui.
NOTE: A distinction is made between screen orientation and direction.
Orientation refers to the following BlackBerry device screen aspect ratios:
ORIENTATION_PORTRAIT, where the vertical resolution is larger than the horizontal resolution;
ORIENTATION_LANDSCAPE, where the horizontal resolution is larger than the vertical resolution; and
ORIENTATION_SQUARE, where both vertical and horizontal resolution are equal.
To retrieve information on current orientation, invoke getOrientation().
Direction refers to the top of the drawing area of the screen, which is always relative to the location
of the BlackBerry logo. That is:
DIRECTION_NORTH is when the top of the drawable area is the screen side closest to the BlackBerry logo;
DIRECTION_WEST is when the top of the drawable area is to the left of the logo;
DIRECTION_EAST is when the top of the drawable area is to the right of the logo; and
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
JDE 4.0.0
Field Summary
static int
DIRECTION_EAST
A direction the BlackBerry device screen can support.
DIRECTION_NORTH
A supported direction for the BlackBerry device screen where the top of the screen is on the same side as the "BlackBerry" logo at the top of the device
.
static int
DIRECTION_PORTRAIT
A direction the BlackBerry device screen can support.
static int
DIRECTION_WEST
A direction the BlackBerry device screen can support.
ORIENTATION_LANDSCAPE
The aspect ratio of the BlackBerry device's screen in the current direction where the vertical resolution is larger than the horizontal resolution.
static int
ORIENTATION_PORTRAIT
The aspect ratio of the BlackBerry device's screen in the current direction where the horizontal resolution is larger than the vertical resolution.
static int
ORIENTATION_SQUARE
The aspect ratio of the BlackBerry device's screen in the current direction where both the vertical and horizontal resolution are equal.
A direction the BlackBerry device screen can support. To set the allowable directions for your application, pass in specific direction parameters
when invoking UiEngineInstance.setAcceptableDirections(int).
DIRECTION_EAST corresponds to the direction when the top of the screen is 90 degrees to the left of the
"BlackBerry" logo at the top of the BlackBerry device.
Since:
JDE 4.7.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
DIRECTION_LANDSCAPE
public static final int DIRECTION_LANDSCAPE
A direction the BlackBerry device screen can support. To set the allowable directions for your application, pass in specific direction parameters
when invoking UiEngineInstance.setAcceptableDirections(int).
Since:
JDE 4.7.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
DIRECTION_NORTH
public static final int DIRECTION_NORTH
A supported direction for the BlackBerry device screen where the top of the screen is on the same side as the "BlackBerry" logo at the top of the device
. To set the allowable directions for your application, pass in specific direction parameters
when invoking UiEngineInstance.setAcceptableDirections(int).
DIRECTION_NORTH corresponds to the direction when the top of the screen is on the same side as the
"BlackBerry" logo at the top of the BlackBerry device.
Since:
JDE 4.7.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
DIRECTION_PORTRAIT
public static final int DIRECTION_PORTRAIT
A direction the BlackBerry device screen can support. To set the allowable directions for your application, pass in specific direction parameters
when invoking UiEngineInstance.setAcceptableDirections(int).
Since:
JDE 4.7.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
DIRECTION_WEST
public static final int DIRECTION_WEST
A direction the BlackBerry device screen can support. To set the allowable directions for your application, pass in specific direction parameters
when invoking UiEngineInstance.setAcceptableDirections(int).
DIRECTION_WEST corresponds to the direction when the top of the screen is 90 degrees to the right of the
"BlackBerry" logo at the top of the BlackBerry device.
Since:
JDE 4.7.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
DISPLAY_PROPERTY_NO_SUBPIXELS
public static final int DISPLAY_PROPERTY_NO_SUBPIXELS
Sets the BlackBerry device screen to not support subpixels.
Since:
JDE 4.1.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
DISPLAY_PROPERTY_REQUIRES_BACKLIGHT
public static final int DISPLAY_PROPERTY_REQUIRES_BACKLIGHT
Sets the BlackBerry device screen use to use the backlight.
Since:
JDE 4.1.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
ORIENTATION_LANDSCAPE
public static final int ORIENTATION_LANDSCAPE
The aspect ratio of the BlackBerry device's screen in the current direction where the vertical resolution is larger than the horizontal resolution.
getOrientation() returns this value if invoked when the BlackBerry device screen horizontal resolution is larger than the vertical
resolution.
Since:
JDE 4.7.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
ORIENTATION_PORTRAIT
public static final int ORIENTATION_PORTRAIT
The aspect ratio of the BlackBerry device's screen in the current direction where the horizontal resolution is larger than the vertical resolution.
getOrientation() returns this value if invoked when the BlackBerry device screen vertical resolution is larger than the horizontal
resolution.
Since:
JDE 4.7.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
ORIENTATION_SQUARE
public static final int ORIENTATION_SQUARE
The aspect ratio of the BlackBerry device's screen in the current direction where both the vertical and horizontal resolution are equal.
getOrientation() returns this value if invoked when the BlackBerry device screen resolution is the same vertically and horizontally.
Since:
JDE 4.7.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Method Detail
getContrast
public static int getContrast()
Deprecated.
Retrieves the screen's current contrast setting.
Use this method to retrieve the screen's contrast setting. The
returned value ranges from 0 (lightest) to 100 (darkest).
Returns:
Current screen contrast setting.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
getContrastIncrement
public static int getContrastIncrement()
Deprecated.
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 value between 1 and 100.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
getHeight
public static int getHeight()
Retrieves the 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 applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
getHorizontalResolution
public static int getHorizontalResolution()
Retrieves the display's horizontal resolution (in pixels per meter, or PPM).
Returns:
Horizontal display resolution (in pixels per meter, or PPM) of the display.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
getNumColors
public static int getNumColors()
Retrieves the number of colors that the BlackBerry device screen can display.
Returns:
Number of colors the BlackBerry device 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 applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
getOrientation
public static int getOrientation()
Retrieves the graphic aspect ratio of the BlackBerry device screen based on number
of horizontal versus vertical pixels.
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
getProperties
public static int getProperties()
Retrieves 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 applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
getVerticalResolution
public static int getVerticalResolution()
Retrieves the display's vertical resolution (in pixels per meter, or PPM).
Returns:
Vertical screen resolution (in pixels per meter, or PPM).
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
getWidth
public static int getWidth()
Retrieves the 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 applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
isColor
public static boolean isColor()
Determines if the BlackBerry device has a color display.
Returns:
true if the BlackBerry device has a color display; false otherwise.
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 applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
isContrastConfigurable
public static boolean isContrastConfigurable()
Deprecated.
Retrieves whether or not the BlackBerry device's screen contrast is configurable.
Returns:
true if the BlackBerry device's screen contrast can be set; false otherwise.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
isRowwise
public static boolean isRowwise()
Determines if the BlackBerry device's display has Rowwise orientation.
Returns:
true if the BlackBerry device's display has a Rowwise orientation; false otherwise.
Since:
JDE 4.1.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Takes a screenshot of the entire screen and saves it into a Bitmap.
The specified Bitmap must be the same dimensions as the screen. The value that represents
the width and height of the screen can be obtained from getWidth() and getHeight(),
respectively. The width and height of the Bitmap must be equal to this value.
The type of the specified Bitmap must match the screen type. The following
methods can be used to determine the screen's properties:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
screenshot
public static void screenshot(Bitmap bitmap,
int x,
int y,
int width,
int height)
Takes a screenshot of a portion of the screen and saves it into a Bitmap.
The dimensions of the specified Bitmap must be large enough to hold the specified
region; that is, the width and height of bitmap must be at least the specified
width and height, respectively.
The specified region (the box represented by x, y,
width, and height) must be fully contained in the screen.
This region is copied into the specified Bitmap starting at (0, 0).
The type of the specified Bitmap must match the type of the screen. The following
methods can be used to determine the screen's properties:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
setContrast
public static void setContrast(int contrast)
Deprecated.
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 applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Copyright 1999-2009 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.