coffeescript-ui

<!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> » CUI » Button </div> </div> <div id='content'> <h1> Class: CUI.Button </h1> <table class='box'> <tr> <td>Defined in:</td> <td>elements/Button/Button.coffee</td> </tr> <tr> <td>Inherits:</td> <td> <a href='../../class/CUI/DOMElement.html'>CUI.DOMElement</a> </td> </tr> </table> <h2>Direct Known Subclasses</h2> <a href='../../class/CUI/ButtonHref.html'>CUI.ButtonHref</a> <a href='../../class/CUI/FileUploadButton.html'>CUI.FileUploadButton</a> <h2>Variables Summary</h2> <dl class='constants'> <dt id='defaults-variable'> defaults = </dt> <dd> <pre><code class='coffeescript'>{ confirm_ok: "Ok", confirm_icon: "question", confirm_cancel: "Cancel", confirm_title: "Confirmation", disabled_css_class: "cui-disabled", active_css_class: "cui-active" }</code></pre> </dd> <dt id='clickTypes-variable'> clickTypes = </dt> <dd> <pre><code class='coffeescript'>{ click: ['click'], mouseup: ['mouseup'], dblclick: ['dblclick'] }</code></pre> </dd> <dt id='clickTypesPrevent-variable'> clickTypesPrevent = </dt> <dd> <pre><code class='coffeescript'>{ click: ['dblclick', 'mousedown'], mouseup: ['mouseup', 'mousedown'], dblclick: ['click', 'mousedown'] }</code></pre> </dd> </dl> <h3 class='inherited'> Variable inherited from <a href='../../class/CUI/DOMElement.html'>CUI.DOMElement</a> </h3> <a href='../../class/CUI/DOMElement.html#defaults-variable'>defaults</a> <a href='../../class/CUI/Element.html#uniqueId-variable'>uniqueId</a> <h2>Instance Method Summary</h2> <ul class='summary'> <li> <a href='#setSize-dynamic'> # (void) setSize(size) </a> </li> <li> <a href='#onClickAction-dynamic'> # (void) onClickAction(ev) </a> </li> <li> <a href='#initOpts-dynamic'> # (void) initOpts() </a> </li> <li> <a href='#__getIcon-dynamic'> # (void) __getIcon(icon) </a> return icon for string </li> <li> <a href='#readOpts-dynamic'> # (void) readOpts() </a> </li> <li> <a href='#getCenter-dynamic'> # (void) getCenter() </a> </li> <li> <a href='#__getTemplateName-dynamic'> # (void) __getTemplateName() </a> </li> <li> <a href='#getTemplateName-dynamic'> # (void) getTemplateName() </a> </li> <li> <a href='#getValue-dynamic'> # (void) getValue() </a> </li> <li> <a href='#getElementForLayer-dynamic'> # (void) getElementForLayer() </a> </li> <li> <a href='#getRadioButtons-dynamic'> # (void) getRadioButtons() </a> </li> <li> <a href='#getGroupButtons-dynamic'> # (void) getGroupButtons() </a> </li> <li> <a href='#__getButtons-dynamic'> # (void) __getButtons(key, value) </a> returns other buttons </li> <li> <a href='#hasMenu-dynamic'> # (void) hasMenu() </a> </li> <li> <a href='#hasLeft-dynamic'> # (void) hasLeft() </a> </li> <li> <a href='#getMenu-dynamic'> # (void) getMenu() </a> </li> <li> <a href='#menuSetActiveIdx-dynamic'> # (void) menuSetActiveIdx(idx) </a> </li> <li> <a href='#getMenuRootButton-dynamic'> # (void) getMenuRootButton() </a> </li> <li> <a href='#toggle-dynamic'> # (void) toggle(flags = {}, event) </a> TODO rename to toggleActiveState </li> <li> <a href='#setActive-dynamic'> # (void) setActive(active, flags = {}, event) </a> </li> <li> <a href='#__callOnGroup-dynamic'> # (void) __callOnGroup(call, flags, event) </a> </li> <li> <a href='#activate-dynamic'> # (void) activate(flags = {}, event) </a> </li> <li> <a href='#deactivate-dynamic'> # (void) deactivate(flags = {}, event) </a> </li> <li> <a href='#setIconRight-dynamic'> # (void) setIconRight(icon = null) </a> </li> <li> <a href='#setIcon-dynamic'> # (void) setIcon(icon = null, _key = "left") </a> </li> <li> <a href='#startSpinner-dynamic'> # (void) startSpinner() </a> </li> <li> <a href='#stopSpinner-dynamic'> # (void) stopSpinner() </a> </li> <li> <a href='#getIcon-dynamic'> # (void) getIcon() </a> </li> <li> <a href='#getIconRight-dynamic'> # (void) getIconRight() </a> </li> <li> <a href='#__setState-dynamic'> # (void) __setState() </a> </li> <li> <a href='#__setIconState-dynamic'> # (void) __setIconState() </a> </li> <li> <a href='#__setTextState-dynamic'> # (void) __setTextState() </a> </li> <li> <a href='#isActive-dynamic'> # (void) isActive() </a> </li> <li> <a href='#isDisabled-dynamic'> # (void) isDisabled() </a> </li> <li> <a href='#isEnabled-dynamic'> # (void) isEnabled() </a> </li> <li> <a href='#setEnabled-dynamic'> # (void) setEnabled(enabled) </a> </li> <li> <a href='#disable-dynamic'> # (void) disable() </a> </li> <li> <a href='#enable-dynamic'> # (void) enable() </a> </li> <li> <a href='#setText-dynamic'> # (void) setText(__txt) </a> </li> <li> <a href='#setTextMaxChars-dynamic'> # (void) setTextMaxChars(max_chars) </a> </li> <li> <a href='#getText-dynamic'> # (void) getText() </a> </li> <li> <a href='#getGroup-dynamic'> # (void) getGroup() </a> </li> <li> <a href='#setGroup-dynamic'> # (void) setGroup(__group) </a> </li> <li> <a href='#__initTooltip-dynamic'> # (void) __initTooltip() </a> </li> <li> <a href='#getTooltip-dynamic'> # (void) getTooltip() </a> </li> <li> <a href='#isShown-dynamic'> # (void) isShown() </a> </li> <li> <a href='#isHidden-dynamic'> # (void) isHidden() </a> </li> <li> <a href='#destroy-dynamic'> # (void) destroy() </a> </li> <li> <a href='#show-dynamic'> # (void) show() </a> </li> <li> <a href='#hide-dynamic'> # (void) hide() </a> </li> </ul> <h2> Inherited Method Summary <h3 class='inherited'> Methods inherited from <a href='../../class/CUI/DOMElement.html'>CUI.DOMElement</a> </h3> <a href='../../class/CUI/DOMElement.html#initOpts-dynamic'>#initOpts</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#hide-dynamic'>#hide</a> <a href='../../class/CUI/DOMElement.html#show-dynamic'>#show</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/DOMElement.html#destroy-dynamic'>#destroy</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#readOpts-dynamic'>#readOpts</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> </h2> <h2>Constructor Details</h2> <div class='methods'> <div class='method_details'> # (void) constructor(opts = {}) </div> </div> <h2>Instance Method Details</h2> <div class='methods'> <div class='method_details'> # (void) setSize(size) </div> <div class='method_details'> # (void) onClickAction(ev) </div> <div class='method_details'> # (void) initOpts() </div> <div class='method_details'> # (void) __getIcon(icon) <div class='docstring'> return icon for string </div> <div class='tags'> </div> </div> <div class='method_details'> # (void) readOpts() </div> <div class='method_details'> # (void) getCenter() </div> <div class='method_details'> # (void) __getTemplateName() </div> <div class='method_details'> # (void) getTemplateName() </div> <div class='method_details'> # (void) getValue() </div> <div class='method_details'> # (void) getElementForLayer() </div> <div class='method_details'> # (void) getRadioButtons() </div> <div class='method_details'> # (void) getGroupButtons() </div> <div class='method_details'> # (void) __getButtons(key, value) <div class='docstring'> returns other buttons </div> <div class='tags'> </div> </div> <div class='method_details'> # (void) hasMenu() </div> <div class='method_details'> # (void) hasLeft() </div> <div class='method_details'> # (void) getMenu() </div> <div class='method_details'> # (void) menuSetActiveIdx(idx) </div> <div class='method_details'> # (void) getMenuRootButton() </div> <div class='method_details'> # (void) toggle(flags = {}, event) <div class='docstring'> TODO rename to toggleActiveState </div> <div class='tags'> </div> </div> <div class='method_details'> # (void) setActive(active, flags = {}, event) </div> <div class='method_details'> # (void) __callOnGroup(call, flags, event) </div> <div class='method_details'> # (void) activate(flags = {}, event) </div> <div class='method_details'> # (void) deactivate(flags = {}, event) </div> <div class='method_details'> # (void) setIconRight(icon = null) </div> <div class='method_details'> # (void) setIcon(icon = null, _key = "left") </div> <div class='method_details'> # (void) startSpinner() </div> <div class='method_details'> # (void) stopSpinner() </div> <div class='method_details'> # (void) getIcon() </div> <div class='method_details'> # (void) getIconRight() </div> <div class='method_details'> # (void) __setState() </div> <div class='method_details'> # (void) __setIconState() </div> <div class='method_details'> # (void) __setTextState() </div> <div class='method_details'> # (void) isActive() </div> <div class='method_details'> # (void) isDisabled() </div> <div class='method_details'> # (void) isEnabled() </div> <div class='method_details'> # (void) setEnabled(enabled) </div> <div class='method_details'> # (void) disable() </div> <div class='method_details'> # (void) enable() </div> <div class='method_details'> # (void) setText(__txt) </div> <div class='method_details'> # (void) setTextMaxChars(max_chars) </div> <div class='method_details'> # (void) getText() </div> <div class='method_details'> # (void) getGroup() </div> <div class='method_details'> # (void) setGroup(__group) </div> <div class='method_details'> # (void) __initTooltip() </div> <div class='method_details'> # (void) getTooltip() </div> <div class='method_details'> # (void) isShown() </div> <div class='method_details'> # (void) isHidden() </div> <div class='method_details'> # (void) destroy() </div> <div class='method_details'> # (void) show() </div> <div class='method_details'> # (void) hide() </div> </div> </div> <div id='footer'> By <a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'> Codo </a> 2.1.2 ✲ Press H to see the keyboard shortcuts ✲ <a href='http://twitter.com/netzpirat' target='_parent'>@netzpirat</a> ✲ <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'> Quickly fuzzy find classes, mixins, methods, file: <ul> <li> T Open fuzzy finder dialog </li> </ul> Control the navigation frame: <ul> <li> L Toggle list view </li> <li> C Show class list </li> <li> I Show mixin list </li> <li> F Show file list </li> <li> M Show method list </li> <li> E Show extras list </li> </ul> You can focus and blur the search input: <ul> <li> S Focus search input </li> <li> Esc Blur search input </li> </ul> </div> </body> </html>