coffeescript-ui
Version:
Coffeescript User Interface System
654 lines (630 loc) • 14.8 kB
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>
»
<span class='title'>CUI</span>
»
<span class='title'>DOMElement</span>
</div>
</div>
<div id='content'>
<h1>
Class:
CUI.DOMElement
</h1>
<table class='box'>
<tr>
<td>Defined in:</td>
<td>base/DOMElement/DOMElement.coffee</td>
</tr>
<tr>
<td>Inherits:</td>
<td>
<a href='../../class/CUI/Element.html'>CUI.Element</a>
</td>
</tr>
</table>
<h2>Direct Known Subclasses</h2>
<p class='children'>
<a href='../../class/CUI/DataField.html'>CUI.DataField</a>
<a href='../../class/CUI/Layer.html'>CUI.Layer</a>
<a href='../../class/CUI/Layout.html'>CUI.Layout</a>
<a href='../../class/CUI/Block.html'>CUI.Block</a>
<a href='../../class/CUI/Button.html'>CUI.Button</a>
<a href='../../class/CUI/Buttonbar.html'>CUI.Buttonbar</a>
<a href='../../class/CUI/Console.html'>CUI.Console</a>
<a href='../../class/CUI/DigiDisplay.html'>CUI.DigiDisplay</a>
<a href='../../class/CUI/Label.html'>CUI.Label</a>
<a href='../../class/CUI/IconMarker.html'>CUI.IconMarker</a>
<a href='../../class/CUI/Panel.html'>CUI.Panel</a>
<a href='../../class/CUI/ProgressMeter.html'>CUI.ProgressMeter</a>
<a href='../../class/CUI/StickyHeader.html'>CUI.StickyHeader</a>
<a href='../../class/CUI/Table.html'>CUI.Table</a>
<a href='../../class/CUI/Tab.html'>CUI.Tab</a>
</p>
<h2>Variables Summary</h2>
<dl class='constants'>
<dt id='defaults-variable'>
defaults
=
</dt>
<dd>
<pre><code class='coffeescript'>{
qa: false
}</code></pre>
</dd>
</dl>
<h3 class='inherited'>
Variable inherited from
<a href='../../class/CUI/Element.html'>CUI.Element</a>
</h3>
<p class='inherited'>
<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='#registerTemplate-dynamic'>
#
(void)
<b>registerTemplate</b><span>(template, add_default_classes = true)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#getDOMElementClasses-dynamic'>
#
(void)
<b>getDOMElementClasses</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#registerDOMElement-dynamic'>
#
(void)
<b>registerDOMElement</b><span>(DOM, add_default_classes = true)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#getElementForLayer-dynamic'>
#
(void)
<b>getElementForLayer</b><span>()</span>
</a>
</span>
<span class='desc'>
if used as parameter in "Layer", overwrite to a different element to position the layer with
</span>
</li>
<li>
<span class='signature'>
<a href='#unregisterDOMElement-dynamic'>
#
(void)
<b>unregisterDOMElement</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#__assertDOMElement-dynamic'>
#
(void)
<b>__assertDOMElement</b><span>(func)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#__assertTemplateElement-dynamic'>
#
(void)
<b>__assertTemplateElement</b><span>(func)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#addClass-dynamic'>
#
(void)
<b>addClass</b><span>(className, key)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#setAria-dynamic'>
#
(void)
<b>setAria</b><span>(attr, value)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#removeClass-dynamic'>
#
(void)
<b>removeClass</b><span>(className, key)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#hide-dynamic'>
#
(void)
<b>hide</b><span>(key)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#show-dynamic'>
#
(void)
<b>show</b><span>(key)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#hasClass-dynamic'>
#
(void)
<b>hasClass</b><span>(cls)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#isDestroyed-dynamic'>
#
(void)
<b>isDestroyed</b><span>(key)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#empty-dynamic'>
#
(void)
<b>empty</b><span>(key)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#replace-dynamic'>
#
(void)
<b>replace</b><span>(value, key)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#append-dynamic'>
#
(void)
<b>append</b><span>(value, key)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#prepend-dynamic'>
#
(void)
<b>prepend</b><span>(value, key)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#text-dynamic'>
#
(void)
<b>text</b><span>(value, key)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#get-dynamic'>
#
(void)
<b>get</b><span>(key)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#getFlexHandle-dynamic'>
#
(void)
<b>getFlexHandle</b><span>(key, do_assert)</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/Element.html'>CUI.Element</a>
</h3>
<p class='inherited'>
<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#initOpts-dynamic'>#initOpts</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#destroy-dynamic'>#destroy</a>
<a href='../../class/CUI/Element.html#isDestroyed-dynamic'>#isDestroyed</a>
<a href='../../class/CUI/Element.html#getOptKeys-static'>.getOptKeys</a>
</p>
</h2>
<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='registerTemplate-dynamic'>
#
(void)
<b>registerTemplate</b><span>(template, add_default_classes = true)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='getDOMElementClasses-dynamic'>
#
(void)
<b>getDOMElementClasses</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='registerDOMElement-dynamic'>
#
(void)
<b>registerDOMElement</b><span>(DOM, add_default_classes = true)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='getElementForLayer-dynamic'>
#
(void)
<b>getElementForLayer</b><span>()</span>
<br>
</p>
<div class='docstring'>
<p>if used as parameter in "Layer", overwrite to
a different element to position the layer with</p>
</div>
<div class='tags'>
</div>
</div>
<div class='method_details'>
<p class='signature' id='unregisterDOMElement-dynamic'>
#
(void)
<b>unregisterDOMElement</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='__assertDOMElement-dynamic'>
#
(void)
<b>__assertDOMElement</b><span>(func)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='__assertTemplateElement-dynamic'>
#
(void)
<b>__assertTemplateElement</b><span>(func)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='addClass-dynamic'>
#
(void)
<b>addClass</b><span>(className, key)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='setAria-dynamic'>
#
(void)
<b>setAria</b><span>(attr, value)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='removeClass-dynamic'>
#
(void)
<b>removeClass</b><span>(className, key)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='hide-dynamic'>
#
(void)
<b>hide</b><span>(key)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='show-dynamic'>
#
(void)
<b>show</b><span>(key)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='hasClass-dynamic'>
#
(void)
<b>hasClass</b><span>(cls)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='isDestroyed-dynamic'>
#
(void)
<b>isDestroyed</b><span>(key)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='empty-dynamic'>
#
(void)
<b>empty</b><span>(key)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='replace-dynamic'>
#
(void)
<b>replace</b><span>(value, key)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='append-dynamic'>
#
(void)
<b>append</b><span>(value, key)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='prepend-dynamic'>
#
(void)
<b>prepend</b><span>(value, key)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='text-dynamic'>
#
(void)
<b>text</b><span>(value, key)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='get-dynamic'>
#
(void)
<b>get</b><span>(key)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='getFlexHandle-dynamic'>
#
(void)
<b>getFlexHandle</b><span>(key, do_assert)</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
✲
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'>
<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>