UNPKG

coffeescript-ui

Version:
717 lines (688 loc) 15.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'>Template</span> </div> </div> <div id='content'> <h1> Class: CUI.Template </h1> <table class='box'> <tr> <td>Defined in:</td> <td>base&#47;Template&#47;Template.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>Variables Summary</h2> <dl class='constants'> <dt id='nodeByName-variable'> nodeByName = </dt> <dd> <pre><code class='coffeescript'>{}</code></pre> </dd> </dl> <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='#loadTemplateFile-static'> . (void) <b>loadTemplateFile</b><span>(filename)</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#loadTemplateText-static'> . (void) <b>loadTemplateText</b><span>(html)</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#loadText-static'> . (void) <b>loadText</b><span>(text)</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#loadFile-static'> . (void) <b>loadFile</b><span>(filename, load_templates = false)</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#load-static'> . (void) <b>load</b><span>(start_element = document.documentElement)</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#__appendContent-static'> . (void) <b>__appendContent</b><span>(data, load_templates)</span> </a> </span> <span class='desc'> </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='#initFlexHandles-dynamic'> # (void) <b>initFlexHandles</b><span>(pane_opts = {})</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#getFlexHandle-dynamic'> # (void) <b>getFlexHandle</b><span>(name)</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#getFlexHandles-dynamic'> # (void) <b>getFlexHandles</b><span>()</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#getElMap-dynamic'> # (void) <b>getElMap</b><span>(map)</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='#addClass-dynamic'> # (void) <b>addClass</b><span>(cls, key)</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#removeClass-dynamic'> # (void) <b>removeClass</b><span>(cls, key)</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#hasClass-dynamic'> # (void) <b>hasClass</b><span>(cls, key)</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#has-dynamic'> # (void) <b>has</b><span>(key)</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#hide-dynamic'> # (void) <b>hide</b><span>(key)</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#show-dynamic'> # (void) <b>show</b><span>(key)</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#empty-dynamic'> # (void) <b>empty</b><span>(key)</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#replace-dynamic'> # (void) <b>replace</b><span>(value, key, element)</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#text-dynamic'> # (void) <b>text</b><span>(value, key, element)</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#prepend-dynamic'> # (void) <b>prepend</b><span>(value, key, element)</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#append-dynamic'> # (void) <b>append</b><span>(value, key, element, prepend = false)</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#get-dynamic'> # (void) <b>get</b><span>(key)</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#isEmpty-dynamic'> # (void) <b>isEmpty</b><span>(key)</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#removeEmptySlots-dynamic'> # (void) <b>removeEmptySlots</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='loadTemplateFile-static'> . (void) <b>loadTemplateFile</b><span>(filename)</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='loadTemplateText-static'> . (void) <b>loadTemplateText</b><span>(html)</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='loadText-static'> . (void) <b>loadText</b><span>(text)</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='loadFile-static'> . (void) <b>loadFile</b><span>(filename, load_templates = false)</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='load-static'> . (void) <b>load</b><span>(start_element = document.documentElement)</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='__appendContent-static'> . (void) <b>__appendContent</b><span>(data, load_templates)</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='initOpts-dynamic'> # (void) <b>initOpts</b><span>()</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='initFlexHandles-dynamic'> # (void) <b>initFlexHandles</b><span>(pane_opts = {})</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='getFlexHandle-dynamic'> # (void) <b>getFlexHandle</b><span>(name)</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='getFlexHandles-dynamic'> # (void) <b>getFlexHandles</b><span>()</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='getElMap-dynamic'> # (void) <b>getElMap</b><span>(map)</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='addClass-dynamic'> # (void) <b>addClass</b><span>(cls, key)</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='removeClass-dynamic'> # (void) <b>removeClass</b><span>(cls, key)</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='hasClass-dynamic'> # (void) <b>hasClass</b><span>(cls, key)</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='has-dynamic'> # (void) <b>has</b><span>(key)</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='hide-dynamic'> # (void) <b>hide</b><span>(key)</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='show-dynamic'> # (void) <b>show</b><span>(key)</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='empty-dynamic'> # (void) <b>empty</b><span>(key)</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='replace-dynamic'> # (void) <b>replace</b><span>(value, key, element)</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='text-dynamic'> # (void) <b>text</b><span>(value, key, element)</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='prepend-dynamic'> # (void) <b>prepend</b><span>(value, key, element)</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='append-dynamic'> # (void) <b>append</b><span>(value, key, element, prepend = false)</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='get-dynamic'> # (void) <b>get</b><span>(key)</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='isEmpty-dynamic'> # (void) <b>isEmpty</b><span>(key)</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='removeEmptySlots-dynamic'> # (void) <b>removeEmptySlots</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 &#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>