net.rim.blackberry.api.phone.phonegui
Class PhoneScreen

java.lang.Object
  net.rim.device.api.ui.Field
      net.rim.device.api.ui.ScrollView
          net.rim.device.api.ui.Manager
              net.rim.device.api.ui.Screen
                  net.rim.device.api.ui.container.FullScreen
                      net.rim.blackberry.api.phone.phonegui.PhoneScreen

All Implemented Interfaces:

AdjustmentListener

public class PhoneScreen
extends FullScreen

Provides the ability to display information on the incoming and active call screens on a BlackBerry device. Use the ScreenModel class to retrieve incoming and active PhoneScreen objects for each orientation of the device that is available (for example, portrait and landscape if applicable). You can then use the PhoneScreen objects to add UI fields to the call screen and invoke ScreenModel.sendAllDataToScreen() to update the call screens.

See the package overview for more information on how to use this class and add content to a call screen.

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.

Since:

BlackBerry API 5.0.0

Field Summary
	static int	ACTIVECALL Connected call screen.
	static int	INCOMING Incoming call screen.
	static int	LANDSCAPE Landscape orientation.
	static int	MAX_FIELD_COUNT The maximum number of fields you can add to a call screen.
	static int	OUTGOING Outgoing call screen.
	static int	PORTRAIT Portrait orientation.
	static int	WAITING Call Waiting screen.

Fields inherited from class net.rim.device.api.ui.Screen

DEFAULT_CLOSE, DEFAULT_MENU, NO_SYSTEM_MENU_ITEMS

Fields inherited from class net.rim.device.api.ui.Manager

BOTTOMMOST, DOWNWARD, HORIZONTAL_SCROLL, HORIZONTAL_SCROLLBAR, HORIZONTAL_SCROLLBAR_MASK, HORIZONTAL_SCROLL_MASK, LEAVE_BLANK_SPACE, LEFTMOST, LEFTWARD, NO_HORIZONTAL_SCROLL, NO_HORIZONTAL_SCROLLBAR, NO_SCROLL_RESET, NO_VERTICAL_SCROLL, NO_VERTICAL_SCROLLBAR, QUANTA_FONT, RIGHTMOST, RIGHTWARD, TOPMOST, UPWARD, VERTICAL_SCROLL, VERTICAL_SCROLLBAR, VERTICAL_SCROLLBAR_MASK, VERTICAL_SCROLL_MASK

Fields inherited from class net.rim.device.api.ui.Field

ACTION_INVOKE, AXIS_HORIZONTAL, AXIS_SEQUENTIAL, AXIS_VERTICAL, EDITABLE, EDITABLE_MASK, FIELD_BOTTOM, FIELD_HALIGN_MASK, FIELD_HCENTER, FIELD_LEADING, FIELD_LEFT, FIELD_RIGHT, FIELD_TOP, FIELD_TRAILING, FIELD_VALIGN_MASK, FIELD_VCENTER, FOCUSABLE, FOCUSABLE_MASK, HIGHLIGHT_FOCUS, HIGHLIGHT_SELECT, NON_FOCUSABLE, NON_SPELLCHECKABLE, READONLY, SPELLCHECKABLE, SPELLCHECKABLE_MASK, STATUS_MOVE_FOCUS_HORIZONTALLY, STATUS_MOVE_FOCUS_VERTICALLY, USE_ALL_HEIGHT, USE_ALL_WIDTH, VISUAL_STATE_ACTIVE, VISUAL_STATE_DISABLED, VISUAL_STATE_DISABLED_FOCUS, VISUAL_STATE_FOCUS, VISUAL_STATE_NORMAL

Constructor Summary
	PhoneScreen(int callid, Application app) Deprecated. As of BlackBerry API 6.0, replaced by ScreenModel.

