Merge branch 'features/63-get-selected-nodes' into develop

* features/63-get-selected-nodes:
  Added tests and doc #63
  Implemented stated based get methods `getSelected`, `getUnselected`, `getExpanded` and `getCollapsed` #63

README.md

@@ -413,6 +413,21 @@ $('#tree').treeview('expandNode', [ nodeId, { levels: 2, silent: true } ]);
 
 Triggers `nodeExpanded` event; pass silent to suppress events.
 
+#### getCollapsed()
+
+Returns an array of collapsed nodes e.g. state.expanded = false.
+
+```javascript
+$('#tree').treeview('getCollapsed', nodeId);
+```
+#### getExpanded()
+
+Returns an array of expanded nodes e.g. state.expanded = true.
+
+```javascript
+$('#tree').treeview('getExpanded', nodeId);
+```
+
 #### getNode(nodeId)
 
 Returns a single node object that matches the given node id.
@@ -429,6 +444,14 @@ Returns the parent node of a given node, if valid otherwise returns undefined.
 $('#tree').treeview('getParent', node);
 ```
 
+#### getSelected()
+
+Returns an array of selected nodes e.g. state.selected = true.
+
+```javascript
+$('#tree').treeview('getSelected', nodeId);
+```
+
 #### getSiblings(node | nodeId)
 
 Returns an array of sibling nodes for a given node, if valid otherwise returns undefined.
@@ -437,6 +460,14 @@ Returns an array of sibling nodes for a given node, if valid otherwise returns u
 $('#tree').treeview('getSiblings', node);
 ```
 
+#### getUnselected()
+
+Returns an array of unselected nodes e.g. state.selected = false.
+
+```javascript
+$('#tree').treeview('getUnselected', nodeId);
+```
+
 #### remove()
 
 Removes the tree view component. Removing attached events, internal attached objects, and added HTML elements.

public/js/bootstrap-treeview.js

@@ -94,6 +94,10 @@
 			getNode: $.proxy(this.getNode, this),
 			getParent: $.proxy(this.getParent, this),
 			getSiblings: $.proxy(this.getSiblings, this),
+			getSelected: $.proxy(this.getSelected, this),
+			getUnselected: $.proxy(this.getUnselected, this),
+			getExpanded: $.proxy(this.getExpanded, this),
+			getCollapsed: $.proxy(this.getCollapsed, this),
 
 			// Select methods
 			selectNode: $.proxy(this.selectNode, this),
@@ -572,7 +576,7 @@
 	/**
 		Returns the parent node of a given node, if valid otherwise returns undefined.
 		@param {Object|Number} identifier - A valid node or node id
-		@returns {Object} parent - The parent node
+		@returns {Object} node - The parent node
 	*/
 	Tree.prototype.getParent = function (identifier) {
 		var node = this.identifyNode(identifier);
@@ -582,7 +586,7 @@
 	/**
 		Returns an array of sibling nodes for a given node, if valid otherwise returns undefined.
 		@param {Object|Number} identifier - A valid node or node id
-		@returns {Array} siblings - Sibling nodes
+		@returns {Array} nodes - Sibling nodes
 	*/
 	Tree.prototype.getSiblings = function (identifier) {
 		var node = this.identifyNode(identifier);
@@ -593,6 +597,38 @@
 			});
 	};
 
