api.html 4.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146
  1. <!doctype html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8" />
  5. <style type="text/css">
  6. .parameters { width:100%; border:0; border-collapse:collapse }
  7. .parameters th,
  8. .parameters td { border:1px solid #c5c5c5; padding:5px; background-color:#fff; color:#000 }
  9. .parameters th { background:#D9D9D9 !important; border-color:#d9d9d9 !important }
  10. .parameters .parameter { font-family:Fixed, monospace }
  11. .parameters ul li {line-height: 25px;}
  12. </style>
  13. </head>
  14. <body>
  15. <table class="parameters" style='margin-bottom: 2em;'>
  16. <caption align="left">表1--jQuery UI Portlet 插件API</caption>
  17. <tr>
  18. <th>参数</th>
  19. <th>描述</th>
  20. <th>默认值</th>
  21. </tr>
  22. <tr>
  23. <td>sortable</td>
  24. <td>是否启用拖动功能,内部调用sortable插件</td>
  25. <td>true</td>
  26. </tr>
  27. <tr>
  28. <td>singleView</td>
  29. <td>是否开启单视图模式,双击标题栏可启用单视图模式</td>
  30. <td>true</td>
  31. </tr>
  32. <tr>
  33. <td>create</td>
  34. <td>当创建portlet组件时被调用</td>
  35. <td>null</td>
  36. </tr>
  37. <tr>
  38. <td>removeItem</td>
  39. <td>关闭一个portlet时的回调函数</td>
  40. <td>null</td>
  41. </tr>
  42. <tr>
  43. <td>columns</td>
  44. <td>见表2</td>
  45. <td>null</td>
  46. </tr>
  47. </table>
  48. <table class="parameters" style='margin-bottom: 2em;'>
  49. <caption align="left">表2--jQuery UI Portlet 插件API--columns</caption>
  50. <tr>
  51. <th>参数</th>
  52. <th>描述</th>
  53. <th>默认值</th>
  54. </tr>
  55. <tr>
  56. <td>width</td>
  57. <td>宽度</td>
  58. <td>300</td>
  59. </tr>
  60. <tr>
  61. <td>portlets</td>
  62. <td colspan="2">
  63. <table class="parameters">
  64. <tr>
  65. <th>参数</th>
  66. <th>描述</th>
  67. <th>默认值</th>
  68. </tr>
  69. <tr>
  70. <td>attrs</td>
  71. <td>portlet的属性, json数组格式</td>
  72. <td>&nbsp;</td>
  73. </tr>
  74. <tr>
  75. <td>title</td>
  76. <td>portlet的title,支持:静态文本,function</td>
  77. <td>&nbsp;</td>
  78. </tr>
  79. <tr>
  80. <td>icon</td>
  81. <td>标题栏左侧的图标,使用jQuery UI提供的图标. icon: 'ui-icon-person'</td>
  82. <td>&nbsp;</td>
  83. </tr>
  84. <tr>
  85. <td>beforeRefresh</td>
  86. <td>刷新portlet之前被调用</td>
  87. <td>&nbsp;</td>
  88. </tr>
  89. <tr>
  90. <td>afterRefresh</td>
  91. <td>刷新portlet之后被调用</td>
  92. <td>&nbsp;</td>
  93. </tr>
  94. <tr>
  95. <td>singleView</td>
  96. <td>
  97. <ul>
  98. <li><b>width:</b>启用单视图模式时portlet的宽度;设置方式:数字、function;默认:body的宽度</li>
  99. <li><b>height:</b>启用单视图模式时portlet的高度;设置方式:数字、function;默认:使用原高度</li>
  100. <li><b>enable:</b>触发单视图模式后回调</li>
  101. <li><b>recovery:</b>关闭(还原)单视图模式后回调</li>
  102. </ul>
  103. </td>
  104. <td>&nbsp;</td>
  105. </tr>
  106. <tr>
  107. <td>content</td>
  108. <td>
  109. <ul>
  110. <li><b>type:</b>内容获取方式:text、ajax</li>
  111. <li><b>text:</b>portlet的内容,html或者function</li>
  112. <li><b>style:</b>设置内容区域的样式,目前支持属性:<b>height</b></li>
  113. <li><b>beforeShow:</b>设置内容之前被调用</li>
  114. <li><b>afterShow:</b>设置内容之后被调用</li>
  115. <li><b>url:</b>当type:'ajax'时需要指定数据来源的网址</li>
  116. <li><b>dataType:</b>当type:'ajax'时需要指定获取的数据类型,所有jquery的ajax支持的数据类型,目前支持:html、json</li>
  117. <li><b>formatter:</b>当type:'ajax'并且dataType:'json'时被调用,用来处理json数据从而转换为html。<br/>调用时传入三个参数:[表1中的参数,本表中的参数, 数据]</li>
  118. <li><b>error:</b>当ajax请求出现错误时调用,参数参考jqueyr的api,this对象为当前的内容区域</li>
  119. </ul>
  120. </td>
  121. <td>&nbsp;</td>
  122. </tr>
  123. <tr>
  124. <td>scripts</td>
  125. <td>数组:指定portlet加载完内容后的js文件路径</td>
  126. <td>&nbsp;</td>
  127. </tr>
  128. </table>
  129. </td>
  130. </tr>
  131. </table>
  132. <table class="parameters" style='margin-bottom: 2em;'>
  133. <caption align="left">表3--jQuery UI Portlet 插件更新参数&nbsp;$('#portlet1').portlet('option', 'paramName', paramValue)</caption>
  134. <tr>
  135. <th>参数名称</th>
  136. <th>描述</th>
  137. </tr>
  138. <tr>
  139. <td>sortable</td>
  140. <td>设置开启/禁用拖动功能</td>
  141. </tr>
  142. </table>
  143. </body>
  144. </html>