JS and UI Interaction

Overview

This chapter covers interaction between JS and UI elements
JS modules that interact with UI are prefixed with ui, e.g. ui.toast("msg")

How to Use

In your project’s layout folder, create a ui.js file with the following content:

1
function main() {
2
    ui.toast("UI controlled by JS");
3
}
4

5
main();

Load and display main.xml from the layout folder:

1
function main() {
2
    ui.toast("UI controlled by JS");
3
    ui.layout("Tab 1", "main.xml");
4
}
5

6
main();

This displays the main.xml layout in a simple UI

Advanced Usage

Example ui.js:

1
/**
2
 * Auto-generated by EasyClick development tools
3
 */
4
function main() {
5
    ui.toast("UI toast function");
6
    var set = ui.layout("Parameter Settings", "main.xml");
7
    ui.layout("Other Notes", "main2.xml");
8
    ui.logd("Set UI result: " + set);
9

10
    // Switch toggle usage
11
    var auto_env = ui.getViewValue(ui.auto_env);
12
    ui.logd("Value of tag auto_env: " + auto_env);
13
    // Switch checkedChange event
14
    ui.setEvent(ui.auto_env, "checkedChange", function (view, isChecked) {
15
        ui.logd("tag auto_env isChecked " + isChecked);
16
        if (isChecked) {
17
            startAutoEnv();
18
        }
19
    });
20
    if (ui.isServiceOk()) {
21
        ui.auto_env.setChecked(true);
22
    } else {
23
        ui.auto_env.setChecked(false);
24
    }
25

26
    // EditText usage
27
    var name = ui.getViewValue(ui.name);
28
    ui.logd("Value of tag name: " + name);
29
    ui.name.setText("name field value");
30
    // Spinner usage
31
    var sex = ui.getViewValue(ui.sex);
32
    ui.logd("Value of tag sex: " + sex);
33
    // Spinner itemSelected event
34
    ui.setEvent(ui.sex, "itemSelected", function (position, value) {
35
        ui.logd("tag sex itemSelected " + value);
36
    });
37

38
    // RadioButton usage
39
    var three = ui.getViewValue(ui.three);
40
    ui.logd("Value of tag three: " + three);
41
    // RadioButton checkedChange event
42
    ui.setEvent(ui.three, "checkedChange", function (view, isChecked) {
43
        ui.logd("tag three isChecked " + isChecked);
44
    });
45
    // CheckBox usage
46
    var dance = ui.getViewValue(ui.dance);
47
    ui.logd("Value of tag dance: " + dance);
48
    // CheckBox checkedChange event
49
    ui.setEvent(ui.dance, "checkedChange", function (view, isChecked) {
50
        ui.logd("tag dance isChecked " + isChecked);
51
    });
52

53
    // saveAllBtn save parameters click event
54
    ui.setEvent(ui.saveAllBtn, "click", function (view) {
55
        var s = ui.saveAllConfig();
56
        ui.logd("Save all parameters result " + s)
57
    });
58

59
    // System settings button
60
    ui.setEvent(ui.systemSetting, "click", function (view) {
61
        ui.openECSystemSetting();
62

63
    });
64
    // Start script button
65
    ui.setEvent(ui.startBtn, "click", function (view) {
66
        ui.start();
67
    });
68
    // Start environment button
69
    ui.setEvent(ui.envBtn, "click", function (view) {
70
        // Start environment async; on success update auto_env switch
71
        startAutoEnv();
72
    });
73
    // Get all UI parameters
74
    ui.logd("All UI parameters: " + ui.getConfigJSON());
75
    // setViewValue examples (commented out)
76
    // ui.setViewValue(ui.name, "set value");
77
    // ui.setViewValue(ui.auto_env, false);
78
    // ui.setViewValue(ui.sex, "Male|Female");
79
    // ui.setViewValue(ui.three, true);
80
    // ui.setViewValue(ui.dance, false)
81
    // Temporary shared storage for variables and data
82
    ui.putShareData("nameVar", ui.name);
83
    ui.putShareData("value", "my value");
84

85

86
}
87

88
function startAutoEnv() {
89
    ui.startEnvAsync(function (r) {
90
        ui.logd("Start environment result: " + r);
91
        ui.auto_env.setChecked(r);
92
    });
93
}
94

95
main();

How Scripts Interact with JS

The following code runs in js/main.js:

1
function main() {
2
    // Script reads UI objects — UI must be loaded first
3
    // Reference UI objects directly
4
    // Assume xml has tag=name EditText
5
    // Read variables/data set in the UI module
6
    logd(ui.getShareData("nameVar"))
7
    logd(ui.getShareData("value"))
8

9

10
    // Method 1: variable reference
11
    // Reset JS variables
12
    ui.resetUIVar()
13
    // Log ui.name
14
    logd("ui.name " + ui.name)
15
    if (ui.name) {
16
        // Run on UI main thread
17
        getHandler().post(function () {
18
            ui.name.setText("Fsdafsadfsa")
19
            ui.logd("EditText content: " + ui.name.getEditableText());
20
        });
21

22
    }
23
    sleep(2000);
24
    // Method 2: findViewByTag
25
    var name = ui.findViewByTag("name");
26
    if (name) {
27
        // Run on UI main thread
28
        getHandler().post(function () {
29
            name.setText("updated text")
30
            ui.logd("EditText content: " + name.getEditableText());
31
        });
32

33
    }
34

35

36
    sleep(5000);
37

38
}
39

40
main();

Message APIs

Toast Message toast

Show a Toast message
@param msg message

1
function main() {
2
    ui.toast("UI controlled by JS");
3
}
4

5
main();

Debug Log logd

Print debug log
@param msg message to print

1
function main() {
2
    ui.logd("debug message");
3
}
4

5
main();

