VirtualKeyboard (Codename One API)

java.lang.Object
- com.codename1.ui.Component
- - com.codename1.ui.Container
  - - com.codename1.ui.Form
    - - com.codename1.ui.Dialog
      - com.codename1.ui.VirtualKeyboard

All Implemented Interfaces:

com.codename1.impl.VirtualKeyboardInterface, Animation, StyleListener, Iterable<Component>

Deprecated.
this is a part of legacy code, modern devices have the virtual keyboard bound to the native text field
```
public class VirtualKeyboard
extends Dialog
implements com.codename1.impl.VirtualKeyboardInterface
```
This class represent the Codename One Light Weight Virtual Keyboard

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CHANGE_MODE` Deprecated.
`static String[][]`	`DEFAULT_NUMBERS` Deprecated. This keymap represents numbers keyboard
`static String[][]`	`DEFAULT_NUMBERS_SYMBOLS` Deprecated. This keymap represents numbers and symbols keyboard
`static String[][]`	`DEFAULT_QWERTY` Deprecated. This keymap represents qwerty keyboard
`static String[][]`	`DEFAULT_SYMBOLS` Deprecated. This keymap represents symbols keyboard
`static int`	`DELETE_CHAR` Deprecated.
`static int`	`INSERT_CHAR` Deprecated.
`static String`	`NAME` Deprecated.
`static String`	`NUMBERS_MODE` Deprecated. The String that represent the numbers mode.
`static String`	`NUMBERS_SYMBOLS_MODE` Deprecated. The String that represent the numbers sybols mode.
`static int`	`OK` Deprecated.
`static String`	`QWERTY_MODE` Deprecated. The String that represent the qwerty mode.
`static int`	`SHIFT` Deprecated.
`static int`	`SPACE` Deprecated.
`static String`	`SYMBOLS_MODE` Deprecated. The String that represent the symbols mode.
`static int`	`T9` Deprecated.

Fields inherited from class com.codename1.ui.Dialog
TYPE_ALARM, TYPE_CONFIRMATION, TYPE_ERROR, TYPE_INFO, TYPE_NONE, TYPE_WARNING

Fields inherited from class com.codename1.ui.Form
focusScrolling

Constructor Summary

Constructors
Constructor and Description

VirtualKeyboard()
Deprecated.

Creates a new instance of VirtualKeyboard

Constructors
Constructor and Description
`VirtualKeyboard()` Deprecated. Creates a new instance of VirtualKeyboard

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`protected void`	`actionCommand(Command cmd)` Deprecated. Invoked to allow subclasses of form to handle a command from one point rather than implementing many command instances
`static void`	`addDefaultInputMode(String mode, String[][] inputChars)` Deprecated. Add an input mode to the virtual keyboard
`void`	`addInputMode(String mode, String[][] inputChars)` Deprecated. Add an input mode to the virtual keyboard
`void`	`addSpecialButton(String key, Command cmd)` Deprecated. This method adds a special button to the virtual keyboard
`void`	`addSpecialButton(String key, Command cmd, int space)` Deprecated. This method adds a special button to the virtual keyboard
`protected void`	`autoAdjust(int w, int h)` Deprecated. Auto adjust size of the dialog.
`static void`	`bindVirtualKeyboard(TextArea t, VirtualKeyboard vkb)` Deprecated. This method is used to bind a specific instance of a virtual keyboard to a specific TextField.
`void`	`dispose()` Deprecated. Closes the current form and returns to the previous form, releasing the EDT in the process
`protected String`	`getCurrentMode()` Deprecated. Gets the current mode.
`static String[]`	`getDefaultInputModeOrder()` Deprecated. Returns the order in which input modes are toggled by default
`protected TextField`	`getInputField()` Deprecated. This method returns the Virtual Keyboard TextField.
`String[]`	`getInputModeOrder()` Deprecated. Returns the order in which input modes are toggled
`static Transition`	`getTransitionIn()` Deprecated. The transition in for the VKB
`static Transition`	`getTransitionOut()` Deprecated. The transition out for the VKB
`static VirtualKeyboard`	`getVirtualKeyboard(TextArea t)` Deprecated. This method returns the Textfield associated VirtualKeyboard, see bindVirtualKeyboard(TextField tf, VirtualKeyboard vkb) method.
`String`	`getVirtualKeyboardName()` Deprecated. Returns the Virtual Keyboard name.
`static int`	`getVKBTint(TextArea tf)` Deprecated. The tint color for the virtual keyboard when shown on top of this text field see the form tint methods for more information
`protected void`	`initModes()` Deprecated. init all virtual keyboard modes, such as QWERTY_MODE, NUMBERS_SYMBOLS_MODE...
`protected void`	`initSpecialButtons()` Deprecated. This method initialize all the virtual keyboard special buttons.
`static boolean`	`isCommitOnDispose(TextArea tf)` Deprecated. Indicates whether the given text field should commit on dispose
`static boolean`	`isShowTooltips()` Deprecated. Indicates whether tooltips should be shown when the keys in the VKB are pressed
`boolean`	`isVirtualKeyboardShowing()` Deprecated. Indicates if the Virtual Keyboard is currently showing.
`protected void`	`onShow()` Deprecated. Allows subclasses to bind functionality that occurs when a specific form or dialog appears on the screen
`void`	`pointerDragged(int x, int y)` Deprecated. If this Component is focused, the pointer dragged event will call this method
`void`	`pointerPressed(int x, int y)` Deprecated. If this Component is focused, the pointer pressed event will call this method
`void`	`pointerReleased(int x, int y)` Deprecated. If this Component is focused, the pointer released event will call this method
`static void`	`setCommitOnDispose(TextField tf, boolean b)` Deprecated. Indicates whether the VKB should commit changes to the text field when the VKB is closed not via the OK button.
`protected void`	`setCurrentMode(String mode)` Deprecated. Sets the current virtual keyboard mode.
`static void`	`setDefaultInputModeOrder(String[] order)` Deprecated. Sets the order in which input modes are toggled by default and allows disabling/hiding an input mode
`static void`	`setDefaultVirtualKeyboardClass(Class vkbClazz)` Deprecated. Sets the default virtual keyboard class for the com.codename1.ui.VirtualKeyboard type This class is used as the default virtual keyboard class if the current platform VirtualKeyboard is com.codename1.ui.VirtualKeyboard.
`void`	`setInputModeOrder(String[] order)` Deprecated. Sets the order in which input modes are toggled and allows disabling/hiding an input mode
`void`	`setInputType(int inputType)` Deprecated. This can be used to indicate to the VirtualKeyboard what type of input to display.
`static void`	`setShowTooltips(boolean aShowTooltips)` Deprecated. Indicates whether tooltips should be shown when the keys in the VKB are pressed
`void`	`setTextField(TextArea field)` Deprecated. Invoked internally by the implementation to indicate the text field that will be edited by the virtual keyboard
`static void`	`setTransitionIn(Transition aTransitionIn)` Deprecated. The transition in for the VKB
`static void`	`setTransitionOut(Transition aTransitionOut)` Deprecated. The transition out for the VKB
`static void`	`setVKBTint(TextField tf, int tint)` Deprecated. Sets the tint color for the virtual keyboard when shown on top of this text field see the form tint methods for more information
`void`	`show()` Deprecated. The default version of show modal shows the dialog occupying the center portion of the screen.
`void`	`showKeyboard(boolean show)` Deprecated. Shows the virtual keyboard that is assoiciated with the displayed TextField or displays the default virtual keyboard.

Methods inherited from class com.codename1.ui.Dialog
addComponent, addComponent, addComponent, addComponent, animate, getBlurBackgroundRadius, getContentPane, getDefaultBlurBackgroundRadius, getDefaultDialogPosition, getDefaultDialogType, getDialogComponent, getDialogPosition, getDialogPreferredSize, getDialogStyle, getDialogType, getDialogUIID, getLayout, getPopupDirectionBiasPortrait, getTitle, getTitleComponent, getTitleStyle, growOrShrink, initGlobalToolbar, initLaf, isAutoAdjustDialogSize, isAutoDispose, isCommandsAsButtons, isDisableStaticDialogScrolling, isDisposeWhenPointerOutOfBounds, keyReleased, placeButtonCommands, removeAll, removeComponent, setAutoAdjustDialogSize, setAutoDispose, setBlurBackgroundRadius, setCommandsAsButtons, setDefaultBlurBackgroundRadius, setDefaultDialogPosition, setDefaultDialogType, setDialogPosition, setDialogStyle, setDialogType, setDialogUIID, setDisableStaticDialogScrolling, setDisposeWhenPointerOutOfBounds, setLayout, setPopupDirectionBiasPortrait, setScrollable, setTimeout, setTitle, setTitleComponent, setTitleComponent, show, show, show, show, show, show, show, show, show, show, show, show, show, show, show, showAtPosition, showBack, showDialog, showModeless, showPacked, showPopupDialog, showPopupDialog, showStetched, showStretched, wasDisposedDueToOutOfBoundsTouch, wasDisposedDueToRotation

Methods inherited from class com.codename1.ui.Form
addCommand, addCommand, addCommandListener, addGameKeyListener, addKeyListener, addOrientationListener, addShowListener, addSizeChangedListener, createStatusBar, deregisterAnimated, dispatchCommand, findNextFocusHorizontal, findNextFocusVertical, getAnimationManager, getBackCommand, getClearCommand, getCommand, getCommandCount, getComponentForm, getComponentIndex, getDefaultCommand, getDragRegionStatus, getEditOnShow, getFocused, getFormLayeredPane, getGlassPane, getInvisibleAreaUnderVKB, getLayeredPane, getLayeredPane, getMenuBar, getMenuStyle, getPropertyNames, getPropertyTypeNames, getPropertyTypes, getPropertyValue, getScrollAnimationSpeed, getSoftButton, getSoftButtonCount, getTintColor, getTitleArea, getToolbar, getTransitionInAnimator, getTransitionOutAnimator, getUIManager, grabAnimationLock, hasMedia, hideNotify, isAlwaysTensile, isCyclicFocus, isDragRegion, isEnableCursors, isFocusScrolling, isFormBottomPaddingEditingMode, isMinimizeOnBack, isScrollable, isScrollableX, isScrollableY, isScrollVisible, isSingleFocusMode, isSmoothScrolling, keyPressed, keyRepeated, longKeyPress, longPointerPress, onShowCompleted, paint, paintBackground, paramString, pointerDragged, pointerHover, pointerHoverPressed, pointerHoverReleased, refreshTheme, registerAnimated, releaseAnimationLock, removeAllCommands, removeAllShowListeners, removeCommand, removeCommandListener, removeGameKeyListener, removeKeyListener, removeOrientationListener, removeShowListener, removeSizeChangedListener, replace, replaceAndWait, scrollComponentToVisible, setAlwaysTensile, setBackCommand, setBackCommand, setBgImage, setClearCommand, setCyclicFocus, setDefaultCommand, setEditOnShow, setEnableCursors, setFocused, setFocusScrolling, setFormBottomPaddingEditingMode, setGlassPane, setMenuBar, setMenuCellRenderer, setMenuTransitions, setMinimizeOnBack, setPropertyValue, setRTL, setScrollableX, setScrollableY, setScrollAnimationSpeed, setScrollVisible, setSmoothScrolling, setTintColor, setTitleStyle, setToolbar, setToolBar, setTransitionInAnimator, setTransitionOutAnimator, setUIManager, setVisible, shouldPaintStatusBar, shouldSendPointerReleaseToOtherForm, showNotify, sizeChanged

Methods inherited from class com.codename1.ui.Container
add, add, add, add, add, add, addAll, animateHierarchy, animateHierarchyAndWait, animateHierarchyFade, animateHierarchyFadeAndWait, animateLayout, animateLayoutAndWait, animateLayoutFade, animateLayoutFadeAndWait, animateUnlayout, animateUnlayoutAndWait, applyRTL, calcPreferredSize, cancelRepaints, clearClientProperties, contains, createAnimateHierarchy, createAnimateHierarchyFade, createAnimateLayout, createAnimateLayoutFade, createAnimateLayoutFadeAndWait, createAnimateMotion, createAnimateUnlayout, createReplaceTransition, dragInitiated, drop, encloseIn, encloseIn, findDropTargetAt, findFirstFocusable, fireClicked, flushReplace, forceRevalidate, getBottomGap, getClosestComponentTo, getComponentAt, getComponentAt, getComponentCount, getGridPosX, getGridPosY, getLayoutHeight, getLayoutWidth, getLeadComponent, getLeadParent, getScrollIncrement, getSideGap, invalidate, isEnabled, isSelectableInteraction, iterator, layoutContainer, morph, morphAndWait, paintComponentBackground, paintGlass, replace, replaceAndWait, replaceAndWait, revalidate, setCellRenderer, setEnabled, setLeadComponent, setScrollIncrement, setShouldCalcPreferredSize, setShouldLayout

Methods inherited from class com.codename1.ui.Component
addDragOverListener, addDropListener, addFocusListener, addPointerDraggedListener, addPointerPressedListener, addPointerReleasedListener, addPullToRefresh, addScrollListener, bindProperty, calcScrollSize, contains, createStyleAnimation, deinitialize, deinitializeCustomStyle, dragEnter, dragExit, dragFinished, draggingOver, drawDraggedImage, focusGained, focusLost, getAbsoluteX, getAbsoluteY, getAllStyles, getBaseline, getBaselineResizeBehavior, getBindablePropertyNames, getBindablePropertyTypes, getBorder, getBoundPropertyValue, getBounds, getClientProperty, getCloudBoundProperty, getCloudDestinationProperty, getComponentState, getCursor, getDirtyRegion, getDisabledStyle, getDraggedx, getDraggedy, getDragImage, getDragSpeed, getHeight, getInnerHeight, getInnerPreferredH, getInnerPreferredW, getInnerWidth, getInnerX, getInnerY, getLabelForComponent, getName, getNextFocusDown, getNextFocusLeft, getNextFocusRight, getNextFocusUp, getOuterHeight, getOuterPreferredH, getOuterPreferredW, getOuterWidth, getOuterX, getOuterY, getParent, getPreferredH, getPreferredSize, getPreferredW, getPressedStyle, getSameHeight, getSameWidth, getScrollable, getScrollDimension, getScrollOpacity, getScrollOpacityChangeSpeed, getScrollX, getScrollY, getSelectCommandText, getSelectedRect, getSelectedStyle, getStyle, getTensileLength, getUIID, getUnselectedStyle, getVisibleBounds, getWidth, getX, getY, growShrink, handlesInput, hasFocus, initComponent, initCustomStyle, installDefaultPainter, isBlockLead, isCellRenderer, isDragActivated, isDragAndDropOperation, isDraggable, isDropTarget, isFlatten, isFocusable, isGrabsPointerEvents, isHidden, isHideInPortrait, isIgnorePointerEvents, isInClippingRegion, isInitialized, isRippleEffect, isRTL, isSetCursorSupported, isSnapToGrid, isStickyDrag, isTactileTouch, isTactileTouch, isTensileDragEnabled, isVisible, laidOut, onScrollX, onScrollY, paintBackgrounds, paintBorder, paintBorderBackground, paintComponent, paintComponent, paintLock, paintLockRelease, paintRippleOverlay, paintScrollbars, paintScrollbarX, paintScrollbarY, pinch, pointerPressed, pointerReleased, putClientProperty, refreshTheme, refreshTheme, remove, removeDragOverListener, removeDropListener, removeFocusListener, removePointerDraggedListener, removePointerPressedListener, removePointerReleasedListener, removeScrollListener, repaint, repaint, requestFocus, resetFocusable, scrollRectToVisible, scrollRectToVisible, setBlockLead, setBoundPropertyValue, setCloudBoundProperty, setCloudDestinationProperty, setComponentState, setCursor, setDirtyRegion, setDisabledStyle, setDraggable, setDropTarget, setFlatten, setFocus, setFocusable, setGrabsPointerEvents, setHandlesInput, setHeight, setHidden, setHidden, setHideInPortrait, setIgnorePointerEvents, setInitialized, setIsScrollVisible, setLabelForComponent, setName, setNextFocusDown, setNextFocusLeft, setNextFocusRight, setNextFocusUp, setPreferredH, setPreferredSize, setPreferredW, setPressedStyle, setRippleEffect, setSameHeight, setSameSize, setSameWidth, setScrollOpacityChangeSpeed, setScrollSize, setScrollX, setScrollY, setSelectCommandText, setSelectedStyle, setSize, setSnapToGrid, setTactileTouch, setTensileDragEnabled, setTensileLength, setUIID, setUnselectedStyle, setWidth, setX, setY, shouldBlockSideSwipe, styleChanged, toString, unbindProperty, visibleBoundsContains

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - DEFAULT_QWERTY
```
public static final String[][] DEFAULT_QWERTY
```
    Deprecated.
    
    This keymap represents qwerty keyboard
  - DEFAULT_NUMBERS
```
public static final String[][] DEFAULT_NUMBERS
```
    Deprecated.
    
    This keymap represents numbers keyboard
  - DEFAULT_NUMBERS_SYMBOLS
```
public static final String[][] DEFAULT_NUMBERS_SYMBOLS
```
    Deprecated.
    
    This keymap represents numbers and symbols keyboard
  - DEFAULT_SYMBOLS
```
public static final String[][] DEFAULT_SYMBOLS
```
    Deprecated.
    
    This keymap represents symbols keyboard
  - QWERTY_MODE
```
public static final String QWERTY_MODE
```
    Deprecated.
    
    The String that represent the qwerty mode.
    
    See Also:
    
    Constant Field Values
  - NUMBERS_MODE
```
public static final String NUMBERS_MODE
```
    Deprecated.
    
    The String that represent the numbers mode.
    
    See Also:
    
    Constant Field Values
  - NUMBERS_SYMBOLS_MODE
```
public static final String NUMBERS_SYMBOLS_MODE
```
    Deprecated.
    
    The String that represent the numbers sybols mode.
    
    See Also:
    
    Constant Field Values
  - SYMBOLS_MODE
```
public static final String SYMBOLS_MODE
```
    Deprecated.
    
    The String that represent the symbols mode.
    
    See Also:
    
    Constant Field Values
  - INSERT_CHAR
```
public static final int INSERT_CHAR
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - DELETE_CHAR
```
public static final int DELETE_CHAR
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - CHANGE_MODE
```
public static final int CHANGE_MODE
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - SHIFT
```
public static final int SHIFT
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - OK
```
public static final int OK
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - SPACE
```
public static final int SPACE
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - T9
```
public static final int T9
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - NAME
```
public static final String NAME
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - VirtualKeyboard
```
public VirtualKeyboard()
```
    Deprecated.
    
    Creates a new instance of VirtualKeyboard
- Method Detail
  - setInputType
```
public void setInputType(int inputType)
```
    Deprecated.
    
    Description copied from interface: com.codename1.impl.VirtualKeyboardInterface
    
    This can be used to indicate to the VirtualKeyboard what type of input to display.
    
    Specified by:
    
    setInputType in interface com.codename1.impl.VirtualKeyboardInterface
  - setTextField
```
public void setTextField(TextArea field)
```
    Deprecated.
    
    Invoked internally by the implementation to indicate the text field that will be edited by the virtual keyboard
    
    Parameters:
    
    field - the text field instance
  - show
```
public void show()
```
    Deprecated.
    
    The default version of show modal shows the dialog occupying the center portion of the screen.
    
    Overrides:
    
    show in class Dialog
  - autoAdjust
```
protected void autoAdjust(int w,
                          int h)
