key.html 5.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145
  1. <!DOCTYPE HTML>
  2. <html>
  3. <head>
  4. <meta charset="utf-8">
  5. <meta name="viewport" content="initial-scale=1.0, minimum-scale=1.0, maximum-scale=1.0, user-scalable=no">
  6. <meta name="HandheldFriendly" content="true">
  7. <meta name="MobileOptimized" content="320">
  8. <title>Events Document</title>
  9. <link rel="stylesheet" type="text/css" href="res/doc.css" charset="utf-8">
  10. <link rel="stylesheet" type="text/css" href="res/prettify.sons.css" charset="utf-8">
  11. <script type="text/javascript" src="res/doc.js" charset="utf-8"></script><script type="text/javascript" src="res/prettify.js" charset="utf-8"></script>
  12. </head>
  13. <body><div id="content" class="content">
  14. <h1><a name="plus.key">key</a></h1>
  15. <p>Key管理设备按键事件</p>
  16. <h2>方法:</h2>
  17. <ul>
  18. <li>
  19. <a href="#plus.key.addEventListener">addEventListener</a>: 添加按键事件监听器</li>
  20. <li>
  21. <a href="#plus.key.hideSoftKeybord">hideSoftKeybord</a>: 隐藏软键盘</li>
  22. <li>
  23. <a href="#plus.key.setAssistantType">setAssistantType</a>: 设置辅助输入类型</li>
  24. <li>
  25. <a href="#plus.key.showSoftKeybord">showSoftKeybord</a>: 显示软键盘</li>
  26. <li>
  27. <a href="#plus.key.removeEventListener">removeEventListener</a>: 移除按键事件监听器</li>
  28. </ul>
  29. <h2>对象:</h2>
  30. <ul>
  31. <li>
  32. <a href="#plus.key.KeyType">KeyType</a>: 按键类型</li>
  33. <li>
  34. <a href="#plus.key.KeyEvent">KeyEvent</a>: 按键事件</li>
  35. </ul>
  36. <h2>回调方法:</h2>
  37. <ul><li>
  38. <a href="#plus.key.KeyEventCallback">KeyEventCallback</a>: 按键事件的回调函数</li></ul>
  39. <h2>权限:</h2>
  40. <p>5+功能模块(permissions)</p>
  41. <pre class="prettyprint linenums">
  42. {
  43. // ...
  44. "permissions":{
  45. // ...
  46. "Webview": {
  47. "description": "窗口管理"
  48. }
  49. }
  50. }
  51. </pre>
  52. <h1><a name="plus.key.KeyType">KeyType</a></h1>
  53. <p>按键类型</p>
  54. <h2>常量:</h2>
  55. <ul>
  56. <li>"backbutton": <em>(<font class="type">String</font>
  57. 类型
  58. )</em>设备“返回”按钮按键事件<br><p>
  59. 如果需要改变默认“返回”按钮的处理逻辑,则可通过plus.key.addEventListener来注册监听"backbutton"事件。
  60. </p>
  61. </li>
  62. <li>"keydown": <em>(<font class="type">String</font>
  63. 类型
  64. )</em>键按下事件<br><p>
  65. 如果需要改变默认键按下的处理逻辑,则可通过plus.key.addEventListener来注册监听"keydown"事件。
  66. 可通过回调函数中KeyEvent对象的keyCode来获取按下的键值。
  67. </p>
  68. </li>
  69. <li>"keyup": <em>(<font class="type">String</font>
  70. 类型
  71. )</em>键松开事件<br><p>
  72. 如果需要改变默认键松开的处理逻辑,则可通过plus.key.addEventListener来注册监听"keyup"事件。
  73. 可通过回调函数中KeyEvent对象的keyCode来获取松开的键值。
  74. </p>
  75. </li>
  76. <li>"longpressed": <em>(<font class="type">String</font>
  77. 类型
  78. )</em>长按键事件<br><p>
  79. 如果需要改变默认长按键的处理逻辑,则可通过plus.key.addEventListener来注册监听"longpressed"事件。
  80. 长按键时会多次触发回调函数,通过回调函数中KeyEvent对象的keyCode来获取长按的键值。
  81. </p>
  82. </li>
  83. <li>"menubutton": <em>(<font class="type">String</font>
  84. 类型
  85. )</em>设备“菜单”按钮按键事件<br><p>
  86. 如果需要改变默认“菜单”按钮的处理逻辑,则可通过plus.key.addEventListener来注册监听"menubutton"事件。
  87. </p>
  88. </li>
  89. <li>"searchbutton": <em>(<font class="type">String</font>
  90. 类型
  91. )</em>设备“搜索”按钮按键事件<br><p>
  92. 如果需要改变默认“搜索”按钮的处理逻辑,则可通过plus.key.addEventListener来注册监听"searchbutton"事件。
  93. </p>
  94. </li>
  95. <li>"volumeupbutton": <em>(<font class="type">String</font>
  96. 类型
  97. )</em>设备“音量+”按钮按键事件<br><p>
  98. 如果需要改变默认“音量+”按钮的处理逻辑,则可通过plus.key.addEventListener来注册监听"volumeupbutton"事件。
  99. </p>
  100. </li>
  101. <li>"volumedownbutton": <em>(<font class="type">String</font>
  102. 类型
  103. )</em>设备“音量-”按钮按键事件<br><p>
  104. 如果需要改变默认“音量-”按钮的处理逻辑,则可通过plus.key.addEventListener来注册监听"volumedownbutton"事件。
  105. </p>
  106. </li>
  107. </ul>
  108. <h1><a name="plus.key.KeyEvent">KeyEvent</a></h1>
  109. <p>按键事件</p>
  110. <h2>属性:</h2>
  111. <ul>
  112. <li>keyCode: <em>(<font class="type">Number</font>
  113. 类型
  114. )</em>触发按键事件的键值<br><p>
  115. 键值由各系统平台定义,一些特殊按键在不同的设备上可能存在差异。
  116. </p>
  117. </li>
  118. <li>keyType: <em>(<font class="type">KeyType</font>
  119. 类型
  120. )</em>按键事件类型<br><p>
  121. 用于表明触发此按键事件的类型,值为KeyType中定义的值。
  122. </p>
  123. </li>
  124. </ul>
  125. <h1><a name="plus.key.KeyEventCallback">KeyEventCallback</a></h1>
  126. <p>按键事件的回调函数</p>
  127. <pre class="prettyprint linenums">
  128. void onKeyEvent( KeyEvent event ){
  129. // Event handled code.
  130. var key=event.keyCode; // 用户按键的键值
  131. }
  132. </pre>
  133. <h2>参数:</h2>
  134. <ul><li>event:
  135. <em>(
  136. <a href="#plus.key.KeyEvent">KeyEvent</a>
  137. )
  138. 必选 </em>监听用户按键操作返回的数据<br>
  139. 可通过event的keyCode属性(String类型)获取用户按键的类型,参考KeyType类型。
  140. </li></ul>
  141. <h2>返回值:</h2>
  142. <font class="type">void</font>
  143. : 无<br><br>
  144. </div></body>
  145. </html>