keyboard

hiddenKeyboard closeKeyboard openCustomKeyboard showCustomKeyboard

概述

本模块封装了原生的数字键盘,26位字母键盘功能，方便开发者使用自定义的数字键盘布局。实现了数字键盘数字，小数点，删除按钮的监听，开发者对监听结果进行解析处理，实现自己的密码输入或者金额，字母等特殊需求输入等功能。

openKeyboard

打开自定义的数字键盘界面。键盘的默认高度为203。位置的设置请自己进行处理。

openKeyboard({params},callback(ret, err))

x：

• 类型：数字类型
• 描述：（必填项）模块左上角的 x 坐标（相对于所属的 Window 或 Frame）
• 默认值：0

y：

• 类型：数字类型
• 描述：（必填项）模块左上角的 y 坐标（相对于所属的 Window 或 Frame）
• 默认值：0

dotLable：

• 类型：字符串
• 描述：（可选项）自定义数字键盘dot显示文本
• 默认值：.

fixedOn：

• 类型：字符串
• 描述：（可选项）模块所属 Frame 的名字，若不传则模块归属于当前 Window

fixed：

• 类型：布尔
• 描述：（（可选项）模块是否随所属 Window 或 Frame 滚动
• 默认值：true（不随之滚动）

callback(ret, err)

ret：

• 类型：JSON对象
• 内部字段：

示例代码

    x : 0,
    y : api.frameHeight - 203,
    fixedOn : api.frameName,
    fixed : true
}, function(ret, err) {
    if (ret.enenType == 'click') {
        api.toast({msg : JSON.stringify(ret)});
    } else {
        api.toast({msg : JSON.stringify(ret)});
    }
});

可用性

iOS,Android系统

可提供的1.0.0及更高版本

hiddenKeyboard

隐藏数字键盘

hiddenKeyboard(callback(ret, err))

callback(ret, err)

ret：

• 类型：JSON对象
• 内部字段：

{
    status: true   //布尔型；true||false
}

err：

• 类型：JSON对象
• 内部字段：

{
    msg: ""
}

示例代码

demo.hiddenKeyboard(function(ret, err) {
    api.toast({
        msg : JSON.stringify(ret)
    });
});

可用性

iOS,Android系统

可提供的1.0.0及更高版本

showKeyboard

显示被隐藏的数字键盘

showKeyboard(callback(ret, err))

callback(ret, err)

ret：

• 类型：JSON对象

{
    status: true   //布尔型；true||false
}

err：

• 类型：JSON对象
• 内部字段：

{
    msg: ""
}

示例代码

demo.showKeyboard(function(ret, err) {
    api.toast({
        msg : JSON.stringify(ret)
    });
});

可用性

iOS,Android系统

可提供的1.0.0及更高版本

closeKeyboard

关闭打开的数字键盘

ret：

• 类型：JSON对象
• 内部字段：

err：

• 类型：JSON对象
• 内部字段：

{
    msg: ""
}

示例代码