Method Summary
	void	add(Field field) Adds a field object.
	int	addImage(Bitmap bitmap) Adds a bitmap object to the field.
	int	addImage(EncodedImage image) Adds an encoded image to the field.
	void	delete(Field field) Deletes a field object.
	void	deleteRange(int start, int count) Deletes a range of field objects.
	Font	getCallerInfoFont() Returns the size of the font on the screen.
	XYRect	getDimensions() Returns the screen dimension.
	static XYRect	getDimensions(int screenType) Deprecated. As of BlackBerry API 6.0, replaced by ScreenModel.getDimensions(int screenType).
	static XYRect	getDimensions(int orientation, int screenType) Deprecated. As of BlackBerry API 6.0, replaced by ScreenModel.getDimensions(int orientation, int screenType).
	Field	getField(int index) Retrieves the field from an index.
	int	getFieldCount() Retrieves the number of fields.
	int	getScreenBackground() Retrieves the background color of the PhoneScreen.
	int	getScreenForeground() Retrieves the foreground color of the PhoneScreen.
	void	insert(Field field, int index) Inserts a field object at a specified index.
	static boolean	isSupported() Deprecated. As of BlackBerry API 6.0, replaced by ScreenModel.isSupported().
	void	replace(Field oldField, Field newField) Replaces a field object.
	void	sendDataToScreen() Deprecated. As of BlackBerry API 6.0, replaced by ScreenModel.sendAllDataToScreen().
	void	setPadding(int top, int right, int bottom, int left) Sets the padding.
	void	setPadding(XYEdges padding) Sets the padding.
	void	setScreenBackground(int rgb) Sets the background colour of the PhoneScreenField.
	void	setScreenForeground(int rgb) Sets the foreground color of the PhoneScreen.

Methods inherited from class net.rim.device.api.ui.container.FullScreen

sublayout

Methods inherited from class net.rim.device.api.ui.Screen

addInputSettings, addKeyListener, addScreenUiEngineAttachedListener, addTrackwheelListener, clearInputSettings, close, doPaint, ensureRegionVisible, getAccessibleContext, getApplication, getContextMenuProvider, getDefaultMenuItem, getDelegate, getFieldAtLocation, getFieldWithFocus, getFieldWithFocusIndex, getFocusRect, getGraphics, getInputHelper, getInputSettings, getLeafFieldWithFocus, getMenu, getScreenAbove, getScreenBelow, getTitleBar, getUiEngine, getVirtualKeyboard, invalidate, invalidate, invalidateAll, invalidateLayout, invokeAction, isDataValid, isDirty, isDisplayed, isFocus, isFocusable, isGlobal, isGlobalStatus, isMuddy, isSelecting, keyChar, keyCharUnhandled, keyControl, keyDown, keyRepeat, keyStatus, keyUp, layoutDelegate, makeMenu, navigationClick, navigationMovement, navigationUnclick, onClose, onDisplay, onExposed, onFocus, onFocusNotify, onMenu, onMenuDismissed, onMenuDismissed, onObscured, onSave, onSavePrompt, onUiEngineAttached, onUndisplay, onUnfocus, openDevelopmentBackdoor, openProductionBackdoor, paint, paintBackground, removeFocus, removeInputSettings, removeKeyListener, removeScreenUiEngineAttachedListener, removeTrackwheelListener, save, scroll, setBackdoorAltStatus, setContextMenuProvider, setDefaultClose, setDirty, setFocus, setFocus, setHorizontalQuantization, setInputHelper, setPositionDelegate, setTitleBar, setTrackballFilter, setTrackballSensitivityXOffset, setTrackballSensitivityYOffset, setVerticalQuantization, touchEvent, trackwheelClick, trackwheelClickUnhandled, trackwheelRoll, trackwheelUnclick, updateDisplay

Methods inherited from class net.rim.device.api.ui.Manager

addAll, deleteAll, getHorizontalScroll, getPreferredHeightOfChild, getPreferredWidthOfChild, getVerticalScroll, getVirtualHeight, getVirtualWidth, insertAll, invalidateFieldRange, isDownArrowShown, isUpArrowShown, isValidLayout, layout, layoutChild, moveFocus, moveFocus, nextFocus, nextFocus, paintChild, setFocus, setPositionChild, setScrollingInertial, setVirtualExtent, subpaint

Methods inherited from class net.rim.device.api.ui.ScrollView

configurationChanged, getHorizontalAdjustment, getVerticalAdjustment, getVisibleHeight, getVisibleWidth, setCurrentLocation, setExtent, setHorizontalAdjustment, setHorizontalScroll, setHorizontalScroll, setScrollListener, setVerticalAdjustment, setVerticalScroll, setVerticalScroll, valueChanged, waitForScrolling

Methods inherited from class net.rim.device.api.ui.Field

drawFocus, drawHighlightRegion, fieldChangeNotify, focusAdd, focusRemove, getBackground, getBackground, getBorder, getBorder, getBorder, getChangeListener, getCommandItemProvider, getContentHeight, getContentLeft, getContentRect, getContentRect, getContentTop, getContentWidth, getContextMenu, getCookie, getExtent, getExtent, getFieldStyle, getFocusListener, getFont, getHeight, getIndex, getLeft, getManager, getMargin, getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getOriginal, getPadding, getPaddingBottom, getPaddingLeft, getPaddingRight, getPaddingTop, getPreferredHeight, getPreferredWidth, getScreen, getStyle, getTop, getVisualState, getWidth, isEditable, isEnabled, isPasteable, isScrollCopyable, isSelectable, isSelectionCopyable, isSelectionCutable, isSelectionDeleteable, isSpellCheckable, isStyle, isVisible, makeContextMenu, onVisibilityChange, paste, select, selectionCopy, selectionCut, selectionDelete, setBackground, setBackground, setBorder, setBorder, setBorder, setBorder, setChangeListener, setCommandItemProvider, setCookie, setEditable, setEnabled, setFocusListener, setFont, setMargin, setMargin, setMuddy, setNonSpellCheckable, setPosition, setVisualState, updateLayout

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PORTRAIT

public static final int PORTRAIT

Portrait orientation.

See Also:

Constant Field Values

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.

Since:

BlackBerry API 5.0.0

LANDSCAPE

public static final int LANDSCAPE

Landscape orientation.

See Also:

Constant Field Values

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.

Since:

BlackBerry API 5.0.0

INCOMING

public static final int INCOMING

Incoming call screen.

See Also:

Constant Field Values

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.

Since:

BlackBerry API 5.0.0

ACTIVECALL

public static final int ACTIVECALL

Connected call screen.

See Also:

Constant Field Values

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.

Since:

BlackBerry API 5.0.0

WAITING

public static final int WAITING

Call Waiting screen.

See Also:

Constant Field Values

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.

Since:

BlackBerry API 5.0.0

OUTGOING

public static final int OUTGOING

Outgoing call screen.

See Also:

Constant Field Values

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.

Since:

BlackBerry API 5.0.0

MAX_FIELD_COUNT

public static final int MAX_FIELD_COUNT

The maximum number of fields you can add to a call screen. Maximum field count is 5.

See Also:

Constant Field Values

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.

Since:

BlackBerry API 5.0.0

Constructor Detail

PhoneScreen

public PhoneScreen(int callid,
                   Application app)

Deprecated. As of BlackBerry API 6.0, replaced by ScreenModel.

Constructor to create PhoneScreen instance. Use ScreenModel instead to initialize a PhoneScreen instance.

Parameters:

callid - The call ID.

app - Instance of the third party application.

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.

Since:

BlackBerry API 5.0.0

Method Detail

addImage

public int addImage(EncodedImage image)

Adds an encoded image to the field.

Parameters:

image - Encoded image to be added.

Returns:

Index of the image in this screen.

Throws:

NullPointerException - if image is null.

RuntimeException - if the number of field exceeds PhoneScreen.MAX_FIELD_COUNT or if the device does not support PhoneScreen objects.

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.

Since:

BlackBerry API 5.0.0

addImage

public int addImage(Bitmap bitmap)

Adds a bitmap object to the field.

Parameters:

bitmap - The bitmap object to be added.

Returns:

Index of the image in this screen.

Throws:

NullPointerException - if bitmap is null.

RuntimeException - if the number of field exceeds PhoneScreen.MAX_FIELD_COUNT or if the device does not support PhoneScreen objects.

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.

Since:

BlackBerry API 5.0.0

add

public void add(Field field)

Adds a field object.

Overrides:

add in class Screen

Parameters:

field - The field object to be added.

Throws:

NullPointerException - if the field is null.

IllegalArgumentException - if the field already has a manager or it is an instance of Screen.

RuntimeException - if the number of field exceeds PhoneScreen.MAX_FIELD_COUNT or if the device does not support PhoneScreen objects.

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.

Since:

BlackBerry API 5.0.0

deleteRange

