ExternalVendorCode/openmct
1
0
Fork 0
mirror of https://github.com/nasa/openmct.git synced 2024-12-18 20:57:53 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

[API] JSDoc for Selection

Browse Source
This commit is contained in:
Victor Woeltjen 2016-09-06 09:54:51 -07:00
parent 70abd5c1f9
commit 4de069b393
1 changed files with 34 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
src/Selection.js
View File

@ -10,14 +10,35 @@ define(['EventEmitter'], function (EventEmitter) {
this.selectedValues = [];
}
/**
* Fired whenever the current selection state changes.
* @event change
* @memberof module:openmct.Selection~
*/
Selection.prototype = Object.create(EventEmitter.prototype);
/**
* Add a new value to the current selection state.
* @param {*} value the newly selected value
* @returns {Function} a function to deselect this value
* @method select
* @memberof module:openmct.Selection#
* @fires module:openmct.Selection~change
*/
Selection.prototype.select = function (value) {
this.selectedValues.push(value);
this.emit('change');
return this.deselect.bind(this, value);
};
/**
* Remove a value from the current selection state.
* @param {*} value the value to deselect
* @method deselect
* @memberof module:openmct.Selection#
* @fires module:openmct.Selection~change
*/
Selection.prototype.deselect = function (value) {
this.selectedValues = this.selectedValues.filter(function (v) {
return v !== value;
@ -25,10 +46,23 @@ define(['EventEmitter'], function (EventEmitter) {
this.emit('change');
};
/**
* Get the current selection state.
* @param {*} value the newly selected value
* @returns {Array} all currently-selected objects
* @method selected
* @memberof module:openmct.Selection#
*/
Selection.prototype.selected = function () {
return this.selectedValues;
};
/**
* Deselect all currently-selected objects.
* @method clear
* @memberof module:openmct.Selection#
* @fires module:openmct.Selection~change
*/
Selection.prototype.clear = function () {
this.selectedValues = [];
this.emit('change');