docs/XV.NumberWidget.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>JSDoc: Class: NumberWidget</title>
    
    <script src="scripts/prettify/prettify.js"> </script>
    <script src="scripts/prettify/lang-css.js"> </script>
    <!--[if lt IE 9]>
      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
    <![endif]-->
    <link type="text/css" rel="stylesheet" href="styles/prettify-jsdoc.css">
    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>

<body>

<div id="main">
    
    <h1 class="page-title">Class: NumberWidget</h1>
    
    
<section>
    
<header>
    <h2>
        <span class="ancestors"><a href="XV.html">XV</a>.</span>
    
    NumberWidget
    </h2>
    
        <div class="class-description">An input control consisting of fittable columns: label, decorator, and input field.<br />
    Use to implement an input field for strings that represents a number, such as prices.</div>
    
</header>  

<article>
    <div class="container-overview">
    
    
<dt>
    <h4 class="name" id="NumberWidget"><span class="type-signature"></span>new NumberWidget</h4>
    
    
</dt>
<dd>
    
    
<dl class="details">
    
        
	<dt class="tag-source">Source:</dt>
	<dd class="tag-source"><ul class="dummy"><li>number.js, line 47</li></ul></dd>
	
    
</dl>

    
</dd>

    
    </div>
    
    
        <h3 class="subsection-title">Extends</h3>
        
        <ul>
            <li><a href="XV.Number.html">XV.Number</a></li>
        </ul>
    
    
        <h3 class="subsection-title">Methods</h3>
        
        <dl>
            
<dt>
    <h4 class="name" id="clear"><span class="type-signature"></span>clear</h4>
    
    
</dt>
<dd>
    
    
<dl class="details">
    
        
	<dt class="inherited-from">Inherited From:</dt>
	<dd class="inherited-from"><ul class="dummy"><li>
		<a href="XV.Number.html#clear">XV.Number#clear</a>
	</li></dd>
	
	
	<dt class="tag-source">Source:</dt>
	<dd class="tag-source"><ul class="dummy"><li>input.js, line 40</li></ul></dd>
	
    
	<dt class="tag-todo">To Do:</dt>
	<dd class="tag-todo">
        <ul>
            <li>Document the clear method.</li>
        </ul>
	</dd>
	
</dl>

    
</dd>

        
<dt>
    <h4 class="name" id="create"><span class="type-signature"></span>create</h4>
    
    
</dt>
<dd>
    
    
<dl class="details">
    
        
	<dt class="tag-source">Source:</dt>
	<dd class="tag-source"><ul class="dummy"><li>number.js, line 74</li></ul></dd>
	
    
	<dt class="tag-todo">To Do:</dt>
	<dd class="tag-todo">
        <ul>
            <li>Document the create method.</li>
        </ul>
	</dd>
	
</dl>

    
</dd>

        
<dt>
    <h4 class="name" id="disabledChanged"><span class="type-signature"></span>disabledChanged</h4>
    
    
</dt>
<dd>
    
    
<dl class="details">
    
        
	<dt class="inherited-from">Inherited From:</dt>
	<dd class="inherited-from"><ul class="dummy"><li>
		<a href="XV.Number.html#disabledChanged">XV.Number#disabledChanged</a>
	</li></dd>
	
	
	<dt class="tag-source">Source:</dt>
	<dd class="tag-source"><ul class="dummy"><li>input.js, line 54</li></ul></dd>
	
    
	<dt class="tag-todo">To Do:</dt>
	<dd class="tag-todo">
        <ul>
            <li>Document the disabledChanged method.</li>
        </ul>
	</dd>
	
</dl>

    
</dd>

        
<dt>
    <h4 class="name" id="focus"><span class="type-signature"></span>focus</h4>
    
    
</dt>
<dd>
    
    
<dl class="details">
    
        
	<dt class="inherited-from">Inherited From:</dt>
	<dd class="inherited-from"><ul class="dummy"><li>
		<a href="XV.Number.html#focus">XV.Number#focus</a>
	</li></dd>
	
	
	<dt class="tag-source">Source:</dt>
	<dd class="tag-source"><ul class="dummy"><li>input.js, line 60</li></ul></dd>
	
    
	<dt class="tag-todo">To Do:</dt>
	<dd class="tag-todo">
        <ul>
            <li>Document the focus method.</li>
        </ul>
	</dd>
	