```
    Deprecated.
    
    Auto adjust size of the dialog. This method is triggered from a sizeChanged event.
    
    Overrides:
    
    autoAdjust in class Dialog
    
    Parameters:
    
    w - width of the screen
    
    h - height of the screen
  - initModes
```
protected void initModes()
```
    Deprecated.
    
    init all virtual keyboard modes, such as QWERTY_MODE, NUMBERS_SYMBOLS_MODE... to add an addtitional mode a developer needs to override this method and add a mode by calling addInputMode method
  - setCurrentMode
```
protected void setCurrentMode(String mode)
```
    Deprecated.
    
    Sets the current virtual keyboard mode.
    
    Parameters:
    
    mode - the String that represents the mode(QWERTY_MODE, SYMBOLS_MODE, ...)
  - getCurrentMode
```
protected String getCurrentMode()
```
    Deprecated.
    
    Gets the current mode.
    
    Returns:
    
    the String that represents the current mode(QWERTY_MODE, SYMBOLS_MODE, ...)
  - addDefaultInputMode
```
public static void addDefaultInputMode(String mode,
                                       String[][] inputChars)
```
    Deprecated.
    
    Add an input mode to the virtual keyboard
    
    Parameters:
    
    mode - a string that represents the identifier of the mode
    
    inputChars - 2 dimensional String array that contains buttons String and special buttons (a special button is identified with $...$ marks e.g: "$Space$")
  - addInputMode
```
public void addInputMode(String mode,
                         String[][] inputChars)
