1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7 <meta http-equiv="content-type" content="text/html; charset=undefined" />
8 <meta name="generator" content="JsDoc Toolkit" />
11 <title>JsDoc Reference - Roo.form.NumberField</title>
14 <link rel="stylesheet" type="text/css" href="../../css/roojs.css" />
15 <link rel="stylesheet" type="text/css" href="../default.css" />
18 <script type="text/javascript" src="../page.js">
25 <body onload="RooDocsPage.onload();">
28 <div class="body-wrap">
30 <!-- ============================== links to methods. ================================= -->
32 <div class="top-tools">
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>
43 <!-- ============================== inheritance Block. ================================= -->
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
52 <!-- ============================== class title / details ============================ -->
55 <h1 class="classTitle">
57 Class Roo.form.NumberField
60 <table cellspacing="0" class="class-summary-table">
62 <tr><td class="label">Package:</td><td class="hd-info">Roo.form</td></tr>
64 <tr><td class="label">Defined In:</td><td class="hd-info">
66 <a href="./src/Roo_form_NumberField.js.html">Roo/form/NumberField.js</a>.
69 <tr><td class="label">Class:</td><td class="hd-info">NumberField</td></tr>
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>
83 <!-- ============================== class summary ========================== -->
84 <div class="description">
85 Numeric text field that provides automatic keystroke filtering and numeric validation.
89 <!-- ============================== Class comment block... ========================== -->
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>
95 <iframe frameborder="0" id="comments-Roo.form" style="border: none;width:100%;"
96 src="/blog.php/GtkDjsComments/Roo.form.NumberField.html"></iframe>
101 <!-- ============================== config options ========================== -->
106 <div class="hr"></div>
107 <a id="Roo.form.NumberField-configs"></a>
113 <table cellspacing="0" class="member-table">
114 <caption>Config Options (Usually are also Properties)</caption>
118 <th class="sig-header" colspan="2">Options</th>
120 <th class="msource-header">Defined By</th>
127 <tr class="config-row expandable config-row-alt0 notInherited">
128 <td class="micon"><a class="exi" href="#expand"> </a></td>
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>
139 <div class="short">False to disallow decimal values (defaults to true)</div>
143 <div class="long">False to disallow decimal values (defaults to true)</div>
157 <tr class="config-row expandable config-row-alt1 notInherited">
158 <td class="micon"><a class="exi" href="#expand"> </a></td>
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>
169 <div class="short">False to prevent entering a negative sign (defaults to true)</div>
173 <div class="long">False to prevent entering a negative sign (defaults to true)</div>
187 <tr class="config-row expandable config-row-alt0 notInherited">
188 <td class="micon"><a class="exi" href="#expand"> </a></td>
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>
199 <div class="short">The maximum precision to display after the decimal separator (defaults to 2)</div>
203 <div class="long">The maximum precision to display after the decimal separator (defaults to 2)</div>
217 <tr class="config-row expandable config-row-alt1 notInherited">
218 <td class="micon"><a class="exi" href="#expand"> </a></td>
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>
229 <div class="short">Character(s) to allow as the decimal separator (defaults to '.</div>
233 <div class="long">Character(s) to allow as the decimal separator (defaults to '.')</div>
247 <tr class="config-row expandable config-row-alt0 notInherited">
248 <td class="micon"><a class="exi" href="#expand"> </a></td>
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>
259 <div class="short">The default CSS class for the field (defaults to "x-form-field x-form-num-field")</div>
263 <div class="long">The default CSS class for the field (defaults to "x-form-field x-form-num-field")</div>
277 <tr class="config-row expandable config-row-alt1 notInherited">
278 <td class="micon"><a class="exi" href="#expand"> </a></td>
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>
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>
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>
307 <tr class="config-row expandable config-row-alt0 notInherited">
308 <td class="micon"><a class="exi" href="#expand"> </a></td>
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>
319 <div class="short">The maximum allowed value (defaults to Number.MAX_VALUE)</div>
323 <div class="long">The maximum allowed value (defaults to Number.MAX_VALUE)</div>
337 <tr class="config-row expandable config-row-alt1 notInherited">
338 <td class="micon"><a class="exi" href="#expand"> </a></td>
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>
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>
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>
367 <tr class="config-row expandable config-row-alt0 notInherited">
368 <td class="micon"><a class="exi" href="#expand"> </a></td>
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>
379 <div class="short">The minimum allowed value (defaults to Number.NEGATIVE_INFINITY)</div>
383 <div class="long">The minimum allowed value (defaults to Number.NEGATIVE_INFINITY)</div>
397 <tr class="config-row expandable config-row-alt1 notInherited">
398 <td class="micon"><a class="exi" href="#expand"> </a></td>
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>
409 <div class="short">Error text to display if the value is not a valid number.</div>
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>
437 <!-- ============================== public properties ==================== -->
441 <a id="Roo.form.NumberField-props"></a>
447 <table cellspacing="0" class="member-table">
448 <caption class="Empty">Public Properties - Has None</caption>
454 <!-- ============================== methods summary / details ======================== -->
457 <a id="Roo.form.NumberField-methods"></a>
458 <!-- constructor?? -->
465 <!-- then dynamics first -->
472 <table cellspacing="0" class="member-table">
473 <caption>Public Methods</caption>
475 <th class="sig-header" colspan="2">Method</th>
476 <th class="msource-header">Defined By</th>
486 <tr class="method-row config-row-alt0 expandable notInherited">
487 <td class="micon"><a class="exi" href="#expand"> </a></td>
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>
495 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
503 <div class="short">Create a new Roo.form.NumberField</div>
510 Create a new Roo.form.NumberField
513 <dl class="detailList">
514 <dt class="heading">Parameters:</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>
520 <dd>Configuration options</dd>
547 <!-- ============================== events summary / details ======================== -->
550 <a id="Roo.form.NumberField-events"></a>
556 <table cellspacing="0" class="member-table">
557 <caption class="Empty">Events - Has None</caption>
568 <!-- ============================== footer ================================= -->
569 <div class="fineprint" style="clear:both">
571 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Fri Jul 16 2010 16:43:12 GMT+0800 (HKT)
573 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>