public void deleteRange(int start,
                        int count)

Deletes a range of field objects.

Overrides:

deleteRange in class Screen

Parameters:

start - The start index.

count - The number of field objects to be deleted.

Throws:

RuntimeException - if Manager is empty or if the device does not support PhoneScreen objects.

IndexOutOfBoundsException - if the start index does not fall into valid range or the range to be deleted exceeds the valid boundary.

IllegalArgumentException - if the count argument is less than 1.

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.

Since:

BlackBerry API 5.0.0

delete

public void delete(Field field)

Deletes a field object.

Overrides:

delete in class Screen

Parameters:

field - The field object to be deleted.

Throws:

NullPointerException - if the field is null.

IllegalArgumentException - if the field does not have a manager or the field's manager is not the current manager instance.

RuntimeException - the device does not support PhoneScreen objects.

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.

Since:

BlackBerry API 5.0.0

replace

public void replace(Field oldField,
                    Field newField)

Replaces a field object.

Overrides:

replace in class Screen

Parameters:

oldField - The field object to be replaced.

newField - The new field object to be added.

Throws:

NullPointerException - if the oldField or newField is null.

IllegalArgumentException - if the new field already has a manager, the old field does not have a manager or the old field's manager is not the current manager instance, or any of the fields are an instance of Screen.

RuntimeException - if the device does not support PhoneScreen objects.

See Also:

Manager.delete(Field), Manager.insert(Field, int), Field.getIndex(), Field.getManager(), Field.setFocus()

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.

Since:

BlackBerry API 5.0.0

insert

public void insert(Field field,
                   int index)

Inserts a field object at a specified index.

Overrides:

insert in class Screen

Parameters:

field - The field object to be inserted.

index - The index where the field object is to be inserted.

Throws:

NullPointerException - if the field is null.

RuntimeException - if the device does not support PhoneScreen objects.

IllegalArgumentException - if the field already has a manager or it is an instance of Screen.

IndexOutOfBoundsException - if index is not in the valid range.

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.

Since:

BlackBerry API 5.0.0

getField

public Field getField(int index)

Retrieves the field from an index.

Overrides:

getField in class Screen

Parameters:

index - Index of the field.

Returns:

Field object at the position specified by the index. Returns null if the device does not support PhoneScreen objects or the index is not in a valid range.

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.

Since:

BlackBerry API 5.0.0

getFieldCount

public int getFieldCount()

Retrieves the number of fields.

Overrides:

getFieldCount in class Screen

Returns:

Number of fields. Returns 0 if the device does not support PhoneScreen objects or if the delegate Manager is empty.

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.

Since:

BlackBerry API 5.0.0

setPadding

public void setPadding(int top,
                       int right,
                       int bottom,
                       int left)

Sets the padding.

Overrides:

setPadding in class Field

Parameters:

top - Top-most padding coordinate.

right - Right-most padding coordinate.

bottom - Bottom-most padding coordinate.

left - Left-most padding coordinate.

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.

Since:

BlackBerry API 5.0.0

setPadding

public void setPadding(XYEdges padding)

Sets the padding.

Overrides:

setPadding in class Field

Parameters:

padding - XYEdges representing the padding.

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.

Since:

BlackBerry API 5.0.0

setScreenBackground

public void setScreenBackground(int rgb)

Sets the background colour of the PhoneScreenField.

To set the background color, the following conditions must be met:

• the device supports PhoneScreen objects
• the rgb is greater than or equal to -1
• the rgb is less than or equal to 0xFFFFFF

Parameters:

rgb - Hexadecimal RGB background (for example, 0xFFFFFF). If you do not specify a background or specify -1, a transparent background is used.

Throws:

ControlledAccessException - if the application does not have permission to display data on the screen when the device is locked.

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.

Since:

BlackBerry API 5.0.0

setScreenForeground

public void setScreenForeground(int rgb)

Sets the foreground color of the PhoneScreen.

To set the foreground color, the following conditions must be met:

• the device supports PhoneScreen objects
• the rgb is greater than or equal to 0
• the rgb is less than or equal to 0xFFFFFF

Parameters:

rgb - Hexadecimal RGB foreground (for example, 0xFFFFFF).

Throws:

ControlledAccessException - if the application does not have permission to display data on the screen when the device is locked.

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.