Layout UI APIs

Set Layout layout

Create a layout and set it on the current page
@param name tab label name
@param content layout file name in the layout folder, or raw XML content
@return boolean true = success, false = failure

1
function main() {
2
    // XML files are in the layout folder
3
    var u1 = ui.layout("Parameter Help", "main.xml");
4
    var u2 = ui.layout("Other Notes", "main2.xml");
5
    ui.logd("Parameter Help create result: " + u1);
6
    ui.logd("Other Notes create result: " + u2);
7
}
8

9
main();

Parse Layout parseView

Parse layout and return
@param content layout file name in the layout folder, or raw XML content
@return View Android View object, or null if parsing fails

1
function main() {
2
    // XML files are in the layout folder
3
    var u1 = ui.parseView("main.xml");
4
    ui.logd("Create result: " + u1);
5
}
6

7
main();

Reset UI Variables resetUIVar

Convert all tags to UI properties for direct access

1
function main() {
2
    // XML files are in the layout folder
3
    var u1 = ui.layout("Parameter Help", "main.xml");
4
    var u2 = ui.layout("Other Notes", "main2.xml");
5
    ui.resetUIVar();
6
}
7

8
main();

Find View by Tag findViewByTag

Find a view by tag
@param tag tag value
@return View native Android View object

1
function main() {
2
    // XML files are in the layout folder
3
    var u1 = ui.layout("Parameter Help", "main.xml");
4
    var u2 = ui.layout("Other Notes", "main2.xml");
5
    // Find view with tag=name
6
    var nameView = ui.findViewByTag("name");
7
    ui.logd("name view is:" + nameView);
8
}
9

10
main();

Save to Shared Storage putShareData

Store data in shared storage for script use
@param key key
@param value value
@return boolean true = success, false = failure

1
function main() {
2
    // XML files are in the layout folder
3
    var u1 = ui.layout("Parameter Help", "main.xml");
4
    var u2 = ui.layout("Other Notes", "main2.xml");
5
    // Save to shared storage
6
    ui.putShareData("name", "temporary data");
7
}
8

9
main();

Read from Shared Storage getShareData

Read data stored by the UI module from shared storage
@param key key
@return stored data

1
function main() {
2
    // XML files are in the layout folder
3
    var u1 = ui.layout("Parameter Help", "main.xml");
4
    var u2 = ui.layout("Other Notes", "main2.xml");
5
    // Read from shared storage
6
    var d = ui.getShareData("name");
7
    logd("d =" + d)
8
}
9

10
main();

Clear All Shared Storage clearAllShareData

Clear all shared storage data
@return true or false

1
function main() {
2
    ui.clearAllShareData();
3
}
4

5
main();

Set Event setEvent

Set an event handler
@param view view to attach the event to, or its tag
@param eventType event type: click, checkedChange (radio/checkbox state change), itemClick (list item click), itemSelected (list item selected)
@param eventCallback event callback
@return boolean true = success, false = failure

1
function main() {
2
    // XML files are in the layout folder
3
    var u1 = ui.layout("Parameter Help", "main.xml");
4
    var u2 = ui.layout("Other Notes", "main2.xml");
5
    // Spinner itemSelected event
6
    ui.setEvent(ui.sex, "itemSelected", function (position, value) {
7
        ui.logd("tag sex itemSelected " + value);
8
    });
9
    ui.setEvent(ui.dance, "checkedChange", function (view, isChecked) {
10
        ui.logd("tag dance isChecked " + isChecked);
11
    });
12
    ui.setEvent(ui.startBtn, "click", function (view) {
13
        ui.start();
14
    });
15

16
}
17

18
main();

Get Root View getRootView

Get root view object(s) — may be a collection on multi-tab pages
@return list of View objects

1
function main() {
2
    // XML files are in the layout folder
3
    var u1 = ui.layout("Parameter Help", "main.xml");
4
    var u2 = ui.layout("Other Notes", "main2.xml");
5
    // Spinner itemSelected event
6
    var views = ui.getRootView();
7
    ui.logd("views " + views)
8
    for (var i = 0; i < views.length; i++) {
9
        var value = views[i];
10
        ui.logd("view-" + value)
11
    }
12
}
13

14
main();

Set View Value setViewValue

Set view value
@param tagOrView view tag or view object
@param value string or boolean
@return boolean true = success, false = failure

1
function main() {
2
    // XML files are in the layout folder
3
    var u1 = ui.layout("Parameter Help", "main.xml");
4
    var u2 = ui.layout("Other Notes", "main2.xml");
5
    // ui.name is the view object for tag=name in xml
6
    ui.setViewValue(ui.name, "configured name")
7

8
}
9

10
main();

Get View Value getViewValue

Get view value
@param tagOrView view tag or view object
@return string or boolean

1
function main() {
2
    // XML files are in the layout folder
3
    var u1 = ui.layout("Parameter Help", "main.xml");
4
    var u2 = ui.layout("Other Notes", "main2.xml");
5
    // ui.name is the view object for tag=name in xml
6
    ui.setViewValue(ui.name, "configured name");
7
    var v = ui.getViewValue(ui.name);
8

9
    ui.logd("Value of name: " + v);
10

11
}
12

13
main();

Get All UI Config getConfigJSON

Get all UI configuration
@return JSON string

1
function main() {
2
    // XML files are in the layout folder
3
    var u1 = ui.layout("Parameter Help", "main.xml");
4
    var u2 = ui.layout("Other Notes", "main2.xml");
5

6
    ui.setViewValue(ui.name, "name value");
7
    // Save all values
8
    ui.saveAllConfig();
9

10
    var data = ui.getConfigJSON();
11
    ui.logd("data " + data);
12

13
    data = JSON.parse(data);
14
    // Log name — save first if empty
15
    ui.logd(data.name);
16

17

18
}
19

