b811590609d61af73bc79f7fd0e3b3c9b8cc98c3.svn-base 92 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670
  1. <div class="body-wrap">
  2. <div class="top-tools">
  3. <a class="inner-link" href="#Ext.tree.TreeNode-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>
  4. <a class="inner-link" href="#Ext.tree.TreeNode-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
  5. <a class="inner-link" href="#Ext.tree.TreeNode-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
  6. <a class="inner-link" href="#Ext.tree.TreeNode-configs"><img src="../resources/images/default/s.gif" class="item-icon icon-config">Config Options</a>
  7. <a class="bookmark" href="../docs/?class=Ext.tree.TreeNode"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>
  8. </div>
  9. <div class="inheritance res-block">
  10. <pre class="res-block-inner"><a ext:cls="Ext.util.Observable" ext:member="" href="output/Ext.util.Observable.html">Observable</a>
  11. <img src="resources/elbow-end.gif"/><a ext:cls="Ext.data.Node" ext:member="" href="output/Ext.data.Node.html">Node</a>
  12. <img src="resources/elbow-end.gif"/>TreeNode</pre></div>
  13. <h1>Class Ext.tree.TreeNode</h1>
  14. <table cellspacing="0">
  15. <tr><td class="label">Package:</td><td class="hd-info">Ext.tree</td></tr>
  16. <tr><td class="label">Defined In:</td><td class="hd-info"><a href="../src/TreeNode.js" target="_blank">TreeNode.js</a></td></tr>
  17. <tr><td class="label">Class:</td><td class="hd-info">TreeNode</td></tr>
  18. <tr><td class="label">Subclasses:</td><td class="hd-info"><a ext:cls="Ext.tree.AsyncTreeNode" href="output/Ext.tree.AsyncTreeNode.html">AsyncTreeNode</a></td></tr>
  19. <tr><td class="label">Extends:</td><td class="hd-info"><a ext:cls="Ext.data.Node" ext:member="" href="output/Ext.data.Node.html">Node</a></td></tr>
  20. </table>
  21. <div class="description">
  22. </div>
  23. <div class="hr"></div>
  24. <a id="Ext.tree.TreeNode-configs"></a>
  25. <h2>Config Options</h2>
  26. <table cellspacing="0" class="member-table">
  27. <tr>
  28. <th class="sig-header" colspan="2">Config Options</th>
  29. <th class="msource-header">Defined By</th>
  30. </tr>
  31. <tr class="config-row">
  32. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  33. <td class="sig">
  34. <a id="Ext.tree.TreeNode-allowChildren"></a>
  35. <b>allowChildren</b> : Boolean <div class="mdesc">
  36. False to not allow this node to have child nodes (defaults to true) </div>
  37. </td>
  38. <td class="msource">TreeNode</td>
  39. </tr>
  40. <tr class="config-row alt">
  41. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  42. <td class="sig">
  43. <a id="Ext.tree.TreeNode-allowDrag"></a>
  44. <b>allowDrag</b> : Boolean <div class="mdesc">
  45. False to make this node undraggable if <a ext:cls="Ext.tree.TreeNode" ext:member="draggable" href="output/Ext.tree.TreeNode.html#draggable">draggable</a> = true (defaults to true) </div>
  46. </td>
  47. <td class="msource">TreeNode</td>
  48. </tr>
  49. <tr class="config-row">
  50. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  51. <td class="sig">
  52. <a id="Ext.tree.TreeNode-allowDrop"></a>
  53. <b>allowDrop</b> : Boolean <div class="mdesc">
  54. False if this node cannot have child nodes dropped on it (defaults to true) </div>
  55. </td>
  56. <td class="msource">TreeNode</td>
  57. </tr>
  58. <tr class="config-row alt expandable">
  59. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  60. <td class="sig">
  61. <a id="Ext.tree.TreeNode-checked"></a>
  62. <b>checked</b> : Boolean <div class="mdesc">
  63. <div class="short">True to render a checked checkbox for this node, false to render an unchecked checkbox (defaults to undefined with no...</div>
  64. <div class="long">
  65. True to render a checked checkbox for this node, false to render an unchecked checkbox (defaults to undefined with no checkbox rendered) </div>
  66. </div>
  67. </td>
  68. <td class="msource">TreeNode</td>
  69. </tr>
  70. <tr class="config-row">
  71. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  72. <td class="sig">
  73. <a id="Ext.tree.TreeNode-cls"></a>
  74. <b>cls</b> : String <div class="mdesc">
  75. A css class to be added to the node </div>
  76. </td>
  77. <td class="msource">TreeNode</td>
  78. </tr>
  79. <tr class="config-row alt">
  80. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  81. <td class="sig">
  82. <a id="Ext.tree.TreeNode-disabled"></a>
  83. <b>disabled</b> : Boolean <div class="mdesc">
  84. true to start the node disabled </div>
  85. </td>
  86. <td class="msource">TreeNode</td>
  87. </tr>
  88. <tr class="config-row">
  89. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  90. <td class="sig">
  91. <a id="Ext.tree.TreeNode-draggable"></a>
  92. <b>draggable</b> : Boolean <div class="mdesc">
  93. True to make this node draggable (defaults to false) </div>
  94. </td>
  95. <td class="msource">TreeNode</td>
  96. </tr>
  97. <tr class="config-row alt">
  98. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  99. <td class="sig">
  100. <a id="Ext.tree.TreeNode-expandable"></a>
  101. <b>expandable</b> : Boolean <div class="mdesc">
  102. If set to true, the node will always show a plus/minus icon, even when empty </div>
  103. </td>
  104. <td class="msource">TreeNode</td>
  105. </tr>
  106. <tr class="config-row">
  107. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  108. <td class="sig">
  109. <a id="Ext.tree.TreeNode-expanded"></a>
  110. <b>expanded</b> : Boolean <div class="mdesc">
  111. true to start the node expanded </div>
  112. </td>
  113. <td class="msource">TreeNode</td>
  114. </tr>
  115. <tr class="config-row alt">
  116. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  117. <td class="sig">
  118. <a id="Ext.tree.TreeNode-href"></a>
  119. <b>href</b> : String <div class="mdesc">
  120. URL of the link used for the node (defaults to #) </div>
  121. </td>
  122. <td class="msource">TreeNode</td>
  123. </tr>
  124. <tr class="config-row">
  125. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  126. <td class="sig">
  127. <a id="Ext.tree.TreeNode-hrefTarget"></a>
  128. <b>hrefTarget</b> : String <div class="mdesc">
  129. target frame for the link </div>
  130. </td>
  131. <td class="msource">TreeNode</td>
  132. </tr>
  133. <tr class="config-row alt expandable">
  134. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  135. <td class="sig">
  136. <a id="Ext.tree.TreeNode-icon"></a>
  137. <b>icon</b> : String <div class="mdesc">
  138. <div class="short">The path to an icon for the node. The preferred way to do this is to use the cls or iconCls attributes and add the ic...</div>
  139. <div class="long">
  140. The path to an icon for the node. The preferred way to do this is to use the cls or iconCls attributes and add the icon via a CSS background image. </div>
  141. </div>
  142. </td>
  143. <td class="msource">TreeNode</td>
  144. </tr>
  145. <tr class="config-row">
  146. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  147. <td class="sig">
  148. <a id="Ext.tree.TreeNode-iconCls"></a>
  149. <b>iconCls</b> : String <div class="mdesc">
  150. A css class to be added to the nodes icon element for applying css background images </div>
  151. </td>
  152. <td class="msource">TreeNode</td>
  153. </tr>
  154. <tr class="config-row inherited alt">
  155. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  156. <td class="sig">
  157. <a id="Ext.tree.TreeNode-id"></a>
  158. <b>id</b> : String <div class="mdesc">
  159. The id for this node. If one is not specified, one is generated. </div>
  160. </td>
  161. <td class="msource"><a ext:cls="Ext.data.Node" ext:member="#id" href="output/Ext.data.Node.html#id">Node</a></td>
  162. </tr>
  163. <tr class="config-row">
  164. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  165. <td class="sig">
  166. <a id="Ext.tree.TreeNode-isTarget"></a>
  167. <b>isTarget</b> : Boolean <div class="mdesc">
  168. False to not allow this node to act as a drop target (defaults to true) </div>
  169. </td>
  170. <td class="msource">TreeNode</td>
  171. </tr>
  172. <tr class="config-row inherited alt">
  173. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  174. <td class="sig">
  175. <a id="Ext.tree.TreeNode-leaf"></a>
  176. <b>leaf</b> : Boolean <div class="mdesc">
  177. true if this node is a leaf and does not have children </div>
  178. </td>
  179. <td class="msource"><a ext:cls="Ext.data.Node" ext:member="#leaf" href="output/Ext.data.Node.html#leaf">Node</a></td>
  180. </tr>
  181. <tr class="config-row inherited expandable">
  182. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  183. <td class="sig">
  184. <a id="Ext.tree.TreeNode-listeners"></a>
  185. <b>listeners</b> : Object <div class="mdesc">
  186. <div class="short">A config object containing one or more event handlers to be added to this object during initialization. This should b...</div>
  187. <div class="long">
  188. A config object containing one or more event handlers to be added to this object during initialization. This should be a valid listeners config object as specified in the <a ext:cls="Ext.util.Observable" ext:member="addListener" href="output/Ext.util.Observable.html#addListener">addListener</a> example for attaching multiple handlers at once. </div>
  189. </div>
  190. </td>
  191. <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#listeners" href="output/Ext.util.Observable.html#listeners">Observable</a></td>
  192. </tr>
  193. <tr class="config-row alt">
  194. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  195. <td class="sig">
  196. <a id="Ext.tree.TreeNode-qtip"></a>
  197. <b>qtip</b> : String <div class="mdesc">
  198. An Ext QuickTip for the node </div>
  199. </td>
  200. <td class="msource">TreeNode</td>
  201. </tr>
  202. <tr class="config-row">
  203. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  204. <td class="sig">
  205. <a id="Ext.tree.TreeNode-qtipCfg"></a>
  206. <b>qtipCfg</b> : String <div class="mdesc">
  207. An Ext QuickTip config for the node (used instead of qtip) </div>
  208. </td>
  209. <td class="msource">TreeNode</td>
  210. </tr>
  211. <tr class="config-row alt">
  212. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  213. <td class="sig">
  214. <a id="Ext.tree.TreeNode-singleClickExpand"></a>
  215. <b>singleClickExpand</b> : Boolean <div class="mdesc">
  216. True for single click expand on this node </div>
  217. </td>
  218. <td class="msource">TreeNode</td>
  219. </tr>
  220. <tr class="config-row">
  221. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  222. <td class="sig">
  223. <a id="Ext.tree.TreeNode-text"></a>
  224. <b>text</b> : String <div class="mdesc">
  225. The text for this node </div>
  226. </td>
  227. <td class="msource">TreeNode</td>
  228. </tr>
  229. <tr class="config-row alt">
  230. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  231. <td class="sig">
  232. <a id="Ext.tree.TreeNode-uiProvider"></a>
  233. <b>uiProvider</b> : Function <div class="mdesc">
  234. A UI <b>class</b> to use for this node (defaults to Ext.tree.TreeNodeUI) </div>
  235. </td>
  236. <td class="msource">TreeNode</td>
  237. </tr>
  238. </table>
  239. <a id="Ext.tree.TreeNode-props"></a>
  240. <h2>Public Properties</h2>
  241. <table cellspacing="0" class="member-table">
  242. <tr>
  243. <th class="sig-header" colspan="2">Property</th>
  244. <th class="msource-header">Defined By</th>
  245. </tr>
  246. <tr class="property-row inherited">
  247. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  248. <td class="sig">
  249. <a id="Ext.tree.TreeNode-attributes"></a>
  250. <b>attributes</b> : Object <div class="mdesc">
  251. The attributes supplied for the node. You can use this property to access any custom attributes you supplied. </div>
  252. </td>
  253. <td class="msource"><a ext:cls="Ext.data.Node" ext:member="#attributes" href="output/Ext.data.Node.html#attributes">Node</a></td>
  254. </tr>
  255. <tr class="property-row inherited alt">
  256. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  257. <td class="sig">
  258. <a id="Ext.tree.TreeNode-childNodes"></a>
  259. <b>childNodes</b> : Array <div class="mdesc">
  260. All child nodes of this node. </div>
  261. </td>
  262. <td class="msource"><a ext:cls="Ext.data.Node" ext:member="#childNodes" href="output/Ext.data.Node.html#childNodes">Node</a></td>
  263. </tr>
  264. <tr class="property-row">
  265. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  266. <td class="sig">
  267. <a id="Ext.tree.TreeNode-disabled"></a>
  268. <b>disabled</b> : Boolean <div class="mdesc">
  269. True if this node is disabled. </div>
  270. </td>
  271. <td class="msource">TreeNode</td>
  272. </tr>
  273. <tr class="property-row inherited alt">
  274. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  275. <td class="sig">
  276. <a id="Ext.tree.TreeNode-firstChild"></a>
  277. <b>firstChild</b> : Node <div class="mdesc">
  278. The first direct child node of this node, or null if this node has no child nodes. </div>
  279. </td>
  280. <td class="msource"><a ext:cls="Ext.data.Node" ext:member="#firstChild" href="output/Ext.data.Node.html#firstChild">Node</a></td>
  281. </tr>
  282. <tr class="property-row inherited">
  283. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  284. <td class="sig">
  285. <a id="Ext.tree.TreeNode-id"></a>
  286. <b>id</b> : String <div class="mdesc">
  287. The node id. </div>
  288. </td>
  289. <td class="msource"><a ext:cls="Ext.data.Node" ext:member="#id" href="output/Ext.data.Node.html#id">Node</a></td>
  290. </tr>
  291. <tr class="property-row inherited alt">
  292. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  293. <td class="sig">
  294. <a id="Ext.tree.TreeNode-lastChild"></a>
  295. <b>lastChild</b> : Node <div class="mdesc">
  296. The last direct child node of this node, or null if this node has no child nodes. </div>
  297. </td>
  298. <td class="msource"><a ext:cls="Ext.data.Node" ext:member="#lastChild" href="output/Ext.data.Node.html#lastChild">Node</a></td>
  299. </tr>
  300. <tr class="property-row inherited">
  301. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  302. <td class="sig">
  303. <a id="Ext.tree.TreeNode-nextSibling"></a>
  304. <b>nextSibling</b> : Node <div class="mdesc">
  305. The node immediately following this node in the tree, or null if there is no sibling node. </div>
  306. </td>
  307. <td class="msource"><a ext:cls="Ext.data.Node" ext:member="#nextSibling" href="output/Ext.data.Node.html#nextSibling">Node</a></td>
  308. </tr>
  309. <tr class="property-row inherited alt">
  310. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  311. <td class="sig">
  312. <a id="Ext.tree.TreeNode-parentNode"></a>
  313. <b>parentNode</b> : Node <div class="mdesc">
  314. The parent node for this node. </div>
  315. </td>
  316. <td class="msource"><a ext:cls="Ext.data.Node" ext:member="#parentNode" href="output/Ext.data.Node.html#parentNode">Node</a></td>
  317. </tr>
  318. <tr class="property-row inherited">
  319. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  320. <td class="sig">
  321. <a id="Ext.tree.TreeNode-previousSibling"></a>
  322. <b>previousSibling</b> : Node <div class="mdesc">
  323. The node immediately preceding this node in the tree, or null if there is no sibling node. </div>
  324. </td>
  325. <td class="msource"><a ext:cls="Ext.data.Node" ext:member="#previousSibling" href="output/Ext.data.Node.html#previousSibling">Node</a></td>
  326. </tr>
  327. <tr class="property-row alt">
  328. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  329. <td class="sig">
  330. <a id="Ext.tree.TreeNode-text"></a>
  331. <b>text</b> : String <div class="mdesc">
  332. Read-only. The text for this node. To change it use setText(). </div>
  333. </td>
  334. <td class="msource">TreeNode</td>
  335. </tr>
  336. <tr class="property-row">
  337. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  338. <td class="sig">
  339. <a id="Ext.tree.TreeNode-ui"></a>
  340. <b>ui</b> : TreeNodeUI <div class="mdesc">
  341. Read-only. The UI for this node </div>
  342. </td>
  343. <td class="msource">TreeNode</td>
  344. </tr>
  345. </table>
  346. <a id="Ext.tree.TreeNode-methods"></a>
  347. <h2>Public Methods</h2>
  348. <table cellspacing="0" class="member-table">
  349. <tr>
  350. <th class="sig-header" colspan="2">Method</th>
  351. <th class="msource-header">Defined By</th>
  352. </tr>
  353. <tr class="method-row expandable">
  354. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  355. <td class="sig">
  356. <a id="Ext.tree.TreeNode-TreeNode"></a>
  357. <b>TreeNode</b>(&nbsp;<code>Object/String attributes</code>&nbsp;) <div class="mdesc">
  358. <div class="short"></div>
  359. <div class="long">
  360. <div class="mdetail-params">
  361. <strong>Parameters:</strong>
  362. <ul><li><code>attributes</code> : Object/String<div class="sub-desc">The attributes/config for the node or just a string with the text for the node</div></li> </ul>
  363. <strong>Returns:</strong>
  364. <ul>
  365. <li><code></code></li>
  366. </ul>
  367. </div>
  368. </div>
  369. </div>
  370. </td>
  371. <td class="msource">TreeNode</td>
  372. </tr>
  373. <tr class="method-row inherited alt expandable">
  374. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  375. <td class="sig">
  376. <a id="Ext.tree.TreeNode-addEvents"></a>
  377. <b>addEvents</b>(&nbsp;<code>Object object</code>&nbsp;) : void <div class="mdesc">
  378. <div class="short">Used to define events on this Observable</div>
  379. <div class="long">
  380. Used to define events on this Observable <div class="mdetail-params">
  381. <strong>Parameters:</strong>
  382. <ul><li><code>object</code> : Object<div class="sub-desc">The object with the events defined</div></li> </ul>
  383. <strong>Returns:</strong>
  384. <ul>
  385. <li><code>void</code></li>
  386. </ul>
  387. </div>
  388. </div>
  389. </div>
  390. </td>
  391. <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#addEvents" href="output/Ext.util.Observable.html#addEvents">Observable</a></td>
  392. </tr>
  393. <tr class="method-row inherited expandable">
  394. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  395. <td class="sig">
  396. <a id="Ext.tree.TreeNode-addListener"></a>
  397. <b>addListener</b>(&nbsp;<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>Object options</code>]</span>&nbsp;) : void <div class="mdesc">
  398. <div class="short">Appends an event handler to this component</div>
  399. <div class="long">
  400. Appends an event handler to this component <div class="mdetail-params">
  401. <strong>Parameters:</strong>
  402. <ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The method the event invokes</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope in which to execute the handler
  403. function. The handler function's "this" context.</div></li><li><code>options</code> : Object<div class="sub-desc">(optional) An object containing handler configuration
  404. properties. This may contain any of the following properties:<ul>
  405. <li><b>scope</b> : Object<p class="sub-desc">The scope in which to execute the handler function. The handler function's "this" context.</p></li>
  406. <li><b>delay</b> : Number<p class="sub-desc">The number of milliseconds to delay the invocation of the handler after the event fires.</p></li>
  407. <li><b>single</b> : Boolean<p class="sub-desc">True to add a handler to handle just the next firing of the event, and then remove itself.</p></li>
  408. <li>buffer {Number} Causes the handler to be scheduled to run in an <a ext:cls="Ext.util.DelayedTask" href="output/Ext.util.DelayedTask.html">Ext.util.DelayedTask</a> delayed
  409. by the specified number of milliseconds. If the event fires again within that time, the original
  410. handler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>
  411. </ul><br>
  412. <p>
  413. <b>Combining Options</b><br>
  414. Using the options argument, it is possible to combine different types of listeners:<br>
  415. <br>
  416. A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)
  417. <pre><code>el.on(<em>'click'</em>, <b>this</b>.onClick, <b>this</b>, {
  418. single: true,
  419. delay: 100,
  420. forumId: 4
  421. });</code></pre>
  422. <p>
  423. <b>Attaching multiple handlers in 1 call</b><br>
  424. The method also allows for a single argument to be passed which is a config object containing properties
  425. which specify multiple handlers.
  426. <p>
  427. <pre><code>foo.on({
  428. <em>'click'</em> : {
  429. fn: <b>this</b>.onClick,
  430. scope: <b>this</b>,
  431. delay: 100
  432. },
  433. <em>'mouseover'</em> : {
  434. fn: <b>this</b>.onMouseOver,
  435. scope: <b>this</b>
  436. },
  437. <em>'mouseout'</em> : {
  438. fn: <b>this</b>.onMouseOut,
  439. scope: <b>this</b>
  440. }
  441. });</code></pre>
  442. <p>
  443. Or a shorthand syntax:<br>
  444. <pre><code>foo.on({
  445. <em>'click'</em> : <b>this</b>.onClick,
  446. <em>'mouseover'</em> : <b>this</b>.onMouseOver,
  447. <em>'mouseout'</em> : <b>this</b>.onMouseOut,
  448. scope: <b>this</b>
  449. });</code></pre></div></li> </ul>
  450. <strong>Returns:</strong>
  451. <ul>
  452. <li><code>void</code></li>
  453. </ul>
  454. </div>
  455. </div>
  456. </div>
  457. </td>
  458. <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#addListener" href="output/Ext.util.Observable.html#addListener">Observable</a></td>
  459. </tr>
  460. <tr class="method-row inherited alt expandable">
  461. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  462. <td class="sig">
  463. <a id="Ext.tree.TreeNode-appendChild"></a>
  464. <b>appendChild</b>(&nbsp;<code>Node/Array node</code>&nbsp;) : Node <div class="mdesc">
  465. <div class="short">Insert node(s) as the last child node of this node.</div>
  466. <div class="long">
  467. Insert node(s) as the last child node of this node. <div class="mdetail-params">
  468. <strong>Parameters:</strong>
  469. <ul><li><code>node</code> : Node/Array<div class="sub-desc">The node or Array of nodes to append</div></li> </ul>
  470. <strong>Returns:</strong>
  471. <ul>
  472. <li><code>Node</code><div class="sub-desc">The appended node if single append, or null if an array was passed</div></li>
  473. </ul>
  474. </div>
  475. </div>
  476. </div>
  477. </td>
  478. <td class="msource"><a ext:cls="Ext.data.Node" ext:member="#appendChild" href="output/Ext.data.Node.html#appendChild">Node</a></td>
  479. </tr>
  480. <tr class="method-row inherited expandable">
  481. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  482. <td class="sig">
  483. <a id="Ext.tree.TreeNode-bubble"></a>
  484. <b>bubble</b>(&nbsp;<code>Function fn</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>Array args</code>]</span>&nbsp;) : void <div class="mdesc">
  485. <div class="short">Bubbles up the tree from this node, calling the specified function with each node. The scope (this) of
  486. function call ...</div>
  487. <div class="long">
  488. Bubbles up the tree from this node, calling the specified function with each node. The scope (<i>this</i>) of
  489. function call will be the scope provided or the current node. The arguments to the function
  490. will be the args provided or the current node. If the function returns false at any point,
  491. the bubble is stopped. <div class="mdetail-params">
  492. <strong>Parameters:</strong>
  493. <ul><li><code>fn</code> : Function<div class="sub-desc">The function to call</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope of the function (defaults to current node)</div></li><li><code>args</code> : Array<div class="sub-desc">(optional) The args to call the function with (default to passing the current node)</div></li> </ul>
  494. <strong>Returns:</strong>
  495. <ul>
  496. <li><code>void</code></li>
  497. </ul>
  498. </div>
  499. </div>
  500. </div>
  501. </td>
  502. <td class="msource"><a ext:cls="Ext.data.Node" ext:member="#bubble" href="output/Ext.data.Node.html#bubble">Node</a></td>
  503. </tr>
  504. <tr class="method-row inherited alt expandable">
  505. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  506. <td class="sig">
  507. <a id="Ext.tree.TreeNode-cascade"></a>
  508. <b>cascade</b>(&nbsp;<code>Function fn</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>Array args</code>]</span>&nbsp;) : void <div class="mdesc">
  509. <div class="short">Cascades down the tree from this node, calling the specified function with each node. The scope (this) of
  510. function ca...</div>
  511. <div class="long">
  512. Cascades down the tree from this node, calling the specified function with each node. The scope (<i>this</i>) of
  513. function call will be the scope provided or the current node. The arguments to the function
  514. will be the args provided or the current node. If the function returns false at any point,
  515. the cascade is stopped on that branch. <div class="mdetail-params">
  516. <strong>Parameters:</strong>
  517. <ul><li><code>fn</code> : Function<div class="sub-desc">The function to call</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope of the function (defaults to current node)</div></li><li><code>args</code> : Array<div class="sub-desc">(optional) The args to call the function with (default to passing the current node)</div></li> </ul>
  518. <strong>Returns:</strong>
  519. <ul>
  520. <li><code>void</code></li>
  521. </ul>
  522. </div>
  523. </div>
  524. </div>
  525. </td>
  526. <td class="msource"><a ext:cls="Ext.data.Node" ext:member="#cascade" href="output/Ext.data.Node.html#cascade">Node</a></td>
  527. </tr>
  528. <tr class="method-row expandable">
  529. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  530. <td class="sig">
  531. <a id="Ext.tree.TreeNode-collapse"></a>
  532. <b>collapse</b>(&nbsp;<span class="optional" title="Optional">[<code>Boolean deep</code>]</span>, <span class="optional" title="Optional">[<code>Boolean anim</code>]</span>&nbsp;) : void <div class="mdesc">
  533. <div class="short">Collapse this node.</div>
  534. <div class="long">
  535. Collapse this node. <div class="mdetail-params">
  536. <strong>Parameters:</strong>
  537. <ul><li><code>deep</code> : Boolean<div class="sub-desc">(optional) True to collapse all children as well</div></li><li><code>anim</code> : Boolean<div class="sub-desc">(optional) false to cancel the default animation</div></li> </ul>
  538. <strong>Returns:</strong>
  539. <ul>
  540. <li><code>void</code></li>
  541. </ul>
  542. </div>
  543. </div>
  544. </div>
  545. </td>
  546. <td class="msource">TreeNode</td>
  547. </tr>
  548. <tr class="method-row alt expandable">
  549. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  550. <td class="sig">
  551. <a id="Ext.tree.TreeNode-collapseChildNodes"></a>
  552. <b>collapseChildNodes</b>(&nbsp;<span class="optional" title="Optional">[<code>Boolean deep</code>]</span>&nbsp;) : void <div class="mdesc">
  553. <div class="short">Collapse all child nodes</div>
  554. <div class="long">
  555. Collapse all child nodes <div class="mdetail-params">
  556. <strong>Parameters:</strong>
  557. <ul><li><code>deep</code> : Boolean<div class="sub-desc">(optional) true if the child nodes should also collapse their child nodes</div></li> </ul>
  558. <strong>Returns:</strong>
  559. <ul>
  560. <li><code>void</code></li>
  561. </ul>
  562. </div>
  563. </div>
  564. </div>
  565. </td>
  566. <td class="msource">TreeNode</td>
  567. </tr>
  568. <tr class="method-row inherited expandable">
  569. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  570. <td class="sig">
  571. <a id="Ext.tree.TreeNode-contains"></a>
  572. <b>contains</b>(&nbsp;<code>Node node</code>&nbsp;) : Boolean <div class="mdesc">
  573. <div class="short">Returns true if this node is an ancestor (at any point) of the passed node.</div>
  574. <div class="long">
  575. Returns true if this node is an ancestor (at any point) of the passed node. <div class="mdetail-params">
  576. <strong>Parameters:</strong>
  577. <ul><li><code>node</code> : Node<div class="sub-desc"></div></li> </ul>
  578. <strong>Returns:</strong>
  579. <ul>
  580. <li><code>Boolean</code></li>
  581. </ul>
  582. </div>
  583. </div>
  584. </div>
  585. </td>
  586. <td class="msource"><a ext:cls="Ext.data.Node" ext:member="#contains" href="output/Ext.data.Node.html#contains">Node</a></td>
  587. </tr>
  588. <tr class="method-row alt expandable">
  589. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  590. <td class="sig">
  591. <a id="Ext.tree.TreeNode-disable"></a>
  592. <b>disable</b>() : void <div class="mdesc">
  593. <div class="short">Disables this node</div>
  594. <div class="long">
  595. Disables this node <div class="mdetail-params">
  596. <strong>Parameters:</strong>
  597. <ul><li>None.</li> </ul>
  598. <strong>Returns:</strong>
  599. <ul>
  600. <li><code>void</code></li>
  601. </ul>
  602. </div>
  603. </div>
  604. </div>
  605. </td>
  606. <td class="msource">TreeNode</td>
  607. </tr>
  608. <tr class="method-row inherited expandable">
  609. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  610. <td class="sig">
  611. <a id="Ext.tree.TreeNode-eachChild"></a>
  612. <b>eachChild</b>(&nbsp;<code>Function fn</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>Array args</code>]</span>&nbsp;) : void <div class="mdesc">
  613. <div class="short">Interates the child nodes of this node, calling the specified function with each node. The scope (this) of
  614. function c...</div>
  615. <div class="long">
  616. Interates the child nodes of this node, calling the specified function with each node. The scope (<i>this</i>) of
  617. function call will be the scope provided or the current node. The arguments to the function
  618. will be the args provided or the current node. If the function returns false at any point,
  619. the iteration stops. <div class="mdetail-params">
  620. <strong>Parameters:</strong>
  621. <ul><li><code>fn</code> : Function<div class="sub-desc">The function to call</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope of the function (defaults to current node)</div></li><li><code>args</code> : Array<div class="sub-desc">(optional) The args to call the function with (default to passing the current node)</div></li> </ul>
  622. <strong>Returns:</strong>
  623. <ul>
  624. <li><code>void</code></li>
  625. </ul>
  626. </div>
  627. </div>
  628. </div>
  629. </td>
  630. <td class="msource"><a ext:cls="Ext.data.Node" ext:member="#eachChild" href="output/Ext.data.Node.html#eachChild">Node</a></td>
  631. </tr>
  632. <tr class="method-row alt expandable">
  633. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  634. <td class="sig">
  635. <a id="Ext.tree.TreeNode-enable"></a>
  636. <b>enable</b>() : void <div class="mdesc">
  637. <div class="short">Enables this node</div>
  638. <div class="long">
  639. Enables this node <div class="mdetail-params">
  640. <strong>Parameters:</strong>
  641. <ul><li>None.</li> </ul>
  642. <strong>Returns:</strong>
  643. <ul>
  644. <li><code>void</code></li>
  645. </ul>
  646. </div>
  647. </div>
  648. </div>
  649. </td>
  650. <td class="msource">TreeNode</td>
  651. </tr>
  652. <tr class="method-row expandable">
  653. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  654. <td class="sig">
  655. <a id="Ext.tree.TreeNode-ensureVisible"></a>
  656. <b>ensureVisible</b>() : void <div class="mdesc">
  657. <div class="short">Ensures all parent nodes are expanded, and if necessary, scrolls
  658. the node into view.</div>
  659. <div class="long">
  660. Ensures all parent nodes are expanded, and if necessary, scrolls
  661. the node into view. <div class="mdetail-params">
  662. <strong>Parameters:</strong>
  663. <ul><li>None.</li> </ul>
  664. <strong>Returns:</strong>
  665. <ul>
  666. <li><code>void</code></li>
  667. </ul>
  668. </div>
  669. </div>
  670. </div>
  671. </td>
  672. <td class="msource">TreeNode</td>
  673. </tr>
  674. <tr class="method-row alt expandable">
  675. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  676. <td class="sig">
  677. <a id="Ext.tree.TreeNode-expand"></a>
  678. <b>expand</b>(&nbsp;<span class="optional" title="Optional">[<code>Boolean deep</code>]</span>, <span class="optional" title="Optional">[<code>Boolean anim</code>]</span>, <span class="optional" title="Optional">[<code>Function callback</code>]</span>&nbsp;) : void <div class="mdesc">
  679. <div class="short">Expand this node.</div>
  680. <div class="long">
  681. Expand this node. <div class="mdetail-params">
  682. <strong>Parameters:</strong>
  683. <ul><li><code>deep</code> : Boolean<div class="sub-desc">(optional) True to expand all children as well</div></li><li><code>anim</code> : Boolean<div class="sub-desc">(optional) false to cancel the default animation</div></li><li><code>callback</code> : Function<div class="sub-desc">(optional) A callback to be called when
  684. expanding this node completes (does not wait for deep expand to complete).
  685. Called with 1 parameter, this node.</div></li> </ul>
  686. <strong>Returns:</strong>
  687. <ul>
  688. <li><code>void</code></li>
  689. </ul>
  690. </div>
  691. </div>
  692. </div>
  693. </td>
  694. <td class="msource">TreeNode</td>
  695. </tr>
  696. <tr class="method-row expandable">
  697. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  698. <td class="sig">
  699. <a id="Ext.tree.TreeNode-expandChildNodes"></a>
  700. <b>expandChildNodes</b>(&nbsp;<span class="optional" title="Optional">[<code>Boolean deep</code>]</span>&nbsp;) : void <div class="mdesc">
  701. <div class="short">Expand all child nodes</div>
  702. <div class="long">
  703. Expand all child nodes <div class="mdetail-params">
  704. <strong>Parameters:</strong>
  705. <ul><li><code>deep</code> : Boolean<div class="sub-desc">(optional) true if the child nodes should also expand their child nodes</div></li> </ul>
  706. <strong>Returns:</strong>
  707. <ul>
  708. <li><code>void</code></li>
  709. </ul>
  710. </div>
  711. </div>
  712. </div>
  713. </td>
  714. <td class="msource">TreeNode</td>
  715. </tr>
  716. <tr class="method-row inherited alt expandable">
  717. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  718. <td class="sig">
  719. <a id="Ext.tree.TreeNode-findChild"></a>
  720. <b>findChild</b>(&nbsp;<code>String attribute</code>, <code>Mixed value</code>&nbsp;) : Node <div class="mdesc">
  721. <div class="short">Finds the first child that has the attribute with the specified value.</div>
  722. <div class="long">
  723. Finds the first child that has the attribute with the specified value. <div class="mdetail-params">
  724. <strong>Parameters:</strong>
  725. <ul><li><code>attribute</code> : String<div class="sub-desc">The attribute name</div></li><li><code>value</code> : Mixed<div class="sub-desc">The value to search for</div></li> </ul>
  726. <strong>Returns:</strong>
  727. <ul>
  728. <li><code>Node</code><div class="sub-desc">The found child or null if none was found</div></li>
  729. </ul>
  730. </div>
  731. </div>
  732. </div>
  733. </td>
  734. <td class="msource"><a ext:cls="Ext.data.Node" ext:member="#findChild" href="output/Ext.data.Node.html#findChild">Node</a></td>
  735. </tr>
  736. <tr class="method-row inherited expandable">
  737. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  738. <td class="sig">
  739. <a id="Ext.tree.TreeNode-findChildBy"></a>
  740. <b>findChildBy</b>(&nbsp;<code>Function fn</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>&nbsp;) : Node <div class="mdesc">
  741. <div class="short">Finds the first child by a custom function. The child matches if the function passed
  742. returns true.</div>
  743. <div class="long">
  744. Finds the first child by a custom function. The child matches if the function passed
  745. returns true. <div class="mdetail-params">
  746. <strong>Parameters:</strong>
  747. <ul><li><code>fn</code> : Function<div class="sub-desc"></div></li><li><code>scope</code> : Object<div class="sub-desc">(optional)</div></li> </ul>
  748. <strong>Returns:</strong>
  749. <ul>
  750. <li><code>Node</code><div class="sub-desc">The found child or null if none was found</div></li>
  751. </ul>
  752. </div>
  753. </div>
  754. </div>
  755. </td>
  756. <td class="msource"><a ext:cls="Ext.data.Node" ext:member="#findChildBy" href="output/Ext.data.Node.html#findChildBy">Node</a></td>
  757. </tr>
  758. <tr class="method-row inherited alt expandable">
  759. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  760. <td class="sig">
  761. <a id="Ext.tree.TreeNode-fireEvent"></a>
  762. <b>fireEvent</b>(&nbsp;<code>String eventName</code>, <code>Object... args</code>&nbsp;) : Boolean <div class="mdesc">
  763. <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
  764. <div class="long">
  765. Fires the specified event with the passed parameters (minus the event name). <div class="mdetail-params">
  766. <strong>Parameters:</strong>
  767. <ul><li><code>eventName</code> : String<div class="sub-desc"></div></li><li><code>args</code> : Object...<div class="sub-desc">Variable number of parameters are passed to handlers</div></li> </ul>
  768. <strong>Returns:</strong>
  769. <ul>
  770. <li><code>Boolean</code><div class="sub-desc">returns false if any of the handlers return false otherwise it returns true</div></li>
  771. </ul>
  772. </div>
  773. </div>
  774. </div>
  775. </td>
  776. <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#fireEvent" href="output/Ext.util.Observable.html#fireEvent">Observable</a></td>
  777. </tr>
  778. <tr class="method-row inherited expandable">
  779. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  780. <td class="sig">
  781. <a id="Ext.tree.TreeNode-getDepth"></a>
  782. <b>getDepth</b>() : Number <div class="mdesc">
  783. <div class="short">Returns depth of this node (the root node has a depth of 0)</div>
  784. <div class="long">
  785. Returns depth of this node (the root node has a depth of 0) <div class="mdetail-params">
  786. <strong>Parameters:</strong>
  787. <ul><li>None.</li> </ul>
  788. <strong>Returns:</strong>
  789. <ul>
  790. <li><code>Number</code></li>
  791. </ul>
  792. </div>
  793. </div>
  794. </div>
  795. </td>
  796. <td class="msource"><a ext:cls="Ext.data.Node" ext:member="#getDepth" href="output/Ext.data.Node.html#getDepth">Node</a></td>
  797. </tr>
  798. <tr class="method-row inherited alt expandable">
  799. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  800. <td class="sig">
  801. <a id="Ext.tree.TreeNode-getOwnerTree"></a>
  802. <b>getOwnerTree</b>() : Tree <div class="mdesc">
  803. <div class="short">Returns the tree this node is in.</div>
  804. <div class="long">
  805. Returns the tree this node is in. <div class="mdetail-params">
  806. <strong>Parameters:</strong>
  807. <ul><li>None.</li> </ul>
  808. <strong>Returns:</strong>
  809. <ul>
  810. <li><code>Tree</code></li>
  811. </ul>
  812. </div>
  813. </div>
  814. </div>
  815. </td>
  816. <td class="msource"><a ext:cls="Ext.data.Node" ext:member="#getOwnerTree" href="output/Ext.data.Node.html#getOwnerTree">Node</a></td>
  817. </tr>
  818. <tr class="method-row inherited expandable">
  819. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  820. <td class="sig">
  821. <a id="Ext.tree.TreeNode-getPath"></a>
  822. <b>getPath</b>(&nbsp;<span class="optional" title="Optional">[<code>String attr</code>]</span>&nbsp;) : String <div class="mdesc">
  823. <div class="short">Returns the path for this node. The path can be used to expand or select this node programmatically.</div>
  824. <div class="long">
  825. Returns the path for this node. The path can be used to expand or select this node programmatically. <div class="mdetail-params">
  826. <strong>Parameters:</strong>
  827. <ul><li><code>attr</code> : String<div class="sub-desc">(optional) The attr to use for the path (defaults to the node's id)</div></li> </ul>
  828. <strong>Returns:</strong>
  829. <ul>
  830. <li><code>String</code><div class="sub-desc">The path</div></li>
  831. </ul>
  832. </div>
  833. </div>
  834. </div>
  835. </td>
  836. <td class="msource"><a ext:cls="Ext.data.Node" ext:member="#getPath" href="output/Ext.data.Node.html#getPath">Node</a></td>
  837. </tr>
  838. <tr class="method-row alt expandable">
  839. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  840. <td class="sig">
  841. <a id="Ext.tree.TreeNode-getUI"></a>
  842. <b>getUI</b>() : TreeNodeUI <div class="mdesc">
  843. <div class="short">Returns the UI object for this node.</div>
  844. <div class="long">
  845. Returns the UI object for this node. <div class="mdetail-params">
  846. <strong>Parameters:</strong>
  847. <ul><li>None.</li> </ul>
  848. <strong>Returns:</strong>
  849. <ul>
  850. <li><code>TreeNodeUI</code><div class="sub-desc">The object which is providing the user interface for this tree node. Unless otherwise specified in the {@link #uiProvider}, this will be an instance of {@link Ext.tree.TreeNodeUI}</div></li>
  851. </ul>
  852. </div>
  853. </div>
  854. </div>
  855. </td>
  856. <td class="msource">TreeNode</td>
  857. </tr>
  858. <tr class="method-row inherited expandable">
  859. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  860. <td class="sig">
  861. <a id="Ext.tree.TreeNode-hasListener"></a>
  862. <b>hasListener</b>(&nbsp;<code>String eventName</code>&nbsp;) : Boolean <div class="mdesc">
  863. <div class="short">Checks to see if this object has any listeners for a specified event</div>
  864. <div class="long">
  865. Checks to see if this object has any listeners for a specified event <div class="mdetail-params">
  866. <strong>Parameters:</strong>
  867. <ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to check for</div></li> </ul>
  868. <strong>Returns:</strong>
  869. <ul>
  870. <li><code>Boolean</code><div class="sub-desc">True if the event is being listened for, else false</div></li>
  871. </ul>
  872. </div>
  873. </div>
  874. </div>
  875. </td>
  876. <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#hasListener" href="output/Ext.util.Observable.html#hasListener">Observable</a></td>
  877. </tr>
  878. <tr class="method-row inherited alt expandable">
  879. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  880. <td class="sig">
  881. <a id="Ext.tree.TreeNode-indexOf"></a>
  882. <b>indexOf</b>(&nbsp;<code>Node node</code>&nbsp;) : Number <div class="mdesc">
  883. <div class="short">Returns the index of a child node</div>
  884. <div class="long">
  885. Returns the index of a child node <div class="mdetail-params">
  886. <strong>Parameters:</strong>
  887. <ul><li><code>node</code> : Node<div class="sub-desc"></div></li> </ul>
  888. <strong>Returns:</strong>
  889. <ul>
  890. <li><code>Number</code><div class="sub-desc">The index of the node or -1 if it was not found</div></li>
  891. </ul>
  892. </div>
  893. </div>
  894. </div>
  895. </td>
  896. <td class="msource"><a ext:cls="Ext.data.Node" ext:member="#indexOf" href="output/Ext.data.Node.html#indexOf">Node</a></td>
  897. </tr>
  898. <tr class="method-row inherited expandable">
  899. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  900. <td class="sig">
  901. <a id="Ext.tree.TreeNode-insertBefore"></a>
  902. <b>insertBefore</b>(&nbsp;<code>Node node</code>, <code>Node refNode</code>&nbsp;) : Node <div class="mdesc">
  903. <div class="short">Inserts the first node before the second node in this nodes childNodes collection.</div>
  904. <div class="long">
  905. Inserts the first node before the second node in this nodes childNodes collection. <div class="mdetail-params">
  906. <strong>Parameters:</strong>
  907. <ul><li><code>node</code> : Node<div class="sub-desc">The node to insert</div></li><li><code>refNode</code> : Node<div class="sub-desc">The node to insert before (if null the node is appended)</div></li> </ul>
  908. <strong>Returns:</strong>
  909. <ul>
  910. <li><code>Node</code><div class="sub-desc">The inserted node</div></li>
  911. </ul>
  912. </div>
  913. </div>
  914. </div>
  915. </td>
  916. <td class="msource"><a ext:cls="Ext.data.Node" ext:member="#insertBefore" href="output/Ext.data.Node.html#insertBefore">Node</a></td>
  917. </tr>
  918. <tr class="method-row inherited alt expandable">
  919. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  920. <td class="sig">
  921. <a id="Ext.tree.TreeNode-isAncestor"></a>
  922. <b>isAncestor</b>(&nbsp;<code>Node node</code>&nbsp;) : Boolean <div class="mdesc">
  923. <div class="short">Returns true if the passed node is an ancestor (at any point) of this node.</div>
  924. <div class="long">
  925. Returns true if the passed node is an ancestor (at any point) of this node. <div class="mdetail-params">
  926. <strong>Parameters:</strong>
  927. <ul><li><code>node</code> : Node<div class="sub-desc"></div></li> </ul>
  928. <strong>Returns:</strong>
  929. <ul>
  930. <li><code>Boolean</code></li>
  931. </ul>
  932. </div>
  933. </div>
  934. </div>
  935. </td>
  936. <td class="msource"><a ext:cls="Ext.data.Node" ext:member="#isAncestor" href="output/Ext.data.Node.html#isAncestor">Node</a></td>
  937. </tr>
  938. <tr class="method-row expandable">
  939. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  940. <td class="sig">
  941. <a id="Ext.tree.TreeNode-isExpanded"></a>
  942. <b>isExpanded</b>() : Boolean <div class="mdesc">
  943. <div class="short">Returns true if this node is expanded</div>
  944. <div class="long">
  945. Returns true if this node is expanded <div class="mdetail-params">
  946. <strong>Parameters:</strong>
  947. <ul><li>None.</li> </ul>
  948. <strong>Returns:</strong>
  949. <ul>
  950. <li><code>Boolean</code></li>
  951. </ul>
  952. </div>
  953. </div>
  954. </div>
  955. </td>
  956. <td class="msource">TreeNode</td>
  957. </tr>
  958. <tr class="method-row inherited alt expandable">
  959. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  960. <td class="sig">
  961. <a id="Ext.tree.TreeNode-isFirst"></a>
  962. <b>isFirst</b>() : Boolean <div class="mdesc">
  963. <div class="short">Returns true if this node is the first child of its parent</div>
  964. <div class="long">
  965. Returns true if this node is the first child of its parent <div class="mdetail-params">
  966. <strong>Parameters:</strong>
  967. <ul><li>None.</li> </ul>
  968. <strong>Returns:</strong>
  969. <ul>
  970. <li><code>Boolean</code></li>
  971. </ul>
  972. </div>
  973. </div>
  974. </div>
  975. </td>
  976. <td class="msource"><a ext:cls="Ext.data.Node" ext:member="#isFirst" href="output/Ext.data.Node.html#isFirst">Node</a></td>
  977. </tr>
  978. <tr class="method-row inherited expandable">
  979. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  980. <td class="sig">
  981. <a id="Ext.tree.TreeNode-isLast"></a>
  982. <b>isLast</b>() : Boolean <div class="mdesc">
  983. <div class="short">Returns true if this node is the last child of its parent</div>
  984. <div class="long">
  985. Returns true if this node is the last child of its parent <div class="mdetail-params">
  986. <strong>Parameters:</strong>
  987. <ul><li>None.</li> </ul>
  988. <strong>Returns:</strong>
  989. <ul>
  990. <li><code>Boolean</code></li>
  991. </ul>
  992. </div>
  993. </div>
  994. </div>
  995. </td>
  996. <td class="msource"><a ext:cls="Ext.data.Node" ext:member="#isLast" href="output/Ext.data.Node.html#isLast">Node</a></td>
  997. </tr>
  998. <tr class="method-row inherited alt expandable">
  999. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  1000. <td class="sig">
  1001. <a id="Ext.tree.TreeNode-isLeaf"></a>
  1002. <b>isLeaf</b>() : Boolean <div class="mdesc">
  1003. <div class="short">Returns true if this node is a leaf</div>
  1004. <div class="long">
  1005. Returns true if this node is a leaf <div class="mdetail-params">
  1006. <strong>Parameters:</strong>
  1007. <ul><li>None.</li> </ul>
  1008. <strong>Returns:</strong>
  1009. <ul>
  1010. <li><code>Boolean</code></li>
  1011. </ul>
  1012. </div>
  1013. </div>
  1014. </div>
  1015. </td>
  1016. <td class="msource"><a ext:cls="Ext.data.Node" ext:member="#isLeaf" href="output/Ext.data.Node.html#isLeaf">Node</a></td>
  1017. </tr>
  1018. <tr class="method-row expandable">
  1019. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  1020. <td class="sig">
  1021. <a id="Ext.tree.TreeNode-isSelected"></a>
  1022. <b>isSelected</b>() : Boolean <div class="mdesc">
  1023. <div class="short">Returns true if this node is selected</div>
  1024. <div class="long">
  1025. Returns true if this node is selected <div class="mdetail-params">
  1026. <strong>Parameters:</strong>
  1027. <ul><li>None.</li> </ul>
  1028. <strong>Returns:</strong>
  1029. <ul>
  1030. <li><code>Boolean</code></li>
  1031. </ul>
  1032. </div>
  1033. </div>
  1034. </div>
  1035. </td>
  1036. <td class="msource">TreeNode</td>
  1037. </tr>
  1038. <tr class="method-row inherited alt expandable">
  1039. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  1040. <td class="sig">
  1041. <a id="Ext.tree.TreeNode-item"></a>
  1042. <b>item</b>(&nbsp;<code>Number index</code>&nbsp;) : Node <div class="mdesc">
  1043. <div class="short">Returns the child node at the specified index.</div>
  1044. <div class="long">
  1045. Returns the child node at the specified index. <div class="mdetail-params">
  1046. <strong>Parameters:</strong>
  1047. <ul><li><code>index</code> : Number<div class="sub-desc"></div></li> </ul>
  1048. <strong>Returns:</strong>
  1049. <ul>
  1050. <li><code>Node</code></li>
  1051. </ul>
  1052. </div>
  1053. </div>
  1054. </div>
  1055. </td>
  1056. <td class="msource"><a ext:cls="Ext.data.Node" ext:member="#item" href="output/Ext.data.Node.html#item">Node</a></td>
  1057. </tr>
  1058. <tr class="method-row inherited expandable">
  1059. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  1060. <td class="sig">
  1061. <a id="Ext.tree.TreeNode-on"></a>
  1062. <b>on</b>(&nbsp;<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>Object options</code>]</span>&nbsp;) : void <div class="mdesc">
  1063. <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
  1064. <div class="long">
  1065. Appends an event handler to this element (shorthand for addListener) <div class="mdetail-params">
  1066. <strong>Parameters:</strong>
  1067. <ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The method the event invokes</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope in which to execute the handler
  1068. function. The handler function's "this" context.</div></li><li><code>options</code> : Object<div class="sub-desc">(optional)</div></li> </ul>
  1069. <strong>Returns:</strong>
  1070. <ul>
  1071. <li><code>void</code></li>
  1072. </ul>
  1073. </div>
  1074. </div>
  1075. </div>
  1076. </td>
  1077. <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#on" href="output/Ext.util.Observable.html#on">Observable</a></td>
  1078. </tr>
  1079. <tr class="method-row inherited alt expandable">
  1080. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  1081. <td class="sig">
  1082. <a id="Ext.tree.TreeNode-purgeListeners"></a>
  1083. <b>purgeListeners</b>() : void <div class="mdesc">
  1084. <div class="short">Removes all listeners for this object</div>
  1085. <div class="long">
  1086. Removes all listeners for this object <div class="mdetail-params">
  1087. <strong>Parameters:</strong>
  1088. <ul><li>None.</li> </ul>
  1089. <strong>Returns:</strong>
  1090. <ul>
  1091. <li><code>void</code></li>
  1092. </ul>
  1093. </div>
  1094. </div>
  1095. </div>
  1096. </td>
  1097. <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#purgeListeners" href="output/Ext.util.Observable.html#purgeListeners">Observable</a></td>
  1098. </tr>
  1099. <tr class="method-row inherited expandable">
  1100. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  1101. <td class="sig">
  1102. <a id="Ext.tree.TreeNode-remove"></a>
  1103. <b>remove</b>() : Node <div class="mdesc">
  1104. <div class="short">Removes this node from it's parent</div>
  1105. <div class="long">
  1106. Removes this node from it's parent <div class="mdetail-params">
  1107. <strong>Parameters:</strong>
  1108. <ul><li>None.</li> </ul>
  1109. <strong>Returns:</strong>
  1110. <ul>
  1111. <li><code>Node</code><div class="sub-desc">this</div></li>
  1112. </ul>
  1113. </div>
  1114. </div>
  1115. </div>
  1116. </td>
  1117. <td class="msource"><a ext:cls="Ext.data.Node" ext:member="#remove" href="output/Ext.data.Node.html#remove">Node</a></td>
  1118. </tr>
  1119. <tr class="method-row inherited alt expandable">
  1120. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  1121. <td class="sig">
  1122. <a id="Ext.tree.TreeNode-removeChild"></a>
  1123. <b>removeChild</b>(&nbsp;<code>Node node</code>&nbsp;) : Node <div class="mdesc">
  1124. <div class="short">Removes a child node from this node.</div>
  1125. <div class="long">
  1126. Removes a child node from this node. <div class="mdetail-params">
  1127. <strong>Parameters:</strong>
  1128. <ul><li><code>node</code> : Node<div class="sub-desc">The node to remove</div></li> </ul>
  1129. <strong>Returns:</strong>
  1130. <ul>
  1131. <li><code>Node</code><div class="sub-desc">The removed node</div></li>
  1132. </ul>
  1133. </div>
  1134. </div>
  1135. </div>
  1136. </td>
  1137. <td class="msource"><a ext:cls="Ext.data.Node" ext:member="#removeChild" href="output/Ext.data.Node.html#removeChild">Node</a></td>
  1138. </tr>
  1139. <tr class="method-row inherited expandable">
  1140. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  1141. <td class="sig">
  1142. <a id="Ext.tree.TreeNode-removeListener"></a>
  1143. <b>removeListener</b>(&nbsp;<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>&nbsp;) : void <div class="mdesc">
  1144. <div class="short">Removes a listener</div>
  1145. <div class="long">
  1146. Removes a listener <div class="mdetail-params">
  1147. <strong>Parameters:</strong>
  1148. <ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The handler to remove</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (this object) for the handler</div></li> </ul>
  1149. <strong>Returns:</strong>
  1150. <ul>
  1151. <li><code>void</code></li>
  1152. </ul>
  1153. </div>
  1154. </div>
  1155. </div>
  1156. </td>
  1157. <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#removeListener" href="output/Ext.util.Observable.html#removeListener">Observable</a></td>
  1158. </tr>
  1159. <tr class="method-row inherited alt expandable">
  1160. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  1161. <td class="sig">
  1162. <a id="Ext.tree.TreeNode-replaceChild"></a>
  1163. <b>replaceChild</b>(&nbsp;<code>Node newChild</code>, <code>Node oldChild</code>&nbsp;) : Node <div class="mdesc">
  1164. <div class="short">Replaces one child node in this node with another.</div>
  1165. <div class="long">
  1166. Replaces one child node in this node with another. <div class="mdetail-params">
  1167. <strong>Parameters:</strong>
  1168. <ul><li><code>newChild</code> : Node<div class="sub-desc">The replacement node</div></li><li><code>oldChild</code> : Node<div class="sub-desc">The node to replace</div></li> </ul>
  1169. <strong>Returns:</strong>
  1170. <ul>
  1171. <li><code>Node</code><div class="sub-desc">The replaced node</div></li>
  1172. </ul>
  1173. </div>
  1174. </div>
  1175. </div>
  1176. </td>
  1177. <td class="msource"><a ext:cls="Ext.data.Node" ext:member="#replaceChild" href="output/Ext.data.Node.html#replaceChild">Node</a></td>
  1178. </tr>
  1179. <tr class="method-row inherited expandable">
  1180. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  1181. <td class="sig">
  1182. <a id="Ext.tree.TreeNode-resumeEvents"></a>
  1183. <b>resumeEvents</b>() : void <div class="mdesc">
  1184. <div class="short">Resume firing events. (see <a ext:cls="Ext.util.Observable" ext:member="suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">suspendEvents</a>)</div>
  1185. <div class="long">
  1186. Resume firing events. (see <a ext:cls="Ext.util.Observable" ext:member="suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">suspendEvents</a>) <div class="mdetail-params">
  1187. <strong>Parameters:</strong>
  1188. <ul><li>None.</li> </ul>
  1189. <strong>Returns:</strong>
  1190. <ul>
  1191. <li><code>void</code></li>
  1192. </ul>
  1193. </div>
  1194. </div>
  1195. </div>
  1196. </td>
  1197. <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">Observable</a></td>
  1198. </tr>
  1199. <tr class="method-row alt expandable">
  1200. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  1201. <td class="sig">
  1202. <a id="Ext.tree.TreeNode-select"></a>
  1203. <b>select</b>() : void <div class="mdesc">
  1204. <div class="short">Triggers selection of this node</div>
  1205. <div class="long">
  1206. Triggers selection of this node <div class="mdetail-params">
  1207. <strong>Parameters:</strong>
  1208. <ul><li>None.</li> </ul>
  1209. <strong>Returns:</strong>
  1210. <ul>
  1211. <li><code>void</code></li>
  1212. </ul>
  1213. </div>
  1214. </div>
  1215. </div>
  1216. </td>
  1217. <td class="msource">TreeNode</td>
  1218. </tr>
  1219. <tr class="method-row expandable">
  1220. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  1221. <td class="sig">
  1222. <a id="Ext.tree.TreeNode-setText"></a>
  1223. <b>setText</b>(&nbsp;<code>String text</code>&nbsp;) : void <div class="mdesc">
  1224. <div class="short">Sets the text for this node</div>
  1225. <div class="long">
  1226. Sets the text for this node <div class="mdetail-params">
  1227. <strong>Parameters:</strong>
  1228. <ul><li><code>text</code> : String<div class="sub-desc"></div></li> </ul>
  1229. <strong>Returns:</strong>
  1230. <ul>
  1231. <li><code>void</code></li>
  1232. </ul>
  1233. </div>
  1234. </div>
  1235. </div>
  1236. </td>
  1237. <td class="msource">TreeNode</td>
  1238. </tr>
  1239. <tr class="method-row inherited alt expandable">
  1240. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  1241. <td class="sig">
  1242. <a id="Ext.tree.TreeNode-sort"></a>
  1243. <b>sort</b>(&nbsp;<code>Function fn</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>&nbsp;) : void <div class="mdesc">
  1244. <div class="short">Sorts this nodes children using the supplied sort function</div>
  1245. <div class="long">
  1246. Sorts this nodes children using the supplied sort function <div class="mdetail-params">
  1247. <strong>Parameters:</strong>
  1248. <ul><li><code>fn</code> : Function<div class="sub-desc"></div></li><li><code>scope</code> : Object<div class="sub-desc">(optional)</div></li> </ul>
  1249. <strong>Returns:</strong>
  1250. <ul>
  1251. <li><code>void</code></li>
  1252. </ul>
  1253. </div>
  1254. </div>
  1255. </div>
  1256. </td>
  1257. <td class="msource"><a ext:cls="Ext.data.Node" ext:member="#sort" href="output/Ext.data.Node.html#sort">Node</a></td>
  1258. </tr>
  1259. <tr class="method-row inherited expandable">
  1260. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  1261. <td class="sig">
  1262. <a id="Ext.tree.TreeNode-suspendEvents"></a>
  1263. <b>suspendEvents</b>() : void <div class="mdesc">
  1264. <div class="short">Suspend the firing of all events. (see <a ext:cls="Ext.util.Observable" ext:member="resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">resumeEvents</a>)</div>
  1265. <div class="long">
  1266. Suspend the firing of all events. (see <a ext:cls="Ext.util.Observable" ext:member="resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">resumeEvents</a>) <div class="mdetail-params">
  1267. <strong>Parameters:</strong>
  1268. <ul><li>None.</li> </ul>
  1269. <strong>Returns:</strong>
  1270. <ul>
  1271. <li><code>void</code></li>
  1272. </ul>
  1273. </div>
  1274. </div>
  1275. </div>
  1276. </td>
  1277. <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">Observable</a></td>
  1278. </tr>
  1279. <tr class="method-row alt expandable">
  1280. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  1281. <td class="sig">
  1282. <a id="Ext.tree.TreeNode-toggle"></a>
  1283. <b>toggle</b>() : void <div class="mdesc">
  1284. <div class="short">Toggles expanded/collapsed state of the node</div>
  1285. <div class="long">
  1286. Toggles expanded/collapsed state of the node <div class="mdetail-params">
  1287. <strong>Parameters:</strong>
  1288. <ul><li>None.</li> </ul>
  1289. <strong>Returns:</strong>
  1290. <ul>
  1291. <li><code>void</code></li>
  1292. </ul>
  1293. </div>
  1294. </div>
  1295. </div>
  1296. </td>
  1297. <td class="msource">TreeNode</td>
  1298. </tr>
  1299. <tr class="method-row inherited expandable">
  1300. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  1301. <td class="sig">
  1302. <a id="Ext.tree.TreeNode-un"></a>
  1303. <b>un</b>(&nbsp;<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>&nbsp;) : void <div class="mdesc">
  1304. <div class="short">Removes a listener (shorthand for removeListener)</div>
  1305. <div class="long">
  1306. Removes a listener (shorthand for removeListener) <div class="mdetail-params">
  1307. <strong>Parameters:</strong>
  1308. <ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The handler to remove</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (this object) for the handler</div></li> </ul>
  1309. <strong>Returns:</strong>
  1310. <ul>
  1311. <li><code>void</code></li>
  1312. </ul>
  1313. </div>
  1314. </div>
  1315. </div>
  1316. </td>
  1317. <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#un" href="output/Ext.util.Observable.html#un">Observable</a></td>
  1318. </tr>
  1319. <tr class="method-row alt expandable">
  1320. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  1321. <td class="sig">
  1322. <a id="Ext.tree.TreeNode-unselect"></a>
  1323. <b>unselect</b>() : void <div class="mdesc">
  1324. <div class="short">Triggers deselection of this node</div>
  1325. <div class="long">
  1326. Triggers deselection of this node <div class="mdetail-params">
  1327. <strong>Parameters:</strong>
  1328. <ul><li>None.</li> </ul>
  1329. <strong>Returns:</strong>
  1330. <ul>
  1331. <li><code>void</code></li>
  1332. </ul>
  1333. </div>
  1334. </div>
  1335. </div>
  1336. </td>
  1337. <td class="msource">TreeNode</td>
  1338. </tr>
  1339. </table>
  1340. <a id="Ext.tree.TreeNode-events"></a>
  1341. <h2>Public Events</h2>
  1342. <table cellspacing="0" class="member-table">
  1343. <tr>
  1344. <th class="sig-header" colspan="2">Event</th>
  1345. <th class="msource-header">Defined By</th>
  1346. </tr>
  1347. <tr class="event-row inherited expandable">
  1348. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  1349. <td class="sig">
  1350. <a id="Ext.tree.TreeNode-append"></a>
  1351. <b>append</b> : (&nbsp;<code>Tree tree</code>, <code>Node this</code>, <code>Node node</code>, <code>Number index</code>&nbsp;) <div class="mdesc">
  1352. <div class="short">Fires when a new child node is appended</div>
  1353. <div class="long">
  1354. Fires when a new child node is appended <div class="mdetail-params">
  1355. <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
  1356. <ul><li><code>tree</code> : Tree<div class="sub-desc">The owner tree</div></li><li><code>this</code> : Node<div class="sub-desc">This node</div></li><li><code>node</code> : Node<div class="sub-desc">The newly appended node</div></li><li><code>index</code> : Number<div class="sub-desc">The index of the newly appended node</div></li> </ul>
  1357. </div>
  1358. </div>
  1359. </div>
  1360. </td>
  1361. <td class="msource"><a ext:cls="Ext.data.Node" ext:member="#event-append" href="output/Ext.data.Node.html#event-append">Node</a></td>
  1362. </tr>
  1363. <tr class="event-row inherited alt expandable">
  1364. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  1365. <td class="sig">
  1366. <a id="Ext.tree.TreeNode-beforeappend"></a>
  1367. <b>beforeappend</b> : (&nbsp;<code>Tree tree</code>, <code>Node this</code>, <code>Node node</code>&nbsp;) <div class="mdesc">
  1368. <div class="short">Fires before a new child is appended, return false to cancel the append.</div>
  1369. <div class="long">
  1370. Fires before a new child is appended, return false to cancel the append. <div class="mdetail-params">
  1371. <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
  1372. <ul><li><code>tree</code> : Tree<div class="sub-desc">The owner tree</div></li><li><code>this</code> : Node<div class="sub-desc">This node</div></li><li><code>node</code> : Node<div class="sub-desc">The child node to be appended</div></li> </ul>
  1373. </div>
  1374. </div>
  1375. </div>
  1376. </td>
  1377. <td class="msource"><a ext:cls="Ext.data.Node" ext:member="#event-beforeappend" href="output/Ext.data.Node.html#event-beforeappend">Node</a></td>
  1378. </tr>
  1379. <tr class="event-row expandable">
  1380. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  1381. <td class="sig">
  1382. <a id="Ext.tree.TreeNode-beforechildrenrendered"></a>
  1383. <b>beforechildrenrendered</b> : (&nbsp;<code>Node this</code>&nbsp;) <div class="mdesc">
  1384. <div class="short">Fires right before the child nodes for this node are rendered</div>
  1385. <div class="long">
  1386. Fires right before the child nodes for this node are rendered <div class="mdetail-params">
  1387. <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
  1388. <ul><li><code>this</code> : Node<div class="sub-desc">This node</div></li> </ul>
  1389. </div>
  1390. </div>
  1391. </div>
  1392. </td>
  1393. <td class="msource">TreeNode</td>
  1394. </tr>
  1395. <tr class="event-row alt expandable">
  1396. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  1397. <td class="sig">
  1398. <a id="Ext.tree.TreeNode-beforeclick"></a>
  1399. <b>beforeclick</b> : (&nbsp;<code>Node this</code>, <code>Ext.EventObject e</code>&nbsp;) <div class="mdesc">
  1400. <div class="short">Fires before click processing. Return false to cancel the default action.</div>
  1401. <div class="long">
  1402. Fires before click processing. Return false to cancel the default action. <div class="mdetail-params">
  1403. <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
  1404. <ul><li><code>this</code> : Node<div class="sub-desc">This node</div></li><li><code>e</code> : Ext.EventObject<div class="sub-desc">The event object</div></li> </ul>
  1405. </div>
  1406. </div>
  1407. </div>
  1408. </td>
  1409. <td class="msource">TreeNode</td>
  1410. </tr>
  1411. <tr class="event-row expandable">
  1412. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  1413. <td class="sig">
  1414. <a id="Ext.tree.TreeNode-beforecollapse"></a>
  1415. <b>beforecollapse</b> : (&nbsp;<code>Node this</code>, <code>Boolean deep</code>, <code>Boolean anim</code>&nbsp;) <div class="mdesc">
  1416. <div class="short">Fires before this node is collapsed, return false to cancel.</div>
  1417. <div class="long">
  1418. Fires before this node is collapsed, return false to cancel. <div class="mdetail-params">
  1419. <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
  1420. <ul><li><code>this</code> : Node<div class="sub-desc">This node</div></li><li><code>deep</code> : Boolean<div class="sub-desc"></div></li><li><code>anim</code> : Boolean<div class="sub-desc"></div></li> </ul>
  1421. </div>
  1422. </div>
  1423. </div>
  1424. </td>
  1425. <td class="msource">TreeNode</td>
  1426. </tr>
  1427. <tr class="event-row alt expandable">
  1428. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  1429. <td class="sig">
  1430. <a id="Ext.tree.TreeNode-beforeexpand"></a>
  1431. <b>beforeexpand</b> : (&nbsp;<code>Node this</code>, <code>Boolean deep</code>, <code>Boolean anim</code>&nbsp;) <div class="mdesc">
  1432. <div class="short">Fires before this node is expanded, return false to cancel.</div>
  1433. <div class="long">
  1434. Fires before this node is expanded, return false to cancel. <div class="mdetail-params">
  1435. <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
  1436. <ul><li><code>this</code> : Node<div class="sub-desc">This node</div></li><li><code>deep</code> : Boolean<div class="sub-desc"></div></li><li><code>anim</code> : Boolean<div class="sub-desc"></div></li> </ul>
  1437. </div>
  1438. </div>
  1439. </div>
  1440. </td>
  1441. <td class="msource">TreeNode</td>
  1442. </tr>
  1443. <tr class="event-row inherited expandable">
  1444. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  1445. <td class="sig">
  1446. <a id="Ext.tree.TreeNode-beforeinsert"></a>
  1447. <b>beforeinsert</b> : (&nbsp;<code>Tree tree</code>, <code>Node this</code>, <code>Node node</code>, <code>Node refNode</code>&nbsp;) <div class="mdesc">
  1448. <div class="short">Fires before a new child is inserted, return false to cancel the insert.</div>
  1449. <div class="long">
  1450. Fires before a new child is inserted, return false to cancel the insert. <div class="mdetail-params">
  1451. <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
  1452. <ul><li><code>tree</code> : Tree<div class="sub-desc">The owner tree</div></li><li><code>this</code> : Node<div class="sub-desc">This node</div></li><li><code>node</code> : Node<div class="sub-desc">The child node to be inserted</div></li><li><code>refNode</code> : Node<div class="sub-desc">The child node the node is being inserted before</div></li> </ul>
  1453. </div>
  1454. </div>
  1455. </div>
  1456. </td>
  1457. <td class="msource"><a ext:cls="Ext.data.Node" ext:member="#event-beforeinsert" href="output/Ext.data.Node.html#event-beforeinsert">Node</a></td>
  1458. </tr>
  1459. <tr class="event-row inherited alt expandable">
  1460. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  1461. <td class="sig">
  1462. <a id="Ext.tree.TreeNode-beforemove"></a>
  1463. <b>beforemove</b> : (&nbsp;<code>Tree tree</code>, <code>Node this</code>, <code>Node oldParent</code>, <code>Node newParent</code>, <code>Number index</code>&nbsp;) <div class="mdesc">
  1464. <div class="short">Fires before this node is moved to a new location in the tree. Return false to cancel the move.</div>
  1465. <div class="long">
  1466. Fires before this node is moved to a new location in the tree. Return false to cancel the move. <div class="mdetail-params">
  1467. <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
  1468. <ul><li><code>tree</code> : Tree<div class="sub-desc">The owner tree</div></li><li><code>this</code> : Node<div class="sub-desc">This node</div></li><li><code>oldParent</code> : Node<div class="sub-desc">The parent of this node</div></li><li><code>newParent</code> : Node<div class="sub-desc">The new parent this node is moving to</div></li><li><code>index</code> : Number<div class="sub-desc">The index it is being moved to</div></li> </ul>
  1469. </div>
  1470. </div>
  1471. </div>
  1472. </td>
  1473. <td class="msource"><a ext:cls="Ext.data.Node" ext:member="#event-beforemove" href="output/Ext.data.Node.html#event-beforemove">Node</a></td>
  1474. </tr>
  1475. <tr class="event-row inherited expandable">
  1476. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  1477. <td class="sig">
  1478. <a id="Ext.tree.TreeNode-beforeremove"></a>
  1479. <b>beforeremove</b> : (&nbsp;<code>Tree tree</code>, <code>Node this</code>, <code>Node node</code>&nbsp;) <div class="mdesc">
  1480. <div class="short">Fires before a child is removed, return false to cancel the remove.</div>
  1481. <div class="long">
  1482. Fires before a child is removed, return false to cancel the remove. <div class="mdetail-params">
  1483. <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
  1484. <ul><li><code>tree</code> : Tree<div class="sub-desc">The owner tree</div></li><li><code>this</code> : Node<div class="sub-desc">This node</div></li><li><code>node</code> : Node<div class="sub-desc">The child node to be removed</div></li> </ul>
  1485. </div>
  1486. </div>
  1487. </div>
  1488. </td>
  1489. <td class="msource"><a ext:cls="Ext.data.Node" ext:member="#event-beforeremove" href="output/Ext.data.Node.html#event-beforeremove">Node</a></td>
  1490. </tr>
  1491. <tr class="event-row alt expandable">
  1492. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  1493. <td class="sig">
  1494. <a id="Ext.tree.TreeNode-checkchange"></a>
  1495. <b>checkchange</b> : (&nbsp;<code>Node this</code>, <code>Boolean checked</code>&nbsp;) <div class="mdesc">
  1496. <div class="short">Fires when a node with a checkbox's checked property changes</div>
  1497. <div class="long">
  1498. Fires when a node with a checkbox's checked property changes <div class="mdetail-params">
  1499. <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
  1500. <ul><li><code>this</code> : Node<div class="sub-desc">This node</div></li><li><code>checked</code> : Boolean<div class="sub-desc"></div></li> </ul>
  1501. </div>
  1502. </div>
  1503. </div>
  1504. </td>
  1505. <td class="msource">TreeNode</td>
  1506. </tr>
  1507. <tr class="event-row expandable">
  1508. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  1509. <td class="sig">
  1510. <a id="Ext.tree.TreeNode-click"></a>
  1511. <b>click</b> : (&nbsp;<code>Node this</code>, <code>Ext.EventObject e</code>&nbsp;) <div class="mdesc">
  1512. <div class="short">Fires when this node is clicked</div>
  1513. <div class="long">
  1514. Fires when this node is clicked <div class="mdetail-params">
  1515. <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
  1516. <ul><li><code>this</code> : Node<div class="sub-desc">This node</div></li><li><code>e</code> : Ext.EventObject<div class="sub-desc">The event object</div></li> </ul>
  1517. </div>
  1518. </div>
  1519. </div>
  1520. </td>
  1521. <td class="msource">TreeNode</td>
  1522. </tr>
  1523. <tr class="event-row alt expandable">
  1524. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  1525. <td class="sig">
  1526. <a id="Ext.tree.TreeNode-collapse"></a>
  1527. <b>collapse</b> : (&nbsp;<code>Node this</code>&nbsp;) <div class="mdesc">
  1528. <div class="short">Fires when this node is collapsed</div>
  1529. <div class="long">
  1530. Fires when this node is collapsed <div class="mdetail-params">
  1531. <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
  1532. <ul><li><code>this</code> : Node<div class="sub-desc">This node</div></li> </ul>
  1533. </div>
  1534. </div>
  1535. </div>
  1536. </td>
  1537. <td class="msource">TreeNode</td>
  1538. </tr>
  1539. <tr class="event-row expandable">
  1540. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  1541. <td class="sig">
  1542. <a id="Ext.tree.TreeNode-contextmenu"></a>
  1543. <b>contextmenu</b> : (&nbsp;<code>Node this</code>, <code>Ext.EventObject e</code>&nbsp;) <div class="mdesc">
  1544. <div class="short">Fires when this node is right clicked</div>
  1545. <div class="long">
  1546. Fires when this node is right clicked <div class="mdetail-params">
  1547. <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
  1548. <ul><li><code>this</code> : Node<div class="sub-desc">This node</div></li><li><code>e</code> : Ext.EventObject<div class="sub-desc">The event object</div></li> </ul>
  1549. </div>
  1550. </div>
  1551. </div>
  1552. </td>
  1553. <td class="msource">TreeNode</td>
  1554. </tr>
  1555. <tr class="event-row alt expandable">
  1556. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  1557. <td class="sig">
  1558. <a id="Ext.tree.TreeNode-dblclick"></a>
  1559. <b>dblclick</b> : (&nbsp;<code>Node this</code>, <code>Ext.EventObject e</code>&nbsp;) <div class="mdesc">
  1560. <div class="short">Fires when this node is double clicked</div>
  1561. <div class="long">
  1562. Fires when this node is double clicked <div class="mdetail-params">
  1563. <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
  1564. <ul><li><code>this</code> : Node<div class="sub-desc">This node</div></li><li><code>e</code> : Ext.EventObject<div class="sub-desc">The event object</div></li> </ul>
  1565. </div>
  1566. </div>
  1567. </div>
  1568. </td>
  1569. <td class="msource">TreeNode</td>
  1570. </tr>
  1571. <tr class="event-row expandable">
  1572. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  1573. <td class="sig">
  1574. <a id="Ext.tree.TreeNode-disabledchange"></a>
  1575. <b>disabledchange</b> : (&nbsp;<code>Node this</code>, <code>Boolean disabled</code>&nbsp;) <div class="mdesc">
  1576. <div class="short">Fires when the disabled status of this node changes</div>
  1577. <div class="long">
  1578. Fires when the disabled status of this node changes <div class="mdetail-params">
  1579. <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
  1580. <ul><li><code>this</code> : Node<div class="sub-desc">This node</div></li><li><code>disabled</code> : Boolean<div class="sub-desc"></div></li> </ul>
  1581. </div>
  1582. </div>
  1583. </div>
  1584. </td>
  1585. <td class="msource">TreeNode</td>
  1586. </tr>
  1587. <tr class="event-row alt expandable">
  1588. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  1589. <td class="sig">
  1590. <a id="Ext.tree.TreeNode-expand"></a>
  1591. <b>expand</b> : (&nbsp;<code>Node this</code>&nbsp;) <div class="mdesc">
  1592. <div class="short">Fires when this node is expanded</div>
  1593. <div class="long">
  1594. Fires when this node is expanded <div class="mdetail-params">
  1595. <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
  1596. <ul><li><code>this</code> : Node<div class="sub-desc">This node</div></li> </ul>
  1597. </div>
  1598. </div>
  1599. </div>
  1600. </td>
  1601. <td class="msource">TreeNode</td>
  1602. </tr>
  1603. <tr class="event-row inherited expandable">
  1604. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  1605. <td class="sig">
  1606. <a id="Ext.tree.TreeNode-insert"></a>
  1607. <b>insert</b> : (&nbsp;<code>Tree tree</code>, <code>Node this</code>, <code>Node node</code>, <code>Node refNode</code>&nbsp;) <div class="mdesc">
  1608. <div class="short">Fires when a new child node is inserted.</div>
  1609. <div class="long">
  1610. Fires when a new child node is inserted. <div class="mdetail-params">
  1611. <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
  1612. <ul><li><code>tree</code> : Tree<div class="sub-desc">The owner tree</div></li><li><code>this</code> : Node<div class="sub-desc">This node</div></li><li><code>node</code> : Node<div class="sub-desc">The child node inserted</div></li><li><code>refNode</code> : Node<div class="sub-desc">The child node the node was inserted before</div></li> </ul>
  1613. </div>
  1614. </div>
  1615. </div>
  1616. </td>
  1617. <td class="msource"><a ext:cls="Ext.data.Node" ext:member="#event-insert" href="output/Ext.data.Node.html#event-insert">Node</a></td>
  1618. </tr>
  1619. <tr class="event-row inherited alt expandable">
  1620. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  1621. <td class="sig">
  1622. <a id="Ext.tree.TreeNode-move"></a>
  1623. <b>move</b> : (&nbsp;<code>Tree tree</code>, <code>Node this</code>, <code>Node oldParent</code>, <code>Node newParent</code>, <code>Number index</code>&nbsp;) <div class="mdesc">
  1624. <div class="short">Fires when this node is moved to a new location in the tree</div>
  1625. <div class="long">
  1626. Fires when this node is moved to a new location in the tree <div class="mdetail-params">
  1627. <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
  1628. <ul><li><code>tree</code> : Tree<div class="sub-desc">The owner tree</div></li><li><code>this</code> : Node<div class="sub-desc">This node</div></li><li><code>oldParent</code> : Node<div class="sub-desc">The old parent of this node</div></li><li><code>newParent</code> : Node<div class="sub-desc">The new parent of this node</div></li><li><code>index</code> : Number<div class="sub-desc">The index it was moved to</div></li> </ul>
  1629. </div>
  1630. </div>
  1631. </div>
  1632. </td>
  1633. <td class="msource"><a ext:cls="Ext.data.Node" ext:member="#event-move" href="output/Ext.data.Node.html#event-move">Node</a></td>
  1634. </tr>
  1635. <tr class="event-row inherited expandable">
  1636. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  1637. <td class="sig">
  1638. <a id="Ext.tree.TreeNode-remove"></a>
  1639. <b>remove</b> : (&nbsp;<code>Tree tree</code>, <code>Node this</code>, <code>Node node</code>&nbsp;) <div class="mdesc">
  1640. <div class="short">Fires when a child node is removed</div>
  1641. <div class="long">
  1642. Fires when a child node is removed <div class="mdetail-params">
  1643. <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
  1644. <ul><li><code>tree</code> : Tree<div class="sub-desc">The owner tree</div></li><li><code>this</code> : Node<div class="sub-desc">This node</div></li><li><code>node</code> : Node<div class="sub-desc">The removed node</div></li> </ul>
  1645. </div>
  1646. </div>
  1647. </div>
  1648. </td>
  1649. <td class="msource"><a ext:cls="Ext.data.Node" ext:member="#event-remove" href="output/Ext.data.Node.html#event-remove">Node</a></td>
  1650. </tr>
  1651. <tr class="event-row alt expandable">
  1652. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  1653. <td class="sig">
  1654. <a id="Ext.tree.TreeNode-textchange"></a>
  1655. <b>textchange</b> : (&nbsp;<code>Node this</code>, <code>String text</code>, <code>String oldText</code>&nbsp;) <div class="mdesc">
  1656. <div class="short">Fires when the text for this node is changed</div>
  1657. <div class="long">
  1658. Fires when the text for this node is changed <div class="mdetail-params">
  1659. <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
  1660. <ul><li><code>this</code> : Node<div class="sub-desc">This node</div></li><li><code>text</code> : String<div class="sub-desc">The new text</div></li><li><code>oldText</code> : String<div class="sub-desc">The old text</div></li> </ul>
  1661. </div>
  1662. </div>
  1663. </div>
  1664. </td>
  1665. <td class="msource">TreeNode</td>
  1666. </tr>
  1667. </table>
  1668. </div>