UNPKG

coffeescript-ui

Version:
623 lines (602 loc) 16.3 kB
<!DOCTYPE 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> &raquo; <span class='title'>CUI</span> &raquo; <span class='title'>ItemList</span> </div> </div> <div id='content'> <h1> Class: CUI.ItemList </h1> <table class='box'> <tr> <td>Defined in:</td> <td>elements&#47;ItemList&#47;ItemList.coffee</td> </tr> <tr> <td>Inherits:</td> <td> <a href='../../class/CUI/VerticalLayout.html'>CUI.VerticalLayout</a> </td> </tr> </table> <h2>Variables Summary</h2> <h3 class='inherited'> Variable inherited from <a href='../../class/CUI/VerticalLayout.html'>CUI.VerticalLayout</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='#init-dynamic'> # (void) <b>init</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='#readOpts-dynamic'> # (void) <b>readOpts</b><span>()</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#setActiveIdx-dynamic'> # (void) <b>setActiveIdx</b><span>(__active_idx)</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#getActiveIdx-dynamic'> # (void) <b>getActiveIdx</b><span>()</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#getBody-dynamic'> # (void) <b>getBody</b><span>()</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#getItemByValue-dynamic'> # (void) <b>getItemByValue</b><span>(value)</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#hasItems-dynamic'> # (void) <b>hasItems</b><span>(event)</span> </a> </span> <span class='desc'> returns immediately, if &quot;Promise&quot; we assume yes </span> </li> <li> <span class='signature'> <a href='#__getItems-dynamic'> # (void) <b>__getItems</b><span>(event)</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#getItems-dynamic'> # (void) <b>getItems</b><span>(event)</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#__initActiveIdx-dynamic'> # (void) <b>__initActiveIdx</b><span>()</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#render-dynamic'> # (void) <b>render</b><span>(menu, event)</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='#preSelectByKeyword-dynamic'> # (void) <b>preSelectByKeyword</b><span>(keyword)</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#activatePreSelectedItem-dynamic'> # (void) <b>activatePreSelectedItem</b><span>()</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#preActivateNextItem-dynamic'> # (void) <b>preActivateNextItem</b><span>()</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#preActivatePreviousItem-dynamic'> # (void) <b>preActivatePreviousItem</b><span>()</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#__preActivateItemByIndex-dynamic'> # (void) <b>__preActivateItemByIndex</b><span>(newPreActiveIndex)</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#__deselectPreActivated-dynamic'> # (void) <b>__deselectPreActivated</b><span>()</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#__activateItemByIndex-dynamic'> # (void) <b>__activateItemByIndex</b><span>(index)</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#__getItemByIndex-dynamic'> # (void) <b>__getItemByIndex</b><span>(index)</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/VerticalLayout.html'>CUI.VerticalLayout</a> </h3> <p class='inherited'> <a href='../../class/CUI/VerticalLayout.html#getName-dynamic'>#getName</a> <a href='../../class/CUI/VerticalLayout.html#getMapPrefix-dynamic'>#getMapPrefix</a> <a href='../../class/CUI/VerticalLayout.html#hasFlexHandles-dynamic'>#hasFlexHandles</a> <a href='../../class/CUI/VerticalLayout.html#getPanes-dynamic'>#getPanes</a> <a href='../../class/CUI/VerticalLayout.html#getSupportedPanes-dynamic'>#getSupportedPanes</a> <a href='../../class/CUI/Layout.html#initOpts-dynamic'>#initOpts</a> <a href='../../class/CUI/Layout.html#readOpts-dynamic'>#readOpts</a> <a href='../../class/CUI/Layout.html#maximizeAddClasses-dynamic'>#maximizeAddClasses</a> <a href='../../class/CUI/Layout.html#maximizeReadOpts-dynamic'>#maximizeReadOpts</a> <a href='../../class/CUI/Layout.html#init-dynamic'>#init</a> <a href='../../class/CUI/Layout.html#getTemplateMap-dynamic'>#getTemplateMap</a> <a href='../../class/CUI/Layout.html#__init-dynamic'>#__init</a> <a href='../../class/CUI/Layout.html#destroy-dynamic'>#destroy</a> <a href='../../class/CUI/Layout.html#__initPane-dynamic'>#__initPane</a> <a href='../../class/CUI/Layout.html#initDefaultPanes-dynamic'>#initDefaultPanes</a> <a href='../../class/CUI/Layout.html#getLayout-dynamic'>#getLayout</a> <a href='../../class/CUI/Layout.html#getButtonbar-dynamic'>#getButtonbar</a> <a href='../../class/CUI/Layout.html#__callAutoButtonbar-dynamic'>#__callAutoButtonbar</a> <a href='../../class/CUI/Layout.html#append-dynamic'>#append</a> <a href='../../class/CUI/Layout.html#replace-dynamic'>#replace</a> <a href='../../class/CUI/Layout.html#setAbsolute-dynamic'>#setAbsolute</a> <a href='../../class/CUI/Layout.html#unsetAbsolute-dynamic'>#unsetAbsolute</a> <a href='../../class/CUI/Layout.html#__all-static'>.__all</a> <a href='../../class/CUI/Layout.html#all-static'>.all</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#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/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#getOptKeys-static'>.getOptKeys</a> </p> </h2> <h2>Instance Method Details</h2> <div class='methods'> <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='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='setActiveIdx-dynamic'> # (void) <b>setActiveIdx</b><span>(__active_idx)</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='getActiveIdx-dynamic'> # (void) <b>getActiveIdx</b><span>()</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='getBody-dynamic'> # (void) <b>getBody</b><span>()</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='getItemByValue-dynamic'> # (void) <b>getItemByValue</b><span>(value)</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='hasItems-dynamic'> # (void) <b>hasItems</b><span>(event)</span> <br> </p> <div class='docstring'> <p>returns immediately, if &quot;Promise&quot; we assume yes</p> </div> <div class='tags'> </div> </div> <div class='method_details'> <p class='signature' id='__getItems-dynamic'> # (void) <b>__getItems</b><span>(event)</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='getItems-dynamic'> # (void) <b>getItems</b><span>(event)</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='__initActiveIdx-dynamic'> # (void) <b>__initActiveIdx</b><span>()</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='render-dynamic'> # (void) <b>render</b><span>(menu, event)</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='preSelectByKeyword-dynamic'> # (void) <b>preSelectByKeyword</b><span>(keyword)</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='activatePreSelectedItem-dynamic'> # (void) <b>activatePreSelectedItem</b><span>()</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='preActivateNextItem-dynamic'> # (void) <b>preActivateNextItem</b><span>()</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='preActivatePreviousItem-dynamic'> # (void) <b>preActivatePreviousItem</b><span>()</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='__preActivateItemByIndex-dynamic'> # (void) <b>__preActivateItemByIndex</b><span>(newPreActiveIndex)</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='__deselectPreActivated-dynamic'> # (void) <b>__deselectPreActivated</b><span>()</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='__activateItemByIndex-dynamic'> # (void) <b>__activateItemByIndex</b><span>(index)</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='__getItemByIndex-dynamic'> # (void) <b>__getItemByIndex</b><span>(index)</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 &#10034; Press H to see the keyboard shortcuts &#10034; <a href='http://twitter.com/netzpirat' target='_parent'>@netzpirat</a> &#10034; <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>