20
main();

Get Single UI Config getConfig

Get a single UI config item
@param key config key
@return string

1
function main() {
2
    // XML files are in the layout folder
3
    var u1 = ui.layout("Parameter Help", "main.xml");
4
    var u2 = ui.layout("Other Notes", "main2.xml");
5

6
    ui.setViewValue(ui.name, "name value");
7
    // Save all values
8
    ui.saveAllConfig();
9

10
    // Save individual values
11
    ui.saveConfig("sex", "Female");
12
    ui.saveConfig("music", true);
13

14
    var data = ui.getConfigJSON();
15
    ui.logd("data " + data);
16

17
    data = JSON.parse(data);
18
    // Log name — save first if empty
19
    ui.logd(data.name);
20
    // Get single value
21
    ui.logd(ui.getConfig("name"));
22
}
23

24
main();

Save All UI Config saveAllConfig

Save all configuration based on configured tags
@return boolean true = saved, false = failed

1
function main() {
2
    // XML files are in the layout folder
3
    var u1 = ui.layout("Parameter Help", "main.xml");
4
    var u2 = ui.layout("Other Notes", "main2.xml");
5

6
    ui.setViewValue(ui.name, "name value");
7
    // Save all values
8
    ui.saveAllConfig();
9

10
    // Save individual values
11
    ui.saveConfig("sex", "Female");
12
    ui.saveConfig("music", true);
13

14
    var data = ui.getConfigJSON();
15
    ui.logd("data " + data);
16

17
    data = JSON.parse(data);
18
    // Log name — save first if empty
19
    ui.logd(data.name);
20
}
21

22
main();

Save Single UI Config saveConfig

Save a UI parameter value
@param key UI key
@param value UI value
@return boolean true = success, false = failure

1
function main() {
2
    // XML files are in the layout folder
3
    var u1 = ui.layout("Parameter Help", "main.xml");
4
    var u2 = ui.layout("Other Notes", "main2.xml");
5

6
    ui.setViewValue(ui.name, "name value");
7
    // Save all values
8
    ui.saveAllConfig();
9

10
    // Save individual values
11
    ui.saveConfig("sex", "Female");
12
    ui.saveConfig("music", true);
13

14
    var data = ui.getConfigJSON();
15
    ui.logd("data " + data);
16

17
    data = JSON.parse(data);
18
    // Log name — save first if empty
19
    ui.logd(data.name);
20
}
21

22
main();

Remove All UI Config removeAllUIConfig

Remove all configuration entries
@return boolean true = success, false = failure

1
function main() {
2
    // XML files are in the layout folder
3
    var u1 = ui.layout("Parameter Help", "main.xml");
4
    var u2 = ui.layout("Other Notes", "main2.xml");
5

6
    ui.setViewValue(ui.name, "name value");
7
    // Remove all config entries
8
    ui.removeAllUIConfig();
9

10
    // Save individual values
11
    ui.saveConfig("sex", "Female");
12
    ui.saveConfig("music", true);
13

14
    var data = ui.getConfigJSON();
15
    ui.logd("data " + data);
16

17
    data = JSON.parse(data);
18
    // Log name — save first if empty
19
    ui.logd(data.name);
20
}
21

22
main();

Load Image Resource resResAsDrawable

Load a file from the IEC package res folder and return as Android Drawable
@param path resource file path under res
@return Drawable image object or null

1
function main() {
2
    // XML files are in the layout folder
3
    var u1 = ui.layout("Parameter Help", "main.xml");
4
    var u2 = ui.layout("Other Notes", "main2.xml");
5

6
    // checkbox.png is in the res folder
7
    var bg = ui.resResAsDrawable("checkbox.png");
8
    // Set dynamic background
9
    ui.music.setBackgroundDrawable(bg);
10
    // Set button drawable
11
    ui.music.setButtonDrawable(bg);
12

13
}
14

15
main();

Dialogs

alert

Alert dialog
@param map e.g. {"title":""} — fixed keys:
title — dialog title
msg — message
cancelText — cancel button text
okText — OK button text
cancelable — whether dismissible
@param okBtnCallback OK button callback
@param cancelBtnCallback cancel button callback
@param dismissListener dialog dismiss callback
@return boolean true = success, false = failure

1
function main() {
2
 var p = {
3
 "title": "Confirm",
4
 "msg": "Are you sure?",
5
 "cancelable": true,
6
 "cancelText": "No",
7
 "okText": "Yes"
8
 };
9
 ui.alert(p,
10
 function (dialog, v) {
11
 logd("ok btn click : ")
12
 // Dismiss dialog
13
 dialog.doDismiss();
14
 return true;
15
 },
16
 function (dialog, v) {
17
 logd("cancel btn click ")
18
 // Dismiss dialog
19
 dialog.doDismiss();
20
 return true;
21
 },
22
 function () {
23
 logd("mission btn click ")
24
 return true;
25
 });
26

27
}
28

29
main();

inputDialog

inputDialog — input dialog
@param map e.g. {"title":""} — fixed keys:
title — dialog title
msg — message
cancelText — cancel button text
okText — OK button text
cancelable — whether dismissible
@param okBtnCallback OK button callback
@param cancelBtnCallback cancel button callback
@param dismissListener dialog dismiss callback
@return boolean true = success, false = failure

1
function main() {
2
 var p = {
3
 "title": "Confirm",
4
 "msg": "Are you sure?",
5
 "cancelable": true,
6
 "cancelText": "No",
7
 "okText": "Yes"
8
 };
9
 ui.inputDialog(p,
10
 function (dialog, v, text) {
11
 // text is the input string
12
 logd("ok btn click : " + text)
13
 // Dismiss dialog
14
 dialog.doDismiss();
15
 return true;
16
 },
17
 function (dialog, v, text) {
18
 logd("cancel btn click " + text)
19
 // Dismiss dialog
20
 dialog.doDismiss();
21
 return true;
22
 },
23
 function () {
24
 logd("mission btn click ")
25
 return true;
26
 });
27

28
}
29

