net.rim.device.api.lcdui.control
Interface VirtualKeyboardControl

All Superinterfaces:
Control

public interface VirtualKeyboardControl
extends Control

Controls the behaviour of the virtual keyboard, if it exists. This Control provides the same functionality as the virtual keyboard methods in the Screen class.

See Also:
Screen
Since:
BlackBerry API 4.7.0

Field Summary
static int KEYBOARD_HIDE
          Specifies default virtual keyboard visibility properties: hidden when this screen is initially focused or when programmatically set.
static int KEYBOARD_HIDE_FORCE
          Specifies the default virtual keyboard visibility properties: always hidden when this screen is in focus.
static int KEYBOARD_IGNORE
          Specifies the default virtual keyboard visibility properties: always ignored when this screen is in focus, i.e. visibility not cached when this screen loses focus.
static int KEYBOARD_RESTORE
          Specifies the default virtual keyboard visibility properties: the keyboard visibility should always be restored to its previous state when the screen is focus.
static int KEYBOARD_SHOW
          Specifies the default virtual keyboard visibility properties: displayed when this screen is initially focused or when programmatically set.
static int KEYBOARD_SHOW_FORCE
          Specifies the default virtual keyboard visibility properties: always displayed when this screen is in focus.
 
Method Summary
 int getKeyboardVisibility()
          Returns the virtual keyboard visibility properties for when the screen that provided this Control is in focus: hidden, displayed, always hidden, always displayed, ignored or restored.
 void setKeyboardVisibility(int visibility)
          Sets the virtual keyboard visibility properties for when the screen that provided this Control is in focus: hidden, displayed, always hidden, always displayed, ignored, or restored.
 



Field Detail

KEYBOARD_HIDE

static final int KEYBOARD_HIDE
Specifies default virtual keyboard visibility properties: hidden when this screen is initially focused or when programmatically set. See setKeyboardVisibility.

See Also:
Constant Field Values
Since:
BlackBerry API 4.7.0

KEYBOARD_SHOW

static final int KEYBOARD_SHOW
Specifies the default virtual keyboard visibility properties: displayed when this screen is initially focused or when programmatically set. See setKeyboardVisibility.

See Also:
Constant Field Values
Since:
BlackBerry API 4.7.0

KEYBOARD_HIDE_FORCE

static final int KEYBOARD_HIDE_FORCE
Specifies the default virtual keyboard visibility properties: always hidden when this screen is in focus. See setKeyboardVisibility.

See Also:
Constant Field Values
Since:
BlackBerry API 4.7.0

KEYBOARD_SHOW_FORCE

static final int KEYBOARD_SHOW_FORCE
Specifies the default virtual keyboard visibility properties: always displayed when this screen is in focus. See setKeyboardVisibility.

See Also:
Constant Field Values
Since:
BlackBerry API 4.7.0

KEYBOARD_IGNORE

static final int KEYBOARD_IGNORE
Specifies the default virtual keyboard visibility properties: always ignored when this screen is in focus, i.e. visibility not cached when this screen loses focus. See setKeyboardVisibility.

See Also:
Constant Field Values
Since:
BlackBerry API 4.7.0

KEYBOARD_RESTORE

static final int KEYBOARD_RESTORE
Specifies the default virtual keyboard visibility properties: the keyboard visibility should always be restored to its previous state when the screen is focus. See setKeyboardVisibility.

See Also:
Constant Field Values
Since:
BlackBerry API 5.0.0


Method Detail

setKeyboardVisibility

void setKeyboardVisibility(int visibility)
Sets the virtual keyboard visibility properties for when the screen that provided this Control is in focus: hidden, displayed, always hidden, always displayed, ignored, or restored.

Parameters:
visibility - One of VirtualKeyboardControl.KEYBOARD_HIDE, VirtualKeyboardControl.KEYBOARD_SHOW, VirtualKeyboardControl.KEYBOARD_HIDE_FORCE, VirtualKeyboardControl.KEYBOARD_SHOW_FORCE, VirtualKeyboardControl.KEYBOARD_IGNORE and VirtualKeyboardControl.KEYBOARD_RESTORE.
Throws:
IllegalArgumentException - when visibility is not one of the VirtualKeyboardControl constants.
Since:
BlackBerry API 4.7.0

getKeyboardVisibility

int getKeyboardVisibility()
Returns the virtual keyboard visibility properties for when the screen that provided this Control is in focus: hidden, displayed, always hidden, always displayed, ignored or restored.

Returns:
One of VirtualKeyboardControl.KEYBOARD_HIDE, VirtualKeyboardControl.KEYBOARD_SHOW, VirtualKeyboardControl.KEYBOARD_HIDE_FORCE, VirtualKeyboardControl.KEYBOARD_SHOW_FORCE, VirtualKeyboardControl.KEYBOARD_IGNORE and VirtualKeyboardControl.KEYBOARD_RESTORE.
Since:
BlackBerry API 4.7.0





Copyright 1999-2010 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. All Rights Reserved.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark of Sun Microsystems, Inc.