coffeescript-ui

<!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> » <span class='title'>CUI</span> » <span class='title'>Layout</span> </div> </div> <div id='content'> <h1> Class: CUI.Layout </h1> <table class='box'> <tr> <td>Defined in:</td> <td>base/Layout/Layout.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>{Layout} is used for all layout related stuff, like {HorizontalLayout}, {VerticalLayout}, {BorderLayout}, {Toolbar}, {Pane}, etc.</p><p>It features an automatic {Buttonbar} generation for all panes (see {Layout#append})</p> </div> <div class='tags'> </div> <h2>Direct Known Subclasses</h2> <p class='children'> <a href='../../class/CUI/BorderLayout.html'>CUI.BorderLayout</a> <a href='../../class/CUI/HorizontalLayout.html'>CUI.HorizontalLayout</a> <a href='../../class/CUI/VerticalLayout.html'>CUI.VerticalLayout</a> </p> <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>Class Method Summary</h2> <ul class='summary'> <li> <span class='signature'> <a href='#setAbsolute-static'> . (void) <b>setAbsolute</b><span>(layout)</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#__all-static'> . (void) <b>__all</b><span>()</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#all-static'> . (void) <b>all</b><span>()</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='#readOpts-dynamic'> # (void) <b>readOpts</b><span>()</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#maximizeAddClasses-dynamic'> # (void) <b>maximizeAddClasses</b><span>()</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#maximizeReadOpts-dynamic'> # (void) <b>maximizeReadOpts</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='#getTemplateMap-dynamic'> # (void) <b>getTemplateMap</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='#destroy-dynamic'> # (void) <b>destroy</b><span>()</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#getMapPrefix-dynamic'> # (void) <b>getMapPrefix</b><span>()</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#__initPane-dynamic'> # (void) <b>__initPane</b><span>(options, pane_name)</span> </a> </span> <span class='desc'> initialive pane option </span> </li> <li> <span class='signature'> <a href='#hasFlexHandles-dynamic'> # (void) <b>hasFlexHandles</b><span>()</span> </a> </span> <span class='desc'> returns true if this Layout has at least one flexHandle </span> </li> <li> <span class='signature'> <a href='#initDefaultPanes-dynamic'> # (void) <b>initDefaultPanes</b><span>()</span> </a> </span> <span class='desc'> init default panes, so that they are in markup </span> </li> <li> <span class='signature'> <a href='#getPanes-dynamic'> # (void) <b>getPanes</b><span>()</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#getSupportedPanes-dynamic'> # (void) <b>getSupportedPanes</b><span>()</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#getLayout-dynamic'> # (void) <b>getLayout</b><span>()</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#getButtonbar-dynamic'> # (void) <b>getButtonbar</b><span>(key)</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#__callAutoButtonbar-dynamic'> # (void) <b>__callAutoButtonbar</b><span>(value, key)</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#append-dynamic'> # (jQuery) <b>append</b><span>(value, key, auto_buttonbar = @_auto_buttonbar)</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#replace-dynamic'> # (void) <b>replace</b><span>(value, key, auto_buttonbar = @_auto_buttonbar)</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#setAbsolute-dynamic'> # (void) <b>setAbsolute</b><span>()</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#unsetAbsolute-dynamic'> # (void) <b>unsetAbsolute</b><span>()</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> </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>Class Method Details</h2> <div class='methods'> <div class='method_details'> <p class='signature' id='setAbsolute-static'> . (void) <b>setAbsolute</b><span>(layout)</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='__all-static'> . (void) <b>__all</b><span>()</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='all-static'> . (void) <b>all</b><span>()</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 class='docstring'> <p>Construct a new Layout.</p><p>TODO document other options TODO create a Pane Class</p> </div> <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 layout creation </span> </li> </ul> <h3> Options Hash: (options): </h3> <ul class='options'> <li> <span class='name'>maximize</span> <span class='type'> ( <tt>String</tt> ) </span> — <span class='desc'>the center so that it pushes top pane to top and bottom pane to the bottom of the parent element </span> </li> <li> <span class='name'>pane</span> <span class='type'> ( <tt>Object</tt> ) </span> — <span class='desc'>name of the pane on its options, check {Layout.initPane} for the options. </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='readOpts-dynamic'> # (void) <b>readOpts</b><span>()</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='maximizeAddClasses-dynamic'> # (void) <b>maximizeAddClasses</b><span>()</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='maximizeReadOpts-dynamic'> # (void) <b>maximizeReadOpts</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='getTemplateMap-dynamic'> # (void) <b>getTemplateMap</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='destroy-dynamic'> # (void) <b>destroy</b><span>()</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='getMapPrefix-dynamic'> # (void) <b>getMapPrefix</b><span>()</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='__initPane-dynamic'> # (void) <b>__initPane</b><span>(options, pane_name)</span> <br> </p> <div class='docstring'> <p>initialive pane option</p> </div> <div class='tags'> </div> </div> <div class='method_details'> <p class='signature' id='hasFlexHandles-dynamic'> # (void) <b>hasFlexHandles</b><span>()</span> <br> </p> <div class='docstring'> <p>returns true if this Layout has at least one flexHandle</p> </div> <div class='tags'> </div> </div> <div class='method_details'> <p class='signature' id='initDefaultPanes-dynamic'> # (void) <b>initDefaultPanes</b><span>()</span> <br> </p> <div class='docstring'> <p>init default panes, so that they are in markup</p> </div> <div class='tags'> </div> </div> <div class='method_details'> <p class='signature' id='getPanes-dynamic'> # (void) <b>getPanes</b><span>()</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='getSupportedPanes-dynamic'> # (void) <b>getSupportedPanes</b><span>()</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='getLayout-dynamic'> # (void) <b>getLayout</b><span>()</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='getButtonbar-dynamic'> # (void) <b>getButtonbar</b><span>(key)</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='__callAutoButtonbar-dynamic'> # (void) <b>__callAutoButtonbar</b><span>(value, key)</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='append-dynamic'> # (jQuery) <b>append</b><span>(value, key, auto_buttonbar = @_auto_buttonbar)</span> <br> </p> <div class='tags'> <h3>Parameters:</h3> <ul class='param'> <li> <span class='name'>value</span> <span class='type'> ( <tt>jQuery, Function, Array, ...</tt> ) </span> — <span class='desc'>the value to append to the layer </span> </li> <li> <span class='name'>key</span> <span class='type'> ( <tt>String</tt> ) </span> — <span class='desc'>the name of the pane </span> </li> <li> <span class='name'>auto_buttonbar</span> <span class='type'> ( <tt>Boolean</tt> ) </span> — <span class='desc'>if set to true (default), automatically generate a {Buttonbar} for Buttons passed directly, in an Array or thru a Function </span> </li> </ul> <h3>Returns:</h3> <ul class='return'> <li> <span class='type'></span> ( <tt>jQuery</tt> ) — <span class='desc'>the DOM node (created and) appended </span> </li> </ul> </div> </div> <div class='method_details'> <p class='signature' id='replace-dynamic'> # (void) <b>replace</b><span>(value, key, auto_buttonbar = @_auto_buttonbar)</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='setAbsolute-dynamic'> # (void) <b>setAbsolute</b><span>()</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='unsetAbsolute-dynamic'> # (void) <b>unsetAbsolute</b><span>()</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='getName-dynamic'> # (void) <b>getName</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>