new Keyboard(idopt, cols, rows, keys, horizontalWrapping, verticalWrapping)
On-screen keyboard widget.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
id |
String |
<optional> |
The unique ID of the widget. If excluded, a temporary internal ID will be used (but not included in any output). |
cols |
Integer | The number of columns of keys on the keyboard. | |
rows |
Integer | The number of rows of keys on the keyboard. | |
keys |
String | A string of characters which make up the keys, starting top-left and working row-by-row to the bottom-right. | |
horizontalWrapping |
boolean | Enable or disable horizontal wrapping. | |
verticalWrapping |
boolean | Enable or disable vertical wrapping.
Special characters include:
"-" DEL
" " SPACE
"_" |
- Source:
Extends
Methods
_onKeyDown(evt)
Key handler for grids. Processes KeyEvent.VK_UP, VK_DOWN, VK_LEFT and VK_RIGHT keys and stops propagation
if the keypress is handled. Otherwise allows the event to be bubbled up to the parent widget to allow
spatial navigation out of the list.
Parameters:
| Name | Type | Description |
|---|---|---|
evt |
antie.events.KeyEvent | The key event. |
- Inherited From:
- Source:
addClass(className)
Adds a CSS class to the widget if not already present.
Parameters:
| Name | Type | Description |
|---|---|---|
className |
String | The class name to add. |
- Inherited From:
- Source:
addEventListener(ev, func)
Add an event listener function to this widget.
Parameters:
| Name | Type | Description |
|---|---|---|
ev |
String | The event type to listen for (e.g. keydown) |
func |
function | The handler to be called when the event is fired. |
- Inherited From:
- Source:
- See:
appendChildWidget(widget)
Appends a child widget to this widget. Not supported for Grids - use setWidgetAt() instead.
Parameters:
| Name | Type | Description |
|---|---|---|
widget |
antie.widgets.Widget | The child widget to add. |
- Inherited From:
- Source:
broadcastEvent()
Broadcasts an event from the application level to every single
object it contains.
- Inherited From:
- Source:
bubbleEvent(ev)
Bubbles an event from object, triggering any event listeners bound to this widget and any
parent widgets.
To halt bubbling of the event, see antie.events.Event#stopPropagation.
Parameters:
| Name | Type | Description |
|---|---|---|
ev |
antie.events.Event | The event to bubble. |
- Inherited From:
- Source:
- See:
fireEvent(ev)
Fires an event on this object, triggering any event listeners bound to this widget only.
Note: this does not bubble or propagate the event to other widgets, for that functionality
see #bubbleEvent.
Parameters:
| Name | Type | Description |
|---|---|---|
ev |
antie.events.Event | The event to fire. |
- Inherited From:
- Source:
- See:
focus()
Moves focus to a button within this container. Focused button will be that which follows
the current 'active' path.
- Overrides:
- Source:
Returns:
Boolean true if focus has been moved to a button. Otherwise returns false.
getActiveChildWidget()
Get the current active widget.
- Inherited From:
- Source:
Returns:
The current active widget
getCapitalisation()
Gets the current capitalisation mode of the keyboard.
- Source:
Returns:
The capitalisation mode of the keyboard.
getChildWidget(id)
Get a child widget from its unique ID.
Parameters:
| Name | Type | Description |
|---|---|---|
id |
String | The id of the child widget to return. |
- Inherited From:
- Source:
Returns:
antie.widgets.Widget of the widget with the given ID, otherwise undefined if the child does not exist.
getChildWidgetCount()
Gets the number of direct child widgets.
- Inherited From:
- Source:
Returns:
The number of direct child widgets.
getChildWidgets()
Get an array of all this widget's children.
- Inherited From:
- Source:
Returns:
An array of all this widget's children.
getClasses()
Get an array of class names that this widget has.
- Inherited From:
- Source:
Returns:
An array of class names (Strings)
getComponent()
Returns the component this widget is a descendant of
- Inherited From:
- Source:
getCurrentApplication()
Gets a reference to the application responsible for creating the widget.
- Inherited From:
- Source:
- See:
-
- antie.RuntimeContext
getDataItem()
Get any data item associated with this widget.
- Inherited From:
- Source:
getMaximumLength()
Gets the maximum number of characters that can be entered
- Source:
Returns:
The maximum number of characters that can be entered
getMultiTap()
Gets whether to multi-tap is supported by this keyboard.
- Source:
Returns:
Boolean
true if multi-tap is supported by this keyboard.
getText()
Gets the text entered/edited by this keyboard.
- Source:
Returns:
The text entered/edited by this keyboard.
getWidgetAt(col, row)
Get the widget positioned at the specified column and row.
Parameters:
| Name | Type | Description |
|---|---|---|
col |
Integer | The column the widget it in |
row |
Integer | The row the widget it in |
- Inherited From:
- Source:
Returns:
The widget in the specified column and row
hasChildWidget(id)
Checks to see if a specific widget is a direct child of this widget.
Parameters:
| Name | Type | Description |
|---|---|---|
id |
String | The widget id of the widget to check to see if it is a direct child of this widget. |
- Inherited From:
- Source:
hasClass(className)
Checks to see if the widget has a given CSS class.
Parameters:
| Name | Type | Description |
|---|---|---|
className |
String | The class name to check. |
- Inherited From:
- Source:
Returns:
Boolean true if the device has the className. Otherwise boolean false.
hide(options)
Hides a widget. If animation is enabled the widget will be faded out of view.
Parameters:
| Name | Type | Description | ||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object | Details of the element to be shown, with optional parameters.
Properties
|
- Inherited From:
- Source:
Returns:
Boolean true if animation was called, otherwise false
insertChildWidget(index, widget)
Inserts a child widget at the specified index. Not supported for Grids.
Parameters:
| Name | Type | Description |
|---|---|---|
index |
Integer | The index where to insert the child widget. |
widget |
antie.widgets.Widget | The child widget to add. |
- Inherited From:
- Source:
isComponent() → {Boolean}
Returns whether the widget is a Component.
- Inherited From:
- Source:
Returns:
True if the widget is a Component.
- Type
- Boolean
isFocusable()
Checks to see if a widget is focussable, i.e. contains an enabled button.
- Inherited From:
- Source:
- See:
isFocussed()
Get if this widget is in the current focus path.
- Inherited From:
- Source:
Returns:
Boolean true if this widget is in the focus path, otherwise false.
moveTo(options)
Moves a widget so that its top-left corner is at the given position.
Parameters:
| Name | Type | Description | ||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object | Details of the element to be shown, with optional parameters.
Properties
|
- Inherited From:
- Source:
Returns:
Boolean true if animation was called, otherwise false
prependWidget(widget)
Inserts a widget before the current one.
Parameters:
| Name | Type | Description |
|---|---|---|
widget |
antie.widgets.Widget | The child widget to add. |
- Inherited From:
- Source:
removeChildWidget(widget, retainElementopt)
Removes a specific child widget from this widget. Not supported for Grids.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
widget |
antie.widgets.Widget | The child widget to remove. | |
retainElement |
Boolean |
<optional> |
Pass true to retain the child output element of the given widget |
- Inherited From:
- Source:
removeChildWidgets()
Remove all child widgets from this widget.
- Inherited From:
- Source:
removeClass(className)
Removes a CSS class from the widget if present.
Parameters:
| Name | Type | Description |
|---|---|---|
className |
String | The class name to remove. |
- Inherited From:
- Source:
removeEventListener(ev, func)
Removes an event listener function to this widget.
Parameters:
| Name | Type | Description |
|---|---|---|
ev |
String | The event type that the listener is to be removed from (e.g. keydown) |
func |
function | The handler to be removed. |
- Inherited From:
- Source:
- See:
removeFocus()
Remove focus state from this widget.
- Inherited From:
- Source:
render(device)
Renders the widget and any child widgets to device-specific output.
Parameters:
| Name | Type | Description |
|---|---|---|
device |
antie.devices.Device | The device to render to. |
- Inherited From:
- Source:
Returns:
A device-specific object that represents the widget as displayed on the device (in a browser, a DOMElement);
setActiveChildIndex(index)
Attempts to set focus to the child widget at the given index.
Parameters:
| Name | Type | Description |
|---|---|---|
index |
Integer | Index of the child widget to set focus to. |
- Inherited From:
- Source:
- See:
Returns:
Boolean true if the child widget was focusable, otherwise boolean false.
setActiveChildKey(character)
Sets the active child widget as the button for the specified character.
Parameters:
| Name | Type | Description |
|---|---|---|
character |
String | The character who's button should be the active child widget. |
- Source:
setActiveChildWidget(widget)
Attempt to set focus to the given child widget.
Note: You can only set focus to a focusable widget. A focusable widget is one that
contains an enabled antie.widgets.Button as either a direct or indirect child.
Note: Widgets have 2 independant states: active and focussed. A focussed widget is
either the Button with focus, or any parent of that Button. An active widget is
one which is the active child of its parent Container. When the parent widget
receives focus, focus will be placed on the active child.
Classes 'active' and 'focus' are appended to widgets with these states.
Parameters:
| Name | Type | Description |
|---|---|---|
widget |
antie.widgets.Widget | The child widget to set focus to. |
- Inherited From:
- Source:
Returns:
Boolean true if the child widget was focusable, otherwise boolean false.
setCapitalisation(capitalisation)
Sets the capitalisation mode of the keyboard. {@see Keyboard.CAPITALISATION_UPPER},
{@see Keyboard.CAPITALISATION_LOWER} and {@see Keyboard.CAPITALISATION_TITLE}
Parameters:
| Name | Type | Description |
|---|---|---|
capitalisation |
Integer | The capitalisation mode to use. |
- Source:
setDataItem(dataItem)
Associate a data item with this widget.
Parameters:
| Name | Type | Description |
|---|---|---|
dataItem |
object | Object to associate with this widget. |
- Inherited From:
- Source:
setMaximumLength(length)
Sets the maximum number of characters that can be entered
Parameters:
| Name | Type | Description |
|---|---|---|
length |
Integer | The maxmimum number of characters that can be entered. Pass null to allow infinite characters. |
- Source:
setMultiTap(multiTap)
Sets whether to support multi-tap on this keyboard. Note: the device must also support it.
Parameters:
| Name | Type | Description |
|---|---|---|
multiTap |
Boolean | Pass true to enable multi-tap. |
- Source:
setText(text)
Sets the current text entered/to-be-edited by this keyboard.
Parameters:
| Name | Type | Description |
|---|---|---|
text |
String | String to be edited by this keyboard. |
- Source:
setWidgetAt(col, row, widget)
Positions a widget at the specified column and row.
Parameters:
| Name | Type | Description |
|---|---|---|
col |
Integer | The column to position the widget in |
row |
Integer | The row to position the widget in |
widget |
antie.widgets.Widget | The widget to add |
- Inherited From:
- Source:
show(options)
Shows a widget. If animation is enabled the widget will be faded in.
Parameters:
| Name | Type | Description | ||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object | Details of the element to be shown, with optional parameters.
Properties
|
- Inherited From:
- Source:
Returns:
Boolean true if animation was called, otherwise false