```
    Deprecated.
    
    Add an input mode to the virtual keyboard
    
    Parameters:
    
    mode - a string that represents the identifier of the mode
    
    inputChars - 2 dimentional String array that contains buttons String and special buttons (a special button is identified with $...$ marks e.g: "$Space$")
  - addSpecialButton
```
public void addSpecialButton(String key,
                             Command cmd)
```
    Deprecated.
    
    This method adds a special button to the virtual keyboard
    
    Parameters:
    
    key - the string identifier from within the relevant input mode
    
    cmd - the Command to invoke when this button is invoked.
  - addSpecialButton
```
public void addSpecialButton(String key,
                             Command cmd,
                             int space)
```
    Deprecated.
    
    This method adds a special button to the virtual keyboard
    
    Parameters:
    
    key - the string identifier from within the relevant input mode
    
    cmd - the Command to invoke when this button is invoked.
    
    space - how much space in percentage from the overall row the special button should occupy
  - pointerPressed
```
public void pointerPressed(int x,
                           int y)
```
    Deprecated.
    
    If this Component is focused, the pointer pressed event will call this method
    
    Overrides:
    
    pointerPressed in class Dialog
    
    Parameters:
    
    x - the pointer x coordinate
    
    y - the pointer y coordinate
  - pointerDragged
```
public void pointerDragged(int x,
                           int y)
