Overlay Functions

Overview

Overlay module functions manage floating overlays
The overlay module uses the floaty prefix, e.g. floaty.requestFloatViewPermission()

floaty.requestFloatViewPermission Request Overlay Permission

Request overlay permission
@return bool true on success

1
function main() {
2
    let tag = "123";
3
    // Close overlay with tag=123
4
    floaty.close(tag)
5
    // Request permission
6
    let p = floaty.requestFloatViewPermission(1000)
7
    logd("Has overlay permission: " + p);
8
    if (!p) {
9
        loge("No overlay permission, aborting");
10
        return;
11
    }
12

13
    sleep(1000);
14
    // Show main.xml view and return the native Android object
15
    let view = floaty.showFloatXml(tag, "main.xml", 100, 100);
16

17
    logd(view);
18
    if (view) {
19
        // Find view with tag=web in overlay (example)
20
        //let web = view.findViewWithTag("web")
21
    }
22

23
    sleep(2000)
24
    // Update size
25
    floaty.updateSize(tag, 800, 1800)
26

27
    sleep(2000)
28
    // Update X position
29
    floaty.updateX(tag, 100)
30

31
    sleep(2000)
32
    // Update Y position
33
    floaty.updateY(tag, 100)
34
    sleep(2000)
35
    // Set non-touchable
36
    floaty.touchable(tag, false)
37
    sleep(10000)
38
    // Set touchable
39
    floaty.touchable(123, true)
40
}
41

42
main();

floaty.showFloatXml Show an XML Overlay

Show an XML overlay
@param tag Overlay tag
@param xml XML path or content
@param x Starting X position
@param y Starting Y position
@return {View} Android View object

1
function main() {
2
 let tag = "123";
3
 floaty.close(tag)
4
 let p = floaty.requestFloatViewPermission(1000)
5
 logd("Has overlay permission: " + p);
6
 if (!p) {
7
 loge("No overlay permission, aborting");
8
 return;
9
 }
10
 sleep(1000);
11
 let view = floaty.showFloatXml(tag, "main.xml", 100, 100);
12
 logd(view);
13
 if (view) {
14
 //let web = view.findViewWithTag("web")
15
 }
16
}
17

18
main();

floaty.showFloatView Show a View Overlay

Show a View overlay
@param tag Overlay tag
@param view Android View object
@param x Starting X position
@param y Starting Y position
@return {View} Android View object

1
function main() {
2
 let tag = "123";
3
 floaty.close(tag)
4
 let p = floaty.requestFloatViewPermission(1000)
5
 logd("Has overlay permission: " + p);
6
 if (!p) {
7
 loge("No overlay permission, aborting");
8
 return;
9
 }
10
 sleep(1000);
11
 importPackage(android.widget)
12
 importPackage(android.graphics)
13
 let tv = new TextView(context);
14
 tv.setText("TEST");
15
 tv.setBackgroundColor(Color.parseColor("#336699"))
16
 let view = floaty.showFloatView(tag, tv, 100, 100);
17
 logd(view);
18
}
19

20
main();

floaty.updateX Set Overlay X Position

Set overlay X position
@param tag Overlay tag
@param x X position
@return {bool} true on success, false on failure

1
function main() {
2
 let tag = "123";
3
 floaty.close(tag)
4
 let p = floaty.requestFloatViewPermission(1000)
5
 logd("Has overlay permission: " + p);
6
 if (!p) {
7
 loge("No overlay permission, aborting");
8
 return;
9
 }
10
 sleep(1000);
11
 let view = floaty.showFloatXml(tag, "main.xml", 100, 100);
12
 logd(view);
13
 sleep(2000)
14
 floaty.updateSize(tag, 800, 1800)
15
 sleep(2000)
16
 floaty.updateX(tag, 100)
17
 sleep(2000)
18
 floaty.updateY(tag, 100)
19
 sleep(2000)
20
 floaty.touchable(tag, false)
21
 sleep(10000)
22
 floaty.touchable(123, true)
23
}
24

25
main();

floaty.updateY Set Overlay Y Position

Set overlay Y position
@param tag Overlay tag
@param y Y position
@return {bool} true on success, false on failure