30
main();

customDialog

Custom dialog
@param params e.g. {"cancelable":""} — fixed keys:
fullScreen — full screen
cancelable — whether dismissible
@param view native view
@param onViewBind view bind callback
@param dismissListener dialog dismiss callback
@return boolean true = success, false = failure

1
function main() {
2
 // Use native Android widgets
3
 importPackage(android.widget)
4
 var textView = new TextView(ui.getContext());
5
 textView.setText("sdfasfsad");
6
 // Or use a view parsed from XML
7
 var textView = ui.parseView("main2.xml");
8
 ui.customDialog({
9
 "fullScreen": true,
10
 "cancelable": true
11
 },
12
 textView,
13
 function (dialog, v) {
14
 // Access view and attach events here
15
 }, function () {
16
 logd("dsssss")
17
 })
18

19
}
20

21
main();

Floating Window APIs

Floating Window Permission hasFloatViewPermission

Whether floating window permission is granted
@return boolean true = granted, false = denied

1
function main() {
2
 var r = ui.hasFloatViewPermission();
3
 if (!r) {
4
 var req = ui.requestFloatViewPermission(10000);
5
 ui.logd("Request floating window permission: " + req);
6
 }
7
 r = ui.hasFloatViewPermission();
8
 ui.logd("Has floating window permission: " + r);
9

10
}
11

12
main();

Request Floating Window Permission Async requestFloatViewPermissionAsync

Request floating window permission asynchronously
@param timeout timeout in milliseconds
@param callback callback
@return boolean true = granted, false = denied

1
function main() {
2
 var r = ui.hasFloatViewPermission();
3
 if (!r) {
4
 ui.requestFloatViewPermissionAsync(20000, function (r) {
5
 ui.logd("Request floating window permission: " + r);
6
 });
7

8
 }
9
 r = ui.hasFloatViewPermission();
10
 ui.logd("Has floating window permission: " + r);
11

12
}
13

14
main();

Show Control Floating Window showCtrlWindow

Show control floating window
@return boolean true = success, false = failure

1
function main() {
2
 var r = ui.hasFloatViewPermission();
3
 ui.logd("Has floating window permission:" + r)
4
 if (!r) {
5
 return
6
 }
7
 // Show floating window
8
 ui.showCtrlWindow();
9
 ui.logd("Showing message")
10
 // Dismiss on UI thread after 3 seconds
11
 ui.getHandler().postDelayed(function () {
12
 ui.closeCtrlWindow();
13
 }, 3000);
14
}
15

16
main();

Close Control Floating Window closeCtrlWindow

Close control floating window
@return boolean true = success, false = failure

1
function main() {
2
 var r = ui.hasFloatViewPermission();
3
 ui.logd("Has floating window permission:" + r)
4
 if (!r) {
5
 return
6
 }
7
 // Show floating window
8
 ui.showCtrlWindow();
9
 ui.logd("Showing message")
10
 // Dismiss on UI thread after 3 seconds
11
 ui.getHandler().postDelayed(function () {
12
 ui.closeCtrlWindow();
13
 }, 3000);
14
}
15

16
main();

Add Control Floating Window Button addCtrlView

Add start/stop floating window button
Requires EC 6.0.0+
@param tag button tag
@param icon icon path under project res/, e.g. res/a.png
@param width button width in dp — system default is 36
@param height button height in dp — system default is 36
@param index insert index — -1 append, 0 insert first
@param onClickListener click callback
@return boolean true = success, false = failure

1
function main() {
2
 ui.toast("UI toast function");
3
 var set = ui.layout("Parameter Settings", "main.xml");
4
 ui.layout("Other Notes", "main2.xml");
5
 ui.logd("Set UI result: " + set);
6
 ui.showCtrlWindow()
7
 // Use delay — showCtrlWindow is async
8
 ui.run(1000, function () {
9
 // Remove default control views
10
 // Close floating panel button
11
 ui.removeCtrlView("log_close_ctrl")
12
 // Home button
13
 ui.removeCtrlView("main_page_ctrl")
14
 // Script start/stop button
15
 ui.removeCtrlView("script_status_ctrl")
16
 // Log window button
17
 ui.removeCtrlView("log_window_ctrl")
18
 // Exit script button
19
 ui.removeCtrlView("system_power_ctrl")
20
 // Add custom button
21
 ui.addCtrlView("tag", "res/a.png", 32, 32, 0, function (v) {
22
 logd(v);
23
 // Start script
24
 ui.start();
25
 })
26
 })
27
 ui.run(3000, function () {
28
 // Remove all control views
29
 ui.removeAllCtrlView()
30
 })
31
 ui.run(5000, function () {
32
 // Reset to defaults
33
 ui.resetDefaultCtrlView()
34
 })
35
}
36

37
main();

Update Control Floating Window Button updateCtrlView

Update start/stop floating window button
Requires EC 6.6.0+
@param tag button tag
@param icon icon path under project res/, e.g. res/a.png
@param onClickListener click callback
@return boolean true = success, false = failure

