UNPKG

coffeescript-ui

Version:
549 lines (534 loc) 15.5 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'>Modal</span> </div> </div> <div id='content'> <h1> Class: CUI.Modal </h1> <table class='box'> <tr> <td>Defined in:</td> <td>elements&#47;Modal&#47;Modal.coffee</td> </tr> <tr> <td>Inherits:</td> <td> <a href='../../class/CUI/LayerPane.html'>CUI.LayerPane</a> </td> </tr> </table> <h2>Overview</h2> <div class='docstring'> <p>Modal</p> </div> <div class='tags'> </div> <h2>Direct Known Subclasses</h2> <p class='children'> <a href='../../class/CUI/ConfirmationDialog.html'>CUI.ConfirmationDialog</a> <a href='../../class/CUI/Popover.html'>CUI.Popover</a> </p> <h2>Variables Summary</h2> <dl class='constants'> <dt id='defaults-variable'> defaults = </dt> <dd> <pre><code class='coffeescript'>{ cancel_tooltip: { text: &quot;Close Dialog&quot; } }</code></pre> </dd> </dl> <h3 class='inherited'> Variable inherited from <a href='../../class/CUI/LayerPane.html'>CUI.LayerPane</a> </h3> <p class='inherited'> <a href='../../class/CUI/Layer.html#knownPlacements-variable'>knownPlacements</a> <a href='../../class/CUI/DOMElement.html#defaults-variable'>defaults</a> <a href='../../class/CUI/Element.html#uniqueId-variable'>uniqueId</a> </p> <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='#__addHeaderButton-dynamic'> # (void) <b>__addHeaderButton</b><span>(pname, _btn)</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#__runOnAllButtons-dynamic'> # (void) <b>__runOnAllButtons</b><span>(func)</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#disableAllButtons-dynamic'> # (void) <b>disableAllButtons</b><span>()</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#enableAllButtons-dynamic'> # (void) <b>enableAllButtons</b><span>()</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#isKeyboardCancellable-dynamic'> # (void) <b>isKeyboardCancellable</b><span>(ev)</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#doCancel-dynamic'> # (void) <b>doCancel</b><span>(ev, force_callback = false, button = null)</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#focusOnShow-dynamic'> # (void) <b>focusOnShow</b><span>(ev)</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#forceFocusOnShow-dynamic'> # (void) <b>forceFocusOnShow</b><span>()</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#empty-dynamic'> # (void) <b>empty</b><span>(key = &quot;center&quot;)</span> </a> </span> <span class='desc'> PROXY some functions </span> </li> <li> <span class='signature'> <a href='#append-dynamic'> # (void) <b>append</b><span>(content, key = &quot;center&quot;)</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#replace-dynamic'> # (void) <b>replace</b><span>(content, key = &quot;center&quot;)</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#setContent-dynamic'> # (void) <b>setContent</b><span>(content)</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#hide-dynamic'> # (void) <b>hide</b><span>(ev)</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/LayerPane.html'>CUI.LayerPane</a> </h3> <p class='inherited'> <a href='../../class/CUI/LayerPane.html#initOpts-dynamic'>#initOpts</a> <a href='../../class/CUI/LayerPane.html#getPane-dynamic'>#getPane</a> <a href='../../class/CUI/LayerPane.html#setPane-dynamic'>#setPane</a> <a href='../../class/CUI/LayerPane.html#destroy-dynamic'>#destroy</a> <a href='../../class/CUI/Layer.html#setBackdropContent-dynamic'>#setBackdropContent</a> <a href='../../class/CUI/Layer.html#getTemplate-dynamic'>#getTemplate</a> <a href='../../class/CUI/Layer.html#getLayerRoot-dynamic'>#getLayerRoot</a> <a href='../../class/CUI/Layer.html#getLayer-dynamic'>#getLayer</a> <a href='../../class/CUI/Layer.html#setVisible-dynamic'>#setVisible</a> <a href='../../class/CUI/Layer.html#__setElement-dynamic'>#__setElement</a> <a href='../../class/CUI/Layer.html#__getOriginalElement-dynamic'>#__getOriginalElement</a> <a href='../../class/CUI/Layer.html#autoSize-dynamic'>#autoSize</a> <a href='../../class/CUI/Layer.html#position-dynamic'>#position</a> <a href='../../class/CUI/Layer.html#__removeDebugDivs-dynamic'>#__removeDebugDivs</a> <a href='../../class/CUI/Layer.html#clearTimeout-dynamic'>#clearTimeout</a> <a href='../../class/CUI/Layer.html#showTimeout-dynamic'>#showTimeout</a> <a href='../../class/CUI/Layer.html#hideTimeout-dynamic'>#hideTimeout</a> <a href='../../class/CUI/Layer.html#hide-dynamic'>#hide</a> <a href='../../class/CUI/Layer.html#__updateLayerStackCounter-dynamic'>#__updateLayerStackCounter</a> <a href='../../class/CUI/Layer.html#getElementOpenClass-dynamic'>#getElementOpenClass</a> <a href='../../class/CUI/Layer.html#show-dynamic'>#show</a> <a href='../../class/CUI/Layer.html#isKeyboardCancellable-dynamic'>#isKeyboardCancellable</a> <a href='../../class/CUI/Layer.html#doCancel-dynamic'>#doCancel</a> <a href='../../class/CUI/Layer.html#focusOnShow-dynamic'>#focusOnShow</a> <a href='../../class/CUI/Layer.html#forceFocusOnShow-dynamic'>#forceFocusOnShow</a> <a href='../../class/CUI/Layer.html#focusOnHide-dynamic'>#focusOnHide</a> <a href='../../class/CUI/Layer.html#getElement-dynamic'>#getElement</a> <a href='../../class/CUI/Layer.html#isShown-dynamic'>#isShown</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#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> </p> </h2> <h2>Constructor Details</h2> <div class='methods'> <div class='method_details'> <p class='signature' id='constructor-dynamic'> # (void) <b>constructor</b><span>(opts = {})</span> <br> </p> <div class='docstring'> <p>Construct a new CUI.Modal.</p> </div> <div class='tags'> </div> </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='__addHeaderButton-dynamic'> # (void) <b>__addHeaderButton</b><span>(pname, _btn)</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='__runOnAllButtons-dynamic'> # (void) <b>__runOnAllButtons</b><span>(func)</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='disableAllButtons-dynamic'> # (void) <b>disableAllButtons</b><span>()</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='enableAllButtons-dynamic'> # (void) <b>enableAllButtons</b><span>()</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='isKeyboardCancellable-dynamic'> # (void) <b>isKeyboardCancellable</b><span>(ev)</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='doCancel-dynamic'> # (void) <b>doCancel</b><span>(ev, force_callback = false, button = null)</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='focusOnShow-dynamic'> # (void) <b>focusOnShow</b><span>(ev)</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='forceFocusOnShow-dynamic'> # (void) <b>forceFocusOnShow</b><span>()</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='empty-dynamic'> # (void) <b>empty</b><span>(key = &quot;center&quot;)</span> <br> </p> <div class='docstring'> <p>PROXY some functions</p> </div> <div class='tags'> </div> </div> <div class='method_details'> <p class='signature' id='append-dynamic'> # (void) <b>append</b><span>(content, key = &quot;center&quot;)</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='replace-dynamic'> # (void) <b>replace</b><span>(content, key = &quot;center&quot;)</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='setContent-dynamic'> # (void) <b>setContent</b><span>(content)</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='hide-dynamic'> # (void) <b>hide</b><span>(ev)</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>