</dl>

    
</dd>

        
<dt>
    <h4 class="name" id="inputChanged"><span class="type-signature"></span>inputChanged</h4>
    
    
</dt>
<dd>
    
    
<dl class="details">
    
        
	<dt class="inherited-from">Inherited From:</dt>
	<dd class="inherited-from"><ul class="dummy"><li>
		<a href="XV.Number.html#inputChanged">XV.Number#inputChanged</a>
	</li></dd>
	
	
	<dt class="tag-source">Source:</dt>
	<dd class="tag-source"><ul class="dummy"><li>input.js, line 66</li></ul></dd>
	
    
	<dt class="tag-todo">To Do:</dt>
	<dd class="tag-todo">
        <ul>
            <li>Document the inputChanged method.</li>
        </ul>
	</dd>
	
</dl>

    
</dd>

        
<dt>
    <h4 class="name" id="keyDown"><span class="type-signature"></span>keyDown</h4>
    
    
</dt>
<dd>
    
    
<dl class="details">
    
        
	<dt class="tag-source">Source:</dt>
	<dd class="tag-source"><ul class="dummy"><li>number.js, line 82</li></ul></dd>
	
    
	<dt class="tag-todo">To Do:</dt>
	<dd class="tag-todo">
        <ul>
            <li>Revisit or remove after enyo fix to ENYO-1104.</li>
        </ul>
	</dd>
	
</dl>

    
</dd>

        
<dt>
    <h4 class="name" id="labelChanged"><span class="type-signature"></span>labelChanged</h4>
    
    
</dt>
<dd>
    
    
<dl class="details">
    
        
	<dt class="tag-source">Source:</dt>
	<dd class="tag-source"><ul class="dummy"><li>number.js, line 93</li></ul></dd>
	
    
	<dt class="tag-todo">To Do:</dt>
	<dd class="tag-todo">
        <ul>
            <li>Document the labelChanged method.</li>
        </ul>
	</dd>
	
</dl>

    
</dd>

        
<dt>
    <h4 class="name" id="placeholderChanged"><span class="type-signature"></span>placeholderChanged</h4>
    
    
</dt>
<dd>
    
    
<dl class="details">
    
        
	<dt class="inherited-from">Inherited From:</dt>
	<dd class="inherited-from"><ul class="dummy"><li>
		<a href="XV.Number.html#placeholderChanged">XV.Number#placeholderChanged</a>
	</li></dd>
	
	
	<dt class="tag-source">Source:</dt>
	<dd class="tag-source"><ul class="dummy"><li>input.js, line 90</li></ul></dd>
	
    
	<dt class="tag-todo">To Do:</dt>
	<dd class="tag-todo">
        <ul>
            <li>Document the placeholderChanged method.</li>
        </ul>
	</dd>
	
</dl>

    
</dd>

        
<dt>
    <h4 class="name" id="receiveBlur"><span class="type-signature"></span>receiveBlur</h4>
    
    
</dt>
<dd>
    
    
<dl class="details">
    
        
	<dt class="inherited-from">Inherited From:</dt>
	<dd class="inherited-from"><ul class="dummy"><li>
		<a href="XV.Number.html#receiveBlur">XV.Number#receiveBlur</a>
	</li></dd>
	
	
	<dt class="tag-source">Source:</dt>
	<dd class="tag-source"><ul class="dummy"><li>input.js, line 97</li></ul></dd>
	
    
	<dt class="tag-todo">To Do:</dt>
	<dd class="tag-todo">
        <ul>
            <li>Document the receiveBlur method.</li>
        </ul>
	</dd>
	
</dl>

    
</dd>

        
<dt>
    <h4 class="name" id="setDisabled"><span class="type-signature"></span>setDisabled</h4>
    
    
</dt>
<dd>
    
    
<dl class="details">
    
        
	<dt class="inherited-from">Inherited From:</dt>
	<dd class="inherited-from"><ul class="dummy"><li>
		<a href="XV.Number.html#setDisabled">XV.Number#setDisabled</a>
	</li></dd>
	
	
	<dt class="tag-source">Source:</dt>
	<dd class="tag-source"><ul class="dummy"><li>input.js, line 139</li></ul></dd>
	
    
	<dt class="tag-todo">To Do:</dt>
	<dd class="tag-todo">
        <ul>
            <li>Document the setDisabled method.</li>
        </ul>
	</dd>
	
</dl>

    
</dd>

        
<dt>
    <h4 class="name" id="setInputStyle"><span class="type-signature"></span>setInputStyle</h4>
    
    
</dt>
<dd>
    
    
<dl class="details">
    
        
	<dt class="inherited-from">Inherited From:</dt>
	<dd class="inherited-from"><ul class="dummy"><li>
		<a href="XV.Number.html#setInputStyle">XV.Number#setInputStyle</a>
	</li></dd>
	
	
	<dt class="tag-source">Source:</dt>
	<dd class="tag-source"><ul class="dummy"><li>input.js, line 133</li></ul></dd>
	
    
	<dt class="tag-todo">To Do:</dt>
	<dd class="tag-todo">
        <ul>
            <li>Document the setInputStyle method.</li>
        </ul>
	</dd>
	
</dl>

    
</dd>

        
<dt>
    <h4 class="name" id="setValue"><span class="type-signature"></span>setValue</h4>
    
    
</dt>
<dd>
    
    
<dl class="details">
    
        
	<dt class="inherited-from">Inherited From:</dt>
	<dd class="inherited-from"><ul class="dummy"><li>
		<a href="XV.Number.html#setValue">XV.Number#setValue</a>
	</li></dd>
	
	
	<dt class="tag-source">Source:</dt>
	<dd class="tag-source"><ul class="dummy"><li>number.js, line 22</li></ul></dd>
	
    
	<dt class="tag-todo">To Do:</dt>
	<dd class="tag-todo">
        <ul>
            <li>Document the setValue method.</li>
        </ul>
	</dd>
	
</dl>

    
</dd>

        
<dt>
    <h4 class="name" id="showLabelChanged"><span class="type-signature"></span>showLabelChanged</h4>
    
    
</dt>
<dd>
    
    
<dl class="details">
    
        
	<dt class="tag-source">Source:</dt>
	<dd class="tag-source"><ul class="dummy"><li>number.js, line 100</li></ul></dd>
	
    
	<dt class="tag-todo">To Do:</dt>
	<dd class="tag-todo">
        <ul>
            <li>Document the showLabelChanged method.</li>
        </ul>
	</dd>
	
</dl>

    
</dd>

        
<dt>
    <h4 class="name" id="validate"><span class="type-signature"></span>validate</h4>
    
    
</dt>
<dd>
    
    
    <div class="description">
        Determines whether the user input is numeric.
      Validates value, whether set programatically or via user input. Gracefully handles
      commas, periods, etc per the set culture using Globalize.
    </div>
    

        <h5>Parameters:</h5>
        

<table class="params">
    <thead>
	<tr>
		
		<th>Name</th>
		
		
		<th>Type</th>
		
		
		<th class="last">Description</th>
	</tr>
	</thead>
	
	<tbody>
	
	
        <tr>
            
                <td class="name"><code>Number</code></td>
            
            
            <td class="type">
            
                
<span class="param-type">String</span>


            </td>
            
            
            <td class="description last">(string) to be validated.</td>
        </tr>
	
	
	</tbody>
</table>
    
    
<dl class="details">
    
        
	<dt class="inherited-from">Inherited From:</dt>
	<dd class="inherited-from"><ul class="dummy"><li>
		<a href="XV.Number.html#validate">XV.Number#validate</a>
	</li></dd>
	
	
	<dt class="tag-source">Source:</dt>
	<dd class="tag-source"><ul class="dummy"><li>number.js, line 34</li></ul></dd>
	
    
</dl>

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    The value if it is valid, otherwise false.
</div>


</dd>

        
<dt>
    <h4 class="name" id="valueChanged"><span class="type-signature"></span>valueChanged</h4>
    
    
</dt>
<dd>
    
    
<dl class="details">
    
        
	<dt class="inherited-from">Inherited From:</dt>
	<dd class="inherited-from"><ul class="dummy"><li>
		<a href="XV.Number.html#valueChanged">XV.Number#valueChanged</a>
	</li></dd>
	
	
	<dt class="tag-source">Source:</dt>
	<dd class="tag-source"><ul class="dummy"><li>number.js, line 41</li></ul></dd>
	
    
	<dt class="tag-todo">To Do:</dt>
	<dd class="tag-todo">
        <ul>
            <li>Document the valueChanged method.</li>
        </ul>
	</dd>
	
