DOMEvent.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582
  1. <html>
  2. <head>
  3. <title>Docs For Class DOMEvent</title>
  4. <link rel="stylesheet" type="text/css" href="../media/style.css">
  5. </head>
  6. <body>
  7. <table border="0" cellspacing="0" cellpadding="0" height="48" width="100%">
  8. <tr>
  9. <td class="header_top">phpQuery</td>
  10. </tr>
  11. <tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt="" /></td></tr>
  12. <tr>
  13. <td class="header_menu">
  14. [ <a href="../classtrees_phpQuery.html" class="menu">class tree: phpQuery</a> ]
  15. [ <a href="../elementindex_phpQuery.html" class="menu">index: phpQuery</a> ]
  16. [ <a href="../elementindex.html" class="menu">all elements</a> ]
  17. </td>
  18. </tr>
  19. <tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt="" /></td></tr>
  20. </table>
  21. <table width="100%" border="0" cellpadding="0" cellspacing="0">
  22. <tr valign="top">
  23. <td width="200" class="menu">
  24. <div id="todolist">
  25. <p><a href="../todolist.html">Todo List</a></p>
  26. </div>
  27. <b>Packages:</b><br />
  28. <a href="../li_phpQuery.html">phpQuery</a><br />
  29. <br /><br />
  30. <b>Files:</b><br />
  31. <div class="package">
  32. <a href="../phpQuery/_Callback.php.html"> Callback.php
  33. </a><br>
  34. <a href="../phpQuery/_DOMDocumentWrapper.php.html"> DOMDocumentWrapper.php
  35. </a><br>
  36. <a href="../phpQuery/_DOMEvent.php.html"> DOMEvent.php
  37. </a><br>
  38. <a href="../phpQuery/_phpQuery.php.html"> phpQuery.php
  39. </a><br>
  40. <a href="../phpQuery/_phpQueryEvents.php.html"> phpQueryEvents.php
  41. </a><br>
  42. <a href="../phpQuery/_phpQueryObject.php.html"> phpQueryObject.php
  43. </a><br>
  44. </div><br />
  45. <b>Classes:</b><br />
  46. <div class="package">
  47. <a href="../phpQuery/Callback.html">Callback</a><br />
  48. <a href="../phpQuery/CallbackParam.html">CallbackParam</a><br />
  49. <a href="../phpQuery/CallbackReference.html">CallbackReference</a><br />
  50. <a href="../phpQuery/DOMDocumentWrapper.html">DOMDocumentWrapper</a><br />
  51. <a href="../phpQuery/DOMEvent.html">DOMEvent</a><br />
  52. <a href="../phpQuery/phpQuery.html">phpQuery</a><br />
  53. <a href="../phpQuery/phpQueryEvents.html">phpQueryEvents</a><br />
  54. <a href="../phpQuery/phpQueryObject.html">phpQueryObject</a><br />
  55. <a href="../phpQuery/phpQueryPlugins.html">phpQueryPlugins</a><br />
  56. </div>
  57. </td>
  58. <td>
  59. <table cellpadding="10" cellspacing="0" width="100%" border="0"><tr><td valign="top">
  60. <h1>Class: DOMEvent</h1>
  61. Source Location: /DOMEvent.php<br /><br />
  62. <table width="100%" border="0">
  63. <tr><td valign="top">
  64. <h3><a href="#class_details">Class Overview</a></h3>
  65. <pre></pre><br />
  66. <div class="description">DOMEvent class.</div><br /><br />
  67. <h4>Author(s):</h4>
  68. <ul>
  69. <li>Tobiasz Cudnik &lt;<a href="mailto:tobiasz.cudnik/gmail.com">tobiasz.cudnik/gmail.com</a>&gt;</li>
  70. </ul>
  71. </td>
  72. <td valign="top">
  73. <h3><a href="#class_vars">Variables</a></h3>
  74. <ul>
  75. <li><a href="../phpQuery/DOMEvent.html#var$bubbles">$bubbles</a></li>
  76. <li><a href="../phpQuery/DOMEvent.html#var$cancelable">$cancelable</a></li>
  77. <li><a href="../phpQuery/DOMEvent.html#var$currentTarget">$currentTarget</a></li>
  78. <li><a href="../phpQuery/DOMEvent.html#var$data">$data</a></li>
  79. <li><a href="../phpQuery/DOMEvent.html#var$detail">$detail</a></li>
  80. <li><a href="../phpQuery/DOMEvent.html#var$eventPhase">$eventPhase</a></li>
  81. <li><a href="../phpQuery/DOMEvent.html#var$explicitOriginalTarget">$explicitOriginalTarget</a></li>
  82. <li><a href="../phpQuery/DOMEvent.html#var$originalTarget">$originalTarget</a></li>
  83. <li><a href="../phpQuery/DOMEvent.html#var$relatedTarget">$relatedTarget</a></li>
  84. <li><a href="../phpQuery/DOMEvent.html#var$runDefault">$runDefault</a></li>
  85. <li><a href="../phpQuery/DOMEvent.html#var$target">$target</a></li>
  86. <li><a href="../phpQuery/DOMEvent.html#var$timeStamp">$timeStamp</a></li>
  87. <li><a href="../phpQuery/DOMEvent.html#var$type">$type</a></li>
  88. </ul>
  89. </td>
  90. <td valign="top">
  91. <h3><a href="#class_methods">Methods</a></h3>
  92. <ul>
  93. <li><a href="../phpQuery/DOMEvent.html#method__construct">__construct</a></li>
  94. <li><a href="../phpQuery/DOMEvent.html#methodpreventDefault">preventDefault</a></li>
  95. <li><a href="../phpQuery/DOMEvent.html#methodstopPropagation">stopPropagation</a></li>
  96. </ul>
  97. </td>
  98. </tr></table>
  99. <hr />
  100. <table width="100%" border="0"><tr>
  101. </tr></table>
  102. <hr />
  103. <a name="class_details"></a>
  104. <h3>Class Details</h3>
  105. <div class="tags">
  106. [line 11]<br />
  107. DOMEvent class.<br /><br /><p>Based on</p><br /><br /><br />
  108. <h4>Tags:</h4>
  109. <div class="tags">
  110. <table border="0" cellspacing="0" cellpadding="0">
  111. <tr>
  112. <td><b>author:</b>&nbsp;&nbsp;</td><td>Tobiasz Cudnik &lt;<a href="mailto:tobiasz.cudnik/gmail.com">tobiasz.cudnik/gmail.com</a>&gt;</td>
  113. </tr>
  114. <tr>
  115. <td><b>link:</b>&nbsp;&nbsp;</td><td><a href="http://developer.mozilla.org/En/DOM:event">http://developer.mozilla.org/En/DOM:event</a></td>
  116. </tr>
  117. <tr>
  118. <td><b>todo:</b>&nbsp;&nbsp;</td><td>implement ArrayAccess ?</td>
  119. </tr>
  120. </table>
  121. </div>
  122. </div><br /><br />
  123. <div class="top">[ <a href="#top">Top</a> ]</div><br />
  124. <hr />
  125. <a name="class_vars"></a>
  126. <h3>Class Variables</h3>
  127. <div class="tags">
  128. <a name="var$bubbles"></a>
  129. <p></p>
  130. <h4>$bubbles = <span class="value">&nbsp;true</span></h4>
  131. <p>[line 17]</p>
  132. Returns a boolean indicating whether the event bubbles up through the DOM or not.<br /><br /><br /><br />
  133. <h4>Tags:</h4>
  134. <div class="tags">
  135. <table border="0" cellspacing="0" cellpadding="0">
  136. <tr>
  137. <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  138. </tr>
  139. </table>
  140. </div>
  141. <br />
  142. <div class="tags">
  143. <table border="0" cellspacing="0" cellpadding="0">
  144. <tr>
  145. <td><b>Type:</b>&nbsp;&nbsp;</td>
  146. <td>unknown_type</td>
  147. </tr>
  148. </table>
  149. </div><br /><br />
  150. <div class="top">[ <a href="#top">Top</a> ]</div><br />
  151. <a name="var$cancelable"></a>
  152. <p></p>
  153. <h4>$cancelable = <span class="value">&nbsp;true</span></h4>
  154. <p>[line 23]</p>
  155. Returns a boolean indicating whether the event is cancelable.<br /><br /><br /><br />
  156. <h4>Tags:</h4>
  157. <div class="tags">
  158. <table border="0" cellspacing="0" cellpadding="0">
  159. <tr>
  160. <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  161. </tr>
  162. </table>
  163. </div>
  164. <br />
  165. <div class="tags">
  166. <table border="0" cellspacing="0" cellpadding="0">
  167. <tr>
  168. <td><b>Type:</b>&nbsp;&nbsp;</td>
  169. <td>unknown_type</td>
  170. </tr>
  171. </table>
  172. </div><br /><br />
  173. <div class="top">[ <a href="#top">Top</a> ]</div><br />
  174. <a name="var$currentTarget"></a>
  175. <p></p>
  176. <h4>$currentTarget = <span class="value"></span></h4>
  177. <p>[line 29]</p>
  178. Returns a reference to the currently registered target for the event.<br /><br /><br /><br />
  179. <h4>Tags:</h4>
  180. <div class="tags">
  181. <table border="0" cellspacing="0" cellpadding="0">
  182. <tr>
  183. <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  184. </tr>
  185. </table>
  186. </div>
  187. <br />
  188. <div class="tags">
  189. <table border="0" cellspacing="0" cellpadding="0">
  190. <tr>
  191. <td><b>Type:</b>&nbsp;&nbsp;</td>
  192. <td>unknown_type</td>
  193. </tr>
  194. </table>
  195. </div><br /><br />
  196. <div class="top">[ <a href="#top">Top</a> ]</div><br />
  197. <a name="var$data"></a>
  198. <p></p>
  199. <h4>$data = <span class="value">&nbsp;null</span></h4>
  200. <p>[line 85]</p>
  201. <br /><br />
  202. <h4>Tags:</h4>
  203. <div class="tags">
  204. <table border="0" cellspacing="0" cellpadding="0">
  205. <tr>
  206. <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  207. </tr>
  208. </table>
  209. </div>
  210. <br />
  211. <div class="tags">
  212. <table border="0" cellspacing="0" cellpadding="0">
  213. <tr>
  214. <td><b>Type:</b>&nbsp;&nbsp;</td>
  215. <td>mixed</td>
  216. </tr>
  217. </table>
  218. </div><br /><br />
  219. <div class="top">[ <a href="#top">Top</a> ]</div><br />
  220. <a name="var$detail"></a>
  221. <p></p>
  222. <h4>$detail = <span class="value"></span></h4>
  223. <p>[line 36]</p>
  224. Returns detail about the event, depending on the type of event.<br /><br /><br /><br />
  225. <h4>Tags:</h4>
  226. <div class="tags">
  227. <table border="0" cellspacing="0" cellpadding="0">
  228. <tr>
  229. <td><b>link:</b>&nbsp;&nbsp;</td><td><a href="http://developer.mozilla.org/en/DOM/event.detail">http://developer.mozilla.org/en/DOM/event.detail</a></td>
  230. </tr>
  231. <tr>
  232. <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  233. </tr>
  234. </table>
  235. </div>
  236. <br />
  237. <div class="tags">
  238. <table border="0" cellspacing="0" cellpadding="0">
  239. <tr>
  240. <td><b>Type:</b>&nbsp;&nbsp;</td>
  241. <td>unknown_type</td>
  242. </tr>
  243. </table>
  244. </div><br /><br />
  245. <div class="top">[ <a href="#top">Top</a> ]</div><br />
  246. <a name="var$eventPhase"></a>
  247. <p></p>
  248. <h4>$eventPhase = <span class="value"></span></h4>
  249. <p>[line 45]</p>
  250. Used to indicate which phase of the event flow is currently being evaluated.<br /><br /><p>NOT IMPLEMENTED</p><br /><br /><br />
  251. <h4>Tags:</h4>
  252. <div class="tags">
  253. <table border="0" cellspacing="0" cellpadding="0">
  254. <tr>
  255. <td><b>link:</b>&nbsp;&nbsp;</td><td><a href="http://developer.mozilla.org/en/DOM/event.eventPhase">http://developer.mozilla.org/en/DOM/event.eventPhase</a></td>
  256. </tr>
  257. <tr>
  258. <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  259. </tr>
  260. </table>
  261. </div>
  262. <br />
  263. <div class="tags">
  264. <table border="0" cellspacing="0" cellpadding="0">
  265. <tr>
  266. <td><b>Type:</b>&nbsp;&nbsp;</td>
  267. <td>unknown_type</td>
  268. </tr>
  269. </table>
  270. </div><br /><br />
  271. <div class="top">[ <a href="#top">Top</a> ]</div><br />
  272. <a name="var$explicitOriginalTarget"></a>
  273. <p></p>
  274. <h4>$explicitOriginalTarget = <span class="value"></span></h4>
  275. <p>[line 53]</p>
  276. The explicit original target of the event (Mozilla-specific).<br /><br /><p>NOT IMPLEMENTED</p><br /><br /><br />
  277. <h4>Tags:</h4>
  278. <div class="tags">
  279. <table border="0" cellspacing="0" cellpadding="0">
  280. <tr>
  281. <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  282. </tr>
  283. </table>
  284. </div>
  285. <br />
  286. <div class="tags">
  287. <table border="0" cellspacing="0" cellpadding="0">
  288. <tr>
  289. <td><b>Type:</b>&nbsp;&nbsp;</td>
  290. <td>unknown_type</td>
  291. </tr>
  292. </table>
  293. </div><br /><br />
  294. <div class="top">[ <a href="#top">Top</a> ]</div><br />
  295. <a name="var$originalTarget"></a>
  296. <p></p>
  297. <h4>$originalTarget = <span class="value"></span></h4>
  298. <p>[line 61]</p>
  299. The original target of the event, before any retargetings (Mozilla-specific).<br /><br /><p>NOT IMPLEMENTED</p><br /><br /><br />
  300. <h4>Tags:</h4>
  301. <div class="tags">
  302. <table border="0" cellspacing="0" cellpadding="0">
  303. <tr>
  304. <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  305. </tr>
  306. </table>
  307. </div>
  308. <br />
  309. <div class="tags">
  310. <table border="0" cellspacing="0" cellpadding="0">
  311. <tr>
  312. <td><b>Type:</b>&nbsp;&nbsp;</td>
  313. <td>unknown_type</td>
  314. </tr>
  315. </table>
  316. </div><br /><br />
  317. <div class="top">[ <a href="#top">Top</a> ]</div><br />
  318. <a name="var$relatedTarget"></a>
  319. <p></p>
  320. <h4>$relatedTarget = <span class="value"></span></h4>
  321. <p>[line 67]</p>
  322. Identifies a secondary target for the event.<br /><br /><br /><br />
  323. <h4>Tags:</h4>
  324. <div class="tags">
  325. <table border="0" cellspacing="0" cellpadding="0">
  326. <tr>
  327. <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  328. </tr>
  329. </table>
  330. </div>
  331. <br />
  332. <div class="tags">
  333. <table border="0" cellspacing="0" cellpadding="0">
  334. <tr>
  335. <td><b>Type:</b>&nbsp;&nbsp;</td>
  336. <td>unknown_type</td>
  337. </tr>
  338. </table>
  339. </div><br /><br />
  340. <div class="top">[ <a href="#top">Top</a> ]</div><br />
  341. <a name="var$runDefault"></a>
  342. <p></p>
  343. <h4>$runDefault = <span class="value">&nbsp;true</span></h4>
  344. <p>[line 84]</p>
  345. <br /><br />
  346. <h4>Tags:</h4>
  347. <div class="tags">
  348. <table border="0" cellspacing="0" cellpadding="0">
  349. <tr>
  350. <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  351. </tr>
  352. </table>
  353. </div>
  354. <br />
  355. <div class="tags">
  356. <table border="0" cellspacing="0" cellpadding="0">
  357. <tr>
  358. <td><b>Type:</b>&nbsp;&nbsp;</td>
  359. <td>mixed</td>
  360. </tr>
  361. </table>
  362. </div><br /><br />
  363. <div class="top">[ <a href="#top">Top</a> ]</div><br />
  364. <a name="var$target"></a>
  365. <p></p>
  366. <h4>$target = <span class="value"></span></h4>
  367. <p>[line 73]</p>
  368. Returns a reference to the target to which the event was originally dispatched.<br /><br /><br /><br />
  369. <h4>Tags:</h4>
  370. <div class="tags">
  371. <table border="0" cellspacing="0" cellpadding="0">
  372. <tr>
  373. <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  374. </tr>
  375. </table>
  376. </div>
  377. <br />
  378. <div class="tags">
  379. <table border="0" cellspacing="0" cellpadding="0">
  380. <tr>
  381. <td><b>Type:</b>&nbsp;&nbsp;</td>
  382. <td>unknown_type</td>
  383. </tr>
  384. </table>
  385. </div><br /><br />
  386. <div class="top">[ <a href="#top">Top</a> ]</div><br />
  387. <a name="var$timeStamp"></a>
  388. <p></p>
  389. <h4>$timeStamp = <span class="value"></span></h4>
  390. <p>[line 79]</p>
  391. Returns the time that the event was created.<br /><br /><br /><br />
  392. <h4>Tags:</h4>
  393. <div class="tags">
  394. <table border="0" cellspacing="0" cellpadding="0">
  395. <tr>
  396. <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  397. </tr>
  398. </table>
  399. </div>
  400. <br />
  401. <div class="tags">
  402. <table border="0" cellspacing="0" cellpadding="0">
  403. <tr>
  404. <td><b>Type:</b>&nbsp;&nbsp;</td>
  405. <td>unknown_type</td>
  406. </tr>
  407. </table>
  408. </div><br /><br />
  409. <div class="top">[ <a href="#top">Top</a> ]</div><br />
  410. <a name="var$type"></a>
  411. <p></p>
  412. <h4>$type = <span class="value"></span></h4>
  413. <p>[line 83]</p>
  414. Returns the name of the event (case-insensitive).<br /><br /><br /><br />
  415. <h4>Tags:</h4>
  416. <div class="tags">
  417. <table border="0" cellspacing="0" cellpadding="0">
  418. <tr>
  419. <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  420. </tr>
  421. </table>
  422. </div>
  423. <br />
  424. <div class="tags">
  425. <table border="0" cellspacing="0" cellpadding="0">
  426. <tr>
  427. <td><b>Type:</b>&nbsp;&nbsp;</td>
  428. <td>mixed</td>
  429. </tr>
  430. </table>
  431. </div><br /><br />
  432. <div class="top">[ <a href="#top">Top</a> ]</div><br />
  433. </div><br />
  434. <hr />
  435. <a name="class_methods"></a>
  436. <h3>Class Methods</h3>
  437. <div class="tags">
  438. <hr />
  439. <a name="method__construct"></a>
  440. <h3>constructor __construct <span class="smalllinenumber">[line 86]</span></h3>
  441. <div class="function">
  442. <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
  443. <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
  444. <code>DOMEvent __construct(
  445. $data)</code>
  446. </td></tr></table>
  447. </td></tr></table><br />
  448. <br /><br />
  449. <h4>Tags:</h4>
  450. <div class="tags">
  451. <table border="0" cellspacing="0" cellpadding="0">
  452. <tr>
  453. <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  454. </tr>
  455. </table>
  456. </div>
  457. <br /><br />
  458. <h4>Parameters:</h4>
  459. <div class="tags">
  460. <table border="0" cellspacing="0" cellpadding="0">
  461. <tr>
  462. <td class="type">&nbsp;&nbsp;</td>
  463. <td><b>$data</b>&nbsp;&nbsp;</td>
  464. <td></td>
  465. </tr>
  466. </table>
  467. </div><br />
  468. <div class="top">[ <a href="#top">Top</a> ]</div>
  469. </div>
  470. <hr />
  471. <a name="methodpreventDefault"></a>
  472. <h3>method preventDefault <span class="smalllinenumber">[line 97]</span></h3>
  473. <div class="function">
  474. <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
  475. <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
  476. <code>void preventDefault(
  477. )</code>
  478. </td></tr></table>
  479. </td></tr></table><br />
  480. Cancels the event (if it is cancelable).<br /><br /><br /><br />
  481. <h4>Tags:</h4>
  482. <div class="tags">
  483. <table border="0" cellspacing="0" cellpadding="0">
  484. <tr>
  485. <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  486. </tr>
  487. </table>
  488. </div>
  489. <br /><br />
  490. <div class="top">[ <a href="#top">Top</a> ]</div>
  491. </div>
  492. <hr />
  493. <a name="methodstopPropagation"></a>
  494. <h3>method stopPropagation <span class="smalllinenumber">[line 104]</span></h3>
  495. <div class="function">
  496. <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
  497. <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
  498. <code>void stopPropagation(
  499. )</code>
  500. </td></tr></table>
  501. </td></tr></table><br />
  502. Stops the propagation of events further along in the DOM.<br /><br /><br /><br />
  503. <h4>Tags:</h4>
  504. <div class="tags">
  505. <table border="0" cellspacing="0" cellpadding="0">
  506. <tr>
  507. <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  508. </tr>
  509. </table>
  510. </div>
  511. <br /><br />
  512. <div class="top">[ <a href="#top">Top</a> ]</div>
  513. </div>
  514. </div><br />
  515. <div class="credit">
  516. <hr />
  517. Documentation generated on Tue, 18 Nov 2008 19:39:25 +0100 by <a href="http://www.phpdoc.org">phpDocumentor 1.4.2</a>
  518. </div>
  519. </td></tr></table>
  520. </td>
  521. </tr>
  522. </table>
  523. </body>
  524. </html>