coffeescript-ui
Version:
Coffeescript User Interface System
767 lines (739 loc) • 17.2 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'>Draggable</span>
</div>
</div>
<div id='content'>
<h1>
Class:
CUI.Draggable
</h1>
<table class='box'>
<tr>
<td>Defined in:</td>
<td>base/DragDropSelect/Draggable.coffee</td>
</tr>
<tr>
<td>Inherits:</td>
<td>
<a href='../../class/CUI/DragDropSelect.html'>CUI.DragDropSelect</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/Dragscroll.html'>CUI.Dragscroll</a>
<a href='../../class/CUI/Lasso.html'>CUI.Lasso</a>
<a href='../../class/CUI/Movable.html'>CUI.Movable</a>
<a href='../../class/CUI/Sortable.html'>CUI.Sortable</a>
<a href='../../class/CUI/ListViewDraggable.html'>CUI.ListViewDraggable</a>
</p>
<h2>Variables Summary</h2>
<dl class='constants'>
<dt id='cls-variable'>
cls
=
</dt>
<dd>
<pre><code class='coffeescript'>"draggable"</code></pre>
</dd>
</dl>
<h3 class='inherited'>
Variable inherited from
<a href='../../class/CUI/DragDropSelect.html'>CUI.DragDropSelect</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='#limitRect-static'>
.
(void)
<b>limitRect</b><span>(pos, limitRect, defaults = {})</span>
</a>
</span>
<span class='desc'>
keep pos inside certain constraints pos.fix is an Array containing any of "n","w","e","s"
limitRect: min_w, min_h, max_w, max_h, min_x, max_x, min_y, max_y
!!! The order of the parameters is how we want them, in Movable it
is different for compability reasons
</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='#getClass-dynamic'>
#
(void)
<b>getClass</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#supportTouch-dynamic'>
#
(void)
<b>supportTouch</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#__killTimeout-dynamic'>
#
(void)
<b>__killTimeout</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#__cleanup-dynamic'>
#
(void)
<b>__cleanup</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>
<li>
<span class='signature'>
<a href='#init-dynamic'>
#
(void)
<b>init</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#init_drag-dynamic'>
#
(void)
<b>init_drag</b><span>(ev, $target)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#getCursor-dynamic'>
#
(void)
<b>getCursor</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#__startDrag-dynamic'>
#
(void)
<b>__startDrag</b><span>(ev, $target, diff)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#before_drag-dynamic'>
#
(void)
<b>before_drag</b><span>()</span>
</a>
</span>
<span class='desc'>
call after first mousedown
</span>
</li>
<li>
<span class='signature'>
<a href='#start_drag-dynamic'>
#
(void)
<b>start_drag</b><span>(ev, $target, diff)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#do_drag-dynamic'>
#
(void)
<b>do_drag</b><span>(ev, $target, diff)</span>
</a>
</span>
<span class='desc'>
do drag first call
</span>
</li>
<li>
<span class='signature'>
<a href='#cleanup_drag-dynamic'>
#
(void)
<b>cleanup_drag</b><span>(ev)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#stop_drag-dynamic'>
#
(void)
<b>stop_drag</b><span>(ev)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#__finish_drag-dynamic'>
#
(void)
<b>__finish_drag</b><span>(ev)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#end_drag-dynamic'>
#
(void)
<b>end_drag</b><span>(ev)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#get_helper_pos-dynamic'>
#
(void)
<b>get_helper_pos</b><span>(ev, gd, diff)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#get_helper_contain_element-dynamic'>
#
(void)
<b>get_helper_contain_element</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#position_helper-dynamic'>
#
(void)
<b>position_helper</b><span>(ev, $target, diff)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#getCloneSourceForHelper-dynamic'>
#
(void)
<b>getCloneSourceForHelper</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#get_axis-dynamic'>
#
(void)
<b>get_axis</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#get_helper-dynamic'>
#
(void)
<b>get_helper</b><span>(ev, gd, diff)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#get_init_helper_pos-dynamic'>
#
(void)
<b>get_init_helper_pos</b><span>(node, gd, offset = {
top: 0,
left: 0
})</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#init_helper-dynamic'>
#
(void)
<b>init_helper</b><span>(ev, $target, diff)</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/DragDropSelect.html'>CUI.DragDropSelect</a>
</h3>
<p class='inherited'>
<a href='../../class/CUI/DragDropSelect.html#initOpts-dynamic'>#initOpts</a>
<a href='../../class/CUI/DragDropSelect.html#readOpts-dynamic'>#readOpts</a>
<a href='../../class/CUI/DragDropSelect.html#getClass-dynamic'>#getClass</a>
<a href='../../class/CUI/DragDropSelect.html#destroy-dynamic'>#destroy</a>
<a href='../../class/CUI/DragDropSelect.html#init-dynamic'>#init</a>
<a href='../../class/CUI/DragDropSelect.html#getInstance-static'>.getInstance</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#readOptsFromAttr-dynamic'>#readOptsFromAttr</a>
<a href='../../class/CUI/Element.html#proxy-dynamic'>#proxy</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='limitRect-static'>
.
(void)
<b>limitRect</b><span>(pos, limitRect, defaults = {})</span>
<br>
</p>
<div class='docstring'>
<p>keep pos inside certain constraints
pos.fix is an Array containing any of "n","w","e","s"
limitRect: min_w, min_h, max_w, max_h, min_x, max_x, min_y, max_y
!!! The order of the parameters is how we want them, in Movable it
is different for compability reasons</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='getClass-dynamic'>
#
(void)
<b>getClass</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='supportTouch-dynamic'>
#
(void)
<b>supportTouch</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='__killTimeout-dynamic'>
#
(void)
<b>__killTimeout</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='__cleanup-dynamic'>
#
(void)
<b>__cleanup</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 class='method_details'>
<p class='signature' id='init-dynamic'>
#
(void)
<b>init</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='init_drag-dynamic'>
#
(void)
<b>init_drag</b><span>(ev, $target)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='getCursor-dynamic'>
#
(void)
<b>getCursor</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='__startDrag-dynamic'>
#
(void)
<b>__startDrag</b><span>(ev, $target, diff)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='before_drag-dynamic'>
#
(void)
<b>before_drag</b><span>()</span>
<br>
</p>
<div class='docstring'>
<p>call after first mousedown</p>
</div>
<div class='tags'>
</div>
</div>
<div class='method_details'>
<p class='signature' id='start_drag-dynamic'>
#
(void)
<b>start_drag</b><span>(ev, $target, diff)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='do_drag-dynamic'>
#
(void)
<b>do_drag</b><span>(ev, $target, diff)</span>
<br>
</p>
<div class='docstring'>
<p>do drag
first call</p>
</div>
<div class='tags'>
</div>
</div>
<div class='method_details'>
<p class='signature' id='cleanup_drag-dynamic'>
#
(void)
<b>cleanup_drag</b><span>(ev)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='stop_drag-dynamic'>
#
(void)
<b>stop_drag</b><span>(ev)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='__finish_drag-dynamic'>
#
(void)
<b>__finish_drag</b><span>(ev)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='end_drag-dynamic'>
#
(void)
<b>end_drag</b><span>(ev)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='get_helper_pos-dynamic'>
#
(void)
<b>get_helper_pos</b><span>(ev, gd, diff)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='get_helper_contain_element-dynamic'>
#
(void)
<b>get_helper_contain_element</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='position_helper-dynamic'>
#
(void)
<b>position_helper</b><span>(ev, $target, diff)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='getCloneSourceForHelper-dynamic'>
#
(void)
<b>getCloneSourceForHelper</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='get_axis-dynamic'>
#
(void)
<b>get_axis</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='get_helper-dynamic'>
#
(void)
<b>get_helper</b><span>(ev, gd, diff)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='get_init_helper_pos-dynamic'>
#
(void)
<b>get_init_helper_pos</b><span>(node, gd, offset = {
top: 0,
left: 0
})</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='init_helper-dynamic'>
#
(void)
<b>init_helper</b><span>(ev, $target, diff)</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>