</dl>

    
</dd>

        </dl>
    
    
</article>

</section>  


</div>

<nav>
    <h2><a href="index.html">Index</a></h2><h3>Classes</h3><ul><li><a href="XV.html">XV</a></li><li><a href="XV.AddressWidget.html">AddressWidget</a></li><li><a href="XV.AssignmentBox.html">AssignmentBox</a></li><li><a href="XV.CharacteristicItem.html">CharacteristicItem</a></li><li><a href="XV.CharacteristicPicker.html">CharacteristicPicker</a></li><li><a href="XV.CharacteristicsWidget.html">CharacteristicsWidget</a></li><li><a href="XV.Checkbox.html">Checkbox</a></li><li><a href="XV.CheckboxWidget.html">CheckboxWidget</a></li><li><a href="XV.Combobox.html">Combobox</a></li><li><a href="XV.CommentBox.html">CommentBox</a></li><li><a href="XV.CommentBoxItem.html">CommentBoxItem</a></li><li><a href="XV.CommentTypePicker.html">CommentTypePicker</a></li><li><a href="XV.Completer.html">Completer</a></li><li><a href="XV.CountryCombobox.html">CountryCombobox</a></li><li><a href="XV.Date.html">Date</a></li><li><a href="XV.DateWidget.html">DateWidget</a></li><li><a href="XV.DocumentListRelations.html">DocumentListRelations</a></li><li><a href="XV.DocumentsBox.html">DocumentsBox</a></li><li><a href="XV.EditorMixin.html">EditorMixin</a></li><li><a href="XV.ExtensionsMixin.html">ExtensionsMixin</a></li><li><a href="XV.FileInput.html">FileInput</a></li><li><a href="XV.Groupbox.html">Groupbox</a></li><li><a href="XV.Input.html">Input</a></li><li><a href="XV.InputWidget.html">InputWidget</a></li><li><a href="XV.List.html">List</a></li><li><a href="XV.ListAttr.html">ListAttr</a></li><li><a href="XV.ListColumn.html">ListColumn</a></li><li><a href="XV.ListItem.html">ListItem</a></li><li><a href="XV.ListRelations.html">ListRelations</a></li><li><a href="XV.ListRelationsBox.html">ListRelationsBox</a></li><li><a href="XV.ListRelationsEditorBox.html">ListRelationsEditorBox</a></li><li><a href="XV.MenuItem.html">MenuItem</a></li><li><a href="XV.Navigator.html">Navigator</a></li><li><a href="XV.Number.html">Number</a></li><li><a href="XV.NumberWidget.html">NumberWidget</a></li><li><a href="XV.OptionsPicker.html">OptionsPicker</a></li><li><a href="XV.ParameterItem.html">ParameterItem</a></li><li><a href="XV.ParameterWidget.html">ParameterWidget</a></li><li><a href="XV.PickerWidget.html">PickerWidget</a></li><li><a href="XV.RelationsEditor.html">RelationsEditor</a></li><li><a href="XV.RelationWidget.html">RelationWidget</a></li><li><a href="XV.ScreenCarousel.html">ScreenCarousel</a></li><li><a href="XV.ScrollableGroupbox.html">ScrollableGroupbox</a></li><li><a href="XV.Scroller.html">Scroller</a></li><li><a href="XV.SearchContainer.html">SearchContainer</a></li><li><a href="XV.StateCombobox.html">StateCombobox</a></li><li><a href="XV.TextArea.html">TextArea</a></li><li><a href="XV.ToggleButton.html">ToggleButton</a></li><li><a href="XV.ToggleButtonWidget.html">ToggleButtonWidget</a></li><li><a href="XV.Workspace.html">Workspace</a></li><li><a href="XV.WorkspaceContainer.html">WorkspaceContainer</a></li></ul><h3>Global</h3><ul><li><a href="global.html#destroy">destroy</a></li><li><a href="global.html#setValue">setValue</a></li></ul>
</nav>

<br clear="both">

<footer>
    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3</a> on Tue Nov 27 2012 20:13:48 GMT-0600 (CST)
</footer>

<script> prettyPrint(); </script>
</body>
</html>