≡
Top

class Node

smx. Node

source: document/Node.js, line 13

The Node class wraps an XMLNode and provides an easy to use api to interact with it.

This class can be further extended by mixins from custom modules.

Details:
Mixes In:

Constructor

new Node(xmlNode)

source: document/Node.js, line 13
Parameters
  • xmlNode {XMLNode}

Members

[0]:XMLNode

  • protected
source: document/Node.js, line 30

Original XMLNode for reference

id:String

  • readonly
source: document/Node.js, line 38

Direct access to XMLNode's id attribute.

name:String

  • readonly
source: document/Node.js, line 47

Direct access to XMLNode name

type:String

  • readonly
source: document/Node.js, line 57

Gets node name based on inner XMLNode.nodeName, default is smx, posible values are txt, md, html, ...

className:String

  • readonly
source: document/Node.js, line 69

Gets node className based on inner XMLNode class attribute

document:SMXDocument

  • readonly
source: document/Node.js, line 81

Gets the owner SMXDoxument

hash:String

  • readonly
source: document/Node.js, line 90

Gets browser url hash

uri:String

  • readonly
source: document/Node.js, line 101

Gets Uniform Resource Identifier. Concatenation of id values from parent nodes up to document root

url:String

  • readonly
source: document/Node.js, line 114

Gets Uniform Resource Locator Concatenation of path values from parent nodes up to document root

src:String

  • readonly
source: document/Node.js, line 149

Gets source file url for this node

parent:SMXNode

  • readonly
source: document/Node.js, line 172

Gets parent node

ancestors:Array.<SMXNode>

  • readonly
source: document/Node.js, line 181

Gets ancestors nodes, ordered from outer to inner.

root:SMXNode

  • readonly
source: document/Node.js, line 197

Gets root node

children:Array.<SMXNode>

  • readonly
source: document/Node.js, line 206

Gets children nodes

first:SMXNode

  • readonly
source: document/Node.js, line 217

Gets first child node

last:SMXNode

  • readonly
source: document/Node.js, line 226

Gets last child node

previous:SMXNode

  • readonly
source: document/Node.js, line 236

Gets previous sibling node

next:SMXNode

  • readonly
source: document/Node.js, line 245

Gets next sibling node

Methods

getIndex([selector]) → {Integer}

source: document/Node-Core.js, line 23

Gets the index position in parent's children. If node has no parent, will return 0. When using the optional parameter selector, the resultant index is calculated based only in the sibling nodes matching the given selector, if node does not match the selector itself will return -1.

Parameters
  • [selector] {String} :

    filter selector
Returns
  • {Integer}
Details:
Mixes In:

getText() → {String}

source: document/Node-Core.js, line 52

Gets the text content.

Returns
  • {String}
Details:
Mixes In:

getHTML() → {String}

source: document/Node-Core.js, line 64

Gets the html content.

Returns
  • {String}
Details:
Mixes In:

getData() → {String}

source: document/Node-Core.js, line 85

Gets the inner data content formatted according to node type.

Returns
  • {String}
Details:
Mixes In:

toString() → {String}

source: document/Node-Core.js, line 112

Gets the string representation.

Returns
  • {String}
Details:
Mixes In:

toJSON() → {Object}

source: document/Node-Core.js, line 118

Gets the Node as JSON Object representation.

Returns
  • {Object}
Details:
Mixes In:
To Do:
  • Not Implemented!

attr(name) → {String}

source: document/Node-Attributes.js, line 20

Gets the value for the given attribute name.

Parameters
  • name {String} :

    attribute name
Returns
  • {String} :

    value
Details:
Mixes In:
Example
//<movie tags="sci-fi, horror, adventures" />
$movie.attr('tags')
// => "sci-fi, horror, adventures"

get(name, [opt]) → {String}

source: document/Node-Attributes.js, line 35

This method is like attr but will use an attribute parser if there is one predefined for the given attribute name.

Parameters
  • name {String} :

    attribute name
  • [opt] {Object} :

    options to pass into attribute parser
