ensemble.base

ensemble

• ensemble
  • ~base
    • new base([element], options)
    • .defaults(defaults, options) ⇒ object
    • .compo(ns, [tag], [name]) ⇒ mixed
    • .data(obj) ⇒ mixed
    • .event(obj) ⇒ mixed
    • .selector(query, node, all) ⇒ mixed
    • .appendNode(parent, node) ⇒ boolean
    • .prependNode(parent, node) ⇒ boolean
    • .removeNode(parent, node) ⇒ boolean
    • .cloneNode(node, deep) ⇒ boolean
    • .hasAttr(node, attr) ⇒ boolean
    • .getAttr(node, attr) ⇒ string
    • .setAttr(node, attr, value)
    • .delAttr(node, attr)
    • .binds(method) ⇒ function
    • .delay(func, node, dtime)
    • .timing(node, prop) ⇒ int

ensemble~base

A base class for ensemble components.

Kind: inner abstract class of ensemble

• ~base
  • new base([element], options)
  • .defaults(defaults, options) ⇒ object
  • .compo(ns, [tag], [name]) ⇒ mixed
  • .data(obj) ⇒ mixed
  • .event(obj) ⇒ mixed
  • .selector(query, node, all) ⇒ mixed
  • .appendNode(parent, node) ⇒ boolean
  • .prependNode(parent, node) ⇒ boolean
  • .removeNode(parent, node) ⇒ boolean
  • .cloneNode(node, deep) ⇒ boolean
  • .hasAttr(node, attr) ⇒ boolean
  • .getAttr(node, attr) ⇒ string
  • .setAttr(node, attr, value)
  • .delAttr(node, attr)
  • .binds(method) ⇒ function
  • .delay(func, node, dtime)
  • .timing(node, prop) ⇒ int

new base([element], options)

Constructor method.

Param	Type	Description
[element]	Element	A valid element, could be used within the extending class
options	object	Options object

Example

new base([, element], options)

base.defaults(defaults, options) ⇒ object

Creates an options Object from a defaults object of pre-defined properties.

Note it supports only the first level of depth.

Kind: instance method of base

Param	Type	Description
defaults	object	The default options Object
options	object	An options Object that would extends

base.compo(ns, [tag], [name]) ⇒ mixed

Shorthand method for ensemble.Compo class.

When passed the first argument it makes a new Compo instance, otherwise it returns a reference to the Compo class.

Kind: instance method of base
Returns: mixed - Instance of ensemble.Data -or- ensemble.Data class reference

Param	Type	Default	Description
ns	string		Composition namespace
[tag]	string	"'div'"	The [DOM] Element node tag -or- component name, empty for ensemble.Compo class reference
[name]	mixed		The composition name, used for CSS className

base.data(obj) ⇒ mixed

Shorthand method for ensemble.Data class.

When passed the first argument it makes a new Data instance, otherwise it returns a reference to the Data class.

Kind: instance method of base
Returns: mixed - Instance of ensemble.Data -or- ensemble.Data class reference

Param	Type	Description
obj	object	A starter Object, empty for ensemble.Data class reference

base.event(obj) ⇒ mixed

Shorthand method for ensemble.Event class.

When the passed first argument is a string it makes a new Event instance, if you pass an Event as the first argument, a preventDefault and blur will be performed, otherwise it returns a reference to the Event class.

Kind: instance method of base

Param	Type	Description
obj	object	A starter Object, empty for ensemble.Event class reference

base.selector(query, node, all) ⇒ mixed

Shortcut to querySelectorAll() and querySelector() [DOM].

Kind: instance method of base
Returns: mixed - - Element -or- ElementCollection
See

• Element.querySelectorAll()
• Element.querySelector()

Param	Type	Default	Description
query	string		A text query
node	Element		An Element node where find
all	boolean	false	Find single or multiple elements

base.appendNode(parent, node) ⇒ boolean

Shortcut to appendChild() [DOM].

Kind: instance method of base
See: Element.appendChild()

Param	Type	Description
parent	Element	An Element parent
node	Element	An Element node to append

base.prependNode(parent, node) ⇒ boolean

Shortcut to prependChild() [DOM].

Kind: instance method of base
See: Element.prependChild()

Param	Type	Description
parent	Element	An Element parent
node	Element	An Element node to prepend

base.removeNode(parent, node) ⇒ boolean

Shortcut to cloneNode() [DOM].

Kind: instance method of base
See: Element.removeNode()

Param	Type	Description
parent	Element	An Element parent
node	Element	An Element node to remove

base.cloneNode(node, deep) ⇒ boolean

Shortcut to Element.cloneNode() [DOM].

Kind: instance method of base
See: Element.cloneNode()

Param	Type	Default	Description
node	Element		An Element node to clone
deep	boolean	false	Clone also all children inside the Element node

base.hasAttr(node, attr) ⇒ boolean

Shortcut to Element.hasAttribute() [DOM].

Kind: instance method of base
See: Element.hasAttribute()

Param	Type	Description
node	Element	An Element node
attr	string	An attribute

base.getAttr(node, attr) ⇒ string

Shortcut to Element.getAttribute() [DOM].

Kind: instance method of base
See: Element.getAttribute()

Param	Type	Description
node	Element	An Element node
attr	string	An attribute

base.setAttr(node, attr, value)

Shortcut to Element.setAttribute() [DOM].

Kind: instance method of base
See: Element.setAttribute()

Param	Type	Description
node	Element	An Element node
attr	string	An attribute
value	string	The value

base.delAttr(node, attr)

Shortcut to Element.removettribute() [DOM].

Kind: instance method of base
See: Element.removeAttribute()

Param	Type	Description
node	Element	An Element node
attr	string	An attribute

base.binds(method) ⇒ function

Creates a proxy function with bindings to instance and optionally an event.

Kind: instance method of base
Todo

• untrusted method

Param	Type	Description
method	function	A method from the current instance

base.delay(func, node, dtime)

Provides a delay and executes a callback function

Kind: instance method of base
See: window.setTimeout()

Param	Type	Description
func	function	A function callback
node	mixed	An Element node -or- an ensemble.Compo composition
dtime	int	A default value of time in milliseconds

base.timing(node, prop) ⇒ int

Calculates a time, based on a time property of the style of an element

Kind: instance method of base
Returns: int - time - Number of time in milliseconds
See: window.getComputedStyle()

Param	Type	Default	Description
node	mixed		An Element node -or- an ensemble.Compo composition
prop	string	"transitionDuration"	A style property