git.roojs.org Git - roojs1/blob - docs/symbols/Roo.tree.TreeSorter.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2
   3
   4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   5
   6         <head>
   7                 <meta http-equiv="content-type" content="text/html; charset=undefined" />
   8                 <meta name="generator" content="JsDoc Toolkit" />
   9
  10
  11                 <title>JsDoc Reference - Roo.tree.TreeSorter</title>
  12
  13
  14         <link rel="stylesheet" type="text/css" href="../../css/roojs.css" />
  15         <link rel="stylesheet" type="text/css" href="../default.css" />
  16
  17
  18         <script type="text/javascript" src="../page.js">
  19
  20         </script>
  21
  22
  23         </head>
  24
  25         <body onload="RooDocsPage.onload();">
  26
  27
  28 <div class="body-wrap">
  29
  30     <!-- ============================== links to methods. ================================= -->
  31
  32     <div class="top-tools">
  33     <!--
  34         <a class="inner-link" href="#Roo.tree.TreeSorter-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
  35         <a class="inner-link" href="#Roo.tree.TreeSorter-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
  36         <a class="inner-link" href="#Roo.tree.TreeSorter-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
  37         <a class="inner-link" href="#Roo.tree.TreeSorter-configs"><img src="resources/s.gif" class="item-icon icon-config">Config Options</a>
  38         <a class="bookmark" href="NEED_TO_CREATE_DIRECT_LINK_HREF"><img src="resources/s.gif" class="item-icon icon-fav">Direct Link</a>
  39         -->
  40     </div>
  41
  42
  43 <!-- ============================== inheritance Block. ================================= -->
  44
  45 <!-- ============================== class title / details ============================ -->
  46
  47
  48     <h1 class="classTitle">
  49
  50                                 Class Roo.tree.TreeSorter
  51                         </h1>
  52
  53     <table cellspacing="0" class="class-summary-table">
  54
  55                 <tr><td class="label">Package:</td><td class="hd-info">Roo.tree</td></tr>
  56
  57         <tr><td class="label">Defined In:</td><td class="hd-info">
  58
  59                                         <a href="./src/Roo_tree_TreeSorter.js.html">Roo/tree/TreeSorter.js</a>.
  60
  61         </td></tr>
  62         <tr><td class="label">Class:</td><td class="hd-info">TreeSorter</td></tr>
  63
  64
  65
  66
  67     </table>
  68
  69
  70 <!-- ============================== class summary ========================== -->
  71     <div class="description">
  72         Provides sorting of nodes in a TreePanel
  73     </div>
  74
  75
  76 <!-- ============================== Class comment block... ========================== -->
  77
  78 <div class="comments">
  79         <b>Class Comments / Notes</B> =>
  80         <u onclick="parent.CommentDialog.showCommentId = 'Roo.tree.TreeSorter';">[Add Your comment/notes about this class]</u>
  81         <br/>
  82         <iframe frameborder="0"  id="comments-Roo.tree" style="border: none;width:100%;"
  83                 src="/blog.php/GtkDjsComments/Roo.tree.TreeSorter.html"></iframe>
  84 </div>
  85
  86
  87
  88 <!-- ============================== config options ========================== -->
  89
  90
  91
  92
  93     <div class="hr"></div>
  94     <a id="Roo.tree.TreeSorter-configs"></a>
  95
  96
  97
  98
  99
 100       <table cellspacing="0" class="member-table">
 101       <caption>Config Options (Usually are also Properties)</caption>
 102
 103
 104         <tr>
 105             <th class="sig-header" colspan="2">Options</th>
 106
 107             <th class="msource-header">Defined By</th>
 108         </tr>
 109
 110
 111
 112
 113
 114                 <tr class="config-row expandable config-row-alt0 notInherited">
 115                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 116                     <td class="sig">
 117
 118                         <a id="Roo.tree.TreeSorter-cfg-caseSensitive" name=".caseSensitive"></a>
 119                         <div class="fixedFont">
 120                                 <b  class="itemname">caseSensitive</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 121
 122
 123                         </div>
 124
 125                         <div class="mdesc">
 126                             <div class="short">true for case sensitive sort (defaults to false)</div>
 127                         </div>
 128
 129                         <div class="mdesc">
 130                             <div class="long">true for case sensitive sort (defaults to false)</div>
 131                         </div>
 132
 133
 134
 135                     </td>
 136                     <td class="msource">
 137
 138                         Roo.tree.TreeSorter
 139
 140                     </td>
 141                 </tr>
 142
 143
 144                 <tr class="config-row expandable config-row-alt1 notInherited">
 145                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 146                     <td class="sig">
 147
 148                         <a id="Roo.tree.TreeSorter-cfg-dir" name=".dir"></a>
 149                         <div class="fixedFont">
 150                                 <b  class="itemname">dir</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 151
 152
 153                         </div>
 154
 155                         <div class="mdesc">
 156                             <div class="short">The direction to sort (asc or desc) (defaults to asc)</div>
 157                         </div>
 158
 159                         <div class="mdesc">
 160                             <div class="long">The direction to sort (asc or desc) (defaults to asc)</div>
 161                         </div>
 162
 163
 164
 165                     </td>
 166                     <td class="msource">
 167
 168                         Roo.tree.TreeSorter
 169
 170                     </td>
 171                 </tr>
 172
 173
 174                 <tr class="config-row expandable config-row-alt0 notInherited">
 175                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 176                     <td class="sig">
 177
 178                         <a id="Roo.tree.TreeSorter-cfg-folderSort" name=".folderSort"></a>
 179                         <div class="fixedFont">
 180                                 <b  class="itemname">folderSort</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 181
 182
 183                         </div>
 184
 185                         <div class="mdesc">
 186                             <div class="short">True to sort leaf nodes under non leaf nodes</div>
 187                         </div>
 188
 189                         <div class="mdesc">
 190                             <div class="long">True to sort leaf nodes under non leaf nodes</div>
 191                         </div>
 192
 193
 194
 195                     </td>
 196                     <td class="msource">
 197
 198                         Roo.tree.TreeSorter
 199
 200                     </td>
 201                 </tr>
 202
 203
 204                 <tr class="config-row expandable config-row-alt1 notInherited">
 205                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 206                     <td class="sig">
 207
 208                         <a id="Roo.tree.TreeSorter-cfg-leafAttr" name=".leafAttr"></a>
 209                         <div class="fixedFont">
 210                                 <b  class="itemname">leafAttr</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 211
 212
 213                         </div>
 214
 215                         <div class="mdesc">
 216                             <div class="short">The attribute used to determine leaf nodes in folder sort (defaults to "leaf")</div>
 217                         </div>
 218
 219                         <div class="mdesc">
 220                             <div class="long">The attribute used to determine leaf nodes in folder sort (defaults to "leaf")</div>
 221                         </div>
 222
 223
 224
 225                     </td>
 226                     <td class="msource">
 227
 228                         Roo.tree.TreeSorter
 229
 230                     </td>
 231                 </tr>
 232
 233
 234                 <tr class="config-row expandable config-row-alt0 notInherited">
 235                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 236                     <td class="sig">
 237
 238                         <a id="Roo.tree.TreeSorter-cfg-property" name=".property"></a>
 239                         <div class="fixedFont">
 240                                 <b  class="itemname">property</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 241
 242
 243                         </div>
 244
 245                         <div class="mdesc">
 246                             <div class="short">The named attribute on the node to sort by (defaults to text)</div>
 247                         </div>
 248
 249                         <div class="mdesc">
 250                             <div class="long">The named attribute on the node to sort by (defaults to text)</div>
 251                         </div>
 252
 253
 254
 255                     </td>
 256                     <td class="msource">
 257
 258                         Roo.tree.TreeSorter
 259
 260                     </td>
 261                 </tr>
 262
 263
 264                 <tr class="config-row expandable config-row-alt1 notInherited">
 265                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 266                     <td class="sig">
 267
 268                         <a id="Roo.tree.TreeSorter-cfg-sortType" name=".sortType"></a>
 269                         <div class="fixedFont">
 270                                 <b  class="itemname">sortType</b> : <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a>
 271
 272
 273                         </div>
 274
 275                         <div class="mdesc">
 276                             <div class="short">A custom "casting" function used to convert node values before sorting</div>
 277                         </div>
 278
 279                         <div class="mdesc">
 280                             <div class="long">A custom "casting" function used to convert node values before sorting</div>
 281                         </div>
 282
 283
 284
 285                     </td>
 286                     <td class="msource">
 287
 288                         Roo.tree.TreeSorter
 289
 290                     </td>
 291                 </tr>
 292
 293
 294     </table>
 295
 296
 297
 298
 299
 300
 301
 302
 303
 304   <!-- ============================== public properties ==================== -->
 305
 306
 307
 308     <a id="Roo.tree.TreeSorter-props"></a>
 309
 310
 311
 312
 313
 314      <table cellspacing="0" class="member-table">
 315       <caption class="Empty">Public Properties - Has None</caption>
 316      </table>
 317
 318
 319
 320
 321   <!-- ============================== methods summary / details ======================== -->
 322
 323
 324   <a id="Roo.tree.TreeSorter-methods"></a>
 325         <!-- constructor?? -->
 326
 327         <!-- static's first
 328
 329
 330         -->
 331
 332         <!-- then dynamics first -->
 333
 334
 335
 336
 337
 338
 339       <table cellspacing="0" class="member-table">
 340       <caption>Public Methods</caption>
 341         <tr>
 342             <th class="sig-header" colspan="2">Method</th>
 343             <th class="msource-header">Defined By</th>
 344
 345         </tr>
 346
 347
 348
 349
 350
 351
 352
 353           <tr class="method-row config-row-alt0 expandable notInherited">
 354             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 355
 356
 357             <td class="sig">
 358                 <a id="Roo.tree-method-TreeSorter"   name=".TreeSorter"></a>
 359                 <div class="fixedFont">
 360                         <span class="attributes">new <B>Roo.tree.</B></span><b class="itemname">TreeSorter</b>
 361
 362                                  (TreePanel <B><i>tree</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
 363
 364
 365
 366                 </div>
 367                 <div class="mdesc">
 368
 369
 370                         <div class="short">Create a new Roo.tree.TreeSorter</div>
 371
 372
 373                     <div class="long">
 374
 375
 376
 377                                 Create a new Roo.tree.TreeSorter
 378
 379
 380                                 <dl class="detailList">
 381                                 <dt class="heading">Parameters:</dt>
 382
 383                                         <dt>
 384                                                 <span class="fixedFont">TreePanel</span>  <b>tree</b>
 385
 386                                         </dt>
 387                                         <dd></dd>
 388
 389                                         <dt>
 390                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>config</b>
 391
 392                                         </dt>
 393                                         <dd></dd>
 394
 395                                 </dl>
 396
 397
 398
 399
 400
 401
 402
 403
 404
 405
 406
 407                     </div>
 408                 </div>
 409
 410             </td>
 411             <td class="msource">
 412                 &nbsp;
 413             </td>
 414         </tr>
 415
 416
 417     </table>
 418
 419
 420   <!-- ============================== events summary / details ======================== -->
 421
 422
 423   <a id="Roo.tree.TreeSorter-events"></a>
 424
 425
 426
 427
 428
 429      <table cellspacing="0" class="member-table">
 430       <caption class="Empty">Events - Has None</caption>
 431      </table>
 432
 433
 434
 435
 436
 437
 438
 439
 440
 441 <!-- ============================== footer ================================= -->
 442                 <div class="fineprint" style="clear:both">
 443
 444                         Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Tue Jul 27 2010 11:05:09 GMT+0800 (HKT)
 445                         Based on
 446                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
 447                 </div>
 448         </body>
 449 </html>