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.

Since:
JDE 4.7.0
See Also:
Screen

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_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, or ignored.
 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, or ignored.
 

Field Detail

KEYBOARD_HIDE

public static final int KEYBOARD_HIDE
Specifies default virtual keyboard visibility properties: hidden when this screen is initially focused or when programmatically set. See #setVisibility.
Since:
JDE 4.7.0

KEYBOARD_HIDE_FORCE

public static final int KEYBOARD_HIDE_FORCE
Specifies the default virtual keyboard visibility properties: always hidden when this screen is in focus. See #setVisibility.
Since:
JDE 4.7.0

KEYBOARD_IGNORE

public 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 VirtualKeyboard#setVisibility.
Since:
JDE 4.7.0

KEYBOARD_SHOW

public static final int KEYBOARD_SHOW
Specifies the default virtual keyboard visibility properties: displayed when this screen is initially focused or when programmatically set. See #setVisibility.
Since:
JDE 4.7.0

KEYBOARD_SHOW_FORCE

public static final int KEYBOARD_SHOW_FORCE
Specifies the default virtual keyboard visibility properties: always displayed when this screen is in focus. See #setVisibility.
Since:
JDE 4.7.0
Method Detail

getKeyboardVisibility

public 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, or ignored.
Returns:
One of #HIDE, #SHOW, #HIDE_FORCE, #SHOW_FORCE, #IGNORE.
Since:
JDE 4.7.0

setKeyboardVisibility

public 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, or ignored.
Parameters:
visibility - One of #HIDE, #SHOW, #HIDE_FORCE, #SHOW_FORCE, #IGNORE.
Since:
JDE 4.7.0



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.