Class: CUI.Layout

Defined in: base/Layout/Layout.coffee
Inherits: CUI.DOMElement

Overview

{Layout} is used for all layout related stuff, like {HorizontalLayout}, {VerticalLayout}, {BorderLayout}, {Toolbar}, {Pane}, etc.

It features an automatic {Buttonbar} generation for all panes (see {Layout#append})

Direct Known Subclasses

CUI.BorderLayout CUI.HorizontalLayout CUI.VerticalLayout

Variables Summary

Variable inherited from CUI.DOMElement

defaults uniqueId

Class Method Summary

Instance Method Summary

Inherited Method Summary

Methods inherited from CUI.DOMElement

#initOpts #registerTemplate #getDOMElementClasses #registerDOMElement #getElementForLayer #unregisterDOMElement #__assertDOMElement #__assertTemplateElement #addClass #setAria #removeClass #hide #show #hasClass #isDestroyed #empty #replace #append #prepend #text #get #getFlexHandle #destroy #getElementClass #getUniqueId #getOpts #getOpt #hasOpt #getSetOpt #hasSetOpt #copy #mergeOpt #removeOpt #addOpt #addOpts #mergeOpts #__getCheckMap #readOpts #readOptsFromAttr #proxy .getOptKeys

Class Method Details

. (void) setAbsolute(layout)

. (void) __all()

. (void) all()

Constructor Details

# (void) constructor(opts = {})

Construct a new Layout.

TODO document other options TODO create a Pane Class

Parameters:

  • options ( Object ) for layout creation

Options Hash: (options):

  • maximize ( String ) the center so that it pushes top pane to top and bottom pane to the bottom of the parent element
  • pane ( Object ) name of the pane on its options, check {Layout.initPane} for the options.

Instance Method Details

# (void) initOpts()

# (void) readOpts()

# (void) maximizeAddClasses()

# (void) maximizeReadOpts()

# (void) init()

# (void) getTemplateMap()

# (void) __init()

# (void) destroy()

# (void) getMapPrefix()

# (void) __initPane(options, pane_name)

initialive pane option

# (void) hasFlexHandles()

returns true if this Layout has at least one flexHandle

# (void) initDefaultPanes()

init default panes, so that they are in markup

# (void) getPanes()

# (void) getSupportedPanes()

# (void) getLayout()

# (void) getButtonbar(key)

# (void) __callAutoButtonbar(value, key)

# (jQuery) append(value, key, auto_buttonbar = @_auto_buttonbar)

Parameters:

  • value ( jQuery, Function, Array, ... ) the value to append to the layer
  • key ( String ) the name of the pane
  • auto_buttonbar ( Boolean ) if set to true (default), automatically generate a {Buttonbar} for Buttons passed directly, in an Array or thru a Function

Returns:

  • ( jQuery ) — the DOM node (created and) appended

# (void) replace(value, key, auto_buttonbar = @_auto_buttonbar)

# (void) setAbsolute()

# (void) unsetAbsolute()

# (void) getName()

    Quickly fuzzy find classes, mixins, methods, file:

    Control the navigation frame:

    You can focus and blur the search input: