HTMLIFrameElement.setInputMethodActive()

Non-standard
This feature is not on a current W3C standards track, but it is supported on the Firefox OS platform. Although implementations may change in the future and it is not supported widely across browsers, it is suitable for use in code dedicated to Firefox OS apps.

This API is available on Firefox OS for privileged or certified applications only.

The setInputMethodActive() method of the HTMLIFrameElement sets the current browser <iframe> as an active Input Method Editor (IME) window and other iframes as non-active IME windows. Useful when a top level app wants to activate a window as an IME.

Syntax

instanceOfHTMLIframeElement.setInputMethodActive(boolean);

Returns

A DOMRequest object that handles the request to set this feature. It has an onsuccess handler that fires if the setting is successful, and an onerror handler that fires if not.

Parameters

A Boolean that indicates if we want to set the current frame to the active IME window (true) or not (false.)

Example

var browser = document.querySelector('iframe');
var request = browser.setInputMethodActive(true);

request.onsuccess = function() {
  // success!
}

request.onerror = function(error) {
  console.log(error);
}

Specification

Not part of any specification.

Browser compatibility

Feature Chrome Firefox (Gecko) Internet Explorer Opera Safari (WebKit)
Basic support Not supported Not supported Not supported Not supported Not supported
Feature Android Firefox Mobile (Gecko) Firefox OS (Gecko) IE Phone Opera Mobile Safari Mobile
Basic support Not supported Not supported 1.0.1 Not supported Not supported Not supported

Note: Use of the Browser API requires a privileged app, and browser and/or embed-apps permissions, depending on what you want to do. See Using the Browser API for more details.

See also

License

© 2016 Mozilla Contributors
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-us/docs/web/api/htmliframeelement/setinputmethodactive