Returns
  • {String} :

    value
Details:
Mixes In:

has(name) → {Boolean}

source: document/Node-Attributes.js, line 51

Checks if node has or not an attribute with the given name

Parameters
  • name {String} :

    attribute name
Returns
  • {Boolean}
Details:
Mixes In:

dsv(name, [delimiter]) → {Array.<String>}

source: document/Node-Attributes.js, line 66

Gets Delimiter Separated Value An utility method converts given attribute value into dsv array

Parameters
  • name {String} :

    the name of the attribute
  • [delimiter] {String} :

    delimiter string
Returns
  • {Array.<String>}
Details:
Mixes In:
Example
//<movie tags="sci-fi, horror, adventures">
$movie.dsv('tags',',')
// => ["sci-fi", "horror", "adventures"]

getAncestors(selector) → {Array.<smx.Node>}

source: document/Node-Traversal.js, line 17

Gets a list of all ancestor nodes matching the given selector, ordered from outer to inner.

Parameters
  • selector {String}
Returns
Details:
Mixes In:

isAncestorOf(node) → {Boolean}

source: document/Node-Traversal.js, line 32

Checks if node is an ancestor of another.

Parameters
Returns
  • {Boolean}
Details:
Mixes In:

isMatch(selector) → {Boolean}

source: document/Node-Traversal.js, line 48

Checks if node matches the given selector.

Parameters
  • selector {String} :

    css selector to match
Returns
  • {Boolean}
Details:
Mixes In:

find(selector) → {Array.<Node>}

source: document/Node-Traversal.js, line 62

Finds all descendant nodes matching the given selector.

Parameters
  • selector {String} :

    search selector
Returns
  • {Array.<Node>}
Details:
Mixes In:

findOne(selector) → {smx.Node}

source: document/Node-Traversal.js, line 78

This method is like find but returns only the first result.

Parameters
  • selector {String} :

    search selector
Returns
Details:
Mixes In:

getChildren([selector]) → {Array.<Node>}

source: document/Node-Traversal.js, line 92

Gets the children nodes matching the given selector.

Parameters
  • [selector] {String}
Returns
  • {Array.<Node>}
Details:
Mixes In:

getFirst([selector]) → {smx.Node}

source: document/Node-Traversal.js, line 107

Gets the first child node matching the given selector.

Parameters
  • [selector] {String}
Returns
Details:
Mixes In:

getLast([selector]) → {smx.Node}

source: document/Node-Traversal.js, line 130

Gets the last child node matching the given selector.

Parameters
  • [selector] {String}
Returns
Details:
Mixes In:

getChildAt(index) → {smx.Node}

source: document/Node-Traversal.js, line 156

Gets child node at given index

Parameters
  • index {Integer} :

    index position
Returns
Details:
Mixes In:

isDescendantOf(node) → {Boolean}

source: document/Node-Traversal.js, line 169

Checks if a node is child of another

Parameters
Returns
  • {Boolean}
Details:
Mixes In:

getNext([selector]) → {smx.Node}

source: document/Node-Traversal.js, line 188

Gets the next sibling node matching the given selector.

Parameters
  • [selector] {String} :

    filter selector
Returns
Details:
Mixes In:

getAllNext([selector]) → {Array.<smx.Node>}

source: document/Node-Traversal.js, line 212

Gets all next sibling nodes matching the given selector.

Parameters
  • [selector] {String} :

    filter selector
Returns
Details:
Mixes In:

getPrevious([selector]) → {smx.Node}

source: document/Node-Traversal.js, line 237

Gets the previous sibling node matching the given selector.

Parameters
  • [selector] {String} :

    filter selector
Returns
Details:
Mixes In:

getAllPrevious([selector]) → {Array.<smx.Node>}

source: document/Node-Traversal.js, line 261

Gets all previous sibling nodes matching the given selector.

Parameters
  • [selector] {String} :

    filter selector
Returns
Details:
Mixes In: