coffeescript-ui
Version:
Coffeescript User Interface System
523 lines (507 loc) • 12.3 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'>Events</span>
</div>
</div>
<div id='content'>
<h1>
Class:
CUI.Events
</h1>
<table class='box'>
<tr>
<td>Defined in:</td>
<td>base/Events/Events.coffee</td>
</tr>
<tr>
<td>Inherits:</td>
<td>
<a href='../../class/CUI/Element.html'>CUI.Element</a>
</td>
</tr>
</table>
<h2>Overview</h2>
<div class='docstring'>
<p>Events Inter-"Process"-Communication for CUI</p><p>Event.listen
type: [ "click", "dblclick" ]
node: jQuery Element or CUI DOM Element
call: (ev, info) ->
selector: jQuery like path selector to filter events</p><p>Event.trigger
type: "content-resize"
node: jQuery Element or CUI DOM Element
bubble: set to yes if event should bubble up or down the DOM tree
info: info Map, contains eventsEvent for DOMElements and
the internal "waits" queue</p><p>Event.ignore
type: "<type>"
node: jQuery or DOM Element</p><p>CUIEvents bound to a node will be checked for the existance in the
DOM tree prio execution. If they don't exist (after they
have been inserted), the CUI.Listener will be deleted.</p><p>All events need to be registered or a warning is output at the console.</p><p>CUI.Events.registerEvent(options)
options are the default options for the event type: <type>
bubble: true|false</p>
</div>
<div class='tags'>
</div>
<h2>Variables Summary</h2>
<dl class='constants'>
<dt id='defaults-variable'>
defaults
=
</dt>
<dd>
<pre><code class='coffeescript'>{
maxWait: 1500
}</code></pre>
</dd>
<dt id='__listeners-variable'>
__listeners
=
</dt>
<dd>
<pre><code class='coffeescript'>[]</code></pre>
</dd>
<dt id='__eventRegistry-variable'>
__eventRegistry
=
</dt>
<dd>
<pre><code class='coffeescript'>{}</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>Class Method Summary</h2>
<ul class='summary'>
<li>
<span class='signature'>
<a href='#__getListenersForNode-static'>
.
(void)
<b>__getListenersForNode</b><span>(node)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#__registerListener-static'>
.
(void)
<b>__registerListener</b><span>(listener)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#__getActiveListeners-static'>
.
(void)
<b>__getActiveListeners</b><span>(doc = document)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#unregisterListener-static'>
.
(void)
<b>unregisterListener</b><span>(listener)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#wait-static'>
.
(void)
<b>wait</b><span>(_opts)</span>
</a>
</span>
<span class='desc'>
wait for an event on a node
</span>
</li>
<li>
<span class='signature'>
<a href='#listen-static'>
.
(void)
<b>listen</b><span>(_listener)</span>
</a>
</span>
<span class='desc'>
register a listener @param listener PlainObject or CUI.Listener
</span>
</li>
<li>
<span class='signature'>
<a href='#trigger-static'>
.
(void)
<b>trigger</b><span>(_event)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#ignore-static'>
.
(void)
<b>ignore</b><span>(filter, doc = document)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#dump-static'>
.
(void)
<b>dump</b><span>(filter = {})</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#dumpTopLevel-static'>
.
(void)
<b>dumpTopLevel</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#hasEventType-static'>
.
(void)
<b>hasEventType</b><span>(type)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#getEventType-static'>
.
(void)
<b>getEventType</b><span>(type)</span>
</a>
</span>
<span class='desc'>
returns event info by type
</span>
</li>
<li>
<span class='signature'>
<a href='#getEventTypeAliases-static'>
.
(void)
<b>getEventTypeAliases</b><span>(type)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#registerEvent-static'>
.
(void)
<b>registerEvent</b><span>(event, allow_array = true)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#__init-static'>
.
(void)
<b>__init</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>Class Method Details</h2>
<div class='methods'>
<div class='method_details'>
<p class='signature' id='__getListenersForNode-static'>
.
(void)
<b>__getListenersForNode</b><span>(node)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='__registerListener-static'>
.
(void)
<b>__registerListener</b><span>(listener)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='__getActiveListeners-static'>
.
(void)
<b>__getActiveListeners</b><span>(doc = document)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='unregisterListener-static'>
.
(void)
<b>unregisterListener</b><span>(listener)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='wait-static'>
.
(void)
<b>wait</b><span>(_opts)</span>
<br>
</p>
<div class='docstring'>
<p>wait for an event on a node</p>
</div>
<div class='tags'>
</div>
</div>
<div class='method_details'>
<p class='signature' id='listen-static'>
.
(void)
<b>listen</b><span>(_listener)</span>
<br>
</p>
<div class='docstring'>
<p>register a listener
@param listener PlainObject or CUI.Listener</p>
</div>
<div class='tags'>
</div>
</div>
<div class='method_details'>
<p class='signature' id='trigger-static'>
.
(void)
<b>trigger</b><span>(_event)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='ignore-static'>
.
(void)
<b>ignore</b><span>(filter, doc = document)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='dump-static'>
.
(void)
<b>dump</b><span>(filter = {})</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='dumpTopLevel-static'>
.
(void)
<b>dumpTopLevel</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='hasEventType-static'>
.
(void)
<b>hasEventType</b><span>(type)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='getEventType-static'>
.
(void)
<b>getEventType</b><span>(type)</span>
<br>
</p>
<div class='docstring'>
<p>returns event info by type</p>
</div>
<div class='tags'>
</div>
</div>
<div class='method_details'>
<p class='signature' id='getEventTypeAliases-static'>
.
(void)
<b>getEventTypeAliases</b><span>(type)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='registerEvent-static'>
.
(void)
<b>registerEvent</b><span>(event, allow_array = true)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='__init-static'>
.
(void)
<b>__init</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>