UNPKG

coffeescript-ui

Version:
732 lines (704 loc) 17.1 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'>Layer</span> </div> </div> <div id='content'> <h1> Class: CUI.Layer </h1> <table class='box'> <tr> <td>Defined in:</td> <td>base&#47;Layer&#47;Layer.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> <p class='children'> <a href='../../class/CUI/Menu.html'>CUI.Menu</a> <a href='../../class/CUI/LayerPane.html'>CUI.LayerPane</a> </p> <h2>Variables Summary</h2> <dl class='constants'> <dt id='knownPlacements-variable'> knownPlacements = </dt> <dd> <pre><code class='coffeescript'>[&quot;s&quot;, &quot;e&quot;, &quot;w&quot;, &quot;ws&quot;, &quot;wn&quot;, &quot;n&quot;, &quot;se&quot;, &quot;ne&quot;, &quot;es&quot;, &quot;en&quot;, &quot;nw&quot;, &quot;sw&quot;, &quot;c&quot;]</code></pre> </dd> </dl> <h3 class='inherited'> Variable inherited from <a href='../../class/CUI/DOMElement.html'>CUI.DOMElement</a> </h3> <p class='inherited'> <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='#setBackdropContent-dynamic'> # (void) <b>setBackdropContent</b><span>(content)</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#getTemplate-dynamic'> # (void) <b>getTemplate</b><span>()</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#getLayerRoot-dynamic'> # (void) <b>getLayerRoot</b><span>()</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#getLayer-dynamic'> # (void) <b>getLayer</b><span>()</span> </a> </span> <span class='desc'> </span> </li> <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='#setVisible-dynamic'> # (void) <b>setVisible</b><span>(on_off = true)</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#__setElement-dynamic'> # (void) <b>__setElement</b><span>(element)</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#__getOriginalElement-dynamic'> # (void) <b>__getOriginalElement</b><span>()</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#autoSize-dynamic'> # (void) <b>autoSize</b><span>()</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#position-dynamic'> # (void) <b>position</b><span>(ev)</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#__removeDebugDivs-dynamic'> # (void) <b>__removeDebugDivs</b><span>()</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#clearTimeout-dynamic'> # (void) <b>clearTimeout</b><span>()</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#showTimeout-dynamic'> # (void) <b>showTimeout</b><span>(ms = @_show_ms, ev)</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#hideTimeout-dynamic'> # (void) <b>hideTimeout</b><span>(ms = @_hide_ms, ev)</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> <li> <span class='signature'> <a href='#__updateLayerStackCounter-dynamic'> # (void) <b>__updateLayerStackCounter</b><span>()</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#getElementOpenClass-dynamic'> # (void) <b>getElementOpenClass</b><span>()</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#show-dynamic'> # (void) <b>show</b><span>(ev)</span> </a> </span> <span class='desc'> use element to temporarily overwrite element used for positioning </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)</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='#focusOnHide-dynamic'> # (void) <b>focusOnHide</b><span>(ev)</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#getElement-dynamic'> # (void) <b>getElement</b><span>()</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#isShown-dynamic'> # (void) <b>isShown</b><span>()</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#destroy-dynamic'> # (void) <b>destroy</b><span>()</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/DOMElement.html'>CUI.DOMElement</a> </h3> <p class='inherited'> <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> </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> </div> <h2>Instance Method Details</h2> <div class='methods'> <div class='method_details'> <p class='signature' id='setBackdropContent-dynamic'> # (void) <b>setBackdropContent</b><span>(content)</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='getTemplate-dynamic'> # (void) <b>getTemplate</b><span>()</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='getLayerRoot-dynamic'> # (void) <b>getLayerRoot</b><span>()</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='getLayer-dynamic'> # (void) <b>getLayer</b><span>()</span> <br> </p> </div> <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='setVisible-dynamic'> # (void) <b>setVisible</b><span>(on_off = true)</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='__setElement-dynamic'> # (void) <b>__setElement</b><span>(element)</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='__getOriginalElement-dynamic'> # (void) <b>__getOriginalElement</b><span>()</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='autoSize-dynamic'> # (void) <b>autoSize</b><span>()</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='position-dynamic'> # (void) <b>position</b><span>(ev)</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='__removeDebugDivs-dynamic'> # (void) <b>__removeDebugDivs</b><span>()</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='clearTimeout-dynamic'> # (void) <b>clearTimeout</b><span>()</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='showTimeout-dynamic'> # (void) <b>showTimeout</b><span>(ms = @_show_ms, ev)</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='hideTimeout-dynamic'> # (void) <b>hideTimeout</b><span>(ms = @_hide_ms, ev)</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 class='method_details'> <p class='signature' id='__updateLayerStackCounter-dynamic'> # (void) <b>__updateLayerStackCounter</b><span>()</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='getElementOpenClass-dynamic'> # (void) <b>getElementOpenClass</b><span>()</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='show-dynamic'> # (void) <b>show</b><span>(ev)</span> <br> </p> <div class='docstring'> <p>use element to temporarily overwrite element used for positioning</p> </div> <div class='tags'> </div> </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)</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='focusOnHide-dynamic'> # (void) <b>focusOnHide</b><span>(ev)</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='getElement-dynamic'> # (void) <b>getElement</b><span>()</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='isShown-dynamic'> # (void) <b>isShown</b><span>()</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='destroy-dynamic'> # (void) <b>destroy</b><span>()</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>