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