qnx.system.VirtualKeyboard

VirtualKeyboard

Properties | Methods | Events


Packageqnx.system
Classpublic class VirtualKeyboard
InheritanceVirtualKeyboard Inheritance flash.events.EventDispatcher

The VirtualKeyboard class dispatches events when the keyboard is show, hidden, and when it's size changes.

It is important to know that events will be dispatched even if the application is deactivated and does not have focus. It is up to application developer to act accordingly when their app is deactivated.



Class information:
BlackBerry 10 Version:   10.0.0



Public Properties

 PropertyDefined By
  virtualKeyboard : VirtualKeyboard
[static] [read-only] Returns the singleton instance of the VirtualKeyboard class.
VirtualKeyboard
  visible : Boolean
[read-only] Returns whether the keyboard is visible.
VirtualKeyboard

Public Methods

 MethodDefined By
  
The constructor of the VirtualKeyboard class.
VirtualKeyboard

Events

 Event Summary Defined By
  Dispatched when the keyboard is hidden.VirtualKeyboard
  Dispatched when the keyboard size changes.VirtualKeyboard
  Dispatched when the keyboard is shown.VirtualKeyboard

Property Detail

virtualKeyboard


virtualKeyboard:VirtualKeyboard  [read-only]

Returns the singleton instance of the VirtualKeyboard class.


Implementation

public static function get virtualKeyboard():VirtualKeyboard

visible


visible:Boolean  [read-only]

Returns whether the keyboard is visible.


Implementation

public function get visible():Boolean

Constructor Detail

VirtualKeyboard()


public function VirtualKeyboard()

The constructor of the VirtualKeyboard class. This should never be called directly. Use the VirtualKeyboard.virtualKeyboard property to create an instance.

See also

virtualKeyboard

Event Detail

virtualKeyboardHide


Event Object Type: qnx.events.VirtualKeyboardEvent
VirtualKeyboardEvent.type property = qnx.events.VirtualKeyboardEvent.HIDE

Dispatched when the keyboard is hidden.

Dispatched when the keyboard is hidden.

This is dispatched when the keyboard is dimissed for any reason.

The VirtualKeyboardEvent.HIDE constant defines the value of the type property of the event object for an virtualKeyboardHide event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe object that is actively processing the Event object with an event listener.
keyboardSizeNot valid for this event type.
typeVirtualKeyboardEvent.HIDE

virtualKeyboardInfo


Event Object Type: qnx.events.VirtualKeyboardEvent
VirtualKeyboardEvent.type property = qnx.events.VirtualKeyboardEvent.INFO

Dispatched when the keyboard size changes.

Dispatched when the size of the keyboard changes.

The VirtualKeyboardEvent.INFO constant defines the value of the type property of the event object for an virtualKeyboardInfo event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe object that is actively processing the Event object with an event listener.
keyboardSizeThe height of the keyboard in pixels.
typeVirtualKeyboardEvent.INFO

virtualKeyboardShow


Event Object Type: qnx.events.VirtualKeyboardEvent
VirtualKeyboardEvent.type property = qnx.events.VirtualKeyboardEvent.SHOW

Dispatched when the keyboard is shown.

Dispatched when the keyboard is shown.

This is dispatched when the keyboard is shown when a field that requires focus gets focus or when the user swipes up from the bottom right.

The VirtualKeyboardEvent.SHOW constant defines the value of the type property of the event object for an virtualKeyboardShow event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe object that is actively processing the Event object with an event listener.
keyboardSizeThe height of the keyboard in pixels.
typeVirtualKeyboardEvent.SHOW




comments powered by Disqus