top

Common popup IME

Published 2014-10-28 | (Compatible with SDK 2.5,3.5,4.5,5.0,5.1 and 2011,2012,2013,2014 models)

Caution

This IME guide document is only compatible with apps from up to 2015.
Don't use this IME for new launching app targetting Orsay.

IMEShell_Common()

Method creates IMEShell_Common object.

Returns: Common Popup IME object
imeBox = new IMEShell_Common();
imeBox.onShow()

Displays Common popup IME

Returns: (Boolean)
  • true: success,
  • false: fail
imeBox.onShow();
imeBox.onClose()

Closes Common popup IME.

imeBox.onClose();
imeBox.setBlockSpace(flag)

Blocks entry of the space character in an input box

Arguments:
  • block (Boolean) – [optional]
  • true: IME will not allow the space character to be entered
  • false: IME will allow the space character to be entered (default)
imeBox.setBlockSpace(true);
imeBox.setUseShowHidePasswordMenu(flag)

Shows or hides helpbar Menu “password Show / Hide” of IME when using the password mode.

Arguments:
  • flag (Boolean) – is the menu displayed in helpbar. (default: false)
Returns:

None

imeBox.setUseShowHidePasswordMenu(true);
imeBox.setUsetIDMode(flag)

Used input English like ID input. Do not be Last memory.

Arguments:
  • flag (Boolean) – IME input mode changed to English.
imeBox.setUsetIDMode(true);
imeBox.String inputboxID

ID of <input> elements. Mandatory.

Note

IME supports HTML <input> elements only; other kinds of element are not supported.

imeBox.inputboxID = "searchText1";
imeBox.inputTitle

String to be displayed in a common part of the Title popup window. Not displayed if no value set.

imeBox.inputTitle = "Common Input Title1";
imeBox.onCompleteFunc

Function to be called whenever the character completion. The completed string is passed by argument to the callback function.

imeBox.onCompleteFunc = onCompleteText;

function onCompleteText(arg) {
    alert("onCompleteText ===================: " + arg);
}
imeBox.onKeyPressFunc

Function to be called when any key is pressed.

Callback function: function to be notified at the end of IME, with followinf parameters:

  • pressed key,
  • string,
  • input id.
imeBox.onKeyPressFunc = onKeyCallback;

function onKeyCallback (key, str ,id) {
    alert("CALLBACK onKeyCallback ===================: " + key + " ID = " + id + "
    STR = " + str);
    switch (key) {
        case (29443): // Enter Key
            alert("ENTER");
            break;
        case (88): //return
            alert("RETURN");
            break;
        case (45): //exit
            alert("EXIT");
            break;
    }
}
context

If set this value, IME call call() to callback function. [Optional].

imeBox.context = this;
showAutoCompletePopup(items)

It is displayed Autocomplete or History data. The maximum number of displayed items: 20.

Arguments:
  • items (Array) – list of displayed data
Returns:

None

var dataObj = {
    request : "w", // Characters entered in IME
    items : [
        "www.naver.com",
        "www.google.com",
        "www.baykoreans.net",
        "www.yahoo.co.kr",
        "www.yesfile.com",
        "www.itemmania.com"
    ] // Data to be displayed in the list
}
imeBox.showAutoCompletePopup(dataObj);
setMaxlength(length)

Sets the maximum length of the user input.

If specify both function and input window properties, function is first.

Arguments:
  • length (Number) – maximum length
imeBox.setMaxlength(50);
setPasswordMode(flag)

Sets whether password mode of IME is used or not.

If specify both function and input window properties, function is first.

Arguments:
  • flag (Boolean) –
Returns:

None

imeBox.setPasswordMode(true);
inputDescription

Guide string is displayed at Common popup. 40 characters per each line, 3 lines of 120 characters can be entered (case of english). If exceed 120 characters, ”...” is displayed.

imeBox.inputDescription = "input text here";
setUsePreviewMode(flag)

Multi-line preview is displayed at Common Popup. Characters beyond the Preview does not apper.

imeBox.setUsePreviewMode(true);