1
function main() {
2
 ui.toast("UI toast function");
3
 var set = ui.layout("Parameter Settings", "main.xml");
4
 ui.layout("Other Notes", "main2.xml");
5
 ui.logd("Set UI result: " + set);
6
 ui.showCtrlWindow()
7
 // Use delay — showCtrlWindow is async
8
 ui.run(1000, function () {
9
 // Remove default control views
10
 // Close floating panel button
11
 ui.removeCtrlView("log_close_ctrl")
12
 // Home button
13
 ui.removeCtrlView("main_page_ctrl")
14
 // Script start/stop button
15
 ui.removeCtrlView("script_status_ctrl")
16
 // Log window button
17
 ui.removeCtrlView("log_window_ctrl")
18
 // Exit script button
19
 ui.removeCtrlView("system_power_ctrl")
20
 // Add custom button
21
 ui.addCtrlView("tag", "res/a.png", 32, 32, 0, function (v) {
22
 logd(v);
23
 // Start script
24
 ui.start();
25
 })
26
 })
27
 ui.run(3000, function () {
28
 // Update button action
29
 ui.updateCtrlView("tag", "res/ab.png", function (v) {
30
 logd("aaaa");
31

32
 })
33
 })
34

35
}
36

37
main();

Remove Control Floating Window Button removeCtrlView

Remove start/stop floating window button
Requires EC 6.0.0+
@param tag button tag
@return boolean true = success, false = failure

1
function main() {
2
 ui.toast("UI toast function");
3
 var set = ui.layout("Parameter Settings", "main.xml");
4
 ui.layout("Other Notes", "main2.xml");
5
 ui.logd("Set UI result: " + set);
6
 ui.showCtrlWindow()
7
 // Use delay — showCtrlWindow is async
8
 ui.run(1000, function () {
9
 // Remove default control views
10
 // Close floating panel button
11
 ui.removeCtrlView("log_close_ctrl")
12
 // Home button
13
 ui.removeCtrlView("main_page_ctrl")
14
 // Script start/stop button
15
 ui.removeCtrlView("script_status_ctrl")
16
 // Log window button
17
 ui.removeCtrlView("log_window_ctrl")
18
 // Exit script button
19
 ui.removeCtrlView("system_power_ctrl")
20
 // Pause and resume
21
 ui.removeCtrlView("pause_ctrl")
22
 // Add custom button
23
 ui.addCtrlView("tag", "res/a.png", 32, 32, 0, function (v) {
24
 logd(v);
25
 // Start script
26
 ui.start();
27
 })
28
 })
29
 ui.run(3000, function () {
30
 // Remove all control views
31
 ui.removeAllCtrlView()
32
 })
33
 ui.run(5000, function () {
34
 // Reset to defaults
35
 ui.resetDefaultCtrlView()
36
 })
37
}
38

39
main();

Remove All Control Floating Window Buttons removeAllCtrlView

Remove all start/stop floating window buttons
Requires EC 6.0.0+
@return boolean true = success, false = failure

1
function main() {
2
 ui.toast("UI toast function");
3
 var set = ui.layout("Parameter Settings", "main.xml");
4
 ui.layout("Other Notes", "main2.xml");
5
 ui.logd("Set UI result: " + set);
6
 ui.showCtrlWindow()
7
 // Use delay — showCtrlWindow is async
8
 ui.run(1000, function () {
9
 // Remove default control views
10
 // Close floating panel button
11
 ui.removeCtrlView("log_close_ctrl")
12
 // Home button
13
 ui.removeCtrlView("main_page_ctrl")
14
 // Script start/stop button
15
 ui.removeCtrlView("script_status_ctrl")
16
 // Log window button
17
 ui.removeCtrlView("log_window_ctrl")
18
 // Exit script button
19
 ui.removeCtrlView("system_power_ctrl")
20
 // Add custom button
21
 ui.addCtrlView("tag", "res/a.png", 32, 32, 0, function (v) {
22
 logd(v);
23
 // Start script
24
 ui.start();
25
 })
26
 })
27
 ui.run(3000, function () {
28
 // Remove all control views
29
 ui.removeAllCtrlView()
30
 })
31
 ui.run(5000, function () {
32
 // Reset to defaults
33
 ui.resetDefaultCtrlView()
34
 })
35
}
36

37
main();

Reset Control Floating Window Buttons resetDefaultCtrlView

Reset start/stop floating window buttons
Requires EC 6.0.0+
@return boolean true = success, false = failure

1
function main() {
2
 ui.toast("UI toast function");
3
 var set = ui.layout("Parameter Settings", "main.xml");
4
 ui.layout("Other Notes", "main2.xml");
5
 ui.logd("Set UI result: " + set);
6
 ui.showCtrlWindow()
7
 // Use delay — showCtrlWindow is async
8
 ui.run(1000, function () {
9
 // Remove default control views
10
 // Close floating panel button
11
 ui.removeCtrlView("log_close_ctrl")
12
 // Home button
13
 ui.removeCtrlView("main_page_ctrl")
14
 // Script start/stop button
15
 ui.removeCtrlView("script_status_ctrl")
16
 // Log window button
17
 ui.removeCtrlView("log_window_ctrl")
18
 // Exit script button
19
 ui.removeCtrlView("system_power_ctrl")
20
 // Add custom button
21
 ui.addCtrlView("tag", "res/a.png", 32, 32, 0, function (v) {
22
 logd(v);
23
 // Start script
24
 ui.start();
25
 })
26
 })
27
 ui.run(3000, function () {
28
 // Remove all control views
29
 ui.removeAllCtrlView()
30
 })
31
 ui.run(5000, function () {
32
 // Reset to defaults
33
 ui.resetDefaultCtrlView()
34
 })
35
}
36

37
main();

Show Log Floating Window showLogWindow

Show log floating window
@return boolean true = success, false = failure

1
function main() {
2
 var r = ui.hasFloatViewPermission();
3
 ui.logd("Has floating window permission:" + r)
4
 if (!r) {
5
 return
6
 }
7
 // Show floating window
8
 ui.showLogWindow();
9
 ui.logd("Showing message")
10
 // Dismiss on UI thread after 3 seconds
11
 ui.getHandler().postDelayed(function () {
12
 ui.closeLogWindow();
13
 }, 3000);
14
}
15

