ExternalVendorCode/openmct
1
0
Fork 0
mirror of https://github.com/nasa/openmct.git synced 2025-04-05 10:26:49 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

[Browse] Add JSDoc

Browse Source 
Add in-line documentation to controller which supports the
moveable splitter in Browse mode, WTD-747.
This commit is contained in:
Victor Woeltjen 2015-01-28 16:38:32 -08:00
parent 8fecaaf4f8
commit 14571ebb6e
1 changed files with 23 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
platform/commonUI/general/src/controllers/SplitPaneController.js
View File

@ -5,35 +5,46 @@ define(
function () {
"use strict";
/**
* Controller for the splitter in Browse mode. Current implementation
* uses many hard-coded constants; this could be generalized.
* @constructor
*/
function SplitPaneController() {
var minimum = 120,
maximum = 600,
current = 200,
start = 200,
style;
function updateStyle() {
style = { left: current + 'px' };
}
updateStyle();
start = 200;
return {
style: function () {
return style;
},
/**
* Get the current position of the splitter, in pixels
* from the left edge.
* @returns {number} position of the splitter, in pixels
*/
state: function () {
return current;
},
/**
* Begin moving the splitter; this will note the splitter's
* current position, which is necessary for correct
* interpretation of deltas provided by mct-drag.
*/
startMove: function () {
start = current;
},
/**
* Move the splitter a number of pixels to the right
* (negative numbers move the splitter to the left.)
* This movement is relative to the position of the
* splitter when startMove was last invoked.
* @param {number} delta number of pixels to move
*/
move: function (delta) {
current = Math.min(
maximum,
Math.max(minimum, start + delta)
);
updateStyle();
}
};
}