nativeUI.html 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675
  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>NativeUI 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.nativeUI">nativeUI</a></h1>
  15. <p>nativeUI管理系统原生界面,可用于弹出系统原生提示对话框窗口、时间日期选择对话框、等待对话框等。</p>
  16. <h2>方法:</h2>
  17. <ul>
  18. <li>
  19. <a href="#plus.nativeUI.actionSheet">actionSheet</a>: 弹出系统选择按钮框</li>
  20. <li>
  21. <a href="#plus.nativeUI.alert">alert</a>: 弹出系统提示对话框</li>
  22. <li>
  23. <a href="#plus.nativeUI.confirm">confirm</a>: 弹出系统确认对话框</li>
  24. <li>
  25. <a href="#plus.nativeUI.closeWaiting">closeWaiting</a>: 关闭系统等待对话框</li>
  26. <li>
  27. <a href="#plus.nativeUI.closeToast">closeToast</a>: 关闭自动消失的提示消息</li>
  28. <li>
  29. <a href="#plus.nativeUI.previewImage">previewImage</a>: 预览图片</li>
  30. <li>
  31. <a href="#plus.nativeUI.showWaiting">showWaiting</a>: 显示系统等待对话框</li>
  32. <li>
  33. <a href="#plus.nativeUI.pickDate">pickDate</a>: 弹出系统日期选择对话框</li>
  34. <li>
  35. <a href="#plus.nativeUI.pickTime">pickTime</a>: 弹出系统时间选择对话框</li>
  36. <li>
  37. <a href="#plus.nativeUI.prompt">prompt</a>: 弹出系统输入对话框</li>
  38. <li>
  39. <a href="#plus.nativeUI.toast">toast</a>: 显示自动消失的提示消息</li>
  40. </ul>
  41. <h2>对象:</h2>
  42. <ul>
  43. <li>
  44. <a href="#plus.nativeUI.ActionButtonStyles">ActionButtonStyles</a>: JSON对象,原生选择按钮框上按钮的样式参数</li>
  45. <li>
  46. <a href="#plus.nativeUI.ActionSheetStyles">ActionSheetStyles</a>: JSON对象,原生选择按钮框的样式参数</li>
  47. <li>
  48. <a href="#plus.nativeUI.ConfirmStyles">ConfirmStyles</a>: 确认对话框的参数</li>
  49. <li>
  50. <a href="#plus.nativeUI.PreviewImageStyles">PreviewImageStyles</a>: JSON对象,图片预览的参数</li>
  51. <li>
  52. <a href="#plus.nativeUI.PickDateStyles">PickDateStyles</a>: 日期选择对话框的参数</li>
  53. <li>
  54. <a href="#plus.nativeUI.PickTimeStyles">PickTimeStyles</a>: JSON对象,时间选择对话框的参数</li>
  55. <li>
  56. <a href="#plus.nativeUI.NativeUIObj">NativeUIObj</a>: 系统原生界面基类对象</li>
  57. <li>
  58. <a href="#plus.nativeUI.WaitingObj">WaitingObj</a>: 系统等待对话框对象</li>
  59. <li>
  60. <a href="#plus.nativeUI.WaitingStyles">WaitingStyles</a>: JSON对象,原生等待对话框的参数</li>
  61. <li>
  62. <a href="#plus.nativeUI.WaitingLoadingStyles">WaitingLoadingStyles</a>: JSON对象,原生等待对话框上loading图标自定义样式</li>
  63. <li>
  64. <a href="#plus.nativeUI.ToastStyles">ToastStyles</a>: JSON对象,系统提示消息框要设置的参数</li>
  65. </ul>
  66. <h2>回调方法:</h2>
  67. <ul>
  68. <li>
  69. <a href="#plus.nativeUI.ActionSheetCallback">ActionSheetCallback</a>: 系统选择按钮框的回调函数</li>
  70. <li>
  71. <a href="#plus.nativeUI.AlertCallback">AlertCallback</a>: 系统提示框确认的回调函数</li>
  72. <li>
  73. <a href="#plus.nativeUI.ConfirmCallback">ConfirmCallback</a>: 关闭确认对话框的回调函数</li>
  74. <li>
  75. <a href="#plus.nativeUI.PromptCallback">PromptCallback</a>: 系统输入对话框关闭后的回调函数</li>
  76. <li>
  77. <a href="#plus.nativeUI.PickDatetimeSuccessCallback">PickDatetimeSuccessCallback</a>: 选择日期或时间操作成功的回调函数</li>
  78. <li>
  79. <a href="#plus.nativeUI.PickDatetimeErrorCallback">PickDatetimeErrorCallback</a>: 选择日期或时间操作取消或失败的回调函数</li>
  80. <li>
  81. <a href="#plus.nativeUI.PreviewImageLongPressCallback">PreviewImageLongPressCallback</a>: 图片预览长按事件</li>
  82. </ul>
  83. <h2>权限:</h2>
  84. <p>5+功能模块(permissions)</p>
  85. <pre class="prettyprint linenums">
  86. {
  87. // ...
  88. "permissions":{
  89. // ...
  90. "NativeUI": {
  91. "description": "原生UI控件"
  92. }
  93. }
  94. }
  95. </pre>
  96. <h1><a name="plus.nativeUI.ActionButtonStyles">ActionButtonStyles</a></h1>
  97. <p>JSON对象,原生选择按钮框上按钮的样式参数</p>
  98. <h2>属性:</h2>
  99. <ul>
  100. <li>color: <em>(<font class="type">String</font>
  101. 类型
  102. )</em>按钮上显示的文字颜色<br><p>
  103. 可取值:
  104. "#RRGGBB"格式字符串,如"#FF0000"表示文字颜色为红色;
  105. "rgba(R,G,B,A)",其中R/G/B分别代表红色值/绿色值/蓝色值,正整数类型,取值范围为0-255,A为透明度,浮点数类型,取值范围为0-1(0为全透明,1为不透明),如"rgba(255,0,0,0.5)",表示红色半透明。
  106. </p>
  107. </li>
  108. <li>title: <em>(<font class="type">String</font>
  109. 类型
  110. )</em>按钮上显示的文字内容<br>
  111. </li>
  112. <li>style: <em>(<font class="type">String</font>
  113. 类型
  114. )</em>按钮的样式<br><p>
  115. 可取值:
  116. "destructive" - 表示警示按钮样式,默认文字颜色为红色;
  117. "default" - 表示默认按钮样式。
  118. 默认值为"default"。
  119. </p>
  120. </li>
  121. </ul>
  122. <h1><a name="plus.nativeUI.ActionSheetStyles">ActionSheetStyles</a></h1>
  123. <p>JSON对象,原生选择按钮框的样式参数</p>
  124. <h2>属性:</h2>
  125. <ul>
  126. <li>title: <em>(<font class="type">String</font>
  127. 类型
  128. )</em>选择按钮框的标题<br>
  129. </li>
  130. <li>cancel: <em>(<font class="type">String</font>
  131. 类型
  132. )</em>取消按钮上显示的文字内容<br><p>
  133. 不设置此属性,则不显示取消按钮。
  134. </p>
  135. </li>
  136. <li>buttons: <em>(<font class="type">Array</font>[
  137. <a href="#plus.nativeUI.ActionButtonStyles">ActionButtonStyles</a>
  138. ]
  139. 类型
  140. )</em>选择框上的按钮,ActionButtonStyles对象数组<br>
  141. </li>
  142. </ul>
  143. <h1><a name="plus.nativeUI.ConfirmStyles">ConfirmStyles</a></h1>
  144. <p>确认对话框的参数</p>
  145. <h2>属性:</h2>
  146. <ul>
  147. <li>title: <em>(<font class="type">String</font>
  148. 类型
  149. )</em>确认对话框显示的标题<br><p>
  150. 如果不设置此属性值,则不显示标题。
  151. </p>
  152. </li>
  153. <li>buttons: <em>(<font class="type">Array</font>[
  154. <font class="type">String</font>
  155. ]
  156. 类型
  157. )</em>确认对话框上显示的按钮<br><p>
  158. 字符串数组,每项对应在确认对话框上显示一个按钮,用户点击后通过confirmCB返回用户点击按钮的在数组中的索引值。
  159. </p>
  160. </li>
  161. <li>verticalAlign: <em>(<font class="type">String</font>
  162. 类型
  163. )</em>对话框在屏幕中的垂直分享对齐方式<br><p>
  164. 可取值:
  165. "top" - 表示垂直居顶对齐;
  166. "center" - 表示垂直居中对齐;
  167. "bottom" - 表示垂直居底对齐。
  168. 默认值为"center"(垂直居中对齐)。
  169. </p>
  170. </li>
  171. </ul>
  172. <h1><a name="plus.nativeUI.PreviewImageStyles">PreviewImageStyles</a></h1>
  173. <p>JSON对象,图片预览的参数</p>
  174. <h2>属性:</h2>
  175. <ul>
  176. <li>background: <em>(<font class="type">String</font>
  177. 类型
  178. )</em>图片预览的背景颜色<br><p>
  179. 颜色值格式为"#RRGGBB",如"#FF0000"表示为红色背景。
  180. 默认值为黑色("#000000")。
  181. </p>
  182. </li>
  183. <li>current: <em>(<font class="type">Number</font>
  184. 类型
  185. )</em>默认显示图片的索引值<br><p>
  186. 索引值从0开始,默认值为0。
  187. </p>
  188. </li>
  189. <li>indicator: <em>(<font class="type">String</font>
  190. 类型
  191. )</em>图片指示器样式<br><p>
  192. 可取值:
  193. "default" - 默认指示器(底部圆点样式);
  194. "number" - 顶部数字指示器(顶部居中显示,文字为%当前图片索引值(从1开始)%/%图片总数%);
  195. "none" - 不显示指示器。
  196. 默认值为"default"。
  197. </p>
  198. </li>
  199. <li>loop: <em>(<font class="type">Boolean</font>
  200. 类型
  201. )</em>是否可循环预览<br><p>
  202. 可取值:
  203. "true" - 支持循环预览;
  204. "false" - 不支持循环预览。
  205. 默认值为"false"。
  206. </p>
  207. </li>
  208. <li>onLongPress: <em>(<a href="#plus.nativeUI.PreviewImageLongPressCallback">PreviewImageLongPressCallback</a>
  209. 类型
  210. )</em>长按事件<br><p>
  211. 用户在图片预览界面长按时触发。
  212. 在回调中返回长按图片的信息(索引值、地址等)。
  213. 由于图片预览界面是层级非常高的窗口,此时只能调用plus.nativeUI.*显示的窗口覆盖在图片预览界面上(原生控件plus.nativeObj.View也无法显示)。
  214. 注意:HBuilderX1.9.5及以上版本支持。
  215. </p>
  216. </li>
  217. </ul>
  218. <h1><a name="plus.nativeUI.PickDateStyles">PickDateStyles</a></h1>
  219. <p>日期选择对话框的参数</p>
  220. <h2>属性:</h2>
  221. <ul>
  222. <li>title: <em>(<font class="type">String</font>
  223. 类型
  224. )</em>日期选择对话框显示的标题<br><p>
  225. 如果未设置,则不显示标题。
  226. </p>
  227. </li>
  228. <li>date: <em>(<font class="type">Date</font>
  229. 类型
  230. )</em>日期选择对话框默认显示的日期<br><p>
  231. 如果未设置,则显示当前的日期。
  232. </p>
  233. </li>
  234. <li>minDate: <em>(<font class="type">Date</font>
  235. 类型
  236. )</em>日期选择对话框可选择的最小日期<br><p>
  237. Date类型对象,如果未设置可选择的最小日期,则使用系统默认可选择的最小日期值。
  238. </p>
  239. </li>
  240. <li>maxDate: <em>(<font class="type">Date</font>
  241. 类型
  242. )</em>日期选择对话框可选择的最大日期<br><p>
  243. Date类型对象,如果未设置可选择的最大日期,则使用系统默认可选择的最大日期值。
  244. 其值必须大于minDate设置的值,否则使用系统默认可选择的最大日期值。
  245. </p>
  246. </li>
  247. <li>popover: <em>(<font class="type">JSON</font>
  248. 类型
  249. )</em>时间选择对话框弹出指示区域<br><p>
  250. JSON类型对象,格式如{top:10;left:10;width:200;height:200;},所有值为像素值,其值为相对于容器Webview的位置。
  251. 如未设置此值,默认在屏幕居中显示。仅在iPad上有效,其它设备忽略此值。
  252. </p>
  253. </li>
  254. </ul>
  255. <h1><a name="plus.nativeUI.PickTimeStyles">PickTimeStyles</a></h1>
  256. <p>JSON对象,时间选择对话框的参数</p>
  257. <h2>属性:</h2>
  258. <ul>
  259. <li>time: <em>(<font class="type">Date</font>
  260. 类型
  261. )</em>时间选择对话框默认显示的时间<br><p>
  262. 如果未设置,则默认当前的时间。
  263. </p>
  264. </li>
  265. <li>title: <em>(<font class="type">String</font>
  266. 类型
  267. )</em>时间选择对话框显示的标题<br><p>
  268. 如果未设置,则不显示标题。
  269. </p>
  270. </li>
  271. <li>is24Hour: <em>(<font class="type">Boolean</font>
  272. 类型
  273. )</em>是否24小时制模式<br><p>
  274. true表示使用24小时制模式显示,fale表示使用12小时制模式显示,默认值为true。
  275. </p>
  276. </li>
  277. <li>popover: <em>(<font class="type">JSON</font>
  278. 类型
  279. )</em>日期选择对话框弹出指示区域<br><p>
  280. JSON类型对象,格式如{top:10;left:10;width:200;height:200;},所有值为像素值,其值相对于容器webview的位置。
  281. 如未设置此值,默认在屏幕居中显示。仅在iPad上有效,其它设备忽略此值。
  282. </p>
  283. </li>
  284. </ul>
  285. <h1><a name="plus.nativeUI.NativeUIObj">NativeUIObj</a></h1>
  286. <p>系统原生界面基类对象</p>
  287. <pre class="prettyprint linenums">
  288. interface NativeUIObj{
  289. function void close();
  290. }
  291. </pre>
  292. <h2>方法:</h2>
  293. <ul><li>
  294. <a href="#plus.nativeUI.NativeUIObj.close">close</a>: 关闭显示的系统原生界面</li></ul>
  295. <h1><a name="plus.nativeUI.WaitingObj">WaitingObj</a></h1>
  296. <p>系统等待对话框对象</p>
  297. <h2>说明:</h2>
  298. <p class="des">
  299. 从NativeUIObj对象继承而来,通过plus.nativeUI.showWaiting方法创建时返回。
  300. 用于控制系统样式等待对话框的操作,如关闭、设置标题内容等。
  301. </p>
  302. <h2>方法:</h2>
  303. <ul>
  304. <li>
  305. <a href="#plus.nativeUI.WaitingObj.setTitle">setTitle</a>: 设置等待对话框上显示的文字内容</li>
  306. <li>
  307. <a href="#plus.nativeUI.WaitingObj.close">close</a>: 关闭显示的系统等待对话框</li>
  308. </ul>
  309. <h2>事件:</h2>
  310. <ul><li>
  311. <a href="#plus.nativeUI.WaitingObj.onclose">onclose</a>: 等待对话框关闭事件</li></ul>
  312. <h1><a name="plus.nativeUI.WaitingStyles">WaitingStyles</a></h1>
  313. <p>JSON对象,原生等待对话框的参数</p>
  314. <h2>属性:</h2>
  315. <ul>
  316. <li>width: <em>(<font class="type">String</font>
  317. 类型
  318. )</em>等待框背景区域的宽度<br><p>
  319. 值支持像素值("500px")或百分比("50%"),百分比相对于屏幕的宽计算,如果不设置则根据内容自动计算合适的宽度。
  320. </p>
  321. </li>
  322. <li>height: <em>(<font class="type">String</font>
  323. 类型
  324. )</em>等待框背景区域的高度<br><p>
  325. 值支持像素绝对值("500px")或百分比("50%"),如果不设置则根据内容自动计算合适的高度。
  326. </p>
  327. </li>
  328. <li>color: <em>(<font class="type">String</font>
  329. 类型
  330. )</em>等待框中文字的颜色<br><p>
  331. 颜色值支持(参考CSS颜色规范):颜色名称(参考CSS Color Names)/十六进制值/rgb值/rgba值,默认值为白色。
  332. </p>
  333. </li>
  334. <li>size: <em>(<font class="type">String</font>
  335. 类型
  336. )</em>等待框中文字的字体大小<br><p>
  337. 如"14px"表示使用14像素高的文字,未设置则使用系统默认字体大小。
  338. </p>
  339. </li>
  340. <li>textalign: <em>(<font class="type">String</font>
  341. 类型
  342. )</em>等待对话框中标题文字的水平对齐方式<br><p>
  343. 对齐方式可选值包括:"left":水平居左对齐显示,"center":水平居中对齐显示,"right":水平居右对齐显示。默认值为水平居中对齐显示,即"center"。
  344. </p>
  345. </li>
  346. <li>padding: <em>(<font class="type">String</font>
  347. 类型
  348. )</em>等待对话框的内边距<br><p>
  349. 值支持像素值("10px")和百分比("5%"),百分比相对于屏幕的宽计算,默认值为"3%"。
  350. </p>
  351. </li>
  352. <li>background: <em>(<font class="type">String</font>
  353. 类型
  354. )</em>等待对话框显示区域的背景色<br><p>
  355. 背景色的值支持(参考CSS颜色规范):颜色名称(参考CSS Color Names)/十六进制值/rgb值/rgba值,默认值为rgba(0,0,0,0.7)。
  356. </p>
  357. </li>
  358. <li>style: <em>(<font class="type">String</font>
  359. 类型
  360. )</em>等待对话框样式<br><p>
  361. 可取值"black"、"white",black表示等待框为黑色雪花样式,通常在背景主色为浅色时使用;white表示等待框为白色雪花样式,通常在背景主色为深色时使用。
  362. 仅在iOS平台有效,其它平台忽略此值,未设置时默认值为white。
  363. </p>
  364. </li>
  365. <li>modal: <em>(<font class="type">Boolen</font>
  366. 类型
  367. )</em>等待框是否模态显示<br><p>
  368. 模态显示时用户不可操作直到等待对话框关闭,否则用户在等待对话框显示时也可操作下面的内容,未设置时默认为true。
  369. </p>
  370. </li>
  371. <li>round: <em>(<font class="type">Number</font>
  372. 类型
  373. )</em>等待框显示区域的圆角<br><p>
  374. 值支持像素值("10px"),未设置时使用默认值"10px"。
  375. </p>
  376. </li>
  377. <li>padlock: <em>(<font class="type">Boolen</font>
  378. 类型
  379. )</em>点击等待显示区域是否自动关闭<br><p>
  380. true表示点击等待对话框显示区域时自动关闭,false则不关闭,未设置时默认值为false。
  381. </p>
  382. </li>
  383. <li>back: <em>(<font class="type">String</font>
  384. 类型
  385. )</em>返回键处理方式<br><p>
  386. 可取值"none"表示截获处理返回键,但不做任何响应;"close"表示截获处理返回键并关闭等待框;"transmit"表示不截获返回键,向后传递给Webview窗口继续处理(与未显示等待框的情况一致)。
  387. </p>
  388. </li>
  389. <li>loading: <em>(<a href="#plus.nativeUI.WaitingLoadingStyles">WaitingLoadingStyles</a>
  390. 类型
  391. )</em>自定义等待框上loading图标样式<br>
  392. </li>
  393. </ul>
  394. <h1><a name="plus.nativeUI.WaitingLoadingStyles">WaitingLoadingStyles</a></h1>
  395. <p>JSON对象,原生等待对话框上loading图标自定义样式</p>
  396. <h2>属性:</h2>
  397. <ul>
  398. <li>display: <em>(<font class="type">String</font>
  399. 类型
  400. )</em>loading图标显示样式<br><p>
  401. 可取值:
  402. "block"表示图标与文字分开两行显示,上面显示loading图标,下面显示文字;
  403. "inline"表示loading图标与文字在同一行显示,左边显示loading图标,右边显示文字;
  404. "none"表示不显示loading图标;
  405. </p>
  406. </li>
  407. <li>height: <em>(<font class="type">String</font>
  408. 类型
  409. )</em>loading图标高度<br><p>
  410. 设置loading图标的高度(宽度等比率缩放),取值类型:像素值,如"14px"表示14像素高。
  411. </p>
  412. </li>
  413. <li>icon: <em>(<font class="type">String</font>
  414. 类型
  415. )</em>loading图标路径<br><p>
  416. 自定义loading图标的路径,png格式,并且必须是本地资源地址;
  417. loading图要求宽是高的整数倍,显示等待框时按照图片的高横向截取每帧刷新。
  418. </p>
  419. </li>
  420. <li>interval: <em>(<font class="type">Number</font>
  421. 类型
  422. )</em>loading图每帧刷新间隔<br><p>
  423. 单位为ms(毫秒),默认值为100ms。
  424. </p>
  425. </li>
  426. <li>type: <em>(<font class="type">String</font>
  427. 类型
  428. )</em>loading图标类型<br><p>
  429. 如果设置了icon属性,则优先使用icon自定义图标。
  430. 可取值:
  431. "circle" - 圆圈类型loading图标;
  432. "snow" - 雪花类型loading图标。
  433. 默认值为"circle"。
  434. </p>
  435. </li>
  436. </ul>
  437. <h1><a name="plus.nativeUI.ToastStyles">ToastStyles</a></h1>
  438. <p>JSON对象,系统提示消息框要设置的参数</p>
  439. <h2>属性:</h2>
  440. <ul>
  441. <li>align: <em>(<font class="type">String</font>
  442. 类型
  443. )</em>提示消息框在屏幕中的水平位置<br><p>
  444. 可选值为"left"、"center"、"right",分别为水平居左、居中、居右,未设置时默认值为"center"。
  445. </p>
  446. </li>
  447. <li>background: <em>(<font class="type">String</font>
  448. 类型
  449. )</em>提示消息框的背景色<br><p>
  450. 背景色的值支持(参考CSS颜色规范):颜色名称(参考CSS Color Names)/十六进制值/rgb值/rgba值。
  451. </p>
  452. </li>
  453. <li>duration: <em>(<font class="type">String</font>
  454. 类型
  455. )</em>提示消息框显示的时间<br><p>
  456. 可选值为"long"、"short",值为"long"时显示时间约为3.5s,值为"short"时显示时间约为2s,未设置时默认值为"short"。
  457. </p>
  458. </li>
  459. <li>icon: <em>(<font class="type">String</font>
  460. 类型
  461. )</em>提示消息框上显示的图标<br><p>
  462. 仅支持本地图片路径。
  463. </p>
  464. </li>
  465. <li>iconWidth: <em>(<font class="type">String</font>
  466. 类型
  467. )</em>图标的宽度<br><p>
  468. 单位为px(逻辑像素值),默认值为图片的宽度。
  469. </p>
  470. </li>
  471. <li>iconHeight: <em>(<font class="type">String</font>
  472. 类型
  473. )</em>图标的高度<br><p>
  474. 单位为px(逻辑像素值),默认值为图片的高度。
  475. </p>
  476. </li>
  477. <li>style: <em>(<font class="type">String</font>
  478. 类型
  479. )</em>提示消息框上显示的样式<br><p>
  480. 可取值:
  481. "block"表示图标与文字分两行显示,上面显示图标,下面显示文字;
  482. "inline"表示图标与文字在同一行显示,左边显示图标,右边显示文字。
  483. 默认值为"block"。
  484. </p>
  485. </li>
  486. <li>type: <em>(<font class="type">String</font>
  487. 类型
  488. )</em>提示消息框上显示的文本类型<br><p>
  489. 可取值:
  490. "text" - 显示的消息内容为文本字符串;
  491. "richtext" - 显示的消息内容为富文本内容。
  492. 默认值为"text"。
  493. 当type为"text"时,富文本使用html的部分标签,具体标签如下:
  494. 图片标签&lt;img src="图片资源url地址" width="图片显示的宽度" height="图片显示的高度" onclick="console.log('clicked img')"&gt;&lt;/img&gt;;
  495. 字体标签&lt;font color="字体颜色"&gt;&lt;/font&gt;,内容在一行显示不下时自动换行,行高默认为字体的1.2倍;
  496. 换行标签&lt;br/&gt;;
  497. 链接标签&lt;a onclick="console.log('clicked a')"&gt;链接地址&lt;/a&gt;。
  498. 如示例“&lt;img onclick="console.log('clicked img')" src="http://img-cdn-qiniu.dcloud.net.cn/icon2.png"/&gt;&lt;a onclick="console.log(clicked a)"&gt;链接地址&lt;/a&gt;”。
  499. </p>
  500. </li>
  501. <li>richTextStyle: <em>(<a href="#href.RichTextStyles">RichTextStyles</a>
  502. 类型
  503. )</em>富文本样式<br><p>
  504. 当type属性值为"richtext"时有效,用于定义富文本的样式,如其文本对齐方式、使用的字体等。
  505. </p>
  506. </li>
  507. <li>verticalAlign: <em>(<font class="type">String</font>
  508. 类型
  509. )</em>提示消息在屏幕中的垂直位置<br><p>
  510. 可选值为"top"、"center"、"bottom",分别为垂直居顶、居中、居底,未设置时默认值为"bottom"。
  511. </p>
  512. </li>
  513. </ul>
  514. <h1><a name="plus.nativeUI.ActionSheetCallback">ActionSheetCallback</a></h1>
  515. <p>系统选择按钮框的回调函数</p>
  516. <pre class="prettyprint linenums">
  517. void onActioned( Event event ){
  518. // actionsheet handled code.
  519. var index=event.index; // 用户关闭时点击按钮的索引值
  520. }
  521. </pre>
  522. <h2>参数:</h2>
  523. <ul><li>event:
  524. <em>(
  525. <font class="type">Event</font>
  526. )
  527. 必选 </em>用户操作选择按钮框关闭后返回的数据<br>
  528. 可通过event.index(Number类型)获取用户关闭时点击按钮的索引值,索引值从0开始;
  529. 0表示用户点击取消按钮,大于0值表示用户点击ActionSheetStyles中buttons属性定义的按钮,索引值从1开始(即1表示点击buttons中定义的第一个按钮)。
  530. 通过API(close()方法)关闭,则回调函数中event的index属性值为-1。
  531. </li></ul>
  532. <h2>返回值:</h2>
  533. <font class="type">void</font>
  534. : 无<h1><a name="plus.nativeUI.AlertCallback">AlertCallback</a></h1>
  535. <p>系统提示框确认的回调函数</p>
  536. <pre class="prettyprint linenums">
  537. void onAlerted( Event event ){
  538. // Alert handled code.
  539. var index=event.index; // 用户关闭提示对话框点击按钮的索引值
  540. }
  541. </pre>
  542. <h2>参数:</h2>
  543. <ul><li>event:
  544. <em>(
  545. <font class="type">Event</font>
  546. )
  547. 必选 </em>用户操作确认对话框关闭后返回的数据<br>
  548. 可通过event.index(Number类型)获取用户关闭确认对话框点击按钮的索引值,点击确认键的索引值为0。
  549. Android平台上通过返回按钮关闭时索引值为-1。
  550. </li></ul>
  551. <h2>返回值:</h2>
  552. <font class="type">void</font>
  553. : 无<h1><a name="plus.nativeUI.ConfirmCallback">ConfirmCallback</a></h1>
  554. <p>关闭确认对话框的回调函数</p>
  555. <pre class="prettyprint linenums">
  556. void onConfirmed( Event event ) {
  557. // Confirm handled code.
  558. var index=event.index; // 用户关闭确认对话框点击按钮的索引值
  559. }
  560. </pre>
  561. <h2>参数:</h2>
  562. <ul><li>event:
  563. <em>(
  564. <font class="type">Event</font>
  565. )
  566. 必选 </em>用户操作确认对话框关闭后返回的数据<br>
  567. 可通过event.index(Number类型)获取用户关闭确认对话框点击按钮的索引值,索引值从0开始;
  568. </li></ul>
  569. <h2>返回值:</h2>
  570. <font class="type">void</font>
  571. : 无<h1><a name="plus.nativeUI.PromptCallback">PromptCallback</a></h1>
  572. <p>系统输入对话框关闭后的回调函数</p>
  573. <pre class="prettyprint linenums">
  574. function void onPrompted( Event event ) {
  575. // Prompt handled code.
  576. var index=event.index; // 用户关闭输入对话框点击按钮的索引值
  577. var value=event.value; // 用户输入的内容
  578. }
  579. </pre>
  580. <h2>参数:</h2>
  581. <ul><li>event:
  582. <em>(
  583. <font class="type">Event</font>
  584. )
  585. 必选 </em>用户操作输入对话框关闭后返回的数据<br>
  586. 可通过event.index(Number类型)获取用户关闭输入对话框点击按钮的索引值,索引值从0开始;
  587. 通过event.value(String类型)获取用户输入的内容,如果没有输入则返回空字符串。
  588. </li></ul>
  589. <h2>返回值:</h2>
  590. <font class="type">void</font>
  591. : 无<h1><a name="plus.nativeUI.PickDatetimeSuccessCallback">PickDatetimeSuccessCallback</a></h1>
  592. <p>选择日期或时间操作成功的回调函数</p>
  593. <pre class="prettyprint linenums">
  594. function void onPickSuccess( Event event ) {
  595. // Date picked code.
  596. var date = event.date;// 用户选择的日期或时间
  597. }
  598. </pre>
  599. <h2>参数:</h2>
  600. <ul><li>event:
  601. <em>(
  602. <font class="type">Event</font>
  603. )
  604. 必选 </em>用户完成选择日期或时间后返回的数据<br>
  605. 可通过event.date(Date类型)获取选择的日期或时间值。
  606. 若调用的是日期选择操作则仅年、月、日信息有效,若调用的是时间选择操作则仅时、分信息有效。
  607. </li></ul>
  608. <h2>返回值:</h2>
  609. <font class="type">void</font>
  610. : 无<h1><a name="plus.nativeUI.PickDatetimeErrorCallback">PickDatetimeErrorCallback</a></h1>
  611. <p>选择日期或时间操作取消或失败的回调函数</p>
  612. <pre class="prettyprint linenums">
  613. function void onPickError( Exception error ) {
  614. // Date picked error.
  615. var code = error.code; // 错误编码
  616. var message = error.message; // 错误描述信息
  617. }
  618. </pre>
  619. <h2>参数:</h2>
  620. <ul><li>error:
  621. <em>(
  622. <font class="type">Exception</font>
  623. )
  624. 必选 </em>用户选择操作失败信息<br>
  625. 可通过error.code(Number类型)获取错误编码;
  626. 可通过error.message(String类型)获取错误描述信息。
  627. </li></ul>
  628. <h2>返回值:</h2>
  629. <font class="type">void</font>
  630. : 无<h1><a name="plus.nativeUI.PreviewImageLongPressCallback">PreviewImageLongPressCallback</a></h1>
  631. <p>图片预览长按事件</p>
  632. <pre class="prettyprint linenums">
  633. function void onlongPress(event) {
  634. // longpress event
  635. var index = event.index; // 长按图片的索引
  636. var url = event.url; // 长按图片的url地址
  637. var path = event.path; // 长按图片的本地图片路径(系统绝对路径)
  638. }
  639. </pre>
  640. <h2>说明:</h2>
  641. <p class="des">
  642. 在图片预览界面长按时触发。
  643. </p>
  644. <h2>参数:</h2>
  645. <ul>
  646. <li>index:
  647. <em>(
  648. <font class="type">Number</font>
  649. )
  650. 必选 </em>长按图片的索引值<br>
  651. 索引值从0开始。
  652. </li>
  653. <li>url:
  654. <em>(
  655. <font class="type">String</font>
  656. )
  657. 必选 </em>长按图片的url地址<br>
  658. 与调用plus.nativeUI.previewImage传入的urls值一致。
  659. </li>
  660. <li>path:
  661. <em>(
  662. <font class="type">String</font>
  663. )
  664. 必选 </em>长按图片的本地地址<br>
  665. 系统绝对路径。
  666. </li>
  667. </ul>
  668. <h2>返回值:</h2>
  669. <font class="type">void</font>
  670. : 无<br><br>
  671. </div></body>
  672. </html>