help-doc.html 8.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <!-- NewPage -->
  3. <html lang="zh">
  4. <head>
  5. <!-- Generated by javadoc (1.8.0_45) on Thu Aug 20 10:01:47 CST 2015 -->
  6. <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  7. <title>API 帮助</title>
  8. <meta name="date" content="2015-08-20">
  9. <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
  10. <script type="text/javascript" src="script.js"></script>
  11. </head>
  12. <body>
  13. <script type="text/javascript"><!--
  14. try {
  15. if (location.href.indexOf('is-external=true') == -1) {
  16. parent.document.title="API \u5E2E\u52A9";
  17. }
  18. }
  19. catch(err) {
  20. }
  21. //-->
  22. </script>
  23. <noscript>
  24. <div>您的浏览器已禁用 JavaScript。</div>
  25. </noscript>
  26. <!-- ========= START OF TOP NAVBAR ======= -->
  27. <div class="topNav"><a name="navbar.top">
  28. <!-- -->
  29. </a>
  30. <div class="skipNav"><a href="#skip.navbar.top" title="跳过导航链接">跳过导航链接</a></div>
  31. <a name="navbar.top.firstrow">
  32. <!-- -->
  33. </a>
  34. <ul class="navList" title="导航">
  35. <li><a href="com/x/collaboration/service/message/package-summary.html">程序包</a></li>
  36. <li>类</li>
  37. <li>使用</li>
  38. <li><a href="com/x/collaboration/service/message/package-tree.html">树</a></li>
  39. <li><a href="deprecated-list.html">已过时</a></li>
  40. <li><a href="index-files/index-1.html">索引</a></li>
  41. <li class="navBarCell1Rev">帮助</li>
  42. </ul>
  43. </div>
  44. <div class="subNav">
  45. <ul class="navList">
  46. <li>上一个</li>
  47. <li>下一个</li>
  48. </ul>
  49. <ul class="navList">
  50. <li><a href="index.html?help-doc.html" target="_top">框架</a></li>
  51. <li><a href="help-doc.html" target="_top">无框架</a></li>
  52. </ul>
  53. <ul class="navList" id="allclasses_navbar_top">
  54. <li><a href="allclasses-noframe.html">所有类</a></li>
  55. </ul>
  56. <div>
  57. <script type="text/javascript"><!--
  58. allClassesLink = document.getElementById("allclasses_navbar_top");
  59. if(window==top) {
  60. allClassesLink.style.display = "block";
  61. }
  62. else {
  63. allClassesLink.style.display = "none";
  64. }
  65. //-->
  66. </script>
  67. </div>
  68. <a name="skip.navbar.top">
  69. <!-- -->
  70. </a></div>
  71. <!-- ========= END OF TOP NAVBAR ========= -->
  72. <div class="header">
  73. <h1 class="title">此 API 文档的组织方式</h1>
  74. <div class="subTitle">此 API (应用程序编程接口) 文档包含对应于导航栏中的项目的页面, 如下所述。</div>
  75. </div>
  76. <div class="contentContainer">
  77. <ul class="blockList">
  78. <li class="blockList">
  79. <h2>程序包</h2>
  80. <p>每个程序包都有一个页面, 其中包含它的类和接口的列表及其概要。此页面可以包含六个类别:</p>
  81. <ul>
  82. <li>接口 (斜体)</li>
  83. <li>类</li>
  84. <li>枚举</li>
  85. <li>异常错误</li>
  86. <li>错误</li>
  87. <li>注释类型</li>
  88. </ul>
  89. </li>
  90. <li class="blockList">
  91. <h2>类/接口</h2>
  92. <p>每个类, 接口, 嵌套类和嵌套接口都有各自的页面。其中每个页面都由三部分 (类/接口说明, 概要表, 以及详细的成员说明) 组成:</p>
  93. <ul>
  94. <li>类继承图</li>
  95. <li>直接子类</li>
  96. <li>所有已知子接口</li>
  97. <li>所有已知实现类</li>
  98. <li>类/接口声明</li>
  99. <li>类/接口说明</li>
  100. </ul>
  101. <ul>
  102. <li>嵌套类概要</li>
  103. <li>字段概要</li>
  104. <li>构造器概要</li>
  105. <li>方法概要</li>
  106. </ul>
  107. <ul>
  108. <li>字段详细资料</li>
  109. <li>构造器详细资料</li>
  110. <li>方法详细资料</li>
  111. </ul>
  112. <p>每个概要条目都包含该项目的详细说明的第一句。概要条目按字母顺序排列, 而详细说明则按其在源代码中出现的顺序排列。这样保持了程序员所建立的逻辑分组。</p>
  113. </li>
  114. <li class="blockList">
  115. <h2>注释类型</h2>
  116. <p>每个注释类型都有各自的页面, 其中包含以下部分:</p>
  117. <ul>
  118. <li>注释类型声明</li>
  119. <li>注释类型说明</li>
  120. <li>必需元素概要</li>
  121. <li>可选元素概要</li>
  122. <li>元素详细资料</li>
  123. </ul>
  124. </li>
  125. <li class="blockList">
  126. <h2>枚举</h2>
  127. <p>每个枚举都有各自的页面, 其中包含以下部分:</p>
  128. <ul>
  129. <li>枚举声明</li>
  130. <li>枚举说明</li>
  131. <li>枚举常量概要</li>
  132. <li>枚举常量详细资料</li>
  133. </ul>
  134. </li>
  135. <li class="blockList">
  136. <h2>使用</h2>
  137. <p>每个已文档化的程序包, 类和接口都有各自的“使用”页面。此页面介绍了使用给定类或程序包的任何部分的程序包, 类, 方法, 构造器和字段。对于给定的类或接口 A, 其“使用”页面包含 A 的子类, 声明为 A 的字段, 返回 A 的方法, 以及带有类型为 A 的参数的方法和构造器。访问此页面的方法是: 首先转至程序包, 类或接口, 然后单击导航栏中的 "使用" 链接。</p>
  138. </li>
  139. <li class="blockList">
  140. <h2>树 (类分层结构)</h2>
  141. <p>对于所有程序包, 有一个<a href="overview-tree.html">类分层结构</a>页面, 以及每个程序包的分层结构。每个分层结构页面都包含类的列表和接口的列表。从<code>java.lang.Object</code>开始, 按继承结构对类进行排列。接口不从<code>java.lang.Object</code>继承。</p>
  142. <ul>
  143. <li>查看“概览”页面时, 单击 "树" 将显示所有程序包的分层结构。</li>
  144. <li>查看特定程序包, 类或接口页面时, 单击 "树" 将仅显示该程序包的分层结构。</li>
  145. </ul>
  146. </li>
  147. <li class="blockList">
  148. <h2>已过时的 API</h2>
  149. <p><a href="deprecated-list.html">已过时的 API</a> 页面列出了所有已过时的 API。一般由于进行了改进并且通常提供了替代的 API, 所以建议不要使用已过时的 API。在将来的实现过程中, 可能会删除已过时的 API。</p>
  150. </li>
  151. <li class="blockList">
  152. <h2>索引</h2>
  153. <p><a href="index-files/index-1.html">索引</a> 包含按字母顺序排列的所有类, 接口, 构造器, 方法和字段的列表。</p>
  154. </li>
  155. <li class="blockList">
  156. <h2>上一个/下一个</h2>
  157. <p>这些链接使您可以转至下一个或上一个类, 接口, 程序包或相关页面。</p>
  158. </li>
  159. <li class="blockList">
  160. <h2>框架/无框架</h2>
  161. <p>这些链接用于显示和隐藏 HTML 框架。所有页面均具有有框架和无框架两种显示方式。</p>
  162. </li>
  163. <li class="blockList">
  164. <h2>所有类</h2>
  165. <p><a href="allclasses-noframe.html">所有类</a>链接显示所有类和接口 (除了非静态嵌套类型)。</p>
  166. </li>
  167. <li class="blockList">
  168. <h2>序列化表格</h2>
  169. <p>每个可序列化或可外部化的类都有其序列化字段和方法的说明。此信息对重新实现者有用, 而对使用 API 的开发者则没有什么用处。尽管导航栏中没有链接, 但您可以通过下列方式获取此信息: 转至任何序列化类, 然后单击类说明的 "另请参阅" 部分中的 "序列化表格"。</p>
  170. </li>
  171. <li class="blockList">
  172. <h2>常量字段值</h2>
  173. <p><a href="constant-values.html">常量字段值</a>页面列出了静态最终字段及其值。</p>
  174. </li>
  175. </ul>
  176. <span class="emphasizedPhrase">此帮助文件适用于使用标准 doclet 生成的 API 文档。</span></div>
  177. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  178. <div class="bottomNav"><a name="navbar.bottom">
  179. <!-- -->
  180. </a>
  181. <div class="skipNav"><a href="#skip.navbar.bottom" title="跳过导航链接">跳过导航链接</a></div>
  182. <a name="navbar.bottom.firstrow">
  183. <!-- -->
  184. </a>
  185. <ul class="navList" title="导航">
  186. <li><a href="com/x/collaboration/service/message/package-summary.html">程序包</a></li>
  187. <li>类</li>
  188. <li>使用</li>
  189. <li><a href="com/x/collaboration/service/message/package-tree.html">树</a></li>
  190. <li><a href="deprecated-list.html">已过时</a></li>
  191. <li><a href="index-files/index-1.html">索引</a></li>
  192. <li class="navBarCell1Rev">帮助</li>
  193. </ul>
  194. </div>
  195. <div class="subNav">
  196. <ul class="navList">
  197. <li>上一个</li>
  198. <li>下一个</li>
  199. </ul>
  200. <ul class="navList">
  201. <li><a href="index.html?help-doc.html" target="_top">框架</a></li>
  202. <li><a href="help-doc.html" target="_top">无框架</a></li>
  203. </ul>
  204. <ul class="navList" id="allclasses_navbar_bottom">
  205. <li><a href="allclasses-noframe.html">所有类</a></li>
  206. </ul>
  207. <div>
  208. <script type="text/javascript"><!--
  209. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  210. if(window==top) {
  211. allClassesLink.style.display = "block";
  212. }
  213. else {
  214. allClassesLink.style.display = "none";
  215. }
  216. //-->
  217. </script>
  218. </div>
  219. <a name="skip.navbar.bottom">
  220. <!-- -->
  221. </a></div>
  222. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  223. </body>
  224. </html>