git.roojs.org Git - roojs1/blob - docs/symbols/Roo.tree.TreeEditor.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.TreeEditor</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.TreeEditor-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
  35         <a class="inner-link" href="#Roo.tree.TreeEditor-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
  36         <a class="inner-link" href="#Roo.tree.TreeEditor-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
  37         <a class="inner-link" href="#Roo.tree.TreeEditor-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                 <div class="inheritance res-block">
  46                    <pre class="res-block-inner"><a href="./Roo.Editor.html#constructor" roo:cls="Roo.Editor.html#constructor">Roo.Editor</a>
  47 <img src="../../images/default/s.gif" height="1"  width="20"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.tree.TreeEditor
  48
  49                    </pre>
  50                 </div>
  51
  52 <!-- ============================== class title / details ============================ -->
  53
  54
  55     <h1 class="classTitle">
  56
  57                                 Class Roo.tree.TreeEditor
  58                         </h1>
  59
  60     <table cellspacing="0" class="class-summary-table">
  61
  62                 <tr><td class="label">Package:</td><td class="hd-info">Roo.tree</td></tr>
  63
  64         <tr><td class="label">Defined In:</td><td class="hd-info">
  65
  66                                         <a href="./src/Roo_tree_TreeEditor.js.html">Roo/tree/TreeEditor.js</a>.
  67
  68         </td></tr>
  69         <tr><td class="label">Class:</td><td class="hd-info">TreeEditor</td></tr>
  70
  71
  72
  73
  74                 <tr><td class="label">Extends:</td><td class="hd-info">
  75                         <a href="./Roo.Editor.html#constructor" roo:cls="Roo.Editor.html#constructor">Roo.Editor</a>
  76
  77                 </td></tr>
  78
  79
  80     </table>
  81
  82
  83 <!-- ============================== class summary ========================== -->
  84     <div class="description">
  85         Provides editor functionality for inline tree node editing.  Any valid {<b>link</b> Roo.form.Field} can be used<br/>as the editor field.
  86     </div>
  87
  88
  89 <!-- ============================== Class comment block... ========================== -->
  90
  91 <div class="comments">
  92         <b>Class Comments / Notes</B> =>
  93         <u onclick="parent.CommentDialog.showCommentId = 'Roo.tree.TreeEditor';">[Add Your comment/notes about this class]</u>
  94         <br/>
  95         <iframe frameborder="0"  id="comments-Roo.tree" style="border: none;width:100%;"
  96                 src="/blog.php/GtkDjsComments/Roo.tree.TreeEditor.html"></iframe>
  97 </div>
  98
  99
 100
 101 <!-- ============================== config options ========================== -->
 102
 103
 104
 105
 106     <div class="hr"></div>
 107     <a id="Roo.tree.TreeEditor-configs"></a>
 108
 109
 110
 111
 112
 113       <table cellspacing="0" class="member-table">
 114       <caption>Config Options (Usually are also Properties)</caption>
 115
 116
 117         <tr>
 118             <th class="sig-header" colspan="2">Options</th>
 119
 120             <th class="msource-header">Defined By</th>
 121         </tr>
 122
 123
 124
 125
 126
 127                 <tr class="config-row expandable config-row-alt0 notInherited">
 128                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 129                     <td class="sig">
 130
 131                         <a id="Roo.tree.TreeEditor-cfg-alignment" name=".alignment"></a>
 132                         <div class="fixedFont">
 133                                 <b  class="itemname">alignment</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 134
 135
 136                         </div>
 137
 138                         <div class="mdesc">
 139                             <div class="short">The position to align to (see {<b>link</b> Roo.Element<b>alignTo</b>} for more details, defaults to "l-l").</div>
 140                         </div>
 141
 142                         <div class="mdesc">
 143                             <div class="long">The position to align to (see {<b>link</b> Roo.Element<b>alignTo</b>} for more details, defaults to "l-l").</div>
 144                         </div>
 145
 146
 147
 148                     </td>
 149                     <td class="msource">
 150
 151                         Roo.tree.TreeEditor
 152
 153                     </td>
 154                 </tr>
 155
 156
 157                 <tr class="config-row expandable config-row-alt1 notInherited">
 158                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 159                     <td class="sig">
 160
 161                         <a id="Roo.tree.TreeEditor-cfg-cls" name=".cls"></a>
 162                         <div class="fixedFont">
 163                                 <b  class="itemname">cls</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 164
 165
 166                         </div>
 167
 168                         <div class="mdesc">
 169                             <div class="short">CSS class to apply to the editor (defaults to "x-small-editor x-tree-editor")</div>
 170                         </div>
 171
 172                         <div class="mdesc">
 173                             <div class="long">CSS class to apply to the editor (defaults to "x-small-editor x-tree-editor")</div>
 174                         </div>
 175
 176
 177
 178                     </td>
 179                     <td class="msource">
 180
 181                         Roo.tree.TreeEditor
 182
 183                     </td>
 184                 </tr>
 185
 186
 187                 <tr class="config-row expandable config-row-alt0 notInherited">
 188                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 189                     <td class="sig">
 190
 191                         <a id="Roo.tree.TreeEditor-cfg-hideEl" name=".hideEl"></a>
 192                         <div class="fixedFont">
 193                                 <b  class="itemname">hideEl</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 194
 195
 196                         </div>
 197
 198                         <div class="mdesc">
 199                             <div class="short">True to hide the bound element while the editor is displayed (defaults to false)</div>
 200                         </div>
 201
 202                         <div class="mdesc">
 203                             <div class="long">True to hide the bound element while the editor is displayed (defaults to false)</div>
 204                         </div>
 205
 206
 207
 208                     </td>
 209                     <td class="msource">
 210
 211                         Roo.tree.TreeEditor
 212
 213                     </td>
 214                 </tr>
 215
 216
 217                 <tr class="config-row expandable config-row-alt1 notInherited">
 218                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 219                     <td class="sig">
 220
 221                         <a id="Roo.tree.TreeEditor-cfg-maxWidth" name=".maxWidth"></a>
 222                         <div class="fixedFont">
 223                                 <b  class="itemname">maxWidth</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
 224
 225
 226                         </div>
 227
 228                         <div class="mdesc">
 229                             <div class="short">The maximum width in pixels of the editor field (defaults to 250).</div>
 230                         </div>
 231
 232                         <div class="mdesc">
 233                             <div class="long">The maximum width in pixels of the editor field (defaults to 250).  Note that if the maxWidth would exceed<br/>the containing tree element's size, it will be automatically limited for you to the container width, taking<br/>scroll and client offsets into account prior to each edit.</div>
 234                         </div>
 235
 236
 237
 238                     </td>
 239                     <td class="msource">
 240
 241                         Roo.tree.TreeEditor
 242
 243                     </td>
 244                 </tr>
 245
 246
 247                 <tr class="config-row expandable config-row-alt0 notInherited">
 248                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 249                     <td class="sig">
 250
 251                         <a id="Roo.tree.TreeEditor-cfg-shim" name=".shim"></a>
 252                         <div class="fixedFont">
 253                                 <b  class="itemname">shim</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 254
 255
 256                         </div>
 257
 258                         <div class="mdesc">
 259                             <div class="short">True to shim the editor if selects/iframes could be displayed beneath it (defaults to false)</div>
 260                         </div>
 261
 262                         <div class="mdesc">
 263                             <div class="long">True to shim the editor if selects/iframes could be displayed beneath it (defaults to false)</div>
 264                         </div>
 265
 266
 267
 268                     </td>
 269                     <td class="msource">
 270
 271                         Roo.tree.TreeEditor
 272
 273                     </td>
 274                 </tr>
 275
 276
 277     </table>
 278
 279
 280
 281
 282
 283
 284
 285
 286
 287   <!-- ============================== public properties ==================== -->
 288
 289
 290
 291     <a id="Roo.tree.TreeEditor-props"></a>
 292
 293
 294
 295
 296
 297      <table cellspacing="0" class="member-table">
 298       <caption class="Empty">Public Properties - Has None</caption>
 299      </table>
 300
 301
 302
 303
 304   <!-- ============================== methods summary / details ======================== -->
 305
 306
 307   <a id="Roo.tree.TreeEditor-methods"></a>
 308         <!-- constructor?? -->
 309
 310         <!-- static's first
 311
 312
 313         -->
 314
 315         <!-- then dynamics first -->
 316
 317
 318
 319
 320
 321
 322       <table cellspacing="0" class="member-table">
 323       <caption>Public Methods</caption>
 324         <tr>
 325             <th class="sig-header" colspan="2">Method</th>
 326             <th class="msource-header">Defined By</th>
 327
 328         </tr>
 329
 330
 331
 332
 333
 334
 335
 336           <tr class="method-row config-row-alt0 expandable notInherited">
 337             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 338
 339
 340             <td class="sig">
 341                 <a id="Roo.tree-method-TreeEditor"   name=".TreeEditor"></a>
 342                 <div class="fixedFont">
 343                         <span class="attributes">new <B>Roo.tree.</B></span><b class="itemname">TreeEditor</b>
 344
 345                                  (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>)
 346
 347
 348
 349                 </div>
 350                 <div class="mdesc">
 351
 352
 353                         <div class="short">Create a new Roo.tree.TreeEditor</div>
 354
 355
 356                     <div class="long">
 357
 358
 359
 360                                 Create a new Roo.tree.TreeEditor
 361
 362
 363                                 <dl class="detailList">
 364                                 <dt class="heading">Parameters:</dt>
 365
 366                                         <dt>
 367                                                 <span class="fixedFont">TreePanel</span>  <b>tree</b>
 368
 369                                         </dt>
 370                                         <dd></dd>
 371
 372                                         <dt>
 373                                                 <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>
 374
 375                                         </dt>
 376                                         <dd>Either a prebuilt {<b>link</b> Roo.form.Field} instance or a Field config object</dd>
 377
 378                                 </dl>
 379
 380
 381
 382
 383
 384
 385
 386
 387
 388
 389
 390                     </div>
 391                 </div>
 392
 393             </td>
 394             <td class="msource">
 395                 &nbsp;
 396             </td>
 397         </tr>
 398
 399
 400     </table>
 401
 402
 403   <!-- ============================== events summary / details ======================== -->
 404
 405
 406   <a id="Roo.tree.TreeEditor-events"></a>
 407
 408
 409
 410
 411
 412      <table cellspacing="0" class="member-table">
 413       <caption class="Empty">Events - Has None</caption>
 414      </table>
 415
 416
 417
 418
 419
 420
 421
 422
 423
 424 <!-- ============================== footer ================================= -->
 425                 <div class="fineprint" style="clear:both">
 426
 427                         Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Fri Jul 16 2010 15:55:29 GMT+0800 (HKT)
 428                         Based on
 429                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
 430                 </div>
 431         </body>
 432 </html>