+	/**
+		Returns an array of selected nodes.
+		@returns {Array} nodes - Selected nodes
+	*/
+	Tree.prototype.getSelected = function () {
+		return this.findNodes('true', 'g', 'state.selected');
+	};
+
+	/**
+		Returns an array of unselected nodes.
+		@returns {Array} nodes - Unselected nodes
+	*/
+	Tree.prototype.getUnselected = function () {
+		return this.findNodes('false', 'g', 'state.selected');
+	};
+
+	/**
+		Returns an array of expanded nodes.
+		@returns {Array} nodes - Expanded nodes
+	*/
+	Tree.prototype.getExpanded = function () {
+		return this.findNodes('true', 'g', 'state.expanded');
+	};
+
+	/**
+		Returns an array of collapsed nodes.
+		@returns {Array} nodes - Collapsed nodes
+	*/
+	Tree.prototype.getCollapsed = function () {
+		return this.findNodes('false', 'g', 'state.expanded');
+	};
+
 
 	/**
 		Set a node state to selected

src/js/bootstrap-treeview.js

@@ -94,6 +94,10 @@
 			getNode: $.proxy(this.getNode, this),
 			getParent: $.proxy(this.getParent, this),
 			getSiblings: $.proxy(this.getSiblings, this),
+			getSelected: $.proxy(this.getSelected, this),
+			getUnselected: $.proxy(this.getUnselected, this),
+			getExpanded: $.proxy(this.getExpanded, this),
+			getCollapsed: $.proxy(this.getCollapsed, this),
 
 			// Select methods
 			selectNode: $.proxy(this.selectNode, this),
@@ -572,7 +576,7 @@
 	/**
 		Returns the parent node of a given node, if valid otherwise returns undefined.
 		@param {Object|Number} identifier - A valid node or node id
-		@returns {Object} parent - The parent node
+		@returns {Object} node - The parent node
 	*/
 	Tree.prototype.getParent = function (identifier) {
 		var node = this.identifyNode(identifier);
@@ -582,7 +586,7 @@
 	/**
 		Returns an array of sibling nodes for a given node, if valid otherwise returns undefined.
 		@param {Object|Number} identifier - A valid node or node id
-		@returns {Array} siblings - Sibling nodes
+		@returns {Array} nodes - Sibling nodes
 	*/
 	Tree.prototype.getSiblings = function (identifier) {
 		var node = this.identifyNode(identifier);
@@ -593,6 +597,38 @@
 			});
 	};
 
+	/**
+		Returns an array of selected nodes.
+		@returns {Array} nodes - Selected nodes
+	*/
+	Tree.prototype.getSelected = function () {
+		return this.findNodes('true', 'g', 'state.selected');
+	};
+
+	/**
+		Returns an array of unselected nodes.
+		@returns {Array} nodes - Unselected nodes
+	*/
+	Tree.prototype.getUnselected = function () {
+		return this.findNodes('false', 'g', 'state.selected');
+	};
+
+	/**
+		Returns an array of expanded nodes.
+		@returns {Array} nodes - Expanded nodes
+	*/
+	Tree.prototype.getExpanded = function () {
+		return this.findNodes('true', 'g', 'state.expanded');
+	};
+
+	/**
+		Returns an array of collapsed nodes.
+		@returns {Array} nodes - Collapsed nodes
+	*/
+	Tree.prototype.getCollapsed = function () {
+		return this.findNodes('false', 'g', 'state.expanded');
+	};
+
 
 	/**
 		Set a node state to selected

tests/lib/bootstrap-treeview.js

@@ -94,6 +94,10 @@
 			getNode: $.proxy(this.getNode, this),
 			getParent: $.proxy(this.getParent, this),
 			getSiblings: $.proxy(this.getSiblings, this),
+			getSelected: $.proxy(this.getSelected, this),
+			getUnselected: $.proxy(this.getUnselected, this),
+			getExpanded: $.proxy(this.getExpanded, this),
+			getCollapsed: $.proxy(this.getCollapsed, this),
 
 			// Select methods
 			selectNode: $.proxy(this.selectNode, this),
@@ -572,7 +576,7 @@
 	/**
 		Returns the parent node of a given node, if valid otherwise returns undefined.
 		@param {Object|Number} identifier - A valid node or node id
-		@returns {Object} parent - The parent node
+		@returns {Object} node - The parent node
 	*/
 	Tree.prototype.getParent = function (identifier) {
 		var node = this.identifyNode(identifier);
@@ -582,7 +586,7 @@
 	/**
 		Returns an array of sibling nodes for a given node, if valid otherwise returns undefined.
 		@param {Object|Number} identifier - A valid node or node id
-		@returns {Array} siblings - Sibling nodes
+		@returns {Array} nodes - Sibling nodes
 	*/
 	Tree.prototype.getSiblings = function (identifier) {
 		var node = this.identifyNode(identifier);
@@ -593,6 +597,38 @@
 			});
 	};
 
