Provides various functions and events for working
with the browser user interface.
- Source:
Members
(static, readonly) OrientationLockType :number
Enum OrientationLockType
Type:
- number
Properties:
| Name | Type | Description |
|---|---|---|
UNLOCKED |
number | Indicates the orientation is dynamic and free to be rotated to portrait or landscape. |
LOCK_PORTRAIT |
number | The browser tab is locked to the portrait orientation. |
LOCK_LANDSCAPE |
number | The browser tab is locked to the landscape orientation. |
SYSTEM_CONTROLLED |
number | The locked or unlocked state is determined by the configuration and/or user settings in the app. |
- Source:
Methods
(static) closeKeyboard()
Hides the software keyboard if visible.
- Source:
(static) getOrientationLock() → {airlock.device.OrientationLockType}
Gets the screen orientation setting for the application.
Screen orientation can be set globally, for all tabs via the app settings screen;
for web applications, via the remote application dialog in the launchpad;
or individual pages, using this JavaScript API.
- Source:
Returns:
The orientation enumeration value.
0 is unlocked, 1 is locked portrait, 2 is locked landscape, 3 is system controlled.
When the value is 3 (system controlled), an orientation value has not been set using this API
and the orientation lock cannot be determined because the current tab
may not be active. When 3, the locked or unlocked state is determined
by the configuration and/or user settings in the app.
- Type
- airlock.device.OrientationLockType
(static) getUILanguage() → {string}
Gets the name of the app's UI language.
The name is a combination of an ISO 639 two-letter
lowercase culture code associated with a language
and an ISO 3166 two-letter uppercase subculture code
associated with a country or region.
For example, en-AU denotes Australian English.
- Source:
Returns:
A language code resembling 'en-AU'.
- Type
- string
(static) isFullScreen() → {boolean}
Get a value indicating whether the app is in full screen mode.
When full screen, the app's application bar is reduced to an ellipsis
and the tabs are hidden.
- Source:
- See:
Returns:
true if the browser is in full screen mode; false otherwise.
- Type
- boolean
(static) isKeyboardOpen() → {boolean}
- Source:
Returns:
True if the software input panel is showing,
False otherwise.
- Type
- boolean
(static) isLaunchpadOpen() → {boolean}
Gets a value indicating whether the sliding panel,
containing web applications, is visible.
- Source:
Returns:
true if the launchpad is open; false otherwise.
- Type
- boolean
(static) setFullScreen(fullScreen)
Changes the apps full screen mode.
When full screen, the app's application bar is reduced to an ellipsis
and the tabs are hidden.
Parameters:
| Name | Type | Description |
|---|---|---|
fullScreen |
boolean | The new setting. If the value matches the current state, there is no effect. |
- Source:
- See:
Throws:
-
Occurs if fullScreen argument is undefined.
- Type
- Exception
(static) setLaunchpadOpen(open)
Changes the open state of the launchpad from opened to closed and vice versa.
Parameters:
| Name | Type | Description |
|---|---|---|
open |
boolean | The new value. If the state of the launchpad matches the value of the parameter, no change occurs. |
- Source:
Throws:
-
Occurs if argument is undefined.
- Type
- Exception
(static) setOrientationLock(lockType)
Sets the orientation for the browser tab, when it is active.
The value set via this function overrides any orientation lock values
from the settings within the app.
Passing null to this function unsets any previously set value and causes
the browser to fall back to remote web application, or browser, settings.
Screen orientation can be set globally, for all tabs via the app settings screen;
for web applications, via the remote application dialog in the launchpad;
or individual pages, using this JavaScript API.
Parameters:
| Name | Type | Description |
|---|---|---|
lockType |
airlock.ui.OrientationLockType | The orientation enumeration value. 0 is unlocked, 1 is locked portrait, 2 is locked landscape, 3 is system controlled. When the value is 3 (system controlled), an orientation value has not been set using this API and the orientation lock cannot be determined because the current tab may not be active. When 3, the locked or unlocked state is determined by the configuration and/or user settings in the app. |
- Source: