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">
 131                     true for case sensitive sort (defaults to false)
 132
 133                 </div>
 134                         </div>
 135
 136
 137
 138                     </td>
 139                     <td class="msource">
 140
 141                         Roo.tree.TreeSorter
 142
 143                     </td>
 144                 </tr>
 145
 146
 147                 <tr class="config-row expandable config-row-alt1 notInherited">
 148                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 149                     <td class="sig">
 150
 151                         <a id="Roo.tree.TreeSorter-cfg-dir" name=".dir"></a>
 152                         <div class="fixedFont">
 153                                 <b  class="itemname">dir</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 154
 155
 156                         </div>
 157
 158                         <div class="mdesc">
 159                             <div class="short">The direction to sort (asc or desc) (defaults to asc)</div>
 160                         </div>
 161
 162                         <div class="mdesc">
 163                             <div class="long">
 164                     The direction to sort (asc or desc) (defaults to asc)
 165
 166                 </div>
 167                         </div>
 168
 169
 170
 171                     </td>
 172                     <td class="msource">
 173
 174                         Roo.tree.TreeSorter
 175
 176                     </td>
 177                 </tr>
 178
 179
 180                 <tr class="config-row expandable config-row-alt0 notInherited">
 181                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 182                     <td class="sig">
 183
 184                         <a id="Roo.tree.TreeSorter-cfg-folderSort" name=".folderSort"></a>
 185                         <div class="fixedFont">
 186                                 <b  class="itemname">folderSort</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 187
 188
 189                         </div>
 190
 191                         <div class="mdesc">
 192                             <div class="short">True to sort leaf nodes under non leaf nodes</div>
 193                         </div>
 194
 195                         <div class="mdesc">
 196                             <div class="long">
 197                     True to sort leaf nodes under non leaf nodes
 198
 199                 </div>
 200                         </div>
 201
 202
 203
 204                     </td>
 205                     <td class="msource">
 206
 207                         Roo.tree.TreeSorter
 208
 209                     </td>
 210                 </tr>
 211
 212
 213                 <tr class="config-row expandable config-row-alt1 notInherited">
 214                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 215                     <td class="sig">
 216
 217                         <a id="Roo.tree.TreeSorter-cfg-leafAttr" name=".leafAttr"></a>
 218                         <div class="fixedFont">
 219                                 <b  class="itemname">leafAttr</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 220
 221
 222                         </div>
 223
 224                         <div class="mdesc">
 225                             <div class="short">The attribute used to determine leaf nodes in folder sort (defaults to "leaf")</div>
 226                         </div>
 227
 228                         <div class="mdesc">
 229                             <div class="long">
 230                     The attribute used to determine leaf nodes in folder sort (defaults to "leaf")
 231
 232                 </div>
 233                         </div>
 234
 235
 236
 237                     </td>
 238                     <td class="msource">
 239
 240                         Roo.tree.TreeSorter
 241
 242                     </td>
 243                 </tr>
 244
 245
 246                 <tr class="config-row expandable config-row-alt0 notInherited">
 247                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 248                     <td class="sig">
 249
 250                         <a id="Roo.tree.TreeSorter-cfg-property" name=".property"></a>
 251                         <div class="fixedFont">
 252                                 <b  class="itemname">property</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 253
 254
 255                         </div>
 256
 257                         <div class="mdesc">
 258                             <div class="short">The named attribute on the node to sort by (defaults to text)</div>
 259                         </div>
 260
 261                         <div class="mdesc">
 262                             <div class="long">
 263                     The named attribute on the node to sort by (defaults to text)
 264
 265                 </div>
 266                         </div>
 267
 268
 269
 270                     </td>
 271                     <td class="msource">
 272
 273                         Roo.tree.TreeSorter
 274
 275                     </td>
 276                 </tr>
 277
 278
 279                 <tr class="config-row expandable config-row-alt1 notInherited">
 280                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 281                     <td class="sig">
 282
 283                         <a id="Roo.tree.TreeSorter-cfg-sortType" name=".sortType"></a>
 284                         <div class="fixedFont">
 285                                 <b  class="itemname">sortType</b> : <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a>
 286
 287
 288                         </div>
 289
 290                         <div class="mdesc">
 291                             <div class="short">A custom "casting" function used to convert node values before sorting</div>
 292                         </div>
 293
 294                         <div class="mdesc">
 295                             <div class="long">
 296                     A custom "casting" function used to convert node values before sorting
 297
 298                 </div>
 299                         </div>
 300
 301
 302
 303                     </td>
 304                     <td class="msource">
 305
 306                         Roo.tree.TreeSorter
 307
 308                     </td>
 309                 </tr>
 310
 311
 312     </table>
 313
 314
 315
 316
 317
 318
 319
 320
 321
 322   <!-- ============================== public properties ==================== -->
 323
 324
 325
 326     <a id="Roo.tree.TreeSorter-props"></a>
 327
 328
 329
 330
 331
 332      <table cellspacing="0" class="member-table">
 333       <caption class="Empty">Public Properties - Has None</caption>
 334      </table>
 335
 336
 337
 338
 339   <!-- ============================== methods summary / details ======================== -->
 340
 341
 342   <a id="Roo.tree.TreeSorter-methods"></a>
 343         <!-- constructor?? -->
 344
 345         <!-- static's first
 346
 347
 348         -->
 349
 350         <!-- then dynamics first -->
 351
 352
 353
 354
 355
 356
 357       <table cellspacing="0" class="member-table">
 358       <caption>Public Methods</caption>
 359         <tr>
 360             <th class="sig-header" colspan="2">Method</th>
 361             <th class="msource-header">Defined By</th>
 362
 363         </tr>
 364
 365
 366
 367
 368
 369
 370
 371           <tr class="method-row config-row-alt0 expandable notInherited">
 372             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 373
 374
 375             <td class="sig">
 376                 <a id="Roo.tree-method-TreeSorter"   name=".TreeSorter"></a>
 377                 <div class="fixedFont">
 378                         <span class="attributes">new <B>Roo.tree.</B></span><b class="itemname">TreeSorter</b>
 379
 380                                  (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>)
 381
 382
 383
 384                 </div>
 385                 <div class="mdesc">
 386
 387
 388                         <div class="short">Create a new Roo.tree.TreeSorter</div>
 389
 390
 391                     <div class="long">
 392
 393
 394
 395                                 Create a new Roo.tree.TreeSorter
 396
 397
 398                                 <dl class="detailList">
 399                                 <dt class="heading">Parameters:</dt>
 400
 401                                         <dt>
 402                                                 <span class="fixedFont">TreePanel</span>  <b>tree</b>
 403
 404                                         </dt>
 405                                         <dd></dd>
 406
 407                                         <dt>
 408                                                 <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>
 409
 410                                         </dt>
 411                                         <dd></dd>
 412
 413                                 </dl>
 414
 415
 416
 417
 418
 419
 420
 421
 422
 423
 424
 425                     </div>
 426                 </div>
 427
 428             </td>
 429             <td class="msource">
 430                 &nbsp;
 431             </td>
 432         </tr>
 433
 434
 435     </table>
 436
 437
 438   <!-- ============================== events summary / details ======================== -->
 439
 440
 441   <a id="Roo.tree.TreeSorter-events"></a>
 442
 443
 444
 445
 446
 447      <table cellspacing="0" class="member-table">
 448       <caption class="Empty">Events - Has None</caption>
 449      </table>
 450
 451
 452
 453
 454
 455
 456
 457
 458
 459 <!-- ============================== footer ================================= -->
 460                 <div class="fineprint" style="clear:both">
 461
 462                         Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Fri Jul 13 2018 14:10:55 GMT+0800 (HKT)
 463                         Based on
 464                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
 465                 </div>
 466         </body>
 467 </html>