ensemble._composition
Classes#
- _composition
Base class for ensemble.Compo and ensemble.Snap composition elements.
Constants#
- REJECTED_TAGS ⇒
boolean Inject an element node inside this composition. Note that any inner element contained will be removed.
Typedefs#
- upCallback :
function up callback
_composition#
Base class for ensemble.Compo and ensemble.Snap composition elements.
Kind: global abstract class
- _composition
- .children ⇒
array - .first ⇒
ensemble.Compo - .last ⇒
ensemble.Compo - ._renderer()
- .install(root, cb) ⇒
boolean - .uninstall(root, cb) ⇒
boolean - .up(pholder, cb) ⇒
boolean - .append(compo) ⇒
boolean - .prepend(compo) ⇒
boolean - .remove(compo) ⇒
boolean - .empty()
- .children ⇒
_composition.children ⇒ array#
Getter for children property, intended as children compo of this composition.
Kind: instance property of _composition
_composition.first ⇒ ensemble.Compo#
Getter for first property, intended as the first compo contained inside of this composition.
Kind: instance property of _composition
_composition.last ⇒ ensemble.Compo#
Getter for last property, intended as the last compo contained inside of this composition.
Kind: instance property of _composition
_composition._renderer()#
Element renderer.
Kind: instance method of _composition
Todo
- TODO
_composition.install(root, cb) ⇒ boolean#
Install the composition.
Kind: instance method of _composition
See: Node.appendChild()
| Param | Type | Description |
|---|---|---|
| root | Element | A valid Element node |
| cb | function | A function callback |
_composition.uninstall(root, cb) ⇒ boolean#
Uninstall the composition.
Kind: instance method of _composition
See: Node.removeChild()
| Param | Type | Description |
|---|---|---|
| root | Element | A valid Element node |
| cb | function | A function callback |
_composition.up(pholder, cb) ⇒ boolean#
Loads the composition replacing a placeholder element.
Kind: instance method of _composition
See: Node.replaceWith()
Todo
- backward compatibility
| Param | Type | Description |
|---|---|---|
| pholder | Element | A valid Element node |
| cb | upCallback | A function callback |
_composition.append(compo) ⇒ boolean#
Appends a compo inside this composition.
Kind: instance method of _composition
See: Node.appendChild()
| Param | Type | Description |
|---|---|---|
| compo | ensemble.Compo | An ensemble.Compo composition |
_composition.prepend(compo) ⇒ boolean#
Prepends a compo inside this composition.
Kind: instance method of _composition
See: Node.prependChild()
| Param | Type | Description |
|---|---|---|
| compo | ensemble.Compo | An ensemble.Compo composition |
_composition.remove(compo) ⇒ boolean#
Removes a compo from this composition.
Kind: instance method of _composition
See: Node.removeChild()
| Param | Type | Description |
|---|---|---|
| compo | ensemble.Compo | An ensemble.Compo composition |
_composition.empty()#
Empty this composition. Any inner element contained will be removed.
Kind: instance method of _composition
REJECTED_TAGS ⇒ boolean#
Inject an element node inside this composition. Note that any inner element contained will be removed.
Kind: global constant
See: Node.appendChild()
| Param | Type | Description |
|---|---|---|
| node | Element | A valid Element node |
upCallback : function#
up callback
Kind: global typedef
| Param | Type |
|---|---|
| compo | ensemble.Compo |