Since:

BlackBerry API 5.0.0

getScreenForeground

public int getScreenForeground()

Retrieves the foreground color of the PhoneScreen.

Returns:

Hexadecimal RGB value of the foreground color.

Throws:

ControlledAccessException - if the application does not have permission to display data on the screen when the device is locked.

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.

Since:

BlackBerry API 5.0.0

getScreenBackground

public int getScreenBackground()

Retrieves the background color of the PhoneScreen.

Returns:

Hexadecimal RGB value of the background color. -1 represents a transparent background.

Throws:

ControlledAccessException - if the application does not have permission to display data on the screen when the device is locked.

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.

Since:

BlackBerry API 5.0.0

isSupported

public static boolean isSupported()

Deprecated. As of BlackBerry API 6.0, replaced by ScreenModel.isSupported().

Verifies whether the device supports PhoneScreen objects and the application control policies permit the application to display information while the device is locked.

Returns:

true if the device supports drawing on the phone screens and 3rd party applications are allowed to display info while the device is locked, false otherwise.

Throws:

ControlledAccessException - if the application does not have permission to display data on the screen when the device is locked.

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.

Since:

BlackBerry API 5.0.0

sendDataToScreen

public void sendDataToScreen()

Deprecated. As of BlackBerry API 6.0, replaced by ScreenModel.sendAllDataToScreen().

Sends data to the incoming and active call screens. If the device does not support PhoneScreen objects, data is not sent to the device screen.

Throws:

ControlledAccessException - if the application does not have permission to display data on the screen when the device is locked.

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.

Since:

BlackBerry API 5.0.0

getDimensions

public static XYRect getDimensions(int screenType)

Deprecated. As of BlackBerry API 6.0, replaced by ScreenModel.getDimensions(int screenType).

Returns the current screen dimensions.

Parameters:

screenType - Type of screen. Must be an incoming call screen (PhoneScreen.INCOMING or PhoneScreen.WAITING) or an active call screen (PhoneScreen.ACTIVECALL or PhoneScreen.OUTGOING).

Returns:

An XYRect object containing the current dimensions of the phone screen. Returns null if the device does not support PhoneScreen objects. You can check for support by invoking PhoneScreen.isSupported().

Throws:

ControlledAccessException - if the application does not have permission to display data on the screen when the device is locked.

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.

Since:

BlackBerry API 5.0.0

getDimensions

public static XYRect getDimensions(int orientation,
                                   int screenType)

Deprecated. As of BlackBerry API 6.0, replaced by ScreenModel.getDimensions(int orientation, int screenType).

Returns the screen dimensions.

Parameters:

orientation - Orientation of the screen. Must be PhoneScreen.PORTRAIT or PhoneScreen.LANDSCAPE.

screenType - Type of screen. Must be an incoming call screen (PhoneScreen.INCOMING or PhoneScreen.WAITING) or an active call screen (PhoneScreen.ACTIVECALL or PhoneScreen.OUTGOING).

Returns:

An XYRect object containing the current dimensions of the phone screen. Returns null if the device does not support PhoneScreen objects. You can check for support by invoking PhoneScreen.isSupported().

Throws:

ControlledAccessException - if the application does not have permission to display data on the screen when the device is locked.

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.

Since:

BlackBerry API 5.0.0

getCallerInfoFont

public Font getCallerInfoFont()

Returns the size of the font on the screen.

The font size can vary depending on the orientation and screen type. By using ScreenModel.getPhoneScreen() to initialize a PhoneScreen instance, the orientation and screen type information is already defined.

Returns:

A Font object or null if the device does not support PhoneScreen objects. You can check for support by invoking PhoneScreen.isSupported().

Throws:

ControlledAccessException - if the application does not have permission to display data on the screen when the device is locked.

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.

Since:

BlackBerry API 6.0.0

getDimensions

public XYRect getDimensions()

Returns the screen dimension. If a PhoneScreen instance was initialized by ScreenModel.getPhoneScreen(), its orientation and screen type are already defined.

Returns:

An XYRect object of the phone screen or null if the device is not support this API.

Throws:

ControlledAccessException - if the application does not have permission to display data on the screen when the device is locked.

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.

Since:

BlackBerry API 6.0.0