16
main();

Close Log Floating Window closeLogWindow

Close log floating window
@return boolean true = success, false = failure

1
function main() {
2
 var r = ui.hasFloatViewPermission();
3
 ui.logd("Has floating window permission:" + r)
4
 if (!r) {
5
 return
6
 }
7
 // Show floating window
8
 ui.showLogWindow();
9
 ui.logd("Showing message")
10
 // Dismiss on UI thread after 3 seconds
11
 ui.getHandler().postDelayed(function () {
12
 ui.closeLogWindow();
13
 }, 3000);
14
}
15

16
main();

Show Script Pause Control Floating Window showScriptCtrlFloatView

Show script pause control floating window
Requires EC 10.0.0+

1
function main() {
2
 var r = ui.hasFloatViewPermission();
3
 ui.logd("Has floating window permission:" + r)
4
 if (!r) {
5
 return
6
 }
7
 // Show floating window
8
 ui.showScriptCtrlFloatView();
9
 // Dismiss on UI thread after 3 seconds
10
 ui.getHandler().postDelayed(function () {
11
 ui.closeScriptCtrlFloatView();
12
 }, 3000);
13
}
14

15
main();

Close Script Pause Control Floating Window closeScriptCtrlFloatView

Close script pause control floating window
Requires EC 10.0.0+

1
function main() {
2
 var r = ui.hasFloatViewPermission();
3
 ui.logd("Has floating window permission:" + r)
4
 if (!r) {
5
 return
6
 }
7
 // Show floating window
8
 ui.showScriptCtrlFloatView();
9
 // Dismiss on UI thread after 3 seconds
10
 ui.getHandler().postDelayed(function () {
11
 ui.closeScriptCtrlFloatView();
12
 }, 3000);
13
}
14

15
main();

Script Launch

Is Accessibility Mode isAccMode

Whether running in accessibility mode
@return boolean true = yes, false = no

1
function main() {
2
 ui.logd("Accessibility mode: " + ui.isAccMode());
3
 ui.logd("Agent mode: " + ui.isAgentMode());
4

5
 // Set running mode
6
 ui.setRunningMode(1);
7

8
 ui.logd("Accessibility mode: " + ui.isAccMode());
9
 ui.logd("Agent mode: " + ui.isAgentMode());
10
}
11

12
main();

Is Agent Mode isAgentMode

Whether running in agent mode
@return boolean true = yes, false = no

1
function main() {
2
 ui.logd("Accessibility mode: " + ui.isAccMode());
3
 ui.logd("Agent mode: " + ui.isAgentMode());
4

5
 // Set running mode
6
 ui.setRunningMode(1);
7

8
 ui.logd("Accessibility mode: " + ui.isAccMode());
9
 ui.logd("Agent mode: " + ui.isAgentMode());
10
}
11

12
main();

Is Automation Service Running isServiceOk

Whether automation service is running
@return boolean true = yes, false = no

1
function main() {
2
 ui.logd("Accessibility mode: " + ui.isAccMode());
3
 ui.logd("Agent mode: " + ui.isAgentMode());
4

5
 // Set running mode
6
 ui.setRunningMode(1);
7

8
 ui.logd("Accessibility mode: " + ui.isAccMode());
9
 ui.logd("Agent mode: " + ui.isAgentMode());
10

11

12
 var ok = ui.isServiceOk();
13
 if (!ok) {
14
 ui.startEnvAsync(function (r) {
15
 ui.logd("Start environment result: " + r);
16

17
 });
18
 }
19
}
20

21
main();

Set Running Mode setRunningMode

Set running mode
@param mode 1 = agent mode, 2 = accessibility mode
@return boolean true = yes, false = no

1
function main() {
2
 ui.logd("Accessibility mode: " + ui.isAccMode());
3
 ui.logd("Agent mode: " + ui.isAgentMode());
4

5
 // Set running mode
6
 ui.setRunningMode(1);
7

8
 ui.logd("Accessibility mode: " + ui.isAccMode());
9
 ui.logd("Agent mode: " + ui.isAgentMode());
10
}
11

12
main();

Start Automation Environment Async startEnvAsync

Start automation environment
@return boolean true = started, false = failed

1
function main() {
2
 var ok = ui.isServiceOk();
3
 if (!ok) {
4
 ui.startEnvAsync(function (r) {
5
 ui.logd("Start environment result: " + r);
6
 });
7
 }
8
}
9

10
main();

Start Script start

Start script
@return boolean true = started, false = failed

1
function main() {
2
 ui.layout("Parameter Settings", "main.xml");
3
// XML has tag=startBtn button
4
// Start script button
5
 ui.setEvent(ui.startBtn, "click", function (view) {
6
 ui.start();
7
 });
8
}
9

10
main();

Stop Script stopTask

Stop script
@return boolean true = started, false = failed

1
function main() {
2
 ui.layout("Parameter Settings", "main.xml");
3
 // XML has tag=stopBtn button
4
 // Start script button
5
 ui.setEvent(ui.stopBtn, "click", function (view) {
6
 ui.stopTask();
7
 });
8
}
9

10
main();

Set Script Pause or Resume setScriptPause

Pause or resume script
Requires EC 10.0.0+
@param pause true = pause, false = resume
@param timeout auto-resume delay in ms — 0 = wait for external resume, >0 = auto-resume after delay
@return {boolean} true = paused, false = running

1
function main() {
2
 ui.layout("Parameter Settings", "main.xml");
3
 // XML has tag=stopBtn button
4
 // Start script button
5
 ui.setEvent(ui.cbtn, "click", function (view) {
6
 ui.setScriptPause(true, 0);
7
 });
8
}
9

10
main();

Is Script Paused isScriptPause

Whether script is paused
Requires EC 10.0.0+
@return {boolean} true = paused

1
function main() {
2
 ui.layout("Parameter Settings", "main.xml");
3
 // Start script button
4
 ui.setEvent(ui.cBtn, "click", function (view) {
5
 // Toggle pause/resume on click
6
 // Demo only
7
 ui.setScriptPause(!ui.isScriptPause(), 0);
8
 });
9
}
10

11
main();

Is Script Running isScriptRunning

Whether script is running
@return boolean true = started, false = failed

1
function main() {
2
 ui.layout("Parameter Settings", "main.xml");
3
 // XML has tag=startBtn button
4
 logd("Running state -{}", ui.isScriptRunning())
5
}
6

7
main();

Scheduled Tasks

Start Scheduled Task startJob

Start a scheduled script task
@param tag unique task ID — use readConfigString(“jobTaskTag”) in script to identify the task
@param execTime schedule time as 2020-04-17 19:20:00, or seconds as string e.g. “3” for 3 seconds later
@param cancelBeforeRunning
@return integer job ID

1
function main() {
2
 var set = ui.layout("Parameter Settings", "main.xml");
3
 // Scheduled task by datetime
4
 var time = "2020-05-15 15:47:00";
5
 var tag = "job1";
6
 var jobid = ui.startJob(tag, time, true);
7
 ui.logd("Scheduled task by datetime:" + jobid)
8

9
 // Run after N seconds
10
 var time2 = "10";
11
 var tag2 = "job2";
12
 var jobid2 = ui.startJob(tag2, time2, false);
13
 ui.logd("Run after seconds:" + jobid2)
14

15
 var tags = ui.getAllJobTag();
16
 ui.logd("Scheduled task tags:" + tags)
17

18
 // Cancel tasks
19
 ui.cancelAllJob();
20
 // Cancel task by tag
21
 ui.cancelJob("job2");
22
}
23

24
main();

Cancel Scheduled Task cancelJob

Cancel task by tag
@param tag tag
@return boolean true = success, false = failure

1
function main() {
2
 var set = ui.layout("Parameter Settings", "main.xml");
3
 // Scheduled task by datetime
4
 var time = "2020-05-15 15:47:00";
5
 var tag = "job1";
6
 var jobid = ui.startJob(tag, time, true);
7
 ui.logd("Scheduled task by datetime:" + jobid)
8

9
 // Run after N seconds
10
 var time2 = "10";
11
 var tag2 = "job2";
12
 var jobid2 = ui.startJob(tag2, time2, false);
13
 ui.logd("Run after seconds:" + jobid2)
14

15
 var tags = ui.getAllJobTag();
16
 ui.logd("Scheduled task tags:" + tags)
17

18
 // Cancel tasks
19
 ui.cancelAllJob();
20
 // Cancel task by tag
21
 ui.cancelJob("job2");
22
}
23

24
main();

Cancel All Scheduled Tasks cancelAllJob

Cancel all scheduled tasks
@return boolean true = success, false = failure

1
function main() {
2
 var set = ui.layout("Parameter Settings", "main.xml");
3
 // Scheduled task by datetime
4
 var time = "2020-05-15 15:47:00";
5
 var tag = "job1";
6
 var jobid = ui.startJob(tag, time, true);
7
 ui.logd("Scheduled task by datetime:" + jobid)
8

9
 // Run after N seconds
10
 var time2 = "10";
11
 var tag2 = "job2";
12
 var jobid2 = ui.startJob(tag2, time2, false);
13
 ui.logd("Run after seconds:" + jobid2)
14

15
 var tags = ui.getAllJobTag();
16
 ui.logd("Scheduled task tags:" + tags)
17

18
 // Cancel tasks
19
 ui.cancelAllJob();
20
 // Cancel task by tag
21
 ui.cancelJob("job2");
22
}
23

24
main();

Get All Scheduled Task Tags getAllJobTag

Get all scheduled task tags
@return JSON string

1
function main() {
2
 var set = ui.layout("Parameter Settings", "main.xml");
3
 // Scheduled task by datetime
4
 var time = "2020-05-15 15:47:00";
5
 var tag = "job1";
6
 var jobid = ui.startJob(tag, time, true);
7
 ui.logd("Scheduled task by datetime:" + jobid)
8

9
 // Run after N seconds
10
 var time2 = "10";
11
 var tag2 = "job2";
12
 var jobid2 = ui.startJob(tag2, time2, false);
13
 ui.logd("Run after seconds:" + jobid2)
14

15
 var tags = ui.getAllJobTag();
16
 ui.logd("Scheduled task tags:" + tags)
17

18
 // Cancel tasks
19
 ui.cancelAllJob();
20
 // Cancel task by tag
21
 ui.cancelJob("job2");
22
}
23

24
main();

Other Extensions

setAgentSupportNode Set Node Retrieval Mode in Agent Mode

Set node retrieval mode in agent mode
Only applies in agent mode
EC Android 11.2.0+
Call before starting agent service — modes 2 and 3 reduce detection signatures
Mode 1 may trigger ruru detection of AccessibilityManager.isEnabled; modes 2+ do not
Mode 1 has strongest node support; mode 2 is weaker; mode 3 disables nodes
@param support 1 = accessibility-like, 2 = shell dump, 3 = disable node service
@return {boolean} true = success, false = failure

1
function main() {
2
 ui.setAgentSupportNode("2");
3
}
4

5
main();

setWebViewType Switch WebView Engine

Requires EC 5.16.0+
Set WebView engine type — default is X5 browser
@param type 1 = system WebView, 2 = X5 browser
@return boolean true = success, false = failure

1
// Injection in ui.js
2
function main() {
3
ui.setWebViewType(2)
4
ui.layout("main", "main.html");
5
}
6