+	/**
+		Returns an array of selected nodes.
+		@returns {Array} nodes - Selected nodes
+	*/
+	Tree.prototype.getSelected = function () {
+		return this.findNodes('true', 'g', 'state.selected');
+	};
+
+	/**
+		Returns an array of unselected nodes.
+		@returns {Array} nodes - Unselected nodes
+	*/
+	Tree.prototype.getUnselected = function () {
+		return this.findNodes('false', 'g', 'state.selected');
+	};
+
+	/**
+		Returns an array of expanded nodes.
+		@returns {Array} nodes - Expanded nodes
+	*/
+	Tree.prototype.getExpanded = function () {
+		return this.findNodes('true', 'g', 'state.expanded');
+	};
+
+	/**
+		Returns an array of collapsed nodes.
+		@returns {Array} nodes - Collapsed nodes
+	*/
+	Tree.prototype.getCollapsed = function () {
+		return this.findNodes('false', 'g', 'state.expanded');
+	};
+
 
 	/**
 		Set a node state to selected

tests/tests.js

@@ -375,7 +375,7 @@
 	test('getNode', function () {
 		var $tree = init({ data: data });
 		var nodeParent1 = $tree.treeview('getNode', 0);
-		equal(nodeParent1.text, 'Parent 1', 'Correct node returned : requested "Parent 1", for "Parent 1"');
+		equal(nodeParent1.text, 'Parent 1', 'Correct node returned : requested "Parent 1", got "Parent 1"');
 	});
 
 	test('getParent', function () {
@@ -412,6 +412,47 @@
 		ok(results, 'Correct siblings for "Child 1" [non root] : results OK');
 	});
 
+	test('getSelected', function () {
+		var $tree = init({ data: data })
+			.treeview('selectNode', 0);
+
+		var selectedNodes = $tree.treeview('getSelected');
+		ok((selectedNodes instanceof Array), 'Result is an array');
+		equal(selectedNodes.length, 1, 'Correct number of nodes returned');
+		equal(selectedNodes[0].text, 'Parent 1', 'Correct node returned');
+	});
+
+	test('getUnselected', function () {
+		var $tree = init({ data: data })
+			.treeview('selectNode', 0);
+
+		var unselectedNodes = $tree.treeview('getUnselected');
+		ok((unselectedNodes instanceof Array), 'Result is an array');
+		equal(unselectedNodes.length, 8, 'Correct number of nodes returned');
+	});
+
+	// Assumptions:
+	// Default tree + expanded to 2 levels,
+	// means 1 node 'Parent 1' should be expanded and therefore returned
+	test('getExpanded', function () {
+		var $tree = init({ data: data });
+		var expandedNodes = $tree.treeview('getExpanded');
+		ok((expandedNodes instanceof Array), 'Result is an array');
+		equal(expandedNodes.length, 1, 'Correct number of nodes returned');
+		equal(expandedNodes[0].text, 'Parent 1', 'Correct node returned');
+	});
+
+	// Assumptions:
+	// Default tree + expanded to 2 levels, means only 'Parent 1' should be expanded
+	// as all other parent nodes have no children their state will be collapsed
+	// which means 8 of the 9 nodes should be returned
+	test('getCollapsed', function () {
+		var $tree = init({ data: data });
+		var collapsedNodes = $tree.treeview('getCollapsed');
+		ok((collapsedNodes instanceof Array), 'Result is an array');
+		equal(collapsedNodes.length, 8, 'Correct number of nodes returned');
+	});
+
 	test('selectNode / unselectNode', function () {
 		var $tree = init({ data: data });
 		var el;