coffeescript-ui
Version:
Coffeescript User Interface System
762 lines (731 loc) • 15.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'>FlexHandle</span>
</div>
</div>
<div id='content'>
<h1>
Class:
CUI.FlexHandle
</h1>
<table class='box'>
<tr>
<td>Defined in:</td>
<td>base/FlexHandle/FlexHandle.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>this class initializes a flex handle</p>
</div>
<div class='tags'>
</div>
<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='#getStretchButton-static'>
.
(void)
<b>getStretchButton</b><span>(_opts = {})</span>
</a>
</span>
<span class='desc'>
</span>
</li>
</ul>
<h2>Instance Method Summary</h2>
<ul class='summary'>
<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='#initOpts-dynamic'>
#
(void)
<b>initOpts</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='#__setSize-dynamic'>
#
(void)
<b>__setSize</b><span>(size)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#resetSize-dynamic'>
#
(void)
<b>resetSize</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#__getSize-dynamic'>
#
(void)
<b>__getSize</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#__isAlive-dynamic'>
#
(void)
<b>__isAlive</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#__resize-dynamic'>
#
(void)
<b>__resize</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#__getState-dynamic'>
#
(void)
<b>__getState</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#__setState-dynamic'>
#
(void)
<b>__setState</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#storeState-dynamic'>
#
(void)
<b>storeState</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#isStretched-dynamic'>
#
(void)
<b>isStretched</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#stretch-dynamic'>
#
(void)
<b>stretch</b><span>(direction, do_stretch = true)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#unstretch-dynamic'>
#
(void)
<b>unstretch</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#getLabel-dynamic'>
#
(void)
<b>getLabel</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#addLabel-dynamic'>
#
(void)
<b>addLabel</b><span>(opts = {})</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#getName-dynamic'>
#
(void)
<b>getName</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#getHandle-dynamic'>
#
(void)
<b>getHandle</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#getPane-dynamic'>
#
(void)
<b>getPane</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='#isHidden-dynamic'>
#
(void)
<b>isHidden</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#isClosed-dynamic'>
#
(void)
<b>isClosed</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#isOpen-dynamic'>
#
(void)
<b>isOpen</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#close-dynamic'>
#
(void)
<b>close</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#open-dynamic'>
#
(void)
<b>open</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#hide-dynamic'>
#
(void)
<b>hide</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#show-dynamic'>
#
(void)
<b>show</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/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='getStretchButton-static'>
.
(void)
<b>getStretchButton</b><span>(_opts = {})</span>
<br>
</p>
</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='readOpts-dynamic'>
#
(void)
<b>readOpts</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='init-dynamic'>
#
(void)
<b>init</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='__setSize-dynamic'>
#
(void)
<b>__setSize</b><span>(size)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='resetSize-dynamic'>
#
(void)
<b>resetSize</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='__getSize-dynamic'>
#
(void)
<b>__getSize</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='__isAlive-dynamic'>
#
(void)
<b>__isAlive</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='__resize-dynamic'>
#
(void)
<b>__resize</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='__getState-dynamic'>
#
(void)
<b>__getState</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='__setState-dynamic'>
#
(void)
<b>__setState</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='storeState-dynamic'>
#
(void)
<b>storeState</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='isStretched-dynamic'>
#
(void)
<b>isStretched</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='stretch-dynamic'>
#
(void)
<b>stretch</b><span>(direction, do_stretch = true)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='unstretch-dynamic'>
#
(void)
<b>unstretch</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='getLabel-dynamic'>
#
(void)
<b>getLabel</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='addLabel-dynamic'>
#
(void)
<b>addLabel</b><span>(opts = {})</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='getName-dynamic'>
#
(void)
<b>getName</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='getHandle-dynamic'>
#
(void)
<b>getHandle</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='getPane-dynamic'>
#
(void)
<b>getPane</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='isHidden-dynamic'>
#
(void)
<b>isHidden</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='isClosed-dynamic'>
#
(void)
<b>isClosed</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='isOpen-dynamic'>
#
(void)
<b>isOpen</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='close-dynamic'>
#
(void)
<b>close</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='open-dynamic'>
#
(void)
<b>open</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='hide-dynamic'>
#
(void)
<b>hide</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='show-dynamic'>
#
(void)
<b>show</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
✲
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>