1
function main() {
2
 let tag = "123";
3
 floaty.close(tag)
4
 let p = floaty.requestFloatViewPermission(1000)
5
 logd("Has overlay permission: " + p);
6
 if (!p) {
7
 loge("No overlay permission, aborting");
8
 return;
9
 }
10
 sleep(1000);
11
 let view = floaty.showFloatXml(tag, "main.xml", 100, 100);
12
 logd(view);
13
 sleep(2000)
14
 floaty.updateSize(tag, 800, 1800)
15
 sleep(2000)
16
 floaty.updateX(tag, 100)
17
 sleep(2000)
18
 floaty.updateY(tag, 100)
19
 sleep(2000)
20
 floaty.touchable(tag, false)
21
 sleep(10000)
22
 floaty.touchable(123, true)
23
}
24

25
main();

floaty.updateSize Set Overlay Size

Set overlay size
@param tag Overlay tag
@param w width
@param h height
@return {bool} true on success, false on failure

1
function main() {
2
 let tag = "123";
3
 floaty.close(tag)
4
 let p = floaty.requestFloatViewPermission(1000)
5
 logd("Has overlay permission: " + p);
6
 if (!p) {
7
 loge("No overlay permission, aborting");
8
 return;
9
 }
10
 sleep(1000);
11
 let view = floaty.showFloatXml(tag, "main.xml", 100, 100);
12
 logd(view);
13
 sleep(2000)
14
 floaty.updateSize(tag, 800, 1800)
15
 sleep(2000)
16
 floaty.updateX(tag, 100)
17
 sleep(2000)
18
 floaty.updateY(tag, 100)
19
 sleep(2000)
20
 floaty.touchable(tag, false)
21
 sleep(10000)
22
 floaty.touchable(123, true)
23
}
24

25
main();

floaty.close Close Overlay

Close overlay
@param tag Overlay tag
@return {bool} true on success, false on failure

1
function main() {
2
 let tag = "123";
3
 floaty.close(tag)
4
 let p = floaty.requestFloatViewPermission(1000)
5
 logd("Has overlay permission: " + p);
6
 if (!p) {
7
 loge("No overlay permission, aborting");
8
 return;
9
 }
10
 sleep(1000);
11
 let view = floaty.showFloatXml(tag, "main.xml", 100, 100);
12
 logd(view);
13
 sleep(2000)
14
 floaty.updateSize(tag, 800, 1800)
15
 sleep(2000)
16
 floaty.updateX(tag, 100)
17
 sleep(2000)
18
 floaty.updateY(tag, 100)
19
 sleep(2000)
20
 floaty.touchable(tag, false)
21
 sleep(10000)
22
 floaty.touchable(123, true)
23
}
24

25
main();

floaty.touchable Set Overlay Touch State

Set overlay touchable
@param touchable Touchable: true = touchable, false = not touchable
@return {bool} true on success, false on failure

1
function main() {
2
 let tag = "123";
3
 floaty.close(tag)
4
 let p = floaty.requestFloatViewPermission(1000)
5
 logd("Has overlay permission: " + p);
6
 if (!p) {
7
 loge("No overlay permission, aborting");
8
 return;
9
 }
10
 sleep(1000);
11
 let view = floaty.showFloatXml(tag, "main.xml", 100, 100);
12
 logd(view);
13
 sleep(2000)
14
 floaty.updateSize(tag, 800, 1800)
15
 sleep(2000)
16
 floaty.updateX(tag, 100)
17
 sleep(2000)
18
 floaty.updateY(tag, 100)
19
 sleep(2000)
20
 floaty.touchable(tag, false)
21
 sleep(10000)
22
 floaty.touchable(123, true)
23
}
24

25
main();

floaty.focusable Set Overlay Focus State

Set overlay focusable (required for input fields to receive focus)
@param focusable Focusable: true = focusable, false = not focusable
@return {bool} true on success, false on failure

1
function main() {
2
 let tag = "123";
3
 floaty.close(tag)
4
 let p = floaty.requestFloatViewPermission(1000)
5
 logd("Has overlay permission: " + p);
6
 if (!p) {
7
 loge("No overlay permission, aborting");
8
 return;
9
 }
10
 sleep(1000);
11
 let view = floaty.showFloatXml(tag, "main.xml", 100, 100);
12
 floaty.focusable(tag, true)
13
 logd(view);
14
 sleep(2000)
15
 floaty.updateSize(tag, 800, 1800)
16
 sleep(2000)
17
 floaty.updateX(tag, 100)
18
 sleep(2000)
19
 floaty.updateY(tag, 100)
20
 sleep(2000)
21
 floaty.touchable(tag, false)
22
 sleep(10000)
23
 floaty.touchable(123, true)
24
}
25

26
main();

floaty.getX Get Overlay X Position

Get overlay X position
Supported EC 6.7.0+
@param tag Overlay tag
@return {int} -1 on failure; otherwise coordinate value

1
function main() {
2
    let tag = "123";
3
    floaty.close(tag)
4
    let p = floaty.requestFloatViewPermission(1000)
5
    logd("Has overlay permission: " + p);
6
    if (!p) {
7
    loge("No overlay permission, aborting");
8
    return;
9
        }
10
        sleep(1000);
11
    let view = floaty.showFloatXml(tag, "main.xml", 100, 100);
12
    floaty.focusable(tag, true)
13
    logd(view);
14
    view.measure(0, 0);
15
    sleep(2000)
16
    logd(floaty.getX(tag))
17
    logd(floaty.getY(tag))
18
    logd(floaty.getWidth(tag))
19
    logd(floaty.getHeight(tag))
20
}
21

22
main();

floaty.getY Get Overlay Y Position

Get overlay Y position
Supported EC 6.7.0+
@param tag Overlay tag
@return {int} -1 on failure; otherwise coordinate value

1
function main() {
2
 let tag = "123";
3
 floaty.close(tag)
4
 let p = floaty.requestFloatViewPermission(1000)
5
 logd("Has overlay permission: " + p);
6
 if (!p) {
7
 loge("No overlay permission, aborting");
8
 return;
9
 }
10
 sleep(1000);
11
 let view = floaty.showFloatXml(tag, "main.xml", 100, 100);
12
 floaty.focusable(tag, true)
13
 logd(view);
14
 view.measure(0, 0);
15
 sleep(2000)
16
 logd(floaty.getX(tag))
17
 logd(floaty.getY(tag))
18
 logd(floaty.getWidth(tag))
19
 logd(floaty.getHeight(tag))
20
}
21

22
main();

floaty.getWidth Get Overlay Width

Get overlay width
Supported EC 6.7.0+
@param tag Overlay tag
@return {int} -1 on failure; otherwise dimension value

1
function main() {
2
 let tag = "123";
3
 floaty.close(tag)
4
 let p = floaty.requestFloatViewPermission(1000)
5
 logd("Has overlay permission: " + p);
6
 if (!p) {
7
 loge("No overlay permission, aborting");
8
 return;
9
 }
10
 sleep(1000);
11
 let view = floaty.showFloatXml(tag, "main.xml", 100, 100);
12
 floaty.focusable(tag, true)
13
 logd(view);
14
 view.measure(0, 0);
15
 sleep(2000)
16
 logd(floaty.getX(tag))
17
 logd(floaty.getY(tag))
18
 logd(floaty.getWidth(tag))
19
 logd(floaty.getHeight(tag))
20
}
21

22
main();

floaty.getHeight Get Overlay Height

Get overlay height
Supported EC 6.7.0+
@param tag Overlay tag
@return {int} -1 on failure; otherwise dimension value

1
function main() {
2
 let tag = "123";
3
 floaty.close(tag)
4
 let p = floaty.requestFloatViewPermission(1000)
5
 logd("Has overlay permission: " + p);
6
 if (!p) {
7
 loge("No overlay permission, aborting");
8
 return;
9
 }
10
 sleep(1000);
11
 let view = floaty.showFloatXml(tag, "main.xml", 100, 100);
12
 floaty.focusable(tag, true)
13
 logd(view);
14
 view.measure(0, 0);
15
 sleep(2000)
16
 logd(floaty.getX(tag))
17
 logd(floaty.getY(tag))
18
 logd(floaty.getWidth(tag))
19
 logd(floaty.getHeight(tag))
20
}
21

22
main();