7
main();

registeH5Function Inject Extension Function into H5

Inject a JS function into the web page for H5/script/HTML interoperability
@param funcName injected function name
@param callback callback — see common example
@return boolean true = success, false = failure

1
// Injection in ui.js
2
function main() {
3
 // Register new extension in UI
4
 ui.registeH5Function("customFunction", function (data) {
5
 logd("h5 call-" + data);
6
 // Data returned to web page
7
 return new Date().toString()
8
 })
9
 ui.layout("main", "main.html");
10
}
11

12
main();

Calling from the web page

1
<!DOCTYPE html>
2
<html lang="en">
3
<head>
4
 <meta charset="UTF-8">
5
 <title>Title</title>
6
</head>
7
<body>
8
<button onclick="test()">Test Extension Function</button>
9
<script>
10
 function test() {
11
 // Call extension injected from ui.js
12
 let d = window.ec.call('customFunction', JSON.stringify({'action': 'android.settings.SETTINGS'}));
13
 console.log("ddd " + d)
14
 }
15
</script>
16
</body>
17
</html>

unregisteH5Function Unregister H5 Injected JS Function

Unregister an injected JS function from the web page
@param funcName injected function name
@return boolean true = success, false = failure

1
// Injection in ui.js
2
function main() {
3
 // Register new extension in UI
4
 ui.registeH5Function("customFunction", function (data) {
5
 logd("h5 call-" + data);
6
 })
7
 ui.layout("main", "main.html");
8

9
 ui.unregisteH5Function("customFunction");
10

11
}
12

13
main();

onActivityEvent Listen to Activity State

Listen to Activity events for the UI
@param eventType onResume, onPause, onStop, onDestroy, onActivityResult
@param callback callback

1
function main() {
2
 // Listen to Activity events
3
 ui.onActivityEvent("onResume", function (eventType) {
4
 // Check whether service is running
5
 ui.logd("activity onResume " + ui.isServiceOk());
6
 });
7

8
 ui.onActivityEvent("onPause", function (eventType) {
9
 ui.logd("activity onPause");
10
 });
11

12
 ui.onActivityEvent("onStop", function (eventType) {
13
 ui.logd("activity onStop");
14
 });
15
 ui.onActivityEvent("onDestroy", function (eventType) {
16
 ui.logd("activity onDestroy");
17
 });
18

19

20
 // See Android docs for parameters
21
 // protected void onActivityResult(int requestCode, int resultCode, @Nullable Intent data)
22
 ui.onActivityEvent("onActivityResult", function (requestCode, resultCode, data) {
23
 ui.logd("activity onDestroy");
24
 });
25
}
26

27
main();

getActivity UI Activity

Get current Activity object
@return Activity object or null

1
function main() {
2
 var activity = ui.getActivity();
3
 ui.logd("activity " + activity);
4
 // Android context is available globally
5
 importPackage(android.widget);
6
 importPackage(android.graphics);
7
 // Use Java objects directly
8
 var tv = new android.widget.TextView(context);
9
 tv.setText("Text from JS/Java interaction");
10
 tv.setTextColor(Color.parseColor("#888888"))
11
 activity.setContentView(tv);
12
}
13

14
main();

getHandler Native Handler

Get current Handler object
@return Handler object or null

1
function main() {
2
 // Show floating window
3
 ui.showLogWindow();
4
 ui.logd("Showing message")
5
 // Dismiss on UI thread after 3 seconds
6
 ui.getHandler().postDelayed(function () {
7
 ui.closeLogWindow();
8
 }, 3000);
9
}
10

11
main();

run UI Thread Async Task

Run on UI thread — equivalent to getHandler.post
@param delayTime delay in ms — 0 runs immediately
@param callback callback

1
function main() {
2
 ui.run(30, function () {
3
 logd("Fsdfsd");
4
 })
5
 sleep(1000)
6
}
7

8
main();

setECSystemConfig Set EC System Parameters

Set EC system parameters
@param params map e.g. {"running_mode":"accessibility"}

1
{
2
 "running_mode": "accessibility",
3
 "auto_start_service": "Yes",
4
 "volume_start_tc": "No",
5
 "log_float_window": "No",
6
 "ctrl_float_window": "No",
7
 "service_start_run_script": "No"
8
}

Parameter reference:
running_mode: accessibility or agent
auto_start_service: Yes or No — start service on boot
log_float_window: Yes or No — show log floating window
ctrl_float_window: Yes or No — show start/stop control floating window
service_start_run_script: Yes or No — auto rerun script after service restart
home_key_start_stop: Yes or No — triple-tap HOME to start/stop script
@return boolean true = yes, false = no

1
function main() {
2
 var m = {
3
 "running_mode": "accessibility",
4
 "auto_start_service": "Yes",
5
 "log_float_window": "No",
6
 "ctrl_float_window": "No"
7
 };
8
 ui.setECSystemConfig(m);
9
}
10

11
main();

openECSystemSetting Open EC System Settings

Open EC system settings
@return boolean true = success, false = failure

1
function main() {
2
 ui.openECSystemSetting();
3
}
4

5
main();

openActivity Open Other Applications

Open an Activity via map parameters
@param map e.g. {"action":""} — fixed keys:
action,
uri, pkg, className, flag — remaining keys are extras
@return boolean true = success, false = failure

1
function main() {
2
 // Open APK installer
3
 var m = {
4
 "action": "android.intent.action.VIEW",
5
 "uri": "file:///sdcard/a.apk",
6
 "type": "application/vnd.android.package-archive"
7
 };
8
 var x = ui.openActivity(m);
9
 ui.logd("x " + x);
10

11
 var map = {
12
 "uri": "xx://xx/live/6701887916223941379",
13
 };
14
 ui.openActivity(map);
15
}
16

17
main();