docs/symbols/Roo.form.NumberField.html
authorAlan Knowles <alan@akbkhome.com>
Fri, 16 Jul 2010 07:57:01 +0000 (15:57 +0800)
committerAlan Knowles <alan@akbkhome.com>
Fri, 16 Jul 2010 07:57:01 +0000 (15:57 +0800)
docs/symbols/Roo.form.NumberField.html [new file with mode: 0644]

diff --git a/docs/symbols/Roo.form.NumberField.html b/docs/symbols/Roo.form.NumberField.html
new file mode 100644 (file)
index 0000000..1f8ea0d
--- /dev/null
@@ -0,0 +1,576 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+
+       <head>
+               <meta http-equiv="content-type" content="text/html; charset=undefined" />
+               <meta name="generator" content="JsDoc Toolkit" />
+               
+               
+               <title>JsDoc Reference - Roo.form.NumberField</title>
+               
+               
+       <link rel="stylesheet" type="text/css" href="../../css/roojs.css" />            
+       <link rel="stylesheet" type="text/css" href="../default.css" />
+       
+       
+       <script type="text/javascript" src="../page.js">
+       
+       </script>
+        
+               
+       </head>
+
+       <body onload="RooDocsPage.onload();">
+        
+       
+<div class="body-wrap">
+
+    <!-- ============================== links to methods. ================================= -->        
+
+    <div class="top-tools">
+    <!--
+        <a class="inner-link" href="#Roo.form.NumberField-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
+        <a class="inner-link" href="#Roo.form.NumberField-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
+        <a class="inner-link" href="#Roo.form.NumberField-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
+        <a class="inner-link" href="#Roo.form.NumberField-configs"><img src="resources/s.gif" class="item-icon icon-config">Config Options</a>
+        <a class="bookmark" href="NEED_TO_CREATE_DIRECT_LINK_HREF"><img src="resources/s.gif" class="item-icon icon-fav">Direct Link</a>
+       -->
+    </div>
+
+    
+<!-- ============================== inheritance Block. ================================= -->   
+       
+               <div class="inheritance res-block">
+                  <pre class="res-block-inner"><a href="./Roo.form.TextField.html#constructor" roo:cls="Roo.form.TextField.html#constructor">Roo.form.TextField</a>
+<img src="../../images/default/s.gif" height="1"  width="20"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.form.NumberField 
+
+                  </pre>
+               </div>
+       
+<!-- ============================== class title / details ============================ -->
+    
+    
+    <h1 class="classTitle">
+                               
+                               Class Roo.form.NumberField
+                       </h1>
+                       
+    <table cellspacing="0" class="class-summary-table">
+       
+               <tr><td class="label">Package:</td><td class="hd-info">Roo.form</td></tr>
+       
+        <tr><td class="label">Defined In:</td><td class="hd-info">
+                       
+                                       <a href="./src/Roo_form_NumberField.js.html">Roo/form/NumberField.js</a>.
+                       
+       </td></tr>
+        <tr><td class="label">Class:</td><td class="hd-info">NumberField</td></tr>
+       
+       
+       
+       
+               <tr><td class="label">Extends:</td><td class="hd-info">
+                       <a href="./Roo.form.TextField.html#constructor" roo:cls="Roo.form.TextField.html#constructor">Roo.form.TextField</a>
+       
+               </td></tr>    
+       
+       
+    </table>
+
+    
+<!-- ============================== class summary ========================== -->                       
+    <div class="description">
+       Numeric text field that provides automatic keystroke filtering and numeric validation.
+    </div>
+
+       
+<!-- ============================== Class comment block... ========================== -->                                      
+
+<div class="comments">
+       <b>Class Comments / Notes</B> =>  
+       <u onclick="parent.CommentDialog.showCommentId = 'Roo.form.NumberField';">[Add Your comment/notes about this class]</u>
+       <br/>
+       <iframe frameborder="0"  id="comments-Roo.form" style="border: none;width:100%;" 
+               src="/blog.php/GtkDjsComments/Roo.form.NumberField.html"></iframe>
+</div>
+       
+
+               
+<!-- ============================== config options ========================== -->                                              
+                
+    
+    
+               
+    <div class="hr"></div>
+    <a id="Roo.form.NumberField-configs"></a>
+               
+    
+     
+    
+       
+      <table cellspacing="0" class="member-table">   
+      <caption>Config Options (Usually are also Properties)</caption>
+    
+       
+        <tr>
+            <th class="sig-header" colspan="2">Options</th>
+           
+            <th class="msource-header">Defined By</th>
+        </tr>
+       
+       
+       
+       
+       
+               <tr class="config-row expandable config-row-alt0 notInherited">
+                  <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
+                   <td class="sig">
+
+                       <a id="Roo.form.NumberField-cfg-allowDecimals" name=".allowDecimals"></a>
+                       <div class="fixedFont">
+                               <b  class="itemname">allowDecimals</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
+                               
+                               
+                       </div>
+                 
+                       <div class="mdesc">
+                           <div class="short">False to disallow decimal values (defaults to true)</div> 
+                       </div>
+                       
+                       <div class="mdesc">
+                           <div class="long">False to disallow decimal values (defaults to true)</div> 
+                       </div>
+                       
+                       
+
+                   </td>
+                   <td class="msource">
+                       
+                       Roo.form.NumberField
+                               
+                   </td>
+               </tr>
+        
+       
+               <tr class="config-row expandable config-row-alt1 notInherited">
+                  <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
+                   <td class="sig">
+
+                       <a id="Roo.form.NumberField-cfg-allowNegative" name=".allowNegative"></a>
+                       <div class="fixedFont">
+                               <b  class="itemname">allowNegative</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
+                               
+                               
+                       </div>
+                 
+                       <div class="mdesc">
+                           <div class="short">False to prevent entering a negative sign (defaults to true)</div> 
+                       </div>
+                       
+                       <div class="mdesc">
+                           <div class="long">False to prevent entering a negative sign (defaults to true)</div> 
+                       </div>
+                       
+                       
+
+                   </td>
+                   <td class="msource">
+                       
+                       Roo.form.NumberField
+                               
+                   </td>
+               </tr>
+        
+       
+               <tr class="config-row expandable config-row-alt0 notInherited">
+                  <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
+                   <td class="sig">
+
+                       <a id="Roo.form.NumberField-cfg-decimalPrecision" name=".decimalPrecision"></a>
+                       <div class="fixedFont">
+                               <b  class="itemname">decimalPrecision</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
+                               
+                               
+                       </div>
+                 
+                       <div class="mdesc">
+                           <div class="short">The maximum precision to display after the decimal separator (defaults to 2)</div> 
+                       </div>
+                       
+                       <div class="mdesc">
+                           <div class="long">The maximum precision to display after the decimal separator (defaults to 2)</div> 
+                       </div>
+                       
+                       
+
+                   </td>
+                   <td class="msource">
+                       
+                       Roo.form.NumberField
+                               
+                   </td>
+               </tr>
+        
+       
+               <tr class="config-row expandable config-row-alt1 notInherited">
+                  <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
+                   <td class="sig">
+
+                       <a id="Roo.form.NumberField-cfg-decimalSeparator" name=".decimalSeparator"></a>
+                       <div class="fixedFont">
+                               <b  class="itemname">decimalSeparator</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
+                               
+                               
+                       </div>
+                 
+                       <div class="mdesc">
+                           <div class="short">Character(s) to allow as the decimal separator (defaults to '.</div> 
+                       </div>
+                       
+                       <div class="mdesc">
+                           <div class="long">Character(s) to allow as the decimal separator (defaults to '.')</div> 
+                       </div>
+                       
+                       
+
+                   </td>
+                   <td class="msource">
+                       
+                       Roo.form.NumberField
+                               
+                   </td>
+               </tr>
+        
+       
+               <tr class="config-row expandable config-row-alt0 notInherited">
+                  <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
+                   <td class="sig">
+
+                       <a id="Roo.form.NumberField-cfg-fieldClass" name=".fieldClass"></a>
+                       <div class="fixedFont">
+                               <b  class="itemname">fieldClass</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
+                               
+                               
+                       </div>
+                 
+                       <div class="mdesc">
+                           <div class="short">The default CSS class for the field (defaults to "x-form-field x-form-num-field")</div> 
+                       </div>
+                       
+                       <div class="mdesc">
+                           <div class="long">The default CSS class for the field (defaults to "x-form-field x-form-num-field")</div> 
+                       </div>
+                       
+                       
+
+                   </td>
+                   <td class="msource">
+                       
+                       Roo.form.NumberField
+                               
+                   </td>
+               </tr>
+        
+       
+               <tr class="config-row expandable config-row-alt1 notInherited">
+                  <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
+                   <td class="sig">
+
+                       <a id="Roo.form.NumberField-cfg-maxText" name=".maxText"></a>
+                       <div class="fixedFont">
+                               <b  class="itemname">maxText</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
+                               
+                               
+                       </div>
+                 
+                       <div class="mdesc">
+                           <div class="short">Error text to display if the maximum value validation fails (defaults to "The maximum value for this field is {maxValue}")</div> 
+                       </div>
+                       
+                       <div class="mdesc">
+                           <div class="long">Error text to display if the maximum value validation fails (defaults to "The maximum value for this field is {maxValue}")</div> 
+                       </div>
+                       
+                       
+
+                   </td>
+                   <td class="msource">
+                       
+                       Roo.form.NumberField
+                               
+                   </td>
+               </tr>
+        
+       
+               <tr class="config-row expandable config-row-alt0 notInherited">
+                  <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
+                   <td class="sig">
+
+                       <a id="Roo.form.NumberField-cfg-maxValue" name=".maxValue"></a>
+                       <div class="fixedFont">
+                               <b  class="itemname">maxValue</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
+                               
+                               
+                       </div>
+                 
+                       <div class="mdesc">
+                           <div class="short">The maximum allowed value (defaults to Number.MAX_VALUE)</div> 
+                       </div>
+                       
+                       <div class="mdesc">
+                           <div class="long">The maximum allowed value (defaults to Number.MAX_VALUE)</div> 
+                       </div>
+                       
+                       
+
+                   </td>
+                   <td class="msource">
+                       
+                       Roo.form.NumberField
+                               
+                   </td>
+               </tr>
+        
+       
+               <tr class="config-row expandable config-row-alt1 notInherited">
+                  <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
+                   <td class="sig">
+
+                       <a id="Roo.form.NumberField-cfg-minText" name=".minText"></a>
+                       <div class="fixedFont">
+                               <b  class="itemname">minText</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
+                               
+                               
+                       </div>
+                 
+                       <div class="mdesc">
+                           <div class="short">Error text to display if the minimum value validation fails (defaults to "The minimum value for this field is {minValue}")</div> 
+                       </div>
+                       
+                       <div class="mdesc">
+                           <div class="long">Error text to display if the minimum value validation fails (defaults to "The minimum value for this field is {minValue}")</div> 
+                       </div>
+                       
+                       
+
+                   </td>
+                   <td class="msource">
+                       
+                       Roo.form.NumberField
+                               
+                   </td>
+               </tr>
+        
+       
+               <tr class="config-row expandable config-row-alt0 notInherited">
+                  <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
+                   <td class="sig">
+
+                       <a id="Roo.form.NumberField-cfg-minValue" name=".minValue"></a>
+                       <div class="fixedFont">
+                               <b  class="itemname">minValue</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
+                               
+                               
+                       </div>
+                 
+                       <div class="mdesc">
+                           <div class="short">The minimum allowed value (defaults to Number.NEGATIVE_INFINITY)</div> 
+                       </div>
+                       
+                       <div class="mdesc">
+                           <div class="long">The minimum allowed value (defaults to Number.NEGATIVE_INFINITY)</div> 
+                       </div>
+                       
+                       
+
+                   </td>
+                   <td class="msource">
+                       
+                       Roo.form.NumberField
+                               
+                   </td>
+               </tr>
+        
+       
+               <tr class="config-row expandable config-row-alt1 notInherited">
+                  <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
+                   <td class="sig">
+
+                       <a id="Roo.form.NumberField-cfg-nanText" name=".nanText"></a>
+                       <div class="fixedFont">
+                               <b  class="itemname">nanText</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
+                               
+                               
+                       </div>
+                 
+                       <div class="mdesc">
+                           <div class="short">Error text to display if the value is not a valid number.</div> 
+                       </div>
+                       
+                       <div class="mdesc">
+                           <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> 
+                       </div>
+                       
+                       
+
+                   </td>
+                   <td class="msource">
+                       
+                       Roo.form.NumberField
+                               
+                   </td>
+               </tr>
+        
+        
+    </table>
+               
+  
+  
+  
+  
+  
+  
+  
+  
+  <!-- ============================== public properties ==================== -->       
+  
+  
+  
+    <a id="Roo.form.NumberField-props"></a>      
+    
+    
+
+    
+    
+     <table cellspacing="0" class="member-table">
+      <caption class="Empty">Public Properties - Has None</caption>
+     </table>
+    
+    
+     
+    
+  <!-- ============================== methods summary / details ======================== -->
+  
+  
+  <a id="Roo.form.NumberField-methods"></a>
+       <!-- constructor?? -->
+       
+       <!-- static's first 
+       
+       
+       -->
+       
+       <!-- then dynamics first -->
+       
+  
+  
+    
+    
+    
+      <table cellspacing="0" class="member-table">
+      <caption>Public Methods</caption>
+        <tr>
+            <th class="sig-header" colspan="2">Method</th>            
+            <th class="msource-header">Defined By</th>
+
+        </tr>
+        
+       
+       
+        
+       
+        
+         
+          <tr class="method-row config-row-alt0 expandable notInherited">
+            <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
+          
+          
+            <td class="sig">
+                <a id="Roo.form-method-NumberField"   name=".NumberField"></a>
+               <div class="fixedFont">
+                       <span class="attributes">new <B>Roo.form.</B></span><b class="itemname">NumberField</b>
+                               
+                                (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>) 
+                       
+                               
+                       
+               </div>
+                <div class="mdesc">
+               
+                
+                       <div class="short">Create a new Roo.form.NumberField</div> 
+                
+                
+                    <div class="long">
+                       
+                       
+                       
+                               Create a new Roo.form.NumberField
+                       
+                       
+                               <dl class="detailList">
+                               <dt class="heading">Parameters:</dt>
+                               
+                                       <dt>
+                                               <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>
+                                               
+                                       </dt>
+                                       <dd>Configuration options</dd>
+                               
+                               </dl>
+                       
+                       
+                       
+                       
+                       
+                       
+                       
+
+                   
+                   
+                    
+                    </div>                    
+                </div>
+
+            </td>
+            <td class="msource">
+               &nbsp;
+            </td>
+        </tr>
+       
+                                                      
+    </table>
+
+  
+  <!-- ============================== events summary / details ======================== -->
+  
+  
+  <a id="Roo.form.NumberField-events"></a>
+    
+  
+       
+   
+    
+     <table cellspacing="0" class="member-table">
+      <caption class="Empty">Events - Has None</caption>
+     </table>
+    
+    
+  
+    
+    
+  
+  
+  
+<!-- ============================== footer ================================= -->
+               <div class="fineprint" style="clear:both">
+                       
+                       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)
+                       Based on 
+                       <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>  
+               </div>
+       </body>
+</html>