coffeescript-ui
Version:
Coffeescript User Interface System
1,080 lines (1,034 loc) • 21.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'>Event</span>
</div>
</div>
<div id='content'>
<h1>
Class:
CUI.Event
</h1>
<table class='box'>
<tr>
<td>Defined in:</td>
<td>base/Events/Event.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'>
<ul>
<li>coffeescript-ui - Coffeescript User Interface System (CUI)</li>
<li>Copyright (c) 2013 - 2016 Programmfabrik GmbH</li>
<li>MIT Licence</li>
<li><a href="https://github.com/programmfabrik/coffeescript-ui">https://github.com/programmfabrik/coffeescript-ui</a>, <a href="http://www.coffeescript-ui.org">http://www.coffeescript-ui.org</a></li>
</ul>
</div>
<div class='tags'>
</div>
<h2>Direct Known Subclasses</h2>
<p class='children'>
<a href='../../class/CUI/DragoverScrollEvent.html'>CUI.DragoverScrollEvent</a>
<a href='../../class/CUI/CUIEvent.html'>CUI.CUIEvent</a>
<a href='../../class/CUI/KeyboardEvent.html'>CUI.KeyboardEvent</a>
<a href='../../class/CUI/MouseEvent.html'>CUI.MouseEvent</a>
</p>
<h2>Variables Summary</h2>
<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='#require-static'>
.
(void)
<b>require</b><span>(event, func)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#createFromDOMEvent-static'>
.
(void)
<b>createFromDOMEvent</b><span>(event, eventClass)</span>
</a>
</span>
<span class='desc'>
cr
</span>
</li>
</ul>
<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='#__setListener-dynamic'>
#
(void)
<b>__setListener</b><span>(listener)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#__setPhase-dynamic'>
#
(void)
<b>__setPhase</b><span>(__phase)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#isExcludeSelf-dynamic'>
#
(void)
<b>isExcludeSelf</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#getPhase-dynamic'>
#
(void)
<b>getPhase</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#getType-dynamic'>
#
(void)
<b>getType</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#getDebug-dynamic'>
#
(void)
<b>getDebug</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#getInfo-dynamic'>
#
(void)
<b>getInfo</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#getNode-dynamic'>
#
(void)
<b>getNode</b><span>()</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='#isBubble-dynamic'>
#
(void)
<b>isBubble</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#isSink-dynamic'>
#
(void)
<b>isSink</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#isInDOM-dynamic'>
#
(void)
<b>isInDOM</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#setNativeEvent-dynamic'>
#
(void)
<b>setNativeEvent</b><span>(NativeEvent)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#getNativeEvent-dynamic'>
#
(void)
<b>getNativeEvent</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#getPointTarget-dynamic'>
#
(void)
<b>getPointTarget</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#getTarget-dynamic'>
#
(void)
<b>getTarget</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#setTarget-dynamic'>
#
(void)
<b>setTarget</b><span>(tg)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#getCurrentTarget-dynamic'>
#
(void)
<b>getCurrentTarget</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#setCurrentTarget-dynamic'>
#
(void)
<b>setCurrentTarget</b><span>(ct)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#getModifiers-dynamic'>
#
(void)
<b>getModifiers</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#hasModifierKey-dynamic'>
#
(void)
<b>hasModifierKey</b><span>(includeShift = false)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#getButton-dynamic'>
#
(void)
<b>getButton</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#keyCode-dynamic'>
#
(void)
<b>keyCode</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#metaKey-dynamic'>
#
(void)
<b>metaKey</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#ctrlKey-dynamic'>
#
(void)
<b>ctrlKey</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#altKey-dynamic'>
#
(void)
<b>altKey</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#shiftKey-dynamic'>
#
(void)
<b>shiftKey</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#clientX-dynamic'>
#
(void)
<b>clientX</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#clientY-dynamic'>
#
(void)
<b>clientY</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#pageX-dynamic'>
#
(void)
<b>pageX</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#pageY-dynamic'>
#
(void)
<b>pageY</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#stopImmediatePropagation-dynamic'>
#
(void)
<b>stopImmediatePropagation</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#stopPropagation-dynamic'>
#
(void)
<b>stopPropagation</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#preventDefault-dynamic'>
#
(void)
<b>preventDefault</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#isImmediatePropagationStopped-dynamic'>
#
(void)
<b>isImmediatePropagationStopped</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#isPropagationStopped-dynamic'>
#
(void)
<b>isPropagationStopped</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#isDefaultPrevented-dynamic'>
#
(void)
<b>isDefaultPrevented</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#dispatch-dynamic'>
#
(void)
<b>dispatch</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#dump-dynamic'>
#
(void)
<b>dump</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#stop-dynamic'>
#
(void)
<b>stop</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='require-static'>
.
(void)
<b>require</b><span>(event, func)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='createFromDOMEvent-static'>
.
(void)
<b>createFromDOMEvent</b><span>(event, eventClass)</span>
<br>
</p>
<div class='docstring'>
<p>cr</p>
</div>
<div class='tags'>
</div>
</div>
</div>
<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='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='__setListener-dynamic'>
#
(void)
<b>__setListener</b><span>(listener)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='__setPhase-dynamic'>
#
(void)
<b>__setPhase</b><span>(__phase)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='isExcludeSelf-dynamic'>
#
(void)
<b>isExcludeSelf</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='getPhase-dynamic'>
#
(void)
<b>getPhase</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='getType-dynamic'>
#
(void)
<b>getType</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='getDebug-dynamic'>
#
(void)
<b>getDebug</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='getInfo-dynamic'>
#
(void)
<b>getInfo</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='getNode-dynamic'>
#
(void)
<b>getNode</b><span>()</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='isBubble-dynamic'>
#
(void)
<b>isBubble</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='isSink-dynamic'>
#
(void)
<b>isSink</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='isInDOM-dynamic'>
#
(void)
<b>isInDOM</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='setNativeEvent-dynamic'>
#
(void)
<b>setNativeEvent</b><span>(NativeEvent)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='getNativeEvent-dynamic'>
#
(void)
<b>getNativeEvent</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='getPointTarget-dynamic'>
#
(void)
<b>getPointTarget</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='getTarget-dynamic'>
#
(void)
<b>getTarget</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='setTarget-dynamic'>
#
(void)
<b>setTarget</b><span>(tg)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='getCurrentTarget-dynamic'>
#
(void)
<b>getCurrentTarget</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='setCurrentTarget-dynamic'>
#
(void)
<b>setCurrentTarget</b><span>(ct)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='getModifiers-dynamic'>
#
(void)
<b>getModifiers</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='hasModifierKey-dynamic'>
#
(void)
<b>hasModifierKey</b><span>(includeShift = false)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='getButton-dynamic'>
#
(void)
<b>getButton</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='keyCode-dynamic'>
#
(void)
<b>keyCode</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='metaKey-dynamic'>
#
(void)
<b>metaKey</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='ctrlKey-dynamic'>
#
(void)
<b>ctrlKey</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='altKey-dynamic'>
#
(void)
<b>altKey</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='shiftKey-dynamic'>
#
(void)
<b>shiftKey</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='clientX-dynamic'>
#
(void)
<b>clientX</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='clientY-dynamic'>
#
(void)
<b>clientY</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='pageX-dynamic'>
#
(void)
<b>pageX</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='pageY-dynamic'>
#
(void)
<b>pageY</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='stopImmediatePropagation-dynamic'>
#
(void)
<b>stopImmediatePropagation</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='stopPropagation-dynamic'>
#
(void)
<b>stopPropagation</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='preventDefault-dynamic'>
#
(void)
<b>preventDefault</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='isImmediatePropagationStopped-dynamic'>
#
(void)
<b>isImmediatePropagationStopped</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='isPropagationStopped-dynamic'>
#
(void)
<b>isPropagationStopped</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='isDefaultPrevented-dynamic'>
#
(void)
<b>isDefaultPrevented</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='dispatch-dynamic'>
#
(void)
<b>dispatch</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='dump-dynamic'>
#
(void)
<b>dump</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='stop-dynamic'>
#
(void)
<b>stop</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>