jsPDF-PubSub.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  2. "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
  4. <head>
  5. <meta http-equiv="content-type" content="text/html; charset=utf-8" />
  6. <meta name="generator" content="JsDoc Toolkit" />
  7. <title>JsDoc Reference - jsPDF-PubSub</title>
  8. <style type="text/css">
  9. /* default.css */
  10. body
  11. {
  12. font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif;
  13. width: 800px;
  14. }
  15. .header
  16. {
  17. clear: both;
  18. background-color: #ccc;
  19. padding: 8px;
  20. }
  21. h1
  22. {
  23. font-size: 150%;
  24. font-weight: bold;
  25. padding: 0;
  26. margin: 1em 0 0 .3em;
  27. }
  28. hr
  29. {
  30. border: none 0;
  31. border-top: 1px solid #7F8FB1;
  32. height: 1px;
  33. }
  34. pre.code
  35. {
  36. display: block;
  37. padding: 8px;
  38. border: 1px dashed #ccc;
  39. }
  40. #index
  41. {
  42. margin-top: 24px;
  43. float: left;
  44. width: 160px;
  45. position: absolute;
  46. left: 8px;
  47. background-color: #F3F3F3;
  48. padding: 8px;
  49. }
  50. #content
  51. {
  52. margin-left: 190px;
  53. width: 600px;
  54. }
  55. .classList
  56. {
  57. list-style-type: none;
  58. padding: 0;
  59. margin: 0 0 0 8px;
  60. font-family: arial, sans-serif;
  61. font-size: 1em;
  62. overflow: auto;
  63. }
  64. .classList li
  65. {
  66. padding: 0;
  67. margin: 0 0 8px 0;
  68. }
  69. .summaryTable { width: 100%; }
  70. h1.classTitle
  71. {
  72. font-size:170%;
  73. line-height:130%;
  74. }
  75. h2 { font-size: 110%; }
  76. caption, div.sectionTitle
  77. {
  78. background-color: #7F8FB1;
  79. color: #fff;
  80. font-size:130%;
  81. text-align: left;
  82. padding: 2px 6px 2px 6px;
  83. border: 1px #7F8FB1 solid;
  84. }
  85. div.sectionTitle { margin-bottom: 8px; }
  86. .summaryTable thead { display: none; }
  87. .summaryTable td
  88. {
  89. vertical-align: top;
  90. padding: 4px;
  91. border-bottom: 1px #7F8FB1 solid;
  92. border-right: 1px #7F8FB1 solid;
  93. }
  94. /*col#summaryAttributes {}*/
  95. .summaryTable td.attributes
  96. {
  97. border-left: 1px #7F8FB1 solid;
  98. width: 140px;
  99. text-align: right;
  100. }
  101. td.attributes, .fixedFont
  102. {
  103. line-height: 15px;
  104. color: #002EBE;
  105. font-family: "Courier New",Courier,monospace;
  106. font-size: 13px;
  107. }
  108. .summaryTable td.nameDescription
  109. {
  110. text-align: left;
  111. font-size: 13px;
  112. line-height: 15px;
  113. }
  114. .summaryTable td.nameDescription, .description
  115. {
  116. line-height: 15px;
  117. padding: 4px;
  118. padding-left: 4px;
  119. }
  120. .summaryTable { margin-bottom: 8px; }
  121. ul.inheritsList
  122. {
  123. list-style: square;
  124. margin-left: 20px;
  125. padding-left: 0;
  126. }
  127. .detailList {
  128. margin-left: 20px;
  129. line-height: 15px;
  130. }
  131. .detailList dt { margin-left: 20px; }
  132. .detailList .heading
  133. {
  134. font-weight: bold;
  135. padding-bottom: 6px;
  136. margin-left: 0;
  137. }
  138. .light, td.attributes, .light a:link, .light a:visited
  139. {
  140. color: #777;
  141. font-style: italic;
  142. }
  143. .fineprint
  144. {
  145. text-align: right;
  146. font-size: 10px;
  147. }
  148. </style>
  149. </head>
  150. <body>
  151. <!-- ============================== header ================================= -->
  152. <!-- begin static/header.html -->
  153. <div id="header">
  154. </div>
  155. <!-- end static/header.html -->
  156. <!-- ============================== classes index ============================ -->
  157. <div id="index">
  158. <!-- begin publish.classesIndex -->
  159. <div align="center"><a href="../index.html">Class Index</a>
  160. | <a href="../files.html">File Index</a></div>
  161. <hr />
  162. <h2>Classes</h2>
  163. <ul class="classList">
  164. <li><i><a href="../symbols/_global_.html">_global_</a></i></li>
  165. <li><a href="../symbols/FontObject.html">FontObject</a></li>
  166. <li><a href="../symbols/jsPDF.html">jsPDF</a></li>
  167. <li><a href="../symbols/jsPDF-PubSub.html">jsPDF-PubSub</a></li>
  168. </ul>
  169. <hr />
  170. <!-- end publish.classesIndex -->
  171. </div>
  172. <div id="content">
  173. <!-- ============================== class title ============================ -->
  174. <h1 class="classTitle">
  175. Class jsPDF-PubSub
  176. </h1>
  177. <!-- ============================== class summary ========================== -->
  178. <p class="description">
  179. <br /><i>Defined in: </i> <a href="../symbols/src/c__work_jsPDF_jspdf.js.html">jspdf.js</a>.
  180. </p>
  181. <!-- ============================== constructor summary ==================== -->
  182. <table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class jsPDF-PubSub.">
  183. <caption>Class Summary</caption>
  184. <thead>
  185. <tr>
  186. <th scope="col">Constructor Attributes</th>
  187. <th scope="col">Constructor Name and Description</th>
  188. </tr>
  189. </thead>
  190. <tbody>
  191. <tr>
  192. <td class="attributes">&lt;inner&gt; &nbsp;</td>
  193. <td class="nameDescription" >
  194. <div class="fixedFont">
  195. <b><a href="../symbols/jsPDF-PubSub.html#constructor">jsPDF-PubSub</a></b>(context)
  196. </div>
  197. <div class="description">PubSub implementation</div>
  198. </td>
  199. </tr>
  200. </tbody>
  201. </table>
  202. <!-- ============================== properties summary ===================== -->
  203. <table class="summaryTable" cellspacing="0" summary="A summary of the fields documented in the class jsPDF-PubSub.">
  204. <caption>Field Summary</caption>
  205. <thead>
  206. <tr>
  207. <th scope="col">Field Attributes</th>
  208. <th scope="col">Field Name and Description</th>
  209. </tr>
  210. </thead>
  211. <tbody>
  212. <tr>
  213. <td class="attributes">&nbsp;</td>
  214. <td class="nameDescription">
  215. <div class="fixedFont">
  216. <b><a href="../symbols/jsPDF-PubSub.html#topics">topics</a></b>
  217. </div>
  218. <div class="description"></div>
  219. </td>
  220. </tr>
  221. </tbody>
  222. </table>
  223. <!-- ============================== methods summary ======================== -->
  224. <table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class jsPDF-PubSub.">
  225. <caption>Method Summary</caption>
  226. <thead>
  227. <tr>
  228. <th scope="col">Method Attributes</th>
  229. <th scope="col">Method Name and Description</th>
  230. </tr>
  231. </thead>
  232. <tbody>
  233. <tr>
  234. <td class="attributes">&nbsp;</td>
  235. <td class="nameDescription">
  236. <div class="fixedFont"><b><a href="../symbols/jsPDF-PubSub.html#publish">publish</a></b>(topic, **arguments, arg2, etc)
  237. </div>
  238. <div class="description">Allows caller to emit an event and pass arguments to event listeners.</div>
  239. </td>
  240. </tr>
  241. <tr>
  242. <td class="attributes">&nbsp;</td>
  243. <td class="nameDescription">
  244. <div class="fixedFont"><b><a href="../symbols/jsPDF-PubSub.html#subscribe">subscribe</a></b>(topic, callback, once)
  245. </div>
  246. <div class="description">Allows listener code to subscribe to channel and be called when data is available</div>
  247. </td>
  248. </tr>
  249. <tr>
  250. <td class="attributes">&nbsp;</td>
  251. <td class="nameDescription">
  252. <div class="fixedFont"><b><a href="../symbols/jsPDF-PubSub.html#unsubscribe">unsubscribe</a></b>(token)
  253. </div>
  254. <div class="description">Allows listener code to unsubscribe from a channel</div>
  255. </td>
  256. </tr>
  257. </tbody>
  258. </table>
  259. <!-- ============================== events summary ======================== -->
  260. <!-- ============================== constructor details ==================== -->
  261. <div class="details"><a name="constructor"> </a>
  262. <div class="sectionTitle">
  263. Class Detail
  264. </div>
  265. <div class="fixedFont">&lt;inner&gt;
  266. <b>jsPDF-PubSub</b>(context)
  267. </div>
  268. <div class="description">
  269. PubSub implementation
  270. </div>
  271. <dl class="detailList">
  272. <dt class="heading">Parameters:</dt>
  273. <dt>
  274. <b>context</b>
  275. </dt>
  276. <dd></dd>
  277. </dl>
  278. </div>
  279. <!-- ============================== field details ========================== -->
  280. <div class="sectionTitle">
  281. Field Detail
  282. </div>
  283. <a name="topics"> </a>
  284. <div class="fixedFont">
  285. <b>topics</b>
  286. </div>
  287. <div class="description">
  288. </div>
  289. <!-- ============================== method details ========================= -->
  290. <div class="sectionTitle">
  291. Method Detail
  292. </div>
  293. <a name="publish"> </a>
  294. <div class="fixedFont">
  295. <b>publish</b>(topic, **arguments, arg2, etc)
  296. </div>
  297. <div class="description">
  298. Allows caller to emit an event and pass arguments to event listeners.
  299. </div>
  300. <dl class="detailList">
  301. <dt class="heading">Parameters:</dt>
  302. <dt>
  303. <b>topic</b>
  304. </dt>
  305. <dd>{String} Name of the channel on which to voice this event</dd>
  306. <dt>
  307. <b>**arguments</b>
  308. </dt>
  309. <dd>Any number of arguments you want to pass to the listeners of this event.</dd>
  310. <dt>
  311. <b>arg2</b>
  312. </dt>
  313. <dd></dd>
  314. <dt>
  315. <b>etc</b>
  316. </dt>
  317. <dd></dd>
  318. </dl>
  319. <hr />
  320. <a name="subscribe"> </a>
  321. <div class="fixedFont">
  322. <span class="light">{Object}</span>
  323. <b>subscribe</b>(topic, callback, once)
  324. </div>
  325. <div class="description">
  326. Allows listener code to subscribe to channel and be called when data is available
  327. </div>
  328. <dl class="detailList">
  329. <dt class="heading">Parameters:</dt>
  330. <dt>
  331. <b>topic</b>
  332. </dt>
  333. <dd>{String} Name of the channel on which to voice this event</dd>
  334. <dt>
  335. <b>callback</b>
  336. </dt>
  337. <dd>{Function} Executable (function pointer) that will be ran when event is voiced on this channel.</dd>
  338. <dt>
  339. <b>once</b>
  340. </dt>
  341. <dd>{Boolean} (optional. False by default) Flag indicating if the function is to be triggered only once.</dd>
  342. </dl>
  343. <dl class="detailList">
  344. <dt class="heading">Returns:</dt>
  345. <dd><span class="light fixedFont">{Object}</span> A token object that cen be used for unsubscribing.</dd>
  346. </dl>
  347. <hr />
  348. <a name="unsubscribe"> </a>
  349. <div class="fixedFont">
  350. <b>unsubscribe</b>(token)
  351. </div>
  352. <div class="description">
  353. Allows listener code to unsubscribe from a channel
  354. </div>
  355. <dl class="detailList">
  356. <dt class="heading">Parameters:</dt>
  357. <dt>
  358. <b>token</b>
  359. </dt>
  360. <dd>{Object} A token object that was returned by `subscribe` method</dd>
  361. </dl>
  362. <!-- ============================== event details ========================= -->
  363. <hr />
  364. </div>
  365. <!-- ============================== footer ================================= -->
  366. <div class="fineprint" style="clear:both">
  367. Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.4.0 on Tue Aug 21 2012 12:58:07 GMT-0700 (PDT)
  368. </div>
  369. </body>
  370. </html>