coffeescript-ui
Version:
Coffeescript User Interface System
431 lines (422 loc) • 11.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'>Buttonbar</span>
</div>
</div>
<div id='content'>
<h1>
Class:
CUI.Buttonbar
</h1>
<table class='box'>
<tr>
<td>Defined in:</td>
<td>elements/Button/Buttonbar.coffee</td>
</tr>
<tr>
<td>Inherits:</td>
<td>
<a href='../../class/CUI/DOMElement.html'>CUI.DOMElement</a>
</td>
</tr>
</table>
<h2>Overview</h2>
<div class='docstring'>
<p>Buttonbar groups {Button}s</p>
</div>
<div class='tags'>
</div>
<h2>Variables Summary</h2>
<h3 class='inherited'>
Variable inherited from
<a href='../../class/CUI/DOMElement.html'>CUI.DOMElement</a>
</h3>
<p class='inherited'>
<a href='../../class/CUI/DOMElement.html#defaults-variable'>defaults</a>
<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='#__proxy-dynamic'>
#
(void)
<b>__proxy</b><span>(func, args...)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#disable-dynamic'>
#
(void)
<b>disable</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#enable-dynamic'>
#
(void)
<b>enable</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#__setVisibilityClasses-dynamic'>
#
(void)
<b>__setVisibilityClasses</b><span>(el)</span>
</a>
</span>
<span class='bound note title'>Bound</span>
<span class='desc'>
sets classes on all children of "el" returns the number of visible children
</span>
</li>
<li>
<span class='signature'>
<a href='#__checkVisibility-dynamic'>
#
(void)
<b>__checkVisibility</b><span>()</span>
</a>
</span>
<span class='desc'>
hide the group if no children
</span>
</li>
<li>
<span class='signature'>
<a href='#removeButtons-dynamic'>
#
(void)
<b>removeButtons</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#prependButton-dynamic'>
#
(void)
<b>prependButton</b><span>(btn, check_visibility = true)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#addButton-dynamic'>
#
(void)
<b>addButton</b><span>(btn, check_visibility = true, prepend = false)</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/DOMElement.html'>CUI.DOMElement</a>
</h3>
<p class='inherited'>
<a href='../../class/CUI/DOMElement.html#initOpts-dynamic'>#initOpts</a>
<a href='../../class/CUI/DOMElement.html#registerTemplate-dynamic'>#registerTemplate</a>
<a href='../../class/CUI/DOMElement.html#getDOMElementClasses-dynamic'>#getDOMElementClasses</a>
<a href='../../class/CUI/DOMElement.html#registerDOMElement-dynamic'>#registerDOMElement</a>
<a href='../../class/CUI/DOMElement.html#getElementForLayer-dynamic'>#getElementForLayer</a>
<a href='../../class/CUI/DOMElement.html#unregisterDOMElement-dynamic'>#unregisterDOMElement</a>
<a href='../../class/CUI/DOMElement.html#__assertDOMElement-dynamic'>#__assertDOMElement</a>
<a href='../../class/CUI/DOMElement.html#__assertTemplateElement-dynamic'>#__assertTemplateElement</a>
<a href='../../class/CUI/DOMElement.html#addClass-dynamic'>#addClass</a>
<a href='../../class/CUI/DOMElement.html#setAria-dynamic'>#setAria</a>
<a href='../../class/CUI/DOMElement.html#removeClass-dynamic'>#removeClass</a>
<a href='../../class/CUI/DOMElement.html#hide-dynamic'>#hide</a>
<a href='../../class/CUI/DOMElement.html#show-dynamic'>#show</a>
<a href='../../class/CUI/DOMElement.html#hasClass-dynamic'>#hasClass</a>
<a href='../../class/CUI/DOMElement.html#isDestroyed-dynamic'>#isDestroyed</a>
<a href='../../class/CUI/DOMElement.html#empty-dynamic'>#empty</a>
<a href='../../class/CUI/DOMElement.html#replace-dynamic'>#replace</a>
<a href='../../class/CUI/DOMElement.html#append-dynamic'>#append</a>
<a href='../../class/CUI/DOMElement.html#prepend-dynamic'>#prepend</a>
<a href='../../class/CUI/DOMElement.html#text-dynamic'>#text</a>
<a href='../../class/CUI/DOMElement.html#get-dynamic'>#get</a>
<a href='../../class/CUI/DOMElement.html#getFlexHandle-dynamic'>#getFlexHandle</a>
<a href='../../class/CUI/DOMElement.html#destroy-dynamic'>#destroy</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#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#getOptKeys-static'>.getOptKeys</a>
</p>
</h2>
<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 class='tags'>
<h3>Parameters:</h3>
<ul class='param'>
<li>
<span class='name'>options</span>
<span class='type'>
(
<tt>Object</tt>
)
</span>
—
<span class='desc'>for {Buttonbar} creation </span>
</li>
</ul>
<h3>
Options Hash:
(options):
</h3>
<ul class='options'>
<li>
<span class='name'>buttons</span>
<span class='type'>
(
<tt>Array</tt>
)
</span>
—
<span class='desc'>is an array of {Button} Objects. Use thie 'group' option in {Button} to let {Buttonbar} sort the buttons into groups. </span>
</li>
<li>
<span class='name'>tooltip</span>
<span class='type'>
(
<tt>Object</tt>
)
</span>
—
<span class='desc'>is a list of options for creating a {Tooltip} for the {Buttonbar}. </span>
</li>
</ul>
</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='__proxy-dynamic'>
#
(void)
<b>__proxy</b><span>(func, args...)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='disable-dynamic'>
#
(void)
<b>disable</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='enable-dynamic'>
#
(void)
<b>enable</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='__setVisibilityClasses-dynamic'>
#
(void)
<b>__setVisibilityClasses</b><span>(el)</span>
<span class='bound note'>Bound</span>
<br>
</p>
<div class='docstring'>
<p>sets classes on all children of "el"
returns the number of visible children</p>
</div>
<div class='tags'>
</div>
</div>
<div class='method_details'>
<p class='signature' id='__checkVisibility-dynamic'>
#
(void)
<b>__checkVisibility</b><span>()</span>
<br>
</p>
<div class='docstring'>
<p>hide the group if no children</p>
</div>
<div class='tags'>
</div>
</div>
<div class='method_details'>
<p class='signature' id='removeButtons-dynamic'>
#
(void)
<b>removeButtons</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='prependButton-dynamic'>
#
(void)
<b>prependButton</b><span>(btn, check_visibility = true)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='addButton-dynamic'>
#
(void)
<b>addButton</b><span>(btn, check_visibility = true, prepend = false)</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>