```
    Deprecated.
    
    If this Component is focused, the pointer dragged event will call this method
    
    Overrides:
    
    pointerDragged in class Form
    
    Parameters:
    
    x - the pointer x coordinate
    
    y - the pointer y coordinate
  - pointerReleased
```
public void pointerReleased(int x,
                            int y)
```
    Deprecated.
    
    If this Component is focused, the pointer released event will call this method
    
    Overrides:
    
    pointerReleased in class Dialog
    
    Parameters:
    
    x - the pointer x coordinate
    
    y - the pointer y coordinate
  - initSpecialButtons
```
protected void initSpecialButtons()
```
    Deprecated.
    
    This method initialize all the virtual keyboard special buttons.
  - getInputModeOrder
```
public String[] getInputModeOrder()
```
    Deprecated.
    
    Returns the order in which input modes are toggled
    
    Returns:
    
    the order of the input modes
  - setInputModeOrder
```
public void setInputModeOrder(String[] order)
```
    Deprecated.
    
    Sets the order in which input modes are toggled and allows disabling/hiding an input mode
    
    Parameters:
    
    order - the order for the input modes in this field
  - getDefaultInputModeOrder
```
public static String[] getDefaultInputModeOrder()
```
    Deprecated.
    
    Returns the order in which input modes are toggled by default
    
    Returns:
    
    the default order of the input mode
  - setDefaultInputModeOrder
```
public static void setDefaultInputModeOrder(String[] order)
```
    Deprecated.
    
    Sets the order in which input modes are toggled by default and allows disabling/hiding an input mode
    
    Parameters:
    
    order - the order for the input modes in all future created fields
  - actionCommand
```
protected void actionCommand(Command cmd)
```
    Deprecated.
    
    Invoked to allow subclasses of form to handle a command from one point rather than implementing many command instances
    
    Overrides:
    
    actionCommand in class Dialog
    
    Parameters:
    
    cmd - the action command
  - dispose
```
public void dispose()
```
    Deprecated.
    
    Closes the current form and returns to the previous form, releasing the EDT in the process
    
    Overrides:
    
    dispose in class Dialog
  - onShow
```
protected void onShow()
```
    Deprecated.
    
    Allows subclasses to bind functionality that occurs when a specific form or dialog appears on the screen
    
    Overrides:
    
    onShow in class Dialog
  - getInputField
```
protected TextField getInputField()
```
    Deprecated.
    
    This method returns the Virtual Keyboard TextField.
    
    Returns:
    
    the the Virtual Keyboard TextField.
  - setCommitOnDispose
```
public static void setCommitOnDispose(TextField tf,
                                      boolean b)
```
    Deprecated.
    
    Indicates whether the VKB should commit changes to the text field when the VKB is closed not via the OK button. This might be useful for some situations such as searches
    
    Parameters:
    
    tf - the text field to mark as commit on dispose
    
    b - the value of commit on dispose, true to always commit changes
  - bindVirtualKeyboard
```
public static void bindVirtualKeyboard(TextArea t,
                                       VirtualKeyboard vkb)
```
    Deprecated.
    
    This method is used to bind a specific instance of a virtual keyboard to a specific TextField. For example if a specific TextField requires only numeric input consider using this method as follows: TextField tf = new TextField(); tf.setConstraint(TextField.NUMERIC); tf.setInputModeOrder(new String[]{"123"}); VirtualKeyboard vkb = new VirtualKeyboard(); vkb.setInputModeOrder(new String[]{VirtualKeyboard.NUMBERS_MODE}); VirtualKeyboard.bindVirtualKeyboard(tf, vkb);
    
    Parameters:
    
    t - the TextField to bind a VirualKeyboard to.
    
    vkb - the binded VirualKeyboard.
  - getVirtualKeyboard
```
public static VirtualKeyboard getVirtualKeyboard(TextArea t)
```
    Deprecated.
    
    This method returns the Textfield associated VirtualKeyboard, see bindVirtualKeyboard(TextField tf, VirtualKeyboard vkb) method.
    
    Parameters:
    
    t - a TextField.that might have an associated VirtualKeyboard instance
    
    Returns:
    
    a VirtualKeyboard instance or null if not exists.
  - isCommitOnDispose
```
public static boolean isCommitOnDispose(TextArea tf)
```
    Deprecated.
    
    Indicates whether the given text field should commit on dispose
    
    Parameters:
    
    tf - the text field
    
    Returns:
    
    true if the text field should save the data despite the fact that it was disposed in an irregular way
  - setVKBTint
```
public static void setVKBTint(TextField tf,
                              int tint)
```
    Deprecated.
    
    Sets the tint color for the virtual keyboard when shown on top of this text field see the form tint methods for more information
    
    Parameters:
    
    tf - the relevant text field
    
    tint - the tint color with an alpha channel
  - getVKBTint
```
public static int getVKBTint(TextArea tf)
```
    Deprecated.
    
    The tint color for the virtual keyboard when shown on top of this text field see the form tint methods for more information
    
    Parameters:
    
    tf - the relevant text field
    
    Returns:
    
    the tint color with an alpha channel
  - isShowTooltips
```
public static boolean isShowTooltips()
```
    Deprecated.
    
    Indicates whether tooltips should be shown when the keys in the VKB are pressed
    
    Returns:
    
    the showTooltips
  - setShowTooltips
```
public static void setShowTooltips(boolean aShowTooltips)
```
    Deprecated.
    
    Indicates whether tooltips should be shown when the keys in the VKB are pressed
    
    Parameters:
    
    aShowTooltips - true to show tooltips
  - getTransitionIn
```
public static Transition getTransitionIn()
```
    Deprecated.
    
    The transition in for the VKB
    
    Returns:
    
    the transitionIn
  - setTransitionIn
```
public static void setTransitionIn(Transition aTransitionIn)
```
    Deprecated.
    
    The transition in for the VKB
    
    Parameters:
    
    aTransitionIn - the transitionIn to set
  - getTransitionOut
```
public static Transition getTransitionOut()
```
    Deprecated.
    
    The transition out for the VKB
    
    Returns:
    
    the transitionOut
  - setTransitionOut
```
public static void setTransitionOut(Transition aTransitionOut)
```
    Deprecated.
    
    The transition out for the VKB
    
    Parameters:
    
    aTransitionOut - the transitionOut to set
  - showKeyboard
```
public void showKeyboard(boolean show)
```
    Deprecated.
    
    Shows the virtual keyboard that is assoiciated with the displayed TextField or displays the default virtual keyboard.
    
    Specified by:
    
    showKeyboard in interface com.codename1.impl.VirtualKeyboardInterface
    
    Parameters:
    
    show - it show is true open the relevant keyboard, if close dispose the displayed keyboard
  - setDefaultVirtualKeyboardClass
```
public static void setDefaultVirtualKeyboardClass(Class vkbClazz)
```
    Deprecated.
    
    Sets the default virtual keyboard class for the com.codename1.ui.VirtualKeyboard type This class is used as the default virtual keyboard class if the current platform VirtualKeyboard is com.codename1.ui.VirtualKeyboard. Platform VirtualKeyboard is defined here: Display.getIntance().setDefaultVirtualKeyboard(VirtualKeyboardInterface vkb)
    
    Parameters:
    
    vkbClazz - this class must extend VirtualKeyboard.
  - getVirtualKeyboardName
```
public String getVirtualKeyboardName()
```
    Deprecated.
    
    Description copied from interface: com.codename1.impl.VirtualKeyboardInterface
    
    Returns the Virtual Keyboard name. This is a unique indentifier for the Virtual Keyboard implementation
    
    Specified by:
    
    getVirtualKeyboardName in interface com.codename1.impl.VirtualKeyboardInterface
    
    Returns:
    
    a unique id that represents this virtual keyboard.
    
    See Also:
    
    VirtualKeyboardInterface
  - isVirtualKeyboardShowing
```
public boolean isVirtualKeyboardShowing()
```
    Deprecated.
    
    Description copied from interface: com.codename1.impl.VirtualKeyboardInterface
    
    Indicates if the Virtual Keyboard is currently showing.
    
    Specified by:
    
    isVirtualKeyboardShowing in interface com.codename1.impl.VirtualKeyboardInterface
    
    Returns:
    
    true if the Virtual Keyboard is currently showing
    
    See Also:
    
    VirtualKeyboardInterface

Codename One API

Class VirtualKeyboard

Field Summary

Fields inherited from class com.codename1.ui.Dialog

Fields inherited from class com.codename1.ui.Form

Fields inherited from class com.codename1.ui.Component

Constructor Summary

Method Summary

Methods inherited from class com.codename1.ui.Dialog

Methods inherited from class com.codename1.ui.Form

Methods inherited from class com.codename1.ui.Container

Methods inherited from class com.codename1.ui.Component

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_QWERTY

DEFAULT_NUMBERS

DEFAULT_NUMBERS_SYMBOLS

DEFAULT_SYMBOLS

QWERTY_MODE

NUMBERS_MODE

NUMBERS_SYMBOLS_MODE

SYMBOLS_MODE

INSERT_CHAR

DELETE_CHAR

CHANGE_MODE

SHIFT

OK

SPACE

T9

NAME

Constructor Detail

VirtualKeyboard

Method Detail

setInputType

setTextField

show

autoAdjust

initModes

setCurrentMode

getCurrentMode

addDefaultInputMode

addInputMode

addSpecialButton

addSpecialButton

pointerPressed

pointerDragged

pointerReleased

initSpecialButtons

getInputModeOrder

setInputModeOrder

getDefaultInputModeOrder

setDefaultInputModeOrder

actionCommand

dispose

onShow

getInputField

setCommitOnDispose

bindVirtualKeyboard

getVirtualKeyboard

isCommitOnDispose

setVKBTint

getVKBTint

isShowTooltips

setShowTooltips

getTransitionIn

setTransitionIn

getTransitionOut

setTransitionOut

showKeyboard

setDefaultVirtualKeyboardClass

getVirtualKeyboardName

isVirtualKeyboardShowing