demo.closeKeyboard(function(ret, err) {
    api.toast({
        msg : JSON.stringify(ret)
    });

可用性

iOS,Android系统

可提供的1.0.0及更高版本

openEditText

打开自定义的文本编辑框，(注意：目前暂时只支持从文本最后删除和插入，不支持文本中进行插入和删除)。

openEditText({params},callback(ret, err))

params

x：

• 类型：数字类型
• 描述：（必填项）模块左上角的 x 坐标（相对于所属的 Window 或 Frame）
• 默认值：0

y：

• 类型：数字类型
• 描述：（必填项）模块左上角的 y 坐标（相对于所属的 Window 或 Frame）
• 默认值：0

w：

• 类型：数字类型
• 描述：（可选项）模块的宽度；默认：所属的 Window 或 Frame 的宽度

h：

• 类型：数字类型
• 描述：（可选项）模块的高度；默认：所属的 Window 或 Frame 的高度

fixedOn：

• 类型：字符串
• 描述：（可选项）模块所属 Frame 的名字，若不传则模块归属于当前 Window

fixed：

• 类型：布尔
• 描述：（（可选项）模块是否随所属 Window 或 Frame 滚动
• 默认值：true（不随之滚动）

message：

• 类型：字符串
• 描述：（可选项）默认要显示的文本消息内容。

placeholder：

• 类型：字符串
• 描述：（可选项）当内容为空时显示的文本提示内容。

callback(ret, err)

ret：

• 类型：JSON对象
• 内部字段：

{
    status: true,   //布尔型；true||false
    enenType : 'open' //open 打开输入框
                     //touch 点击输入框，进入编辑模式，此时可以调用显示键盘
}

示例代码

demo.openEditText({
    x : 0,
    y : 0,
    h: 100,
    fixedOn : api.frameName,
    fixed : true,
    message : "消息记录。",
    placeholder : "你想说点什么？"
},function(ret, err) {
    if(ret.enenType=='touch'){
        openCustomKeyboard();
    }
    api.toast({
        msg : JSON.stringify(ret)
    });
});

可用性

iOS,Android系统

可提供的1.0.0及更高版本

openCustomKeyboard

打开自定义的26位字母键盘界面。键盘的默认高度为203。位置的设置请自己进行处理。

openCustomKeyboard({params},callback(ret, err))

params

x：

• 类型：数字类型
• 描述：（必填项）模块左上角的 x 坐标（相对于所属的 Window 或 Frame）
• 默认值：0

y：

• 类型：数字类型
• 描述：（必填项）模块左上角的 y 坐标（相对于所属的 Window 或 Frame）
• 默认值：0

fixedOn：

• 类型：字符串
• 描述：（可选项）模块所属 Frame 的名字，若不传则模块归属于当前 Window

fixed：

• 类型：布尔
• 描述：（可选项）模块是否随所属 Window 或 Frame 滚动
• 默认值：true（不随之滚动）

altLabel1：

• 类型：字符串
• 描述：（可选项）默认键盘时左下角alt键按显示文字
• 默认值：符号

altLabel2：

• 类型：字符串
• 描述：（可选项）alt键按切换后左下角显示文字
• 默认值：英文

• 描述：（可选项）右下角键按显示文字
• 默认值：确定

spaceLabel：

• 类型：字符串
• 描述：（可选项）空格键按钮显示文字
• 默认值：空格

charDefault：

• 类型：数组
• 描述：（必须项）默认显示在键盘上的信息，长度必须位26，可为小写26字母

charShift：

• 类型：数组
• 描述：（必须项）点击shift按钮切换在键盘上的信息，长度必须位26，可为大写26字母

charAlt：

• 类型：数组
• 描述：（必须项）点击alt按钮切换在键盘上的信息，长度必须位26，可为数字和特殊符号集合

callback(ret, err)

ret：

• 类型：JSON对象
• 内部字段：

{
    status: true,   //布尔型；true||false
    enenType : 'open', //open 打开键盘
                     //click 点击键盘按键返回
                     //space 空格
                     //delete 删除
                     //longDelete 长按删除(安卓无效)
                     //return 确定
    value : 1, //点击数字时有效
    completeValue : '',//缓存当前已经输入的文本内容
    height : 203 //键盘真实高度,安卓此值不同手机有细微差别，请注意
}

示例代码

demo.openCustomKeyboard({
    x : 0,
    y : api.frameHeight - 203,
    fixedOn : api.frameName,
    fixed : true,            
    altLabel1 : '符号',
    altLabel2 : '英文',
    spaceLabel : '空格',
    charDefault : ['q','w','e','r','t','y','u','i','o','p','a','s','d','f','g','h','j','k','l','z','x','c','v','b','n','m'],
    charShift : ['Q','W','E','R','T','Y','U','I','O','P','A','S','D','F','G','H','J','K','L','Z','X','C','V','B','N','M'],
    charAlt : ['1','2','3','4','5','6','7','8','9','0','-','+','{','}','|','\\',':','"','<','>','?','~','!','@','#','$'],
}, function(ret, err) {
    if (ret.enenType == 'click') {
        api.toast({
            msg : JSON.stringify(ret)+"  "+JSON.stringify(err)
        });
});

iOS,Android系统

可提供的1.0.0及更高版本

hiddenCustomKeyboard

隐藏字母键盘

hiddenCustomKeyboard(callback(ret, err))

callback(ret, err)

ret：

• 类型：JSON对象
• 内部字段：

{
    status: true   //布尔型；true||false
}

err：

• 类型：JSON对象
• 内部字段：

示例代码

demo.hiddenCustomKeyboard(function(ret, err) {
    api.toast({
        msg : JSON.stringify(ret)
    });
});

可用性

iOS,Android系统

可提供的1.0.0及更高版本

showCustomKeyboard

显示被隐藏的字母键盘

showCustomKeyboard(callback(ret, err))

callback(ret, err)

ret：

• 类型：JSON对象
• 内部字段：

{
    status: true   //布尔型；true||false
}

err：

• 类型：JSON对象
• 内部字段：

{
    msg: ""
}

示例代码

demo.showCustomKeyboard(function(ret, err) {
    api.toast({
        msg : JSON.stringify(ret)
    });
});

可用性

iOS,Android系统

可提供的1.0.0及更高版本

closeCustomKeyboard

关闭打开的字母键盘

closeCustomKeyboard(callback(ret, err))

callback(ret, err)

ret：

• 类型：JSON对象
• 内部字段：

{
    status: true   //布尔型；true||false
}

err：

• 类型：JSON对象
• 内部字段：

{
    msg: ""
}

示例代码

demo.closeCustomKeyboard(function(ret, err) {
    api.toast({
        msg : JSON.stringify(ret)
    });

可用性

iOS,Android系统

可提供的1.0.0及更高版本