git.roojs.org Git - roojs1/blob - docs/symbols/Roo.KeyNav.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.KeyNav</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.KeyNav-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
  35         <a class="inner-link" href="#Roo.KeyNav-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
  36         <a class="inner-link" href="#Roo.KeyNav-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
  37         <a class="inner-link" href="#Roo.KeyNav-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.KeyNav
  51                         </h1>
  52
  53     <table cellspacing="0" class="class-summary-table">
  54
  55                 <tr><td class="label">Package:</td><td class="hd-info">Roo</td></tr>
  56
  57         <tr><td class="label">Defined In:</td><td class="hd-info">
  58
  59                                         <a href="./src/Roo_KeyNav.js.html">Roo/KeyNav.js</a>.
  60
  61         </td></tr>
  62         <tr><td class="label">Class:</td><td class="hd-info">KeyNav</td></tr>
  63
  64
  65
  66
  67     </table>
  68
  69
  70 <!-- ============================== class summary ========================== -->
  71     <div class="description">
  72         <p>Provides a convenient wrapper for normalized keyboard navigation.  KeyNav allows you to bind<br/>navigation keys to function calls that will get called when the keys are pressed, providing an easy<br/>way to implement custom navigation schemes for any UI component.</p><br/><p>The following are all of the possible keys that can be implemented: enter, left, right, up, down, tab, esc,<br/>pageUp, pageDown, del, home, end.  Usage:</p><br/> <pre><code><br/>var nav = new Roo.KeyNav("my-element", {<br/>    "left" : function(e){<br/>        this.moveLeft(e.ctrlKey);<br/>    },<br/>    "right" : function(e){<br/>        this.moveRight(e.ctrlKey);<br/>    },<br/>    "enter" : function(e){<br/>        this.save();<br/>    },<br/>    scope : this<br/>});<br/></code></pre>
  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.KeyNav';">[Add Your comment/notes about this class]</u>
  81         <br/>
  82         <iframe frameborder="0"  id="comments-Roo" style="border: none;width:100%;"
  83                 src="/blog.php/GtkDjsComments/Roo.KeyNav.html"></iframe>
  84 </div>
  85
  86
  87
  88 <!-- ============================== config options ========================== -->
  89
  90
  91
  92
  93     <div class="hr"></div>
  94     <a id="Roo.KeyNav-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.KeyNav-cfg-defaultEventAction" name=".defaultEventAction"></a>
 119                         <div class="fixedFont">
 120                                 <b  class="itemname">defaultEventAction</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 121
 122
 123                         </div>
 124
 125                         <div class="mdesc">
 126                             <div class="short">The method to call on the {<b>link</b> Roo.EventObject} after this KeyNav intercepts a key.</div>
 127                         </div>
 128
 129                         <div class="mdesc">
 130                             <div class="long">
 131                     The method to call on the {<b>link</b> Roo.EventObject} after this KeyNav intercepts a key.  Valid values are<br/>{<b>link</b> Roo.EventObject<b>stopEvent</b>}, {<b>link</b> Roo.EventObject<b>preventDefault</b>} and<br/>{<b>link</b> Roo.EventObject<b>stopPropagation</b>} (defaults to 'stopEvent')
 132
 133                 </div>
 134                         </div>
 135
 136
 137
 138                     </td>
 139                     <td class="msource">
 140
 141                         Roo.KeyNav
 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.KeyNav-cfg-disabled" name=".disabled"></a>
 152                         <div class="fixedFont">
 153                                 <b  class="itemname">disabled</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 154
 155
 156                         </div>
 157
 158                         <div class="mdesc">
 159                             <div class="short">True to disable this KeyNav instance (defaults to false)</div>
 160                         </div>
 161
 162                         <div class="mdesc">
 163                             <div class="long">
 164                     True to disable this KeyNav instance (defaults to false)
 165
 166                 </div>
 167                         </div>
 168
 169
 170
 171                     </td>
 172                     <td class="msource">
 173
 174                         Roo.KeyNav
 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.KeyNav-cfg-forceKeyDown" name=".forceKeyDown"></a>
 185                         <div class="fixedFont">
 186                                 <b  class="itemname">forceKeyDown</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">Handle the keydown event instead of keypress (defaults to false).</div>
 193                         </div>
 194
 195                         <div class="mdesc">
 196                             <div class="long">
 197                     Handle the keydown event instead of keypress (defaults to false).  KeyNav automatically does this for IE since<br/>IE does not propagate special keys on keypress, but setting this to true will force other browsers to also<br/>handle keydown instead of keypress.
 198
 199                 </div>
 200                         </div>
 201
 202
 203
 204                     </td>
 205                     <td class="msource">
 206
 207                         Roo.KeyNav
 208
 209                     </td>
 210                 </tr>
 211
 212
 213     </table>
 214
 215
 216
 217
 218
 219
 220
 221
 222
 223   <!-- ============================== public properties ==================== -->
 224
 225
 226
 227     <a id="Roo.KeyNav-props"></a>
 228
 229
 230
 231
 232
 233      <table cellspacing="0" class="member-table">
 234       <caption class="Empty">Public Properties - Has None</caption>
 235      </table>
 236
 237
 238
 239
 240   <!-- ============================== methods summary / details ======================== -->
 241
 242
 243   <a id="Roo.KeyNav-methods"></a>
 244         <!-- constructor?? -->
 245
 246         <!-- static's first
 247
 248
 249         -->
 250
 251         <!-- then dynamics first -->
 252
 253
 254
 255
 256
 257
 258       <table cellspacing="0" class="member-table">
 259       <caption>Public Methods</caption>
 260         <tr>
 261             <th class="sig-header" colspan="2">Method</th>
 262             <th class="msource-header">Defined By</th>
 263
 264         </tr>
 265
 266
 267
 268
 269
 270
 271
 272           <tr class="method-row config-row-alt0 expandable notInherited">
 273             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 274
 275
 276             <td class="sig">
 277                 <a id="Roo-method-KeyNav"   name=".KeyNav"></a>
 278                 <div class="fixedFont">
 279                         <span class="attributes">new <B>Roo.</B></span><b class="itemname">KeyNav</b>
 280
 281                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Roo.Element <B><i>el</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>)
 282
 283
 284
 285                 </div>
 286                 <div class="mdesc">
 287
 288
 289                         <div class="short">Create a new Roo.KeyNav</div>
 290
 291
 292                     <div class="long">
 293
 294
 295
 296                                 Create a new Roo.KeyNav
 297
 298
 299                                 <dl class="detailList">
 300                                 <dt class="heading">Parameters:</dt>
 301
 302                                         <dt>
 303                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Roo.Element</span>  <b>el</b>
 304
 305                                         </dt>
 306                                         <dd>The element to bind to</dd>
 307
 308                                         <dt>
 309                                                 <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>
 310
 311                                         </dt>
 312                                         <dd>The config</dd>
 313
 314                                 </dl>
 315
 316
 317
 318
 319
 320
 321
 322
 323
 324
 325
 326                     </div>
 327                 </div>
 328
 329             </td>
 330             <td class="msource">
 331                 &nbsp;
 332             </td>
 333         </tr>
 334
 335
 336           <tr class="method-row config-row-alt1 expandable notInherited">
 337             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 338
 339
 340             <td class="sig">
 341                 <a id="Roo.KeyNav-method-disable"   name=".disable"></a>
 342                 <div class="fixedFont">
 343                         <span class="attributes"></span><b class="itemname">disable</b>
 344
 345                                  ()
 346
 347
 348
 349                 </div>
 350                 <div class="mdesc">
 351
 352                    <div class="short">Disable this KeyNav</div>
 353
 354
 355
 356                     <div class="long">
 357
 358                                 Disable this KeyNav
 359
 360
 361
 362
 363
 364
 365
 366
 367
 368
 369
 370
 371
 372
 373
 374
 375                     </div>
 376                 </div>
 377
 378             </td>
 379             <td class="msource">
 380
 381                         Roo.KeyNav
 382                 &nbsp;
 383             </td>
 384         </tr>
 385
 386
 387           <tr class="method-row config-row-alt0 expandable notInherited">
 388             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 389
 390
 391             <td class="sig">
 392                 <a id="Roo.KeyNav-method-enable"   name=".enable"></a>
 393                 <div class="fixedFont">
 394                         <span class="attributes"></span><b class="itemname">enable</b>
 395
 396                                  ()
 397
 398
 399
 400                 </div>
 401                 <div class="mdesc">
 402
 403                    <div class="short">Enable this KeyNav</div>
 404
 405
 406
 407                     <div class="long">
 408
 409                                 Enable this KeyNav
 410
 411
 412
 413
 414
 415
 416
 417
 418
 419
 420
 421
 422
 423
 424
 425
 426                     </div>
 427                 </div>
 428
 429             </td>
 430             <td class="msource">
 431
 432                         Roo.KeyNav
 433                 &nbsp;
 434             </td>
 435         </tr>
 436
 437
 438     </table>
 439
 440
 441   <!-- ============================== events summary / details ======================== -->
 442
 443
 444   <a id="Roo.KeyNav-events"></a>
 445
 446
 447
 448
 449
 450      <table cellspacing="0" class="member-table">
 451       <caption class="Empty">Events - Has None</caption>
 452      </table>
 453
 454
 455
 456
 457
 458
 459
 460
 461
 462 <!-- ============================== footer ================================= -->
 463                 <div class="fineprint" style="clear:both">
 464
 465                         Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Fri Jul 13 2018 14:10:53 GMT+0800 (HKT)
 466                         Based on
 467                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
 468                 </div>
 469         </body>
 470 </html>