git.roojs.org Git - roojs1/blob - docs/symbols/Roo.form.NumberField.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.form.NumberField</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.form.NumberField-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
  35         <a class="inner-link" href="#Roo.form.NumberField-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
  36         <a class="inner-link" href="#Roo.form.NumberField-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
  37         <a class="inner-link" href="#Roo.form.NumberField-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.form.TextField.html#constructor" roo:cls="Roo.form.TextField.html#constructor">Roo.form.TextField</a>
  47 <img src="../../images/default/s.gif" height="1"  width="20"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.form.NumberField
  48
  49                    </pre>
  50                 </div>
  51
  52 <!-- ============================== class title / details ============================ -->
  53
  54
  55     <h1 class="classTitle">
  56
  57                                 Class Roo.form.NumberField
  58                         </h1>
  59
  60     <table cellspacing="0" class="class-summary-table">
  61
  62                 <tr><td class="label">Package:</td><td class="hd-info">Roo.form</td></tr>
  63
  64         <tr><td class="label">Defined In:</td><td class="hd-info">
  65
  66                                         <a href="./src/Roo_form_NumberField.js.html">Roo/form/NumberField.js</a>.
  67
  68         </td></tr>
  69         <tr><td class="label">Class:</td><td class="hd-info">NumberField</td></tr>
  70
  71
  72
  73
  74                 <tr><td class="label">Extends:</td><td class="hd-info">
  75                         <a href="./Roo.form.TextField.html#constructor" roo:cls="Roo.form.TextField.html#constructor">Roo.form.TextField</a>
  76
  77                 </td></tr>
  78
  79
  80     </table>
  81
  82
  83 <!-- ============================== class summary ========================== -->
  84     <div class="description">
  85         Numeric text field that provides automatic keystroke filtering and numeric validation.
  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.form.NumberField';">[Add Your comment/notes about this class]</u>
  94         <br/>
  95         <iframe frameborder="0"  id="comments-Roo.form" style="border: none;width:100%;"
  96                 src="/blog.php/GtkDjsComments/Roo.form.NumberField.html"></iframe>
  97 </div>
  98
  99
 100
 101 <!-- ============================== config options ========================== -->
 102
 103
 104
 105
 106     <div class="hr"></div>
 107     <a id="Roo.form.NumberField-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.form.NumberField-cfg-allowDecimals" name=".allowDecimals"></a>
 132                         <div class="fixedFont">
 133                                 <b  class="itemname">allowDecimals</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 134
 135
 136                         </div>
 137
 138                         <div class="mdesc">
 139                             <div class="short">False to disallow decimal values (defaults to true)</div>
 140                         </div>
 141
 142                         <div class="mdesc">
 143                             <div class="long">False to disallow decimal values (defaults to true)</div>
 144                         </div>
 145
 146
 147
 148                     </td>
 149                     <td class="msource">
 150
 151                         Roo.form.NumberField
 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.form.NumberField-cfg-allowNegative" name=".allowNegative"></a>
 162                         <div class="fixedFont">
 163                                 <b  class="itemname">allowNegative</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 164
 165
 166                         </div>
 167
 168                         <div class="mdesc">
 169                             <div class="short">False to prevent entering a negative sign (defaults to true)</div>
 170                         </div>
 171
 172                         <div class="mdesc">
 173                             <div class="long">False to prevent entering a negative sign (defaults to true)</div>
 174                         </div>
 175
 176
 177
 178                     </td>
 179                     <td class="msource">
 180
 181                         Roo.form.NumberField
 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.form.NumberField-cfg-decimalPrecision" name=".decimalPrecision"></a>
 192                         <div class="fixedFont">
 193                                 <b  class="itemname">decimalPrecision</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
 194
 195
 196                         </div>
 197
 198                         <div class="mdesc">
 199                             <div class="short">The maximum precision to display after the decimal separator (defaults to 2)</div>
 200                         </div>
 201
 202                         <div class="mdesc">
 203                             <div class="long">The maximum precision to display after the decimal separator (defaults to 2)</div>
 204                         </div>
 205
 206
 207
 208                     </td>
 209                     <td class="msource">
 210
 211                         Roo.form.NumberField
 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.form.NumberField-cfg-decimalSeparator" name=".decimalSeparator"></a>
 222                         <div class="fixedFont">
 223                                 <b  class="itemname">decimalSeparator</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 224
 225
 226                         </div>
 227
 228                         <div class="mdesc">
 229                             <div class="short">Character(s) to allow as the decimal separator (defaults to '.</div>
 230                         </div>
 231
 232                         <div class="mdesc">
 233                             <div class="long">Character(s) to allow as the decimal separator (defaults to '.')</div>
 234                         </div>
 235
 236
 237
 238                     </td>
 239                     <td class="msource">
 240
 241                         Roo.form.NumberField
 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.form.NumberField-cfg-fieldClass" name=".fieldClass"></a>
 252                         <div class="fixedFont">
 253                                 <b  class="itemname">fieldClass</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 254
 255
 256                         </div>
 257
 258                         <div class="mdesc">
 259                             <div class="short">The default CSS class for the field (defaults to "x-form-field x-form-num-field")</div>
 260                         </div>
 261
 262                         <div class="mdesc">
 263                             <div class="long">The default CSS class for the field (defaults to "x-form-field x-form-num-field")</div>
 264                         </div>
 265
 266
 267
 268                     </td>
 269                     <td class="msource">
 270
 271                         Roo.form.NumberField
 272
 273                     </td>
 274                 </tr>
 275
 276
 277                 <tr class="config-row expandable config-row-alt1 notInherited">
 278                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 279                     <td class="sig">
 280
 281                         <a id="Roo.form.NumberField-cfg-maxText" name=".maxText"></a>
 282                         <div class="fixedFont">
 283                                 <b  class="itemname">maxText</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 284
 285
 286                         </div>
 287
 288                         <div class="mdesc">
 289                             <div class="short">Error text to display if the maximum value validation fails (defaults to "The maximum value for this field is {maxValue}")</div>
 290                         </div>
 291
 292                         <div class="mdesc">
 293                             <div class="long">Error text to display if the maximum value validation fails (defaults to "The maximum value for this field is {maxValue}")</div>
 294                         </div>
 295
 296
 297
 298                     </td>
 299                     <td class="msource">
 300
 301                         Roo.form.NumberField
 302
 303                     </td>
 304                 </tr>
 305
 306
 307                 <tr class="config-row expandable config-row-alt0 notInherited">
 308                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 309                     <td class="sig">
 310
 311                         <a id="Roo.form.NumberField-cfg-maxValue" name=".maxValue"></a>
 312                         <div class="fixedFont">
 313                                 <b  class="itemname">maxValue</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
 314
 315
 316                         </div>
 317
 318                         <div class="mdesc">
 319                             <div class="short">The maximum allowed value (defaults to Number.MAX_VALUE)</div>
 320                         </div>
 321
 322                         <div class="mdesc">
 323                             <div class="long">The maximum allowed value (defaults to Number.MAX_VALUE)</div>
 324                         </div>
 325
 326
 327
 328                     </td>
 329                     <td class="msource">
 330
 331                         Roo.form.NumberField
 332
 333                     </td>
 334                 </tr>
 335
 336
 337                 <tr class="config-row expandable config-row-alt1 notInherited">
 338                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 339                     <td class="sig">
 340
 341                         <a id="Roo.form.NumberField-cfg-minText" name=".minText"></a>
 342                         <div class="fixedFont">
 343                                 <b  class="itemname">minText</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 344
 345
 346                         </div>
 347
 348                         <div class="mdesc">
 349                             <div class="short">Error text to display if the minimum value validation fails (defaults to "The minimum value for this field is {minValue}")</div>
 350                         </div>
 351
 352                         <div class="mdesc">
 353                             <div class="long">Error text to display if the minimum value validation fails (defaults to "The minimum value for this field is {minValue}")</div>
 354                         </div>
 355
 356
 357
 358                     </td>
 359                     <td class="msource">
 360
 361                         Roo.form.NumberField
 362
 363                     </td>
 364                 </tr>
 365
 366
 367                 <tr class="config-row expandable config-row-alt0 notInherited">
 368                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 369                     <td class="sig">
 370
 371                         <a id="Roo.form.NumberField-cfg-minValue" name=".minValue"></a>
 372                         <div class="fixedFont">
 373                                 <b  class="itemname">minValue</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
 374
 375
 376                         </div>
 377
 378                         <div class="mdesc">
 379                             <div class="short">The minimum allowed value (defaults to Number.NEGATIVE_INFINITY)</div>
 380                         </div>
 381
 382                         <div class="mdesc">
 383                             <div class="long">The minimum allowed value (defaults to Number.NEGATIVE_INFINITY)</div>
 384                         </div>
 385
 386
 387
 388                     </td>
 389                     <td class="msource">
 390
 391                         Roo.form.NumberField
 392
 393                     </td>
 394                 </tr>
 395
 396
 397                 <tr class="config-row expandable config-row-alt1 notInherited">
 398                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 399                     <td class="sig">
 400
 401                         <a id="Roo.form.NumberField-cfg-nanText" name=".nanText"></a>
 402                         <div class="fixedFont">
 403                                 <b  class="itemname">nanText</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 404
 405
 406                         </div>
 407
 408                         <div class="mdesc">
 409                             <div class="short">Error text to display if the value is not a valid number.</div>
 410                         </div>
 411
 412                         <div class="mdesc">
 413                             <div class="long">Error text to display if the value is not a valid number.  For example, this can happen<br/>if a valid character like '.' or '-' is left in the field with no number (defaults to "{value} is not a valid number")</div>
 414                         </div>
 415
 416
 417
 418                     </td>
 419                     <td class="msource">
 420
 421                         Roo.form.NumberField
 422
 423                     </td>
 424                 </tr>
 425
 426
 427     </table>
 428
 429
 430
 431
 432
 433
 434
 435
 436
 437   <!-- ============================== public properties ==================== -->
 438
 439
 440
 441     <a id="Roo.form.NumberField-props"></a>
 442
 443
 444
 445
 446
 447      <table cellspacing="0" class="member-table">
 448       <caption class="Empty">Public Properties - Has None</caption>
 449      </table>
 450
 451
 452
 453
 454   <!-- ============================== methods summary / details ======================== -->
 455
 456
 457   <a id="Roo.form.NumberField-methods"></a>
 458         <!-- constructor?? -->
 459
 460         <!-- static's first
 461
 462
 463         -->
 464
 465         <!-- then dynamics first -->
 466
 467
 468
 469
 470
 471
 472       <table cellspacing="0" class="member-table">
 473       <caption>Public Methods</caption>
 474         <tr>
 475             <th class="sig-header" colspan="2">Method</th>
 476             <th class="msource-header">Defined By</th>
 477
 478         </tr>
 479
 480
 481
 482
 483
 484
 485
 486           <tr class="method-row config-row-alt0 expandable notInherited">
 487             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 488
 489
 490             <td class="sig">
 491                 <a id="Roo.form-method-NumberField"   name=".NumberField"></a>
 492                 <div class="fixedFont">
 493                         <span class="attributes">new <B>Roo.form.</B></span><b class="itemname">NumberField</b>
 494
 495                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
 496
 497
 498
 499                 </div>
 500                 <div class="mdesc">
 501
 502
 503                         <div class="short">Create a new Roo.form.NumberField</div>
 504
 505
 506                     <div class="long">
 507
 508
 509
 510                                 Create a new Roo.form.NumberField
 511
 512
 513                                 <dl class="detailList">
 514                                 <dt class="heading">Parameters:</dt>
 515
 516                                         <dt>
 517                                                 <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>
 518
 519                                         </dt>
 520                                         <dd>Configuration options</dd>
 521
 522                                 </dl>
 523
 524
 525
 526
 527
 528
 529
 530
 531
 532
 533
 534                     </div>
 535                 </div>
 536
 537             </td>
 538             <td class="msource">
 539                 &nbsp;
 540             </td>
 541         </tr>
 542
 543
 544     </table>
 545
 546
 547   <!-- ============================== events summary / details ======================== -->
 548
 549
 550   <a id="Roo.form.NumberField-events"></a>
 551
 552
 553
 554
 555
 556      <table cellspacing="0" class="member-table">
 557       <caption class="Empty">Events - Has None</caption>
 558      </table>
 559
 560
 561
 562
 563
 564
 565
 566
 567
 568 <!-- ============================== footer ================================= -->
 569                 <div class="fineprint" style="clear:both">
 570
 571                         Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Fri Jul 16 2010 15:55:27 GMT+0800 (HKT)
 572                         Based on
 573                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
 574                 </div>
 575         </body>
 576 </html>