nativeobj.html 51 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357
  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.nativeObj">nativeObj</a></h1>
  15. <p>nativeObj管理系统原生对象。</p>
  16. <h2>对象:</h2>
  17. <ul>
  18. <li>
  19. <a href="#plus.nativeObj.AnimationOptions">AnimationOptions</a>: 原生动画参数</li>
  20. <li>
  21. <a href="#plus.nativeObj.AnimationViewStyles">AnimationViewStyles</a>: 原生动画窗口样式</li>
  22. <li>
  23. <a href="#plus.nativeObj.Bitmap">Bitmap</a>: 原生图片对象</li>
  24. <li>
  25. <a href="#plus.nativeObj.BitmapSaveOptions">BitmapSaveOptions</a>: JSON对象,保存图片的参数</li>
  26. <li>
  27. <a href="#plus.nativeObj.ImageSlider">ImageSlider</a>: 原生图片轮播控件对象</li>
  28. <li>
  29. <a href="#plus.nativeObj.ImageSliderStyles">ImageSliderStyles</a>: 图片轮播控件样式</li>
  30. <li>
  31. <a href="#plus.nativeObj.ImageSliderImageStyles">ImageSliderImageStyles</a>: 图片轮播控件中图片项配置参数</li>
  32. <li>
  33. <a href="#plus.nativeObj.InputStyles">InputStyles</a>: 输入框样式</li>
  34. <li>
  35. <a href="#plus.nativeObj.Rect">Rect</a>: 区域信息对象</li>
  36. <li>
  37. <a href="#plus.nativeObj.RectStyles">RectStyles</a>: 绘制区域样式对象</li>
  38. <li>
  39. <a href="#plus.nativeObj.RichTextStyles">RichTextStyles</a>: 富文本样式</li>
  40. <li>
  41. <a href="#plus.nativeObj.Position">Position</a>: 区域信息对象</li>
  42. <li>
  43. <a href="#plus.nativeObj.TextStyles">TextStyles</a>: 绘制文本样式对象</li>
  44. <li>
  45. <a href="#plus.nativeObj.View">View</a>: 原生控件对象</li>
  46. <li>
  47. <a href="#plus.nativeObj.ViewAnimationOptions">ViewAnimationOptions</a>: View控件动画参数</li>
  48. <li>
  49. <a href="#plus.nativeObj.ViewDrawTagStyles">ViewDrawTagStyles</a>: View控件绘制元素参数</li>
  50. <li>
  51. <a href="#plus.nativeObj.ViewEvents">ViewEvents</a>: View控件事件</li>
  52. <li>
  53. <a href="#plus.nativeObj.ViewStatusbarStyles">ViewStatusbarStyles</a>: JSON对象,View控件的系统状态栏区域样式</li>
  54. <li>
  55. <a href="#plus.nativeObj.ViewStyles">ViewStyles</a>: View控件样式</li>
  56. </ul>
  57. <h2>回调方法:</h2>
  58. <ul>
  59. <li>
  60. <a href="#plus.nativeObj.BitmapSaveSuccessCallback">BitmapSaveSuccessCallback</a>: 图片保存操作成功回调接口</li>
  61. <li>
  62. <a href="#plus.nativeObj.InputCompleteCallback">InputCompleteCallback</a>: 输入框完成输入回调函数</li>
  63. <li>
  64. <a href="#plus.nativeObj.InputEventCallback">InputEventCallback</a>: 输入框事件回调函数</li>
  65. <li>
  66. <a href="#plus.nativeObj.RichTextClickedCallback">RichTextClickedCallback</a>: 富文本区域点击事件回调函数</li>
  67. <li>
  68. <a href="#plus.nativeObj.TouchEventCallback">TouchEventCallback</a>: 触屏事件的回调函数</li>
  69. <li>
  70. <a href="#plus.nativeObj.NativeObjSuccessCallback">NativeObjSuccessCallback</a>: 操作成功回调函数接口</li>
  71. <li>
  72. <a href="#plus.nativeObj.NativeObjErrorCallback">NativeObjErrorCallback</a>: 操作错误回调函数接口</li>
  73. </ul>
  74. <h2>权限:</h2>
  75. <p>5+功能模块(permissions)</p>
  76. <pre class="prettyprint linenums">
  77. {
  78. // ...
  79. "permissions":{
  80. // ...
  81. "NativeObj": {
  82. "description": "原生对象"
  83. }
  84. }
  85. }
  86. </pre>
  87. <h1><a name="plus.nativeObj.AnimationOptions">AnimationOptions</a></h1>
  88. <p>原生动画参数</p>
  89. <pre class="prettyprint linenums">
  90. interface AnimationOptions {
  91. attribute String type;
  92. attribute Number duration;
  93. } </pre>
  94. <h2>说明:</h2>
  95. <p class="des">
  96. 指定动画的类型、持续时间等信息。
  97. </p>
  98. <h2>属性:</h2>
  99. <ul>
  100. <li>type: <em>(<font class="type">String</font>
  101. 类型
  102. )</em>动画类型<br><p>
  103. 可取值:
  104. "pop-in" - 从右侧平移入栈动画效果(副窗口从右侧向左平移滑出显示,主窗口从当前屏幕区域向左侧平移滑出被遮盖),如果仅传入一个View控件对象则自动降级为slide-in-right动画;
  105. "pop-out" - 从右侧平移出栈动画效果(副窗口从当前屏幕区域向右侧平移出可视区域,主窗口从左侧向右平移滑出显示),如果仅出入一个View控件对象则自动降级为slide-out-right动画;
  106. "slide-in-right" - 从右侧横向滑动效果(主窗口从当前屏幕右侧外向内横向滑动显示);
  107. "slide-out-right - 横向向右侧滑出屏幕动画(主窗口从屏幕中横向向右侧滑动到屏幕外)。
  108. </p>
  109. </li>
  110. <li>duration: <em>(<font class="type">Number</font>
  111. 类型
  112. )</em>动画持续时间<br><p>
  113. 单位为毫秒,默认值为200ms。
  114. </p>
  115. </li>
  116. </ul>
  117. <h1><a name="plus.nativeObj.AnimationViewStyles">AnimationViewStyles</a></h1>
  118. <p>原生动画窗口样式</p>
  119. <pre class="prettyprint linenums">
  120. interface AnimationViewStyles {
  121. attribute Bitmap bitmap;
  122. attribute String text;
  123. } </pre>
  124. <h2>说明:</h2>
  125. <p class="des">
  126. 指定动画窗口的样式,如背景图片,绘制的文字等。
  127. </p>
  128. <h2>属性:</h2>
  129. <ul>
  130. <li>bitmap: <em>(<a href="#plus.nativeObj.Bitmap">Bitmap</a>
  131. 类型
  132. )</em>动画窗口上绘制的背景图片<br><p>
  133. 图片可以通过Webview对象的draw方法截图,也可以通过Bitmap的API从本地文件中加载。
  134. </p>
  135. </li>
  136. <li>text: <em>(<font class="type">String</font>
  137. 类型
  138. )</em>动画窗口上绘制的文本内容<br>
  139. </li>
  140. <li>textStyles: <em>(<a href="#plus.nativeObj.TextStyles">TextStyles</a>
  141. 类型
  142. )</em>动画窗口上绘制的文本样式<br>
  143. </li>
  144. <li>textRect: <em>(<a href="#plus.nativeObj.Rect">Rect</a>
  145. 类型
  146. )</em>动画窗口上绘制的文本区域<br><p>
  147. 默认值为{top:'0px',left:'0px',width:'100%',height:'44px'}。
  148. </p>
  149. </li>
  150. </ul>
  151. <h1><a name="plus.nativeObj.Bitmap">Bitmap</a></h1>
  152. <p>原生图片对象</p>
  153. <pre class="prettyprint linenums">
  154. interface Bitmap {
  155. readonly attribute String id;
  156. static function Array[Bitmap] getItems();
  157. static function Bitmap getBitmapById( id );
  158. function void clear();
  159. function void load( path, successCallback, errorCallback );
  160. function void loadBase64Data( data, successCallback, errorCallback );
  161. function void save( path, options, successCallback, errorCallback );
  162. function String toBase64Data();
  163. } </pre>
  164. <h2>说明:</h2>
  165. <p class="des">
  166. 原生图片对象会占用较大的内存资源,在使用时需谨慎管理,当图片不再使用时应该及时调用clear方法进行销毁。
  167. </p>
  168. <h2>构造:</h2>
  169. <ul><li>
  170. <a href="#plus.nativeObj.Bitmap.Bitmap(id,%20path)">Bitmap(id, path)</a>: 创建Bitmap对象</li></ul>
  171. <h2>属性:</h2>
  172. <ul><li>
  173. <a href="#plus.nativeObj.Bitmap.id">id</a>: Bitmap对象的标识</li></ul>
  174. <h2>方法:</h2>
  175. <ul>
  176. <li>
  177. <a href="#plus.nativeObj.Bitmap.getItems">getItems</a>: 静态方法,获取所有Bitmap图片对象</li>
  178. <li>
  179. <a href="#plus.nativeObj.Bitmap.getBitmapById">getBitmapById</a>: 静态方法,获取指定标识的Bitmap图片对象</li>
  180. <li>
  181. <a href="#plus.nativeObj.Bitmap.clear">clear</a>: 销毁Bitmap图片</li>
  182. <li>
  183. <a href="#plus.nativeObj.Bitmap.load">load</a>: 加载Bitmap图片</li>
  184. <li>
  185. <a href="#plus.nativeObj.Bitmap.loadBase64Data">loadBase64Data</a>: 加载Base64编码格式图片到Bitmap对象</li>
  186. <li>
  187. <a href="#plus.nativeObj.Bitmap.recycle">recycle</a>: 回收Bitmap图片内存</li>
  188. <li>
  189. <a href="#plus.nativeObj.Bitmap.save">save</a>: 保存图片</li>
  190. <li>
  191. <a href="#plus.nativeObj.Bitmap.toBase64Data">toBase64Data</a>: 获取图片的Base64编码数据</li>
  192. </ul>
  193. <h1><a name="plus.nativeObj.BitmapSaveOptions">BitmapSaveOptions</a></h1>
  194. <p>JSON对象,保存图片的参数</p>
  195. <pre class="prettyprint linenums">
  196. interface BitmapSaveOptions {
  197. attribute Boolean overwrite;
  198. attribute String format;
  199. attribute Number quality;
  200. attribute Rect clip;
  201. } </pre>
  202. <h2>属性:</h2>
  203. <ul>
  204. <li>overwrite: <em>(<font class="type">Boolean</font>
  205. 类型
  206. )</em>覆盖保存图片文件<br><p>
  207. 仅在保存的图片路径文件存在时有效:
  208. true表示覆盖存在的文件;
  209. false表示不覆盖,如果文件存在,则返回失败。
  210. 默认值为false。
  211. </p>
  212. </li>
  213. <li>format: <em>(<font class="type">String</font>
  214. 类型
  215. )</em>保存图片的格式<br><p>
  216. 支持"jpg"、"png",如果未指定则默认使用指定的保存路径后缀对应的文件格式,如果后缀文件格式无效则使用jpg格式。
  217. </p>
  218. </li>
  219. <li>quality: <em>(<font class="type">Number</font>
  220. 类型
  221. )</em>保存图片的质量<br><p>
  222. 取值范围为1-100,1表示使用最低的图片质量(保存后的图片文件最小)、100表示使用最高的图片质量(保存后的图片文件最大);
  223. 默认值为50。
  224. </p>
  225. </li>
  226. <li>clip: <em>(<a href="#plus.nativeObj.Rect">Rect</a>
  227. 类型
  228. )</em>指定裁剪区域保存图片<br><p>
  229. 相对于图片的区域信息,默认值为{top:'0px',left:'0px',width:'100%',height:'100%'}。
  230. </p>
  231. </li>
  232. </ul>
  233. <h1><a name="plus.nativeObj.ImageSlider">ImageSlider</a></h1>
  234. <p>原生图片轮播控件对象</p>
  235. <pre class="prettyprint linenums">
  236. interface ImageSlider extends View {
  237. function void addImages(images);
  238. function Number currentImageIndex();
  239. function void setImages(images);
  240. }
  241. </pre>
  242. <h2>说明:</h2>
  243. <p class="des">
  244. 原生图片轮播控件对象从原生View控件(plus.nativeObj.View)继承而来,用于绘制图片轮播内容。
  245. </p>
  246. <h2>构造:</h2>
  247. <ul><li>
  248. <a href="#plus.nativeObj.ImageSlider.ImageSlider(id,%20styles,%20tags)">ImageSlider(id, styles, tags)</a>: 创建图片轮播控件对象</li></ul>
  249. <h2>方法:</h2>
  250. <ul>
  251. <li>
  252. <a href="#plus.nativeObj.ImageSlider.addImages">addImages</a>: 添加图片轮播控件的图片</li>
  253. <li>
  254. <a href="#plus.nativeObj.ImageSlider.currentImageIndex">currentImageIndex</a>: 获取当前图片轮播控件显示的图片索引值</li>
  255. <li>
  256. <a href="#plus.nativeObj.ImageSlider.setImages">setImages</a>: 设置图片轮播控件的图片</li>
  257. </ul>
  258. <h1><a name="plus.nativeObj.ImageSliderStyles">ImageSliderStyles</a></h1>
  259. <p>图片轮播控件样式</p>
  260. <pre class="prettyprint linenums">
  261. interface ImageSliderStyles extends ViewStyles {
  262. attribute Boolean autoplay;
  263. attribute Array&lt;ImageSliderImageStyles&gt; images;
  264. attribute Boolean loop;
  265. attribute Boolean fullscreen;
  266. } </pre>
  267. <h2>说明:</h2>
  268. <p class="des">
  269. 从ViewStyles继承而来,扩展支持轮播图片等配置。
  270. </p>
  271. <h2>属性:</h2>
  272. <ul>
  273. <li>autoplay: <em>(<font class="type">Boolean</font>
  274. 类型
  275. )</em>是否自动播放<br><p>
  276. 可取值:
  277. "true" - 自动播放;
  278. "false" - 不自动播放。
  279. 默认值为"false"。
  280. </p>
  281. </li>
  282. <li>fullscreen: <em>(<font class="type">Boolean</font>
  283. 类型
  284. )</em>是否可全屏显示<br><p>
  285. 可取值:
  286. "true" - 表示可全屏显示,用户点击轮播图片时全屏显示;
  287. "false" - 表示不可全屏显示,用户点击轮播图片时无响应。
  288. 默认值为"true"。
  289. </p>
  290. </li>
  291. <li>loop: <em>(<font class="type">Boolean</font>
  292. 类型
  293. )</em>是否可循环轮播<br><p>
  294. 可取值:
  295. "true" - 支持循环轮播;
  296. "false" - 不支持循环轮播。
  297. 默认值为"false"。
  298. </p>
  299. </li>
  300. <li>images: <em>(<font class="type">Array</font>[
  301. <a href="#plus.nativeObj.ImageSliderImageStyles">ImageSliderImageStyles</a>
  302. ]
  303. 类型
  304. )</em>轮播的图片<br><p>
  305. 至少必须设置一张图片的地址信息,否则可能导致图片轮播控件显示不正常。
  306. </p>
  307. </li>
  308. <li>interval: <em>(<font class="type">Number</font>
  309. 类型
  310. )</em>自动播放切换时间<br><p>
  311. 当autoplay属性值为true时生效,单位为毫秒。默认值为3000(3秒)。
  312. </p>
  313. </li>
  314. </ul>
  315. <h1><a name="plus.nativeObj.ImageSliderImageStyles">ImageSliderImageStyles</a></h1>
  316. <p>图片轮播控件中图片项配置参数</p>
  317. <h2>说明:</h2>
  318. <p class="des">
  319. 用于指定图片地址等信息。
  320. </p>
  321. <h2>属性:</h2>
  322. <ul>
  323. <li>src: <em>(<font class="type">String</font>
  324. 类型
  325. )</em>图片地址<br><p>
  326. 支持本地地址(相对地址、绝对路径、RelativeURL、本地路径URL);
  327. 也支持网络地址(http://或https://)。
  328. </p>
  329. </li>
  330. <li>align: <em>(<font class="type">String</font>
  331. 类型
  332. )</em>图片水平对齐方式<br><p>
  333. 仅在图片显示的宽度与图片轮播控件宽度不一致时有效,可取值:
  334. "left" - 图片在轮播控件中水平居左对齐;
  335. "center" - 图片在轮播控件中水平居中对齐;
  336. "right" - 图片在轮播控件中水平居右对齐。
  337. 默认值为"center"。
  338. </p>
  339. </li>
  340. <li>height: <em>(<font class="type">String</font>
  341. 类型
  342. )</em>图片显示的高度<br><p>
  343. 可取值:
  344. 像素值,如"100px";
  345. 百分比,如"10%",现对于图片轮播控件的高度;
  346. 自动计算"auto",如果指定图片宽度(width),则按图片实际大小等比缩放图片高度值,如果没有指定宽度(width值为"auto")则自动缩放图片至可完整显示。
  347. </p>
  348. </li>
  349. <li>width: <em>(<font class="type">String</font>
  350. 类型
  351. )</em>图片显示的宽度<br><p>
  352. 可取值:
  353. 像素值,如"100px";
  354. 百分比,如"10%",相对于图片轮播控件的宽度;
  355. 自动计算"auto",如果指定图片高度(height),则按图片实际大小等比缩放图片宽度值,如果没有指定高度(height值为"auto")则自动缩放图片至可完整显示。
  356. 默认值为"auto"。
  357. </p>
  358. </li>
  359. <li>verticalAlign: <em>(<font class="type">String</font>
  360. 类型
  361. )</em>图片垂直对齐方式<br><p>
  362. 仅在图片显示的高度与图片轮播控件宽度不一致时有效,可取值:
  363. "top" - 图片在轮播控件中垂直居顶对齐;
  364. "middle" - 图片在轮播控件中垂直居中对齐;
  365. "bottom" - 图片在轮播控件中垂直居底对齐。
  366. 默认值为"middle"。
  367. </p>
  368. </li>
  369. </ul>
  370. <h1><a name="plus.nativeObj.InputStyles">InputStyles</a></h1>
  371. <p>输入框样式</p>
  372. <pre class="prettyprint linenums">
  373. interface InputStyles{
  374. attribute String type;
  375. attribute String placeholder;
  376. attribute String fontSize;
  377. attribute String borderWidth;
  378. attribute String borderColor;
  379. attribute String borderRadius;
  380. attribute function onComplete;
  381. attribute function onFocus;
  382. attribute function onBlur;
  383. }
  384. </pre>
  385. <h2>说明:</h2>
  386. <p class="des">
  387. 用于定义输入框的显示样式,如字体大小,提示内容等信息。
  388. 输入文本内容在指定区域水平居左,垂直居中显示。
  389. </p>
  390. <h2>属性:</h2>
  391. <ul>
  392. <li>type: <em>(<font class="type">String</font>
  393. 类型
  394. )</em>输入框类型<br><p>
  395. 可取值:
  396. "email" - 邮箱地址输入框;
  397. "number" - 数字输入框;
  398. "search" - 搜索文本输入框;
  399. "tel" - 电话号码输入框;
  400. "text" - 普通文本输入框;
  401. "url" - URL地址输入框。
  402. 默认为text(即普通文本输入框)。
  403. </p>
  404. </li>
  405. <li>placeholder: <em>(<font class="type">String</font>
  406. 类型
  407. )</em>输入框的提示文本<br><p>
  408. 当用户未输入内容时显示在编辑框中(灰色文字)。
  409. </p>
  410. </li>
  411. <li>fontSize: <em>(<font class="type">String</font>
  412. 类型
  413. )</em>输入框的字体大小<br><p>
  414. 可取值:字体高度像素值,数字加"px"格式字符串,如"12px"。
  415. 默认值为"16px"。
  416. </p>
  417. </li>
  418. <li>borderColor: <em>(<font class="type">String</font>
  419. 类型
  420. )</em>输入框的边框颜色<br><p>
  421. 可取值: "#RRGGBB"格式字符串,如"#FF0000"表示红色边框。默认值为"#000000"(黑色)。
  422. </p>
  423. </li>
  424. <li>borderRadius: <em>(<font class="type">String</font>
  425. 类型
  426. )</em>输入框边框圆角半径<br><p>
  427. 可取值:圆角半径像素值,数字加"px"格式字符串,如"6px"。
  428. 默认值为"0px"(边框无圆角)。
  429. </p>
  430. </li>
  431. <li>borderWidth: <em>(<font class="type">String</font>
  432. 类型
  433. )</em>输入框的边框宽度<br><p>
  434. 可取值:像素值,数字加"px"格式字符串,如"2px"。 默认值为"1px"。
  435. </p>
  436. </li>
  437. <li>onComplete: <em>(<a href="#plus.nativeObj.InputCompleteCallback">InputCompleteCallback</a>
  438. 类型
  439. )</em>输入框完成输入事件<br><p>
  440. 弹出软键盘完成输入后,点击软键盘上的“完成”、“前往”按钮时触发。
  441. </p>
  442. </li>
  443. <li>onFocus: <em>(<a href="#plus.nativeObj.InputEventCallback">InputEventCallback</a>
  444. 类型
  445. )</em>输入框获取焦点事件<br><p>
  446. 当编辑框获取焦点时触发。
  447. </p>
  448. </li>
  449. <li>onBlur: <em>(<a href="#plus.nativeObj.InputEventCallback">InputEventCallback</a>
  450. 类型
  451. )</em>输入框失去焦点事件<br><p>
  452. 当编辑框失去焦点时触发。
  453. </p>
  454. </li>
  455. </ul>
  456. <h1><a name="plus.nativeObj.Rect">Rect</a></h1>
  457. <p>区域信息对象</p>
  458. <pre class="prettyprint linenums">
  459. interface Rect {
  460. attribute String top;
  461. attribute String left;
  462. attribute String width;
  463. attribute String height;
  464. } </pre>
  465. <h2>说明:</h2>
  466. <p class="des">
  467. 包括位置、大小等信息。
  468. </p>
  469. <h2>属性:</h2>
  470. <ul>
  471. <li>top: <em>(<font class="type">String</font>
  472. 类型
  473. )</em>区域左上角的垂直偏移量<br><p>
  474. 可取值:
  475. 像素值,如"100px";
  476. 百分比,如"10%",相对于作用对象的高度;
  477. 自动计算,如"auto",根据height值自动计算,相对于作用对象垂直居中。
  478. </p>
  479. </li>
  480. <li>left: <em>(<font class="type">String</font>
  481. 类型
  482. )</em>区域左上角的水平偏移量<br><p>
  483. 可取值:
  484. 像素值,如"100px";
  485. 百分比,如"10%",相对于作用对象的宽度;
  486. 自动计算,如"auto",根据width值自动计算,相对于作用对象水平居中。
  487. </p>
  488. </li>
  489. <li>width: <em>(<font class="type">String</font>
  490. 类型
  491. )</em>区域的宽度<br><p>
  492. 可取值:
  493. 像素值,如"100px";
  494. 百分比,如"10%",相对于作用对象的宽度。
  495. </p>
  496. </li>
  497. <li>height: <em>(<font class="type">String</font>
  498. 类型
  499. )</em>区域的高度<br><p>
  500. 可取值:
  501. 像素值,如"100px";
  502. 百分比,如"10%",相对于作用对象的高度。
  503. 内容自适应,如"wrap_content",根据内容计算高度(如调用drawText绘制文本时支持)。
  504. </p>
  505. </li>
  506. </ul>
  507. <h1><a name="plus.nativeObj.RectStyles">RectStyles</a></h1>
  508. <p>绘制区域样式对象</p>
  509. <pre class="prettyprint linenums">
  510. interface RectStyles {
  511. attribute String color;
  512. attribute String radius;
  513. attribute String borderColor;
  514. attribute String borderWidth;
  515. } </pre>
  516. <h2>说明:</h2>
  517. <p class="des">
  518. 用于定义矩形区域的显示样式,如空心/实心样式、圆角等信息。
  519. </p>
  520. <h2>属性:</h2>
  521. <ul>
  522. <li>color: <em>(<font class="type">String</font>
  523. 类型
  524. )</em>绘制颜色<br><p>
  525. 矩形填充区域的颜色,可取值:
  526. "#RRGGBB"格式字符串,如"#FF0000"表示绘制红色区域;
  527. "rgba(R,G,B,A)",其中R/G/B分别代表红色值/绿色值/蓝色值,正整数类型,取值范围为0-255,A为透明度,浮点数类型,取值范围为0-1(0为全透明,1为不透明),如"rgba(255,0,0,0.5)",表示红色半透明。
  528. 默认值为"#FFFFFF"(白色)。
  529. </p>
  530. </li>
  531. <li>radius: <em>(<font class="type">String</font>
  532. 类型
  533. )</em>矩形区域的圆角半径<br><p>
  534. 可取值:圆角半径像素值,数字加"px"格式字符串,如"6px"。
  535. 默认值为"0px"(矩形无圆角)。
  536. </p>
  537. </li>
  538. <li>borderColor: <em>(<font class="type">String</font>
  539. 类型
  540. )</em>矩形边框颜色<br><p>
  541. 绘制矩形边框的颜色,可取值:
  542. "#RRGGBB"格式字符串,如"#FF0000"表示绘制红色区域;
  543. "rgba(R,G,B,A)",其中R/G/B分别代表红色值/绿色值/蓝色值,正整数类型,取值范围为0-255,A为透明度,浮点数类型,取值范围为0-1(0为全透明,1为不透明),如"rgba(255,0,0,0.5)",表示红色半透明。
  544. 默认值为矩形填充区域颜色(color属性值)。
  545. </p>
  546. </li>
  547. <li>borderWidth: <em>(<font class="type">String</font>
  548. 类型
  549. )</em>矩形边框宽度<br><p>
  550. 可取值:像素值,数字加"px"格式字符串,如"2px"。
  551. 默认值为"0px"(无边框)。
  552. </p>
  553. </li>
  554. </ul>
  555. <h1><a name="plus.nativeObj.RichTextStyles">RichTextStyles</a></h1>
  556. <p>富文本样式</p>
  557. <pre class="prettyprint linenums">
  558. interface RichTextStyles{
  559. attribute String align;
  560. attribute String family;
  561. attribute String fontSrc;
  562. attribute Function onClick;
  563. }
  564. </pre>
  565. <h2>说明:</h2>
  566. <p class="des">
  567. 用于定义富文本使用的默认使用的字体名称、字体文件路径等信息。
  568. </p>
  569. <h2>属性:</h2>
  570. <ul>
  571. <li>align: <em>(<font class="type">String</font>
  572. 类型
  573. )</em>富文本内容的水平对齐方式<br><p>
  574. 对整体内容有效,无法单独控制每行的内容。
  575. 可取值:
  576. "left"-字体在指定的区域中水平居左对齐;
  577. "center"-字体在指定的区域中水平居中对齐;
  578. "right"-字体在指定的区域中水平居右对齐。
  579. 默认值为"left"。
  580. </p>
  581. </li>
  582. <li>family: <em>(<font class="type">String</font>
  583. 类型
  584. )</em>富文本默认使用的字体名称<br><p>
  585. 例如"Times New Roman", 如果指定名称的字体不存在,则使用系统默认字体。
  586. </p>
  587. </li>
  588. <li>fontSrc: <em>(<font class="type">String</font>
  589. 类型
  590. )</em>富文本默认使用的字体文件路径<br><p>
  591. 加载字体文件路径,必须为本地路径,如果指定的文件路径无效,则使用系统默认字体。
  592. </p>
  593. </li>
  594. <li>onClick: <em>(<a href="#plus.nativeObj.RichTextClickedCallback">RichTextClickedCallback</a>
  595. 类型
  596. )</em>点击事件回调函数<br><p>
  597. 如果设置此属性,则表示拦截所有RichText上的点击事件(不透传事件)。
  598. 如果没有设置此属性,则仅拦截操作包含onclick属性的a/img标签的点击事件。
  599. </p>
  600. </li>
  601. </ul>
  602. <h1><a name="plus.nativeObj.Position">Position</a></h1>
  603. <p>区域信息对象</p>
  604. <pre class="prettyprint linenums">
  605. interface Position {
  606. attribute String top;
  607. attribute String left;
  608. attribute String width;
  609. attribute String height;
  610. attribute String bottom;
  611. attribute String right;
  612. } </pre>
  613. <h2>说明:</h2>
  614. <p class="des">
  615. 包括位置、大小等信息。
  616. </p>
  617. <h2>属性:</h2>
  618. <ul>
  619. <li>top: <em>(<font class="type">String</font>
  620. 类型
  621. )</em>区域顶部相对于作用对象(或容器)向下的偏移量<br><p>
  622. 可取值:像素值,如"100px";百分比,如"10%",相对于作用对象(或容器)的高度;
  623. 自动计算,如"auto",根据height值自动计算,相对于作用对象(或容器)垂直居中。
  624. </p>
  625. </li>
  626. <li>left: <em>(<font class="type">String</font>
  627. 类型
  628. )</em>区域左侧相对于作用对象(或容器)向右的偏移量<br><p>
  629. 可取值:像素值,如"100px";百分比,如"10%",相对于作用对象(或容器)的宽度;
  630. 自动计算,如"auto",根据width值自动计算,相对于作用对象(或容器)水平居中。
  631. </p>
  632. </li>
  633. <li>width: <em>(<font class="type">String</font>
  634. 类型
  635. )</em>区域的宽度<br><p>
  636. 可取值:像素值,如"100px";百分比,如"10%",相对于作用对象(或容器)的宽度。
  637. </p>
  638. </li>
  639. <li>height: <em>(<font class="type">String</font>
  640. 类型
  641. )</em>区域的高度<br><p>
  642. 可取值:像素值,如"100px";百分比,如"10%",相对于作用对象(或容器)的高度。
  643. </p>
  644. </li>
  645. <li>bottom: <em>(<font class="type">String</font>
  646. 类型
  647. )</em>区域底部相对于作用对象(或容器)向上的偏移量<br><p>
  648. 可取值:像素值,如"100px";百分比,如"10%",相对于作用对象(或容器)的高度。
  649. 当设置了top和height值时,忽略此属性值;
  650. 当未设置top值时,可通过bottom属性值来确定区域的垂直位置;
  651. 当未设置height值时,可通过top和bottom属性值来确定区域的高度。
  652. </p>
  653. </li>
  654. <li>right: <em>(<font class="type">String</font>
  655. 类型
  656. )</em>区域右侧相对于作用对象(或容器)向左的偏移量<br><p>
  657. 可取值:像素值,如"100px";百分比,如"10%",相对于作用对象(或容器)的宽度。
  658. 当设置了left和width值时,忽略此属性值;
  659. 当未设置left值时,可通过right属性值来确定区域的水平位置;
  660. 当未设置width值时,可通过left和right属性值来确定区域的宽度。
  661. </p>
  662. </li>
  663. </ul>
  664. <h1><a name="plus.nativeObj.TextStyles">TextStyles</a></h1>
  665. <p>绘制文本样式对象</p>
  666. <pre class="prettyprint linenums">
  667. interface TextStyles {
  668. attribute String align;
  669. attribute String color;
  670. attribute String family;
  671. attribute String size;
  672. attribute String style;
  673. attribute String weight;
  674. attribute String fontSrc;
  675. attribute String overflow;
  676. } </pre>
  677. <h2>说明:</h2>
  678. <p class="des">
  679. 用于定义文本的显示样式,如字体大小、字体颜色、字体粗细、字体样式、字体名称等信息。
  680. </p>
  681. <h2>属性:</h2>
  682. <ul>
  683. <li>align: <em>(<font class="type">String</font>
  684. 类型
  685. )</em>水平对齐方式<br><p>
  686. 可取值:
  687. "left"-字体在指定的区域中水平居左对齐;
  688. "center"-字体在指定的区域中水平居中对齐;
  689. "right"-字体在指定的区域中水平居右对齐。
  690. 默认值为"center"。
  691. </p>
  692. </li>
  693. <li>color: <em>(<font class="type">String</font>
  694. 类型
  695. )</em>字体颜色<br><p>
  696. 可取值:
  697. "#RRGGBB"格式字符串,如"#FF0000"表示绘制红色区域;
  698. "rgba(R,G,B,A)",其中R/G/B分别代表红色值/绿色值/蓝色值,正整数类型,取值范围为0-255,A为透明度,浮点数类型,取值范围为0-1(0为全透明,1为不透明),如"rgba(255,0,0,0.5)",表示红色半透明。
  699. 默认值为"#000000"(黑色)。
  700. </p>
  701. </li>
  702. <li>decoration: <em>(<font class="type">Boolean</font>
  703. 类型
  704. )</em>文本装饰<br><p>
  705. 可取值:
  706. "none" - 无装饰效果;
  707. "underline" - 文本带下划线效果;
  708. "line-through" - 文本带贯穿线(删除线)效果。
  709. 默认值为"none"。
  710. </p>
  711. </li>
  712. <li>family: <em>(<font class="type">String</font>
  713. 类型
  714. )</em>字体名称<br><p>
  715. 例如"Times New Roman", 如果指定名称的字体不存在,则使用默认字体。
  716. </p>
  717. </li>
  718. <li>fontSrc: <em>(<font class="type">String</font>
  719. 类型
  720. )</em>字体文件路径<br><p>
  721. 加载字体文件路径。
  722. </p>
  723. </li>
  724. <li>lineSpacing: <em>(<font class="type">String</font>
  725. 类型
  726. )</em>文本的行间距<br><p>
  727. 可取值:
  728. 像素值,如"100px";百分比,如"10%",相对于字体的高度(size属性);
  729. 默认值为"20%"。
  730. </p>
  731. </li>
  732. <li>margin: <em>(<font class="type">String</font>
  733. 类型
  734. )</em>字体的边距<br><p>
  735. 用于设置字体在绘制目标区域四个方向(top/right/bottom/left)的边距,可取值:像素值,如"10px";百分比,相对于绘制目标区域,如"5%";
  736. 默认值为"0px"。
  737. </p>
  738. </li>
  739. <li>overflow: <em>(<font class="type">String</font>
  740. 类型
  741. )</em>文本内容超出显示区域时处理方式<br><p>
  742. 可取值:
  743. "clip" - 超出显示区域时内容裁剪;
  744. "ellipsis" - 超出显示区域时尾部显示省略标记(...)。
  745. 默认值为"clip"。
  746. </p>
  747. </li>
  748. <li>size: <em>(<font class="type">String</font>
  749. 类型
  750. )</em>字体大小<br><p>
  751. 可取值:字体高度像素值,数字加"px"格式字符串,如"12px"。
  752. 默认值为"16px"。
  753. </p>
  754. </li>
  755. <li>style: <em>(<font class="type">String</font>
  756. 类型
  757. )</em>字体样式<br><p>
  758. 可取值:"normal" - 正常字体样式;"italic" - 斜体样式。默认值为"normal"。
  759. </p>
  760. </li>
  761. <li>verticalAlign: <em>(<font class="type">String</font>
  762. 类型
  763. )</em>垂直对齐方式<br><p>
  764. 文本内容在指定绘制区域中的垂直对齐方式,可取值:
  765. "top" - 垂直居顶对齐;
  766. "middle" - 垂直居中对齐;
  767. "bottom" - 垂直居底对齐。
  768. 默认值为"middle"。
  769. </p>
  770. </li>
  771. <li>weight: <em>(<font class="type">String</font>
  772. 类型
  773. )</em>字体粗细<br><p>
  774. 可取值:"normal" - 普通字体;"bold" - 粗字体。默认值为"normal"。
  775. </p>
  776. </li>
  777. <li>whiteSpace: <em>(<font class="type">String</font>
  778. 类型
  779. )</em>文本换行模式<br><p>
  780. 可取值:
  781. "nowrap" - 不换行,将所有文本在一行中绘制,忽略换行符("\n");
  782. "normal" - 自动换行,当指定的宽度无法绘制所有文本时自动换行绘制,碰到'\n'字符时强制换行。
  783. 默认值为"nowrap"。
  784. </p>
  785. </li>
  786. </ul>
  787. <h1><a name="plus.nativeObj.View">View</a></h1>
  788. <p>原生控件对象</p>
  789. <pre class="prettyprint linenums">
  790. interface View {
  791. readonly attribute String id;
  792. static function void startAnimation(options, view, otherview, callback);
  793. static function void clearAnimation(type);
  794. static function View getViewById(id);
  795. function void addEventListener(event, listener, capture);
  796. function void animate(options, callback);
  797. function void close();
  798. function void clearRect(position, id);
  799. function void draw(tags);
  800. function void drawBitmap(src, sprite, position, id);
  801. function void drawRect(color, position, id);
  802. function void drawText(text, position, styles, id);
  803. function void drawRichText(text, position, styles, id);
  804. function void drawInput(position, styles, id);
  805. function Boolean getInputFocusById(id);
  806. function String getInputValueById(id);
  807. function void reset();
  808. function void restore();
  809. function void show();
  810. function void setInputFocusById(id, focusable);
  811. function void setStyle(styles);
  812. function void setTouchEventRect(rect);
  813. function void hide();
  814. function void interceptTouchEvent(intercept);
  815. function Boolean isVisible();
  816. }
  817. </pre>
  818. <h2>说明:</h2>
  819. <p class="des">
  820. 原生控件对象可用于在屏幕上绘制图片或文本内容,当控件不再使用时需要调用close方法销毁控件。
  821. NView不支持zindex,后显示的覆盖先显示的;
  822. 调用Webview窗口对象的append方法添加到Webview中,显示在父窗口所有子Webview的上面;不添加到Webview窗口对象,显示在所有Webview的上面。
  823. </p>
  824. <h2>构造:</h2>
  825. <ul><li>
  826. <a href="#plus.nativeObj.View.View(id,%20styles,%20tags)">View(id, styles, tags)</a>: 创建View对象</li></ul>
  827. <h2>属性:</h2>
  828. <ul><li>
  829. <a href="#plus.nativeObj.View.id">id</a>: View对象的标识</li></ul>
  830. <h2>方法:</h2>
  831. <ul>
  832. <li>
  833. <a href="#plus.nativeObj.View.startAnimation">startAnimation</a>: 静态方法,开始原生动画</li>
  834. <li>
  835. <a href="#plus.nativeObj.View.clearAnimation">clearAnimation</a>: 静态方法,关闭原生动画窗口</li>
  836. <li>
  837. <a href="#plus.nativeObj.View.getViewById">getViewById</a>: 静态方法,获取指定标识的View控件对象</li>
  838. <li>
  839. <a href="#plus.nativeObj.View.addEventListener">addEventListener</a>: 添加事件监听器</li>
  840. <li>
  841. <a href="#plus.nativeObj.View.animate">animate</a>: View控件内容动画</li>
  842. <li>
  843. <a href="#plus.nativeObj.View.close">close</a>: 关闭View控件</li>
  844. <li>
  845. <a href="#plus.nativeObj.View.clearRect">clearRect</a>: 清空矩形区域</li>
  846. <li>
  847. <a href="#plus.nativeObj.View.draw">draw</a>: 绘制内容</li>
  848. <li>
  849. <a href="#plus.nativeObj.View.drawBitmap">drawBitmap</a>: 绘制图片</li>
  850. <li>
  851. <a href="#plus.nativeObj.View.drawRect">drawRect</a>: 绘制矩形区域</li>
  852. <li>
  853. <a href="#plus.nativeObj.View.drawText">drawText</a>: 绘制文本</li>
  854. <li>
  855. <a href="#plus.nativeObj.View.drawRichText">drawRichText</a>: 绘制富文本</li>
  856. <li>
  857. <a href="#plus.nativeObj.View.drawInput">drawInput</a>: 绘制输入框</li>
  858. <li>
  859. <a href="#plus.nativeObj.View.getInputFocusById">getInputFocusById</a>: 获取编辑框的焦点状态</li>
  860. <li>
  861. <a href="#plus.nativeObj.View.getInputValueById">getInputValueById</a>: 获取编辑框的内容</li>
  862. <li>
  863. <a href="#plus.nativeObj.View.reset">reset</a>: 重置view控件显示内容</li>
  864. <li>
  865. <a href="#plus.nativeObj.View.restore">restore</a>: 恢复View控件显示内容</li>
  866. <li>
  867. <a href="#plus.nativeObj.View.show">show</a>: 显示View控件</li>
  868. <li>
  869. <a href="#plus.nativeObj.View.setInputFocusById">setInputFocusById</a>: 设置编辑框的焦点状态</li>
  870. <li>
  871. <a href="#plus.nativeObj.View.setStyle">setStyle</a>: 设置View控件的样式</li>
  872. <li>
  873. <a href="#plus.nativeObj.View.setTouchEventRect">setTouchEventRect</a>: 指定监听触屏事件区域</li>
  874. <li>
  875. <a href="#plus.nativeObj.View.hide">hide</a>: 隐藏View控件</li>
  876. <li>
  877. <a href="#plus.nativeObj.View.interceptTouchEvent">interceptTouchEvent</a>: 是否拦截View控件的触屏事件</li>
  878. <li>
  879. <a href="#plus.nativeObj.View.isVisible">isVisible</a>: 获取View控件的显示状态</li>
  880. </ul>
  881. <h1><a name="plus.nativeObj.ViewAnimationOptions">ViewAnimationOptions</a></h1>
  882. <p>View控件动画参数</p>
  883. <pre class="prettyprint linenums">
  884. interface ViewAnimationOptions {
  885. attribute String type;
  886. attribute Number duration;
  887. attribute Number frames;
  888. attribute Rect region;
  889. } </pre>
  890. <h2>说明:</h2>
  891. <p class="des">
  892. 指定动画的类型、持续时间等信息。
  893. </p>
  894. <h2>属性:</h2>
  895. <ul>
  896. <li>type: <em>(<font class="type">String</font>
  897. 类型
  898. )</em>动画类型<br><p>
  899. 可取值:"shrink" - 从上到下分块收缩清除窗口动画。
  900. </p>
  901. </li>
  902. <li>duration: <em>(<font class="type">Number</font>
  903. 类型
  904. )</em>动画持续时间<br><p>
  905. 单位为毫秒,默认值为200ms。
  906. </p>
  907. </li>
  908. <li>frames: <em>(<font class="type">Number</font>
  909. 类型
  910. )</em>动画帧数<br><p>
  911. 必须为大于0的整数,默认值为12。
  912. </p>
  913. </li>
  914. <li>region: <em>(<a href="#plus.nativeObj.Rect">Rect</a>
  915. 类型
  916. )</em>动画作用区域<br><p>
  917. 支持以下属性:
  918. top - 区域距离控件顶部的偏移量,属性值可取像素值(如"100px"),百分比(如"10%",相对于控件的高度),默认值为'0px';
  919. bottom - 区域距离控件底部的偏移量,属性值可取像素值(如"100px"),百分比(如"10%",相对于控件的高度),默认值为'0px';
  920. left - 区域距离控件左侧的偏移量,属性值可取像素值(如"100px"),百分比(如"10%",相对于控件的宽度),默认值为'0px';
  921. right - 区域距离控件右侧的偏移量,属性值可取像素值(如"100px"),百分比(如"10%",相对于控件的宽度),默认值为'0px'。
  922. 如“{top:'44px',bottom:'48px'}”。
  923. </p>
  924. </li>
  925. </ul>
  926. <h1><a name="plus.nativeObj.ViewDrawTagStyles">ViewDrawTagStyles</a></h1>
  927. <p>View控件绘制元素参数</p>
  928. <pre class="prettyprint linenums">
  929. interface ViewDrawTagStyles {
  930. attribute String id;
  931. attribute String tag;
  932. attribute String color;
  933. attribute InputStyles inputStyles;
  934. attribute Position position;
  935. attribute RectStyles rectStyles;
  936. attribute String src;
  937. attribute Position sprite;
  938. attribute String text;
  939. attribute TextStyles textStyles;
  940. attribute RichTextStyles richTextStyles;
  941. } </pre>
  942. <h2>说明:</h2>
  943. <p class="des">
  944. 指定绘制图片、矩形区域、文本内容等信息。
  945. </p>
  946. <h2>属性:</h2>
  947. <ul>
  948. <li>id: <em>(<font class="type">String</font>
  949. 类型
  950. )</em>绘制操作标识<br><p>
  951. 可通过view对象的drawBitmap/drawRect/drawText/clearRect方法进行更新。
  952. </p>
  953. </li>
  954. <li>tag: <em>(<font class="type">String</font>
  955. 类型
  956. )</em>绘制操作类型<br><p>
  957. 可取值:
  958. "img" - 绘制图片,与drawBitmap操作一致,此时id、src、position、sprite属性值有效;
  959. "rect" - 绘制矩形区域,与drawRect操作一致,此时id、color、position、rectStyles属性值有效;
  960. "font" - 绘制文本内容,与drawText操作一致,此时id、position、text、textStyles属性值有效;
  961. "richtext" - 绘制富文本内容,与drawRichText操作一致,此时id、position、text、richTextStyles属性值有效;
  962. "input" - 绘制输入框内容,此时id、position、inputStyles属性值有效。
  963. </p>
  964. </li>
  965. <li>color: <em>(<font class="type">String</font>
  966. 类型
  967. )</em>矩形区域颜色<br><p>
  968. 不推荐使用(推荐使用rectStyles),可取值:
  969. "#RRGGBB"格式字符串,如红色为"#FF0000"。
  970. "rgba(R,G,B,A)",其中R/G/B分别代表红色值/绿色值/蓝色值,正整数类型,取值范围为0-255,A为透明度,浮点数类型,取值范围为0-1(0为全透明,1为不透明),如"rgba(255,0,0,0.5)",表示红色半透明。
  971. 当tag属性值为"rect"时有效,用于指定矩形区域颜色,默认值为"#FFFFFF"(白色)。
  972. </p>
  973. </li>
  974. <li>inputStyles: <em>(<a href="#plus.nativeObj.InputStyles">InputStyles</a>
  975. 类型
  976. )</em>绘制输入框的样式<br><p>
  977. 当tag属性值为"input"时有效,用于指定绘制输入框的样式、大小位置等信息。,
  978. </p>
  979. </li>
  980. <li>position: <em>(<a href="#plus.nativeObj.Position">Position</a>
  981. 类型
  982. )</em>绘制内容区域<br><p>
  983. 当tag属性值为"img"时,用于指定绘制图片的目标区域;
  984. 当tag属性值为"rect"时,用于指定绘制的矩形区域;
  985. 当tag属性值为"font"时,用于指定绘制文本的目标区域,此时height属性值支持设置为"wrap_content",表示文本高度根据内容自动计算,此时通过top来定位文本绘制的起始位置。
  986. 相对于View控件的区域信息,默认值为{top:'0px',left:'0px',width:'100%',height:'100%'}。
  987. </p>
  988. </li>
  989. <li>rectStyles: <em>(<a href="#plus.nativeObj.RectStyles">RectStyles</a>
  990. 类型
  991. )</em>绘制区域的样式<br><p>
  992. 当tag属性值为"rect"时有效,用于指定绘制区域的样式、填充颜色、圆角大小等信息。
  993. </p>
  994. </li>
  995. <li>src: <em>(<font class="type">String</font>
  996. 类型
  997. )</em>绘制的图片资源<br><p>
  998. 当tag属性值为"img"时有效,可以是图片资源路径(字符串类型)或者图片对象(plus.nativeObj.Bitmap对象)。
  999. src路径支持gif图片,但设置的图片路径文件使用".gif"后缀时则认为是gif图片,如"_www/loading.gif"。
  1000. </p>
  1001. </li>
  1002. <li>sprite: <em>(<a href="#plus.nativeObj.Position">Position</a>
  1003. 类型
  1004. )</em>图片源的绘制区域<br><p>
  1005. 当tag属性值为"img"时有效,用于指定图片源的绘制区域,相对于图片的区域信息,默认值为{top:'0px',left:'0px',width:'100%',height:'100%'}。
  1006. </p>
  1007. </li>
  1008. <li>text: <em>(<font class="type">String</font>
  1009. 类型
  1010. )</em>绘制的文本内容<br><p>
  1011. 当tag属性值为"font"时有效,用于保存绘制的文本内容。
  1012. </p>
  1013. </li>
  1014. <li>textStyles: <em>(<a href="#plus.nativeObj.TextStyles">TextStyles</a>
  1015. 类型
  1016. )</em>绘制文本的样式<br><p>
  1017. 当tag属性值为"font"时有效,用于指定绘制文本内容的字体大小、字体颜色、字体类型等信息。
  1018. </p>
  1019. </li>
  1020. <li>richTextStyles: <em>(<a href="#plus.nativeObj.RichTextStyles">RichTextStyles</a>
  1021. 类型
  1022. )</em>绘制富文本的样式<br><p>
  1023. 当tag属性值为"richtext"时有效,用于指定绘制富文本内容的默认字体颜色、字体类型等信息。
  1024. </p>
  1025. </li>
  1026. </ul>
  1027. <h1><a name="plus.nativeObj.ViewEvents">ViewEvents</a></h1>
  1028. <p>View控件事件</p>
  1029. <h2>常量:</h2>
  1030. <ul>
  1031. <li>"doubleclick": <em>(<font class="type">String</font>
  1032. 类型
  1033. )</em>双击事件<br><p>
  1034. 双击屏幕时触发。
  1035. 注意:如果将View控件设置为不拦截触屏事件(view.interceptTouchEvent(false))则不会触发此事件。
  1036. </p>
  1037. </li>
  1038. <li>"click": <em>(<font class="type">String</font>
  1039. 类型
  1040. )</em>点击事件<br><p>
  1041. 当手指点击屏幕时触发。
  1042. 注意:如果将View控件设置为不拦截触屏事件(view.interceptTouchEvent(false))则不会触发此事件。
  1043. </p>
  1044. </li>
  1045. <li>"touchstart": <em>(<font class="type">String</font>
  1046. 类型
  1047. )</em>开始触屏事件<br><p>
  1048. 当手指触摸屏幕时候触发。
  1049. 注意:如果将View控件设置为不拦截触屏事件(view.interceptTouchEvent(false))则不会触发此事件。
  1050. </p>
  1051. </li>
  1052. <li>"touchmove": <em>(<font class="type">String</font>
  1053. 类型
  1054. )</em>触摸滑屏事件<br><p>
  1055. 当手指在屏幕上滑动的时候连续地触发。
  1056. 注意:如果将View控件设置为不拦截触屏事件(view.interceptTouchEvent(false))则不会触发此事件。
  1057. </p>
  1058. </li>
  1059. <li>"touchend": <em>(<font class="type">String</font>
  1060. 类型
  1061. )</em>结束触屏事件<br><p>
  1062. 当手指从屏幕上离开的时候触发。
  1063. 注意:如果将View控件设置为不拦截触屏事件(view.interceptTouchEvent(false))则不会触发此事件。
  1064. </p>
  1065. </li>
  1066. </ul>
  1067. <h1><a name="plus.nativeObj.ViewStatusbarStyles">ViewStatusbarStyles</a></h1>
  1068. <p>JSON对象,View控件的系统状态栏区域样式</p>
  1069. <h2>说明:</h2>
  1070. <p class="des">
  1071. 仅在应用设置为沉浸式状态栏样式下有效,非沉浸式状态栏样式下忽略此属性。
  1072. </p>
  1073. <h2>属性:</h2>
  1074. <ul><li>background: <em>(<font class="type">String</font>
  1075. 类型
  1076. )</em>系统状态栏区域背景颜色<br><p>
  1077. 颜色值格式为"#RRGGBB",如"#FF0000"表示为红色背景,默认值为应用manifest.json中plus-&gt;statusbar-&gt;background属性配置的值。
  1078. </p>
  1079. </li></ul>
  1080. <h1><a name="plus.nativeObj.ViewStyles">ViewStyles</a></h1>
  1081. <p>View控件样式</p>
  1082. <pre class="prettyprint linenums">
  1083. interface ViewStyles {
  1084. attribute String backgroundColor;
  1085. attribute String left;
  1086. attribute String top;
  1087. attribute String bottom;
  1088. attribute String height;
  1089. attribute String width;
  1090. attribute String dock;
  1091. attribute Number opacity;
  1092. attribute String position;
  1093. attribute ViewStatusbarStyles statusbar;
  1094. } </pre>
  1095. <h2>说明:</h2>
  1096. <p class="des">
  1097. 包括位置、大小等信息等,其中位置信息相对于父容器控件进行计算。
  1098. </p>
  1099. <h2>属性:</h2>
  1100. <ul>
  1101. <li>backgroundColor: <em>(<font class="type">String</font>
  1102. 类型
  1103. )</em>区域背景颜色<br><p>
  1104. 可取值:
  1105. #RRGGBB"格式字符串,如"#FF0000"表示绘制红色区域;
  1106. "rgba(R,G,B,A)",其中R/G/B分别代表红色值/绿色值/蓝色值,正整数类型,取值范围为0-255,A为透明度,浮点数类型,取值范围为0-1(0为全透明,1为不透明),如"rgba(255,0,0,0.5)",表示红色半透明。 默认值为"#FFFFFF"(白色)。 "rgba(R,G,B,A)",其中R/G/B分别代表红色值/绿色值/蓝色值,正整数类型,取值范围为0-255,A为透明度,浮点数类型,取值范围为0-1(0为全透明,1为不透明),如"rgba(255,0,0,0.5)",表示红色半透明。 默认值为"#FFFFFF"(白色)。
  1107. </p>
  1108. </li>
  1109. <li>bottom: <em>(<font class="type">String</font>
  1110. 类型
  1111. )</em>View控件垂直向上的偏移量<br><p>
  1112. 现对于父容器底部的距离,可取值:
  1113. 像素值,如"100px";
  1114. 百分比,如"10%",相对于父容器的高度,如果没有父容器则相对于屏幕高度。
  1115. 当设置了top和height值时,忽略此属性值;
  1116. 未设置height值时,可通过top和bottom属性值来确定View控件的高度。
  1117. </p>
  1118. </li>
  1119. <li>dock: <em>(<font class="type">String</font>
  1120. 类型
  1121. )</em>View控件的停靠方式<br><p>
  1122. 仅当View控件添加到Webview窗口对象中并且position属性值设置为"dock"时才生效,此时View控件挤压Webview窗口的大小。
  1123. 可取值:
  1124. "top",控件停靠则页面顶部;
  1125. "bottom",控件停靠在页面底部;
  1126. "right",控件停靠在页面右侧;
  1127. "left",控件停靠在页面左侧。
  1128. 默认值为"top"。
  1129. </p>
  1130. </li>
  1131. <li>height: <em>(<font class="type">String</font>
  1132. 类型
  1133. )</em>区域的高度<br><p>
  1134. 可取值:
  1135. 像素值,如"100px";
  1136. 百分比,如"10%",相对于父容器的高度,如果没有父容器则相对于屏幕高度;
  1137. 内容自适应,如"wrap_content",根据内容计算控件的高度。
  1138. 默认值为"100%"。
  1139. </p>
  1140. </li>
  1141. <li>left: <em>(<font class="type">String</font>
  1142. 类型
  1143. )</em>区域左上角的水平偏移量<br><p>
  1144. 可取值:
  1145. 像素值,如"100px";
  1146. 百分比,如"10%",相对于父控件的宽度;
  1147. 自动计算,如"auto",根据width值自动计算,相对于父控件水平居中。
  1148. 默认值为"0px"。
  1149. </p>
  1150. </li>
  1151. <li>opacity: <em>(<font class="type">Number</font>
  1152. 类型
  1153. )</em>View控件的不透明度<br><p>
  1154. 取值范围为0-1,0为全透明,1为不透明,默认值为1,即不透明。
  1155. </p>
  1156. </li>
  1157. <li>position: <em>(<font class="type">String</font>
  1158. 类型
  1159. )</em>View控件的排版方式<br><p>
  1160. 仅当View控件添加到Webview窗口对象中时才生效。
  1161. 可取值:
  1162. "static",View控件在页面中正常定位,如果页面存在滚动条则随窗口内容滚动;
  1163. "absolute",Veiw控件在页面中绝对定位,如果页面存在滚动条不随窗口内容滚动;
  1164. "dock",View控件在页面中停靠,停靠的位置由dock属性值决定。
  1165. 默认值为"absolute"。
  1166. </p>
  1167. </li>
  1168. <li>statusbar: <em>(<a href="#plus.nativeObj.ViewStatusbarStyles">ViewStatusbarStyles</a>
  1169. 类型
  1170. )</em>View控件的状态栏样式<br><p>
  1171. 仅在应用设置为沉浸式状态栏样式下有效,设置此属性后将自动保留系统状态栏区域不被View控件占用(即View控件非沉浸式样式显示)。
  1172. </p>
  1173. </li>
  1174. <li>top: <em>(<font class="type">String</font>
  1175. 类型
  1176. )</em>View控件左上角的垂直偏移量<br><p>
  1177. 可取值:像素值,如"100px";百分比,如"10%",相对于父控件的高度;自动计算,如"auto",根据height值自动计算,相对于父控件垂直居中。
  1178. </p>
  1179. </li>
  1180. <li>width: <em>(<font class="type">String</font>
  1181. 类型
  1182. )</em>区域的宽度<br><p>
  1183. 可取值:像素值,如"100px";百分比,如"10%",相对于父控件的宽度。
  1184. </p>
  1185. </li>
  1186. </ul>
  1187. <h1><a name="plus.nativeObj.BitmapSaveSuccessCallback">BitmapSaveSuccessCallback</a></h1>
  1188. <p>图片保存操作成功回调接口</p>
  1189. <pre class="prettyprint linenums">
  1190. void onSuccess( Event event ){
  1191. // Code here
  1192. var target = event.target; // 保存后的图片url路径,以"file://"开头
  1193. var size = event.size; // 保存后图片的大小,单位为字节(Byte)
  1194. var width = event.width; // 保存后图片的实际宽度,单位为px
  1195. var height = event.height; // 保存后图片的实际高度,单位为px
  1196. }
  1197. </pre>
  1198. <h2>参数:</h2>
  1199. <ul><li>event:
  1200. <em>(
  1201. <font class="type">Event</font>
  1202. )
  1203. 可选 </em>保存后的图片信息<br>
  1204. 可通过event.target(String类型)获取保存后的图片url路径,以"file://"开头,可直接在html页面中通过src属性引用,如Android平台"file:///storage/sdcard0/Android/data/io.dcloud.HBuilder/.HBuilder/apps/HBuilder/doc/a.jpg",iOS平台"file:///var/mobile/Containers/Data/Application/757966CF-345C-4348-B07F-EEF83CF9A369/Library/Pandora/apps/HBuilder/doc/a.png";
  1205. 可通过event.size(Number类型)获取保存后图片的大小,单位为字节(Byte);
  1206. 可通过event.width(Number类型)获取保存后的图片的实际宽度,单位为px;
  1207. 可通过event.height(Number类型)获取保存后的图片的实际高度,单位为px。
  1208. </li></ul>
  1209. <h2>返回值:</h2>
  1210. <font class="type">void</font>
  1211. : 无<h1><a name="plus.nativeObj.InputCompleteCallback">InputCompleteCallback</a></h1>
  1212. <p>输入框完成输入回调函数</p>
  1213. <pre class="prettyprint linenums">
  1214. void onComplete(Event event){
  1215. // Code here
  1216. var text = event.text; // 保存用户输入的内容
  1217. }
  1218. </pre>
  1219. <h2>说明:</h2>
  1220. <p class="des">
  1221. 弹出软键盘完成输入后,点击软键盘上的“完成”、“前往”按钮时触发。
  1222. </p>
  1223. <h2>参数:</h2>
  1224. <ul><li>event:
  1225. <em>(
  1226. <font class="type">Event</font>
  1227. )
  1228. 可选 </em>保存编辑框输入信息<br>
  1229. 可通过event.text(String类型)获取用户输入的文本。
  1230. </li></ul>
  1231. <h2>返回值:</h2>
  1232. <font class="type">void</font>
  1233. : 无<h1><a name="plus.nativeObj.InputEventCallback">InputEventCallback</a></h1>
  1234. <p>输入框事件回调函数</p>
  1235. <pre class="prettyprint linenums">
  1236. void onEvent(Event event){
  1237. // Code here
  1238. var id = event.id; // 编辑框的标识
  1239. }
  1240. </pre>
  1241. <h2>说明:</h2>
  1242. <p class="des">
  1243. 输入框获取/失去焦点时触发。
  1244. </p>
  1245. <h2>参数:</h2>
  1246. <ul><li>event:
  1247. <em>(
  1248. <font class="type">Event</font>
  1249. )
  1250. 可选 </em>输入框信息<br>
  1251. 可通过event.id(String类型)获取输入框的标识。
  1252. </li></ul>
  1253. <h2>返回值:</h2>
  1254. <font class="type">void</font>
  1255. : 无<h1><a name="plus.nativeObj.RichTextClickedCallback">RichTextClickedCallback</a></h1>
  1256. <p>富文本区域点击事件回调函数</p>
  1257. <pre class="prettyprint linenums">
  1258. void onEvent(Event event){
  1259. // Event handled code.
  1260. var tagName = event.tagName;
  1261. var href = event.href;
  1262. var src = event.src;
  1263. }
  1264. </pre>
  1265. <h2>说明:</h2>
  1266. <p class="des">
  1267. 用户点击RichText区域时触发,如果点击RichText的a标签则回调函数event参数中包含tagName(值为"a")和href属性;
  1268. 如果点击RichText的img标签则回调函数event参数中包含tagName(值为"img")和src属性;
  1269. 如果点击其它区域则回调函数event参数中包含tagName(值为"")。
  1270. </p>
  1271. <h2>参数:</h2>
  1272. <ul><li>event:
  1273. <em>(
  1274. <font class="type">Event</font>
  1275. )
  1276. 必选 </em>点击事件参数<br>
  1277. 包含以下属性:
  1278. "tagName" - 如果点击RichText上的a/img标签则为"a"/"img",否则未空字符串"";
  1279. "href" - 点击RichText上的a标签时有效;
  1280. "src" - 点击RichText上的img标签时有效。
  1281. </li></ul>
  1282. <h2>返回值:</h2>
  1283. <font class="type">void</font>
  1284. : 无<h1><a name="plus.nativeObj.TouchEventCallback">TouchEventCallback</a></h1>
  1285. <p>触屏事件的回调函数</p>
  1286. <pre class="prettyprint linenums">
  1287. void onEvent(Event e){
  1288. // Event handled code.
  1289. var clientX = e.clientX;
  1290. var clientY = e.clientY;
  1291. var pageX = e.pageX;
  1292. var pageY = e.pageY;
  1293. var screenX = e.screenX;
  1294. var screenY = e.screenY;
  1295. var target = e.target;
  1296. var imageIndex = e.currentImageIndex;
  1297. }
  1298. </pre>
  1299. <h2>参数:</h2>
  1300. <ul><li>event:
  1301. <em>(
  1302. <font class="type">Event</font>
  1303. )
  1304. 必选 </em>触屏数据<br>
  1305. Event对象包含以下属性:
  1306. target:保存触发此事件的对象;
  1307. clientX:Number类型,保存触摸目标在View控件中的X坐标;
  1308. clientY:Number类型,保存触摸目标在View控件中的Y坐标;
  1309. pageX:Number类型,保存触摸目标在当前页面(运行此脚本的窗口)中的X坐标;
  1310. pageY:Number类型,保存触摸目标在当前页面(运行此脚本的窗口)中的Y坐标;
  1311. screenX:Number类型,保存触摸目标在屏幕中的X坐标;
  1312. screenY:Number类型,保存触摸目标在屏幕中的Y坐标;
  1313. currentImageIndex:Number类型,保存当前图片轮播控件显示的图片索引值(从0开始),仅监听图片轮播控件(ImageSlider)的click事件时包含此属性。
  1314. </li></ul>
  1315. <h2>返回值:</h2>
  1316. <font class="type">void</font>
  1317. : 无<h1><a name="plus.nativeObj.NativeObjSuccessCallback">NativeObjSuccessCallback</a></h1>
  1318. <p>操作成功回调函数接口</p>
  1319. <pre class="prettyprint linenums">
  1320. void onSuccess(){
  1321. // Code here
  1322. }
  1323. </pre>
  1324. <h2>参数:</h2>
  1325. <p>无</p>
  1326. <h2>返回值:</h2>
  1327. <font class="type">void</font>
  1328. : 无<h1><a name="plus.nativeObj.NativeObjErrorCallback">NativeObjErrorCallback</a></h1>
  1329. <p>操作错误回调函数接口</p>
  1330. <pre class="prettyprint linenums">
  1331. function void onError( Exception error ) {
  1332. // Error.
  1333. var code = error.code; // 错误编码
  1334. var message = error.message; // 错误描述信息
  1335. }
  1336. </pre>
  1337. <h2>参数:</h2>
  1338. <ul><li>error:
  1339. <em>(
  1340. <font class="type">Exception</font>
  1341. )
  1342. 必选 </em>用户选择操作失败信息<br>
  1343. 可通过error.code(Number类型)获取错误编码;
  1344. 可通过error.message(String类型)获取错误描述信息。
  1345. </li></ul>
  1346. <h2>返回值:</h2>
  1347. <font class="type">void</font>
  1348. : 无<br><br>
  1349. </div></body>
  1350. </html>