UNPKG

coffeescript-ui

Version:
676 lines (656 loc) 24.3 kB
<!DOCTYPE html> <html> <head> <meta charset='UTF-8'> <title>Coffeescript-UI Documentation</title> <script src='../../javascript/application.js'></script> <script src='../../javascript/search.js'></script> <link rel='stylesheet' href='../../stylesheets/application.css' type='text/css'> </head> <body> <div id='base' data-path='../../'></div> <div id='header'> <div id='menu'> <a href='../../alphabetical_index.html' title='Index'> Index </a> &raquo; <span class='title'>CUI</span> &raquo; <span class='title'>NumberInput</span> </div> </div> <div id='content'> <h1> Class: CUI.NumberInput </h1> <table class='box'> <tr> <td>Defined in:</td> <td>elements&#47;Input&#47;NumberInput.coffee</td> </tr> <tr> <td>Inherits:</td> <td> <a href='../../class/CUI/Input.html'>CUI.Input</a> </td> </tr> </table> <h2>Overview</h2> <div class='docstring'> <ul> <li>coffeescript-ui - Coffeescript User Interface System (CUI)</li> <li>Copyright (c) 2013 - 2016 Programmfabrik GmbH</li> <li>MIT Licence</li> <li><a href="https://github.com/programmfabrik/coffeescript-ui">https://github.com/programmfabrik/coffeescript-ui</a>, <a href="http://www.coffeescript-ui.org">http://www.coffeescript-ui.org</a></li> </ul> </div> <div class='tags'> </div> <h2>Variables Summary</h2> <h3 class='inherited'> Variable inherited from <a href='../../class/CUI/Input.html'>CUI.Input</a> </h3> <p class='inherited'> <a href='../../class/CUI/Input.html#uniqueId-variable'>uniqueId</a> <a href='../../class/CUI/DataField.html#changed_marker_css_class-variable'>changed_marker_css_class</a> <a href='../../class/CUI/DataField.html#defaults-variable'>defaults</a> </p> <h2>Class Method Summary</h2> <ul class='summary'> <li> <span class='signature'> <a href='#format-static'> . (void) <b>format</b><span>(v, opts = {})</span> </a> </span> <span class='desc'> </span> </li> </ul> <h2>Instance Method Summary</h2> <ul class='summary'> <li> <span class='signature'> <a href='#initOpts-dynamic'> # (void) <b>initOpts</b><span>()</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#readOpts-dynamic'> # (void) <b>readOpts</b><span>()</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#setMin-dynamic'> # (void) <b>setMin</b><span>(__min)</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#setMax-dynamic'> # (void) <b>setMax</b><span>(__max)</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#formatValueForDisplay-dynamic'> # (void) <b>formatValueForDisplay</b><span>(value, forInput = false)</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#getValue-dynamic'> # (void) <b>getValue</b><span>()</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#getValueForDisplay-dynamic'> # (void) <b>getValueForDisplay</b><span>()</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#getValueForStore-dynamic'> # (void) <b>getValueForStore</b><span>(value)</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#getDefaultValue-dynamic'> # (void) <b>getDefaultValue</b><span>()</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#setValue-dynamic'> # (void) <b>setValue</b><span>(v, flags = {})</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#checkValue-dynamic'> # (void) <b>checkValue</b><span>(v)</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#__addSymbol-dynamic'> # (void) <b>__addSymbol</b><span>(str)</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#__addSeparator-dynamic'> # (void) <b>__addSeparator</b><span>(str)</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#correctValueForInput-dynamic'> # (void) <b>correctValueForInput</b><span>(value)</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#getValueForInput-dynamic'> # (void) <b>getValueForInput</b><span>()</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#checkInput-dynamic'> # (void) <b>checkInput</b><span>(value)</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#__checkInput-dynamic'> # (void) <b>__checkInput</b><span>(value)</span> </a> </span> <span class='desc'> </span> </li> </ul> <h2> <small>Inherited Method Summary</small> <h3 class='inherited'> Methods inherited from <a href='../../class/CUI/Input.html'>CUI.Input</a> </h3> <p class='inherited'> <a href='../../class/CUI/Input.html#initOpts-dynamic'>#initOpts</a> <a href='../../class/CUI/Input.html#readOpts-dynamic'>#readOpts</a> <a href='../../class/CUI/Input.html#__checkInputRegexp-dynamic'>#__checkInputRegexp</a> <a href='../../class/CUI/Input.html#setSpellcheck-dynamic'>#setSpellcheck</a> <a href='../../class/CUI/Input.html#setPlaceholder-dynamic'>#setPlaceholder</a> <a href='../../class/CUI/Input.html#getPlaceholder-dynamic'>#getPlaceholder</a> <a href='../../class/CUI/Input.html#__createElement-dynamic'>#__createElement</a> <a href='../../class/CUI/Input.html#__setCursor-dynamic'>#__setCursor</a> <a href='../../class/CUI/Input.html#getValueForStore-dynamic'>#getValueForStore</a> <a href='../../class/CUI/Input.html#storeValue-dynamic'>#storeValue</a> <a href='../../class/CUI/Input.html#handleSelectionChange-dynamic'>#handleSelectionChange</a> <a href='../../class/CUI/Input.html#getElement-dynamic'>#getElement</a> <a href='../../class/CUI/Input.html#getUniqueIdForLabel-dynamic'>#getUniqueIdForLabel</a> <a href='../../class/CUI/Input.html#markBlock-dynamic'>#markBlock</a> <a href='../../class/CUI/Input.html#remove-dynamic'>#remove</a> <a href='../../class/CUI/Input.html#__focusShadowInput-dynamic'>#__focusShadowInput</a> <a href='../../class/CUI/Input.html#__unfocusShadowInput-dynamic'>#__unfocusShadowInput</a> <a href='../../class/CUI/Input.html#hasShadowFocus-dynamic'>#hasShadowFocus</a> <a href='../../class/CUI/Input.html#setContentSize-dynamic'>#setContentSize</a> <a href='../../class/CUI/Input.html#__initContentSize-dynamic'>#__initContentSize</a> <a href='../../class/CUI/Input.html#__setContentSize-dynamic'>#__setContentSize</a> <a href='../../class/CUI/Input.html#checkBlocks-dynamic'>#checkBlocks</a> <a href='../../class/CUI/Input.html#getInputBlocks-dynamic'>#getInputBlocks</a> <a href='../../class/CUI/Input.html#__getInputBlocks-dynamic'>#__getInputBlocks</a> <a href='../../class/CUI/Input.html#__overwriteBlocks-dynamic'>#__overwriteBlocks</a> <a href='../../class/CUI/Input.html#getMarkedBlock-dynamic'>#getMarkedBlock</a> <a href='../../class/CUI/Input.html#getSelection-dynamic'>#getSelection</a> <a href='../../class/CUI/Input.html#setSelection-dynamic'>#setSelection</a> <a href='../../class/CUI/Input.html#selectAll-dynamic'>#selectAll</a> <a href='../../class/CUI/Input.html#updateSelection-dynamic'>#updateSelection</a> <a href='../../class/CUI/Input.html#setValue-dynamic'>#setValue</a> <a href='../../class/CUI/Input.html#incNumberBounds-dynamic'>#incNumberBounds</a> <a href='../../class/CUI/Input.html#__removeContentSize-dynamic'>#__removeContentSize</a> <a href='../../class/CUI/Input.html#__removeShadowInput-dynamic'>#__removeShadowInput</a> <a href='../../class/CUI/Input.html#preventInvalidInput-dynamic'>#preventInvalidInput</a> <a href='../../class/CUI/Input.html#__initShadowInput-dynamic'>#__initShadowInput</a> <a href='../../class/CUI/Input.html#__shadowInput-dynamic'>#__shadowInput</a> <a href='../../class/CUI/Input.html#checkValue-dynamic'>#checkValue</a> <a href='../../class/CUI/Input.html#render-dynamic'>#render</a> <a href='../../class/CUI/Input.html#getTemplateKeyForRender-dynamic'>#getTemplateKeyForRender</a> <a href='../../class/CUI/Input.html#isRequired-dynamic'>#isRequired</a> <a href='../../class/CUI/Input.html#updateInputState-dynamic'>#updateInputState</a> <a href='../../class/CUI/Input.html#getInputState-dynamic'>#getInputState</a> <a href='../../class/CUI/Input.html#leaveInput-dynamic'>#leaveInput</a> <a href='../../class/CUI/Input.html#enterInput-dynamic'>#enterInput</a> <a href='../../class/CUI/Input.html#hasUserInput-dynamic'>#hasUserInput</a> <a href='../../class/CUI/Input.html#checkInput-dynamic'>#checkInput</a> <a href='../../class/CUI/Input.html#__checkInputInternal-dynamic'>#__checkInputInternal</a> <a href='../../class/CUI/Input.html#setInputHint-dynamic'>#setInputHint</a> <a href='../../class/CUI/Input.html#setInvalidHint-dynamic'>#setInvalidHint</a> <a href='../../class/CUI/Input.html#setValidHint-dynamic'>#setValidHint</a> <a href='../../class/CUI/Input.html#displayValue-dynamic'>#displayValue</a> <a href='../../class/CUI/Input.html#getValueForDisplay-dynamic'>#getValueForDisplay</a> <a href='../../class/CUI/Input.html#getValueForInput-dynamic'>#getValueForInput</a> <a href='../../class/CUI/Input.html#correctValueForInput-dynamic'>#correctValueForInput</a> <a href='../../class/CUI/Input.html#getDefaultValue-dynamic'>#getDefaultValue</a> <a href='../../class/CUI/Input.html#getValue-dynamic'>#getValue</a> <a href='../../class/CUI/Input.html#enable-dynamic'>#enable</a> <a href='../../class/CUI/Input.html#disable-dynamic'>#disable</a> <a href='../../class/CUI/Input.html#focus-dynamic'>#focus</a> <a href='../../class/CUI/Input.html#getCursorBlocks-dynamic'>#getCursorBlocks</a> <a href='../../class/CUI/Input.html#findBlock-dynamic'>#findBlock</a> <a href='../../class/CUI/Input.html#initCursor-dynamic'>#initCursor</a> <a href='../../class/CUI/Input.html#showCursor-dynamic'>#showCursor</a> <a href='../../class/CUI/Input.html#checkSelectionChange-dynamic'>#checkSelectionChange</a> <a href='../../class/CUI/Input.html#getRangeFromCursor-dynamic'>#getRangeFromCursor</a> <a href='../../class/CUI/Input.html#moveCursor-dynamic'>#moveCursor</a> <a href='../../class/CUI/Input.html#destroy-dynamic'>#destroy</a> <a href='../../class/CUI/DataFieldInput.html#getGroup-dynamic'>#getGroup</a> <a href='../../class/CUI/DataFieldInput.html#isResizable-dynamic'>#isResizable</a> <a href='../../class/CUI/DataField.html#maximizeAddClasses-dynamic'>#maximizeAddClasses</a> <a href='../../class/CUI/DataField.html#initTemplate-dynamic'>#initTemplate</a> <a href='../../class/CUI/DataField.html#getTemplate-dynamic'>#getTemplate</a> <a href='../../class/CUI/DataField.html#init-dynamic'>#init</a> <a href='../../class/CUI/DataField.html#debug-dynamic'>#debug</a> <a href='../../class/CUI/DataField.html#reload-dynamic'>#reload</a> <a href='../../class/CUI/DataField.html#getNameOpt-dynamic'>#getNameOpt</a> <a href='../../class/CUI/DataField.html#registerLabel-dynamic'>#registerLabel</a> <a href='../../class/CUI/DataField.html#getLabel-dynamic'>#getLabel</a> <a href='../../class/CUI/DataField.html#setForm-dynamic'>#setForm</a> <a href='../../class/CUI/DataField.html#getFormDepth-dynamic'>#getFormDepth</a> <a href='../../class/CUI/DataField.html#setFormDepth-dynamic'>#setFormDepth</a> <a href='../../class/CUI/DataField.html#getFormPath-dynamic'>#getFormPath</a> <a href='../../class/CUI/DataField.html#getForm-dynamic'>#getForm</a> <a href='../../class/CUI/DataField.html#getOtherField-dynamic'>#getOtherField</a> <a href='../../class/CUI/DataField.html#getRootForm-dynamic'>#getRootForm</a> <a href='../../class/CUI/DataField.html#__initDisabled-dynamic'>#__initDisabled</a> <a href='../../class/CUI/DataField.html#isDisabled-dynamic'>#isDisabled</a> <a href='../../class/CUI/DataField.html#isHidden-dynamic'>#isHidden</a> <a href='../../class/CUI/DataField.html#isShown-dynamic'>#isShown</a> <a href='../../class/CUI/DataField.html#updateData-dynamic'>#updateData</a> <a href='../../class/CUI/DataField.html#setData-dynamic'>#setData</a> <a href='../../class/CUI/DataField.html#setDataOnOthers-dynamic'>#setDataOnOthers</a> <a href='../../class/CUI/DataField.html#hide-dynamic'>#hide</a> <a href='../../class/CUI/DataField.html#show-dynamic'>#show</a> <a href='../../class/CUI/DataField.html#isRendered-dynamic'>#isRendered</a> <a href='../../class/CUI/DataField.html#start-dynamic'>#start</a> <a href='../../class/CUI/DataField.html#getAllDataFields-dynamic'>#getAllDataFields</a> <a href='../../class/CUI/DataField.html#getDataFields-dynamic'>#getDataFields</a> <a href='../../class/CUI/DataField.html#renderAsBlock-dynamic'>#renderAsBlock</a> <a href='../../class/CUI/DataField.html#isDataField-dynamic'>#isDataField</a> <a href='../../class/CUI/DataField.html#callOnOthers-dynamic'>#callOnOthers</a> <a href='../../class/CUI/DataField.html#getData-dynamic'>#getData</a> <a href='../../class/CUI/DataField.html#hasData-dynamic'>#hasData</a> <a href='../../class/CUI/DataField.html#hasUserData-dynamic'>#hasUserData</a> <a href='../../class/CUI/DataField.html#getArrayFromOpt-dynamic'>#getArrayFromOpt</a> <a href='../../class/CUI/DataField.html#getName-dynamic'>#getName</a> <a href='../../class/CUI/DataField.html#getInitValue-dynamic'>#getInitValue</a> <a href='../../class/CUI/DataField.html#getLastValue-dynamic'>#getLastValue</a> <a href='../../class/CUI/DataField.html#reset-dynamic'>#reset</a> <a href='../../class/CUI/DataField.html#undo-dynamic'>#undo</a> <a href='../../class/CUI/DataField.html#redo-dynamic'>#redo</a> <a href='../../class/CUI/DataField.html#goto-dynamic'>#goto</a> <a href='../../class/CUI/DataField.html#initData-dynamic'>#initData</a> <a href='../../class/CUI/DataField.html#initValue-dynamic'>#initValue</a> <a href='../../class/CUI/DataField.html#setCheckChangedValue-dynamic'>#setCheckChangedValue</a> <a href='../../class/CUI/DataField.html#getCheckChangedValue-dynamic'>#getCheckChangedValue</a> <a href='../../class/CUI/DataField.html#getUndo-dynamic'>#getUndo</a> <a href='../../class/CUI/DataField.html#triggerDataChanged-dynamic'>#triggerDataChanged</a> <a href='../../class/CUI/DataField.html#isChanged-dynamic'>#isChanged</a> <a href='../../class/CUI/DataField.html#checkChanged-dynamic'>#checkChanged</a> <a href='../../class/CUI/DataField.html#getChangedMarker-dynamic'>#getChangedMarker</a> <a href='../../class/CUI/DataField.html#new-static'>.new</a> <a href='../../class/CUI/DOMElement.html#registerTemplate-dynamic'>#registerTemplate</a> <a href='../../class/CUI/DOMElement.html#getDOMElementClasses-dynamic'>#getDOMElementClasses</a> <a href='../../class/CUI/DOMElement.html#registerDOMElement-dynamic'>#registerDOMElement</a> <a href='../../class/CUI/DOMElement.html#getElementForLayer-dynamic'>#getElementForLayer</a> <a href='../../class/CUI/DOMElement.html#unregisterDOMElement-dynamic'>#unregisterDOMElement</a> <a href='../../class/CUI/DOMElement.html#__assertDOMElement-dynamic'>#__assertDOMElement</a> <a href='../../class/CUI/DOMElement.html#__assertTemplateElement-dynamic'>#__assertTemplateElement</a> <a href='../../class/CUI/DOMElement.html#addClass-dynamic'>#addClass</a> <a href='../../class/CUI/DOMElement.html#setAria-dynamic'>#setAria</a> <a href='../../class/CUI/DOMElement.html#removeClass-dynamic'>#removeClass</a> <a href='../../class/CUI/DOMElement.html#hasClass-dynamic'>#hasClass</a> <a href='../../class/CUI/DOMElement.html#isDestroyed-dynamic'>#isDestroyed</a> <a href='../../class/CUI/DOMElement.html#empty-dynamic'>#empty</a> <a href='../../class/CUI/DOMElement.html#replace-dynamic'>#replace</a> <a href='../../class/CUI/DOMElement.html#append-dynamic'>#append</a> <a href='../../class/CUI/DOMElement.html#prepend-dynamic'>#prepend</a> <a href='../../class/CUI/DOMElement.html#text-dynamic'>#text</a> <a href='../../class/CUI/DOMElement.html#get-dynamic'>#get</a> <a href='../../class/CUI/DOMElement.html#getFlexHandle-dynamic'>#getFlexHandle</a> <a href='../../class/CUI/Element.html#getElementClass-dynamic'>#getElementClass</a> <a href='../../class/CUI/Element.html#getUniqueId-dynamic'>#getUniqueId</a> <a href='../../class/CUI/Element.html#getOpts-dynamic'>#getOpts</a> <a href='../../class/CUI/Element.html#getOpt-dynamic'>#getOpt</a> <a href='../../class/CUI/Element.html#hasOpt-dynamic'>#hasOpt</a> <a href='../../class/CUI/Element.html#getSetOpt-dynamic'>#getSetOpt</a> <a href='../../class/CUI/Element.html#hasSetOpt-dynamic'>#hasSetOpt</a> <a href='../../class/CUI/Element.html#copy-dynamic'>#copy</a> <a href='../../class/CUI/Element.html#mergeOpt-dynamic'>#mergeOpt</a> <a href='../../class/CUI/Element.html#removeOpt-dynamic'>#removeOpt</a> <a href='../../class/CUI/Element.html#addOpt-dynamic'>#addOpt</a> <a href='../../class/CUI/Element.html#addOpts-dynamic'>#addOpts</a> <a href='../../class/CUI/Element.html#mergeOpts-dynamic'>#mergeOpts</a> <a href='../../class/CUI/Element.html#__getCheckMap-dynamic'>#__getCheckMap</a> <a href='../../class/CUI/Element.html#readOptsFromAttr-dynamic'>#readOptsFromAttr</a> <a href='../../class/CUI/Element.html#proxy-dynamic'>#proxy</a> <a href='../../class/CUI/Element.html#getOptKeys-static'>.getOptKeys</a> </p> </h2> <h2>Class Method Details</h2> <div class='methods'> <div class='method_details'> <p class='signature' id='format-static'> . (void) <b>format</b><span>(v, opts = {})</span> <br> </p> </div> </div> <h2>Instance Method Details</h2> <div class='methods'> <div class='method_details'> <p class='signature' id='initOpts-dynamic'> # (void) <b>initOpts</b><span>()</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='readOpts-dynamic'> # (void) <b>readOpts</b><span>()</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='setMin-dynamic'> # (void) <b>setMin</b><span>(__min)</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='setMax-dynamic'> # (void) <b>setMax</b><span>(__max)</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='formatValueForDisplay-dynamic'> # (void) <b>formatValueForDisplay</b><span>(value, forInput = false)</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='getValue-dynamic'> # (void) <b>getValue</b><span>()</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='getValueForDisplay-dynamic'> # (void) <b>getValueForDisplay</b><span>()</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='getValueForStore-dynamic'> # (void) <b>getValueForStore</b><span>(value)</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='getDefaultValue-dynamic'> # (void) <b>getDefaultValue</b><span>()</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='setValue-dynamic'> # (void) <b>setValue</b><span>(v, flags = {})</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='checkValue-dynamic'> # (void) <b>checkValue</b><span>(v)</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='__addSymbol-dynamic'> # (void) <b>__addSymbol</b><span>(str)</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='__addSeparator-dynamic'> # (void) <b>__addSeparator</b><span>(str)</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='correctValueForInput-dynamic'> # (void) <b>correctValueForInput</b><span>(value)</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='getValueForInput-dynamic'> # (void) <b>getValueForInput</b><span>()</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='checkInput-dynamic'> # (void) <b>checkInput</b><span>(value)</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='__checkInput-dynamic'> # (void) <b>__checkInput</b><span>(value)</span> <br> </p> </div> </div> </div> <div id='footer'> By <a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'> Codo </a> 2.1.2 &#10034; Press H to see the keyboard shortcuts &#10034; <a href='http://twitter.com/netzpirat' target='_parent'>@netzpirat</a> &#10034; <a href='http://twitter.com/_inossidabile' target='_parent'>@_inossidabile</a> </div> <iframe id='search_frame'></iframe> <div id='fuzzySearch'> <input type='text'> <ol></ol> </div> <div id='help'> <p> Quickly fuzzy find classes, mixins, methods, file: </p> <ul> <li> <span>T</span> Open fuzzy finder dialog </li> </ul> <p> Control the navigation frame: </p> <ul> <li> <span>L</span> Toggle list view </li> <li> <span>C</span> Show class list </li> <li> <span>I</span> Show mixin list </li> <li> <span>F</span> Show file list </li> <li> <span>M</span> Show method list </li> <li> <span>E</span> Show extras list </li> </ul> <p> You can focus and blur the search input: </p> <ul> <li> <span>S</span> Focus search input </li> <li> <span>Esc</span> Blur search input </li> </ul> </div> </body> </html>