ExternalVendorCode/openmct
1
0
Fork 0
mirror of https://github.com/nasa/openmct.git synced 2024-12-21 22:17:49 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

[Common UI] Add JSDoc to DialogService

Browse Source 
Add in-line documentation to the dialog service,
exposed by bundle platform/commonUI/dialog, one
of the common user interface bundles being
transitioned for WTD-574.
This commit is contained in:
Victor Woeltjen 2014-11-25 13:31:30 -08:00
parent d950fe14e5
commit 6cce00d601
1 changed files with 24 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
platform/commonUI/dialog/src/DialogService.js
View File

@ -8,28 +8,46 @@ define(
function () {
"use strict";
// Template to inject into the DOM to show the dialog; really just points to
// the overlay-dialog template.
var TEMPLATE = "<mct-include ng-model=\"dialog\" key=\"'overlay-dialog'\"></mct-include>";
/**
*
* The dialog service is responsible for handling window-modal
* communication with the user, such as displaying forms for user
* input.
* @constructor
*/
function DialogService($document, $compile, $rootScope, $timeout, $q, $log) {
var scope;
// Inject the dialog at the top of the body; this is necessary to
// ensure that the dialog is positioned appropriately and can fill
// the screen to block other interactions.
function addContent() {
scope = $rootScope.$new();
$document.find('body').prepend(
$compile(
"<mct-include ng-model=\"dialog\" key=\"'overlay-dialog'\"></mct-include>"
)(scope)
);
$document.find('body').prepend($compile(TEMPLATE)(scope));
scope.dialog = { visible: false, value: {} };
}
// Dismiss the dialog; just stop showing it, and release any
// form information for garbage collection.
function dismiss() {
scope.dialog = { visible: false, value: {} };
}
return {
/**
* Request user input via a window-modal dialog.
*
* @param {FormModel} formModel a description of the form
* to be shown (see platform/forms)
* @param {object} value the initial state of the form
* @returns {Promise} a promsie for the form value that the
* user has supplied; this may be rejected if
* user input cannot be obtained (for instance,
* because the user cancelled the dialog)
*/
getUserInput: function (formModel, value) {
var deferred = $q.defer();