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

Merge remote-tracking branch 'origin/open254'

Browse Source
This commit is contained in:
Pete Richards 2016-07-18 11:35:43 -07:00
commit 99ec188813
11 changed files with 212 additions and 148 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
example/notifications/src/DialogLaunchController.js
View File

@ -44,7 +44,8 @@ define(
periodically with the progress of an ongoing process.
*/
$scope.launchProgress = function (knownProgress) {
var model = {
var dialog,
model = {
title: "Progress Dialog Example",
progress: 0,
hint: "Do not navigate away from this page or close this browser tab while this operation is in progress.",
@ -57,7 +58,7 @@ define(
label: "Cancel Operation",
callback: function () {
$log.debug("Operation cancelled");
dialogService.dismiss();
dialog.dismiss();
}
},
{
@ -77,7 +78,9 @@ define(
}
}
if (dialogService.showBlockingMessage(model)) {
dialog = dialogService.showBlockingMessage(model);
if (dialog) {
//Do processing here
model.actionText = "Processing 100 objects...";
if (knownProgress) {
@ -93,7 +96,8 @@ define(
Demonstrates launching an error dialog
*/
$scope.launchError = function () {
var model = {
var dialog,
model = {
title: "Error Dialog Example",
actionText: "Something happened, and it was not good.",
severity: "error",
@ -102,20 +106,21 @@ define(
label: "Try Again",
callback: function () {
$log.debug("Try Again Pressed");
dialogService.dismiss();
dialog.dismiss();
}
},
{
label: "Cancel",
callback: function () {
$log.debug("Cancel Pressed");
dialogService.dismiss();
dialog.dismiss();
}
}
]
};
dialog = dialogService.showBlockingMessage(model);
if (!dialogService.showBlockingMessage(model)) {
if (!dialog) {
$log.error("Could not display modal dialog");
}
};
@ -124,7 +129,8 @@ define(
Demonstrates launching an error dialog
*/
$scope.launchInfo = function () {
var model = {
var dialog,
model = {
title: "Info Dialog Example",
actionText: "This is an example of a blocking info" +
" dialog. This dialog can be used to draw the user's" +
@ -134,12 +140,14 @@ define(
label: "OK",
callback: function () {
$log.debug("OK Pressed");
dialogService.dismiss();
dialog.dismiss();
}
}
};
if (!dialogService.showBlockingMessage(model)) {
dialog = dialogService.showBlockingMessage(model);
if (!dialog) {
$log.error("Could not display modal dialog");
}
};

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

@ -39,25 +39,28 @@ define(
this.overlayService = overlayService;
this.$q = $q;
this.$log = $log;
this.overlay = undefined;
this.dialogVisible = false;
this.activeOverlay = undefined;
}
// Stop showing whatever overlay is currently active
// (e.g. because the user hit cancel)
DialogService.prototype.dismiss = function () {
var overlay = this.overlay;
if (overlay) {
/**
* @private
*/
DialogService.prototype.dismissOverlay = function (overlay) {
//Dismiss the overlay
overlay.dismiss();
//If dialog is the current active one, dismiss it
if (overlay === this.activeOverlay) {
this.activeOverlay = undefined;
}
this.dialogVisible = false;
};
DialogService.prototype.getDialogResponse = function (key, model, resultGetter, typeClass) {
// We will return this result as a promise, because user
// input is asynchronous.
var deferred = this.$q.defer(),
self = this;
self = this,
overlay;
// Confirm function; this will be passed in to the
// overlay-dialog template and associated with a
@ -65,9 +68,7 @@ define(
function confirm(value) {
// Pass along the result
deferred.resolve(resultGetter ? resultGetter() : value);
// Stop showing the dialog
self.dismiss();
self.dismissOverlay(overlay);
}
// Cancel function; this will be passed in to the
@ -75,7 +76,7 @@ define(
// Cancel or X button click
function cancel() {
deferred.reject();
self.dismiss();
self.dismissOverlay(overlay);
}
// Add confirm/cancel callbacks
@ -85,15 +86,11 @@ define(
if (this.canShowDialog(model)) {
// Add the overlay using the OverlayService, which
// will handle actual insertion into the DOM
this.overlay = this.overlayService.createOverlay(
overlay = this.activeOverlay = this.overlayService.createOverlay(
key,
model,
typeClass || "t-dialog"
);
// Track that a dialog is already visible, to
// avoid spawning multiple dialogs at once.
this.dialogVisible = true;
} else {
deferred.reject();
}
@ -156,7 +153,7 @@ define(
* otherwise
*/
DialogService.prototype.canShowDialog = function (dialogModel) {
if (this.dialogVisible) {
if (this.activeOverlay) {
// Only one dialog should be shown at a time.
// The application design should be such that
// we never even try to do this.
@ -183,6 +180,11 @@ define(
* button is clicked
*/
/**
* @typedef DialogHandle
* @property {function} dismiss a function to dismiss the given dialog
*/
/**
* A description of the model options that may be passed to the
* showBlockingMessage method. Note that the DialogModel desribed
@ -222,21 +224,26 @@ define(
* the user can take if necessary
* @param {DialogModel} dialogModel defines options for the dialog
* @param {typeClass} string tells overlayService that this overlay should use appropriate CSS class
* @returns {boolean}
* @returns {boolean | {DialogHandle}}
*/
DialogService.prototype.showBlockingMessage = function (dialogModel) {
if (this.canShowDialog(dialogModel)) {
// Add the overlay using the OverlayService, which
// will handle actual insertion into the DOM
this.overlay = this.overlayService.createOverlay(
var self = this,
overlay = this.overlayService.createOverlay(
"overlay-blocking-message",
dialogModel,
"t-dialog-sm"
);
// Track that a dialog is already visible, to
// avoid spawning multiple dialogs at once.
this.dialogVisible = true;
return true;
this.activeOverlay = overlay;
return {
dismiss: function () {
self.dismissOverlay(overlay);
}
};
} else {
return false;
}

41
platform/commonUI/dialog/test/DialogServiceSpec.js
View File

@ -122,7 +122,7 @@ define(
it("invokes the overlay service with the correct parameters when" +
" a blocking dialog is requested", function () {
var dialogModel = {};
expect(dialogService.showBlockingMessage(dialogModel)).toBe(true);
expect(dialogService.showBlockingMessage(dialogModel)).not.toBe(false);
expect(mockOverlayService.createOverlay).toHaveBeenCalledWith(
"overlay-blocking-message",
dialogModel,
@ -130,6 +130,45 @@ define(
);
});
describe("the blocking message dialog", function () {
var dialogModel = {};
var dialogHandle;
beforeEach(function () {
dialogHandle = dialogService.showBlockingMessage(dialogModel);
});
it("returns a handle to the dialog", function () {
expect(dialogHandle).not.toBe(undefined);
});
it("dismissing the dialog dismisses the overlay", function () {
dialogHandle.dismiss();
expect(mockOverlay.dismiss).toHaveBeenCalled();
});
it("individual dialogs can be dismissed", function () {
var secondDialogHandle,
secondMockOverlay;
dialogHandle.dismiss();
secondMockOverlay = jasmine.createSpyObj(
"overlay",
["dismiss"]
);
mockOverlayService.createOverlay.andReturn(secondMockOverlay);
secondDialogHandle = dialogService.showBlockingMessage(dialogModel);
//Dismiss the first dialog. It should only dismiss if it
// is active
dialogHandle.dismiss();
expect(secondMockOverlay.dismiss).not.toHaveBeenCalled();
secondDialogHandle.dismiss();
expect(secondMockOverlay.dismiss).toHaveBeenCalled();
});
});
});
}
);

7
platform/commonUI/edit/src/actions/SaveInProgressDialog.js
View File

@ -1,10 +1,11 @@
define([], function () {
function SaveInProgressDialog(dialogService) {
this.dialogService = dialogService;
this.dialog = undefined;
}
SaveInProgressDialog.prototype.show = function () {
this.dialogService.showBlockingMessage({
this.dialog = this.dialogService.showBlockingMessage({
title: "Saving...",
hint: "Do not navigate away from this page or close this browser tab while this message is displayed.",
unknownProgress: true,
@ -13,7 +14,9 @@ define([], function () {
};
SaveInProgressDialog.prototype.hide = function () {
this.dialogService.dismiss();
if (this.dialog) {
this.dialog.dismiss();
}
};
return SaveInProgressDialog;

19
platform/commonUI/edit/test/actions/SaveActionSpec.js
View File

@ -70,7 +70,7 @@ define(
};
dialogService = jasmine.createSpyObj(
"dialogService",
["showBlockingMessage", "dismiss"]
["showBlockingMessage"]
);
mockDomainObject.hasCapability.andReturn(true);
@ -111,17 +111,28 @@ define(
expect(mockActionCapability.perform).toHaveBeenCalledWith("navigate");
});
describe("a blocking dialog", function () {
var mockDialogHandle;
beforeEach(function () {
mockDialogHandle = jasmine.createSpyObj("dialogHandle", ["dismiss"]);
dialogService.showBlockingMessage.andReturn(mockDialogHandle);
});
it("shows a dialog while saving", function () {
mockEditorCapability.save.andReturn(new Promise(function () {}));
mockEditorCapability.save.andReturn(new Promise(function () {
}));
action.perform();
expect(dialogService.showBlockingMessage).toHaveBeenCalled();
expect(dialogService.dismiss).not.toHaveBeenCalled();
expect(mockDialogHandle.dismiss).not.toHaveBeenCalled();
});
it("hides a dialog when saving is complete", function () {
action.perform();
expect(dialogService.showBlockingMessage).toHaveBeenCalled();
expect(dialogService.dismiss).toHaveBeenCalled();
expect(mockDialogHandle.dismiss).toHaveBeenCalled();
});
});
});

21
platform/commonUI/edit/test/actions/SaveAsActionSpec.js
View File

@ -101,8 +101,7 @@ define(
"dialogService",
[
"getUserInput",
"showBlockingMessage",
"dismiss"
"showBlockingMessage"
]
);
mockDialogService.getUserInput.andReturn(mockPromise(undefined));
@ -171,14 +170,22 @@ define(
expect(mockDialogService.getUserInput).toHaveBeenCalled();
});
it("shows a blocking dialog while waiting for save", function () {
describe("a blocking dialog", function () {
var mockDialogHandle;
beforeEach(function () {
mockDialogHandle = jasmine.createSpyObj("dialogHandle", ["dismiss"]);
mockDialogService.showBlockingMessage.andReturn(mockDialogHandle);
});
it("indicates that a save is taking place", function () {
mockEditorCapability.save.andReturn(new Promise(function () {}));
action.perform();
expect(mockDialogService.showBlockingMessage).toHaveBeenCalled();
expect(mockDialogService.dismiss).not.toHaveBeenCalled();
expect(mockDialogHandle.dismiss).not.toHaveBeenCalled();
});
it("hides the blocking dialog after saving", function () {
it("is hidden after saving", function () {
var mockCallback = jasmine.createSpy();
action.perform().then(mockCallback);
expect(mockDialogService.showBlockingMessage).toHaveBeenCalled();
@ -186,10 +193,10 @@ define(
return mockCallback.calls.length > 0;
});
runs(function () {
expect(mockDialogService.dismiss).toHaveBeenCalled();
expect(mockDialogHandle.dismiss).toHaveBeenCalled();
});
});
});
});
}
);

8
platform/commonUI/general/src/controllers/BannerController.js
View File

@ -54,17 +54,17 @@ define(
};
$scope.maximize = function (notification) {
if (notification.model.severity !== "info") {
var dialog;
notification.model.cancel = function () {
dialogService.dismiss();
dialog.dismiss();
};
//If the notification is dismissed by the user, close
// the dialog.
notification.onDismiss(function () {
dialogService.dismiss();
dialog.dismiss();
});
dialogService.showBlockingMessage(notification.model);
dialog = dialogService.showBlockingMessage(notification.model);
}
};
}

3
platform/commonUI/notification/src/NotificationIndicatorController.js
View File

@ -49,9 +49,6 @@ define(
//Launch the message list dialog with the models
// from the notifications
messages: notificationService.notifications
},
cancel: function () {
dialogService.dismiss();
}
});

15
platform/commonUI/notification/test/NotificationIndicatorControllerSpec.js
View File

@ -54,22 +54,7 @@ define(
expect(mockDialogService.getDialogResponse).toHaveBeenCalled();
expect(mockDialogService.getDialogResponse.mostRecentCall.args[0]).toBe('overlay-message-list');
expect(mockDialogService.getDialogResponse.mostRecentCall.args[1].dialog).toBeDefined();
expect(mockDialogService.getDialogResponse.mostRecentCall.args[1].cancel).toBeDefined();
//Invoke the cancel callback
mockDialogService.getDialogResponse.mostRecentCall.args[1].cancel();
expect(mockDialogService.dismiss).toHaveBeenCalled();
});
it("provides a means of dismissing the message list", function () {
expect(mockScope.showNotificationsList).toBeDefined();
mockScope.showNotificationsList();
expect(mockDialogService.getDialogResponse).toHaveBeenCalled();
expect(mockDialogService.getDialogResponse.mostRecentCall.args[1].cancel).toBeDefined();
//Invoke the cancel callback
mockDialogService.getDialogResponse.mostRecentCall.args[1].cancel();
expect(mockDialogService.dismiss).toHaveBeenCalled();
});
});
}
);

13
platform/entanglement/src/actions/CopyAction.js
View File

@ -86,7 +86,9 @@ define(
severity: "info"
});
} else if (phase.toLowerCase() === "copying") {
this.dialogService.dismiss();
if (this.dialog) {
this.dialog.dismiss();
}
if (!this.notification) {
this.notification = this.notificationService
.notify({
@ -115,7 +117,8 @@ define(
}
function error(errorDetails) {
var errorMessage = {
var errorDialog,
errorMessage = {
title: "Error copying objects.",
severity: "error",
hint: errorDetails.message,
@ -123,12 +126,12 @@ define(
options: [{
label: "OK",
callback: function () {
self.dialogService.dismiss();
errorDialog.dismiss();
}
}]
};
self.dialogService.dismiss();
self.dialog.dismiss();
if (self.notification) {
self.notification.dismiss(); // Clear the progress notification
}
@ -136,7 +139,7 @@ define(
//Show a minimized notification of error for posterity
self.notificationService.notify(errorMessage);
//Display a blocking message
self.dialogService.showBlockingMessage(errorMessage);
errorDialog = self.dialogService.showBlockingMessage(errorMessage);
}
function notification(details) {

6
platform/entanglement/test/actions/CopyActionSpec.js
View File

@ -44,6 +44,7 @@ define(
notificationService,
notification,
dialogService,
mockDialog,
mockLog,
abstractComposePromise,
progress = {phase: "copying", totalObjects: 10, processed: 1};
@ -120,9 +121,12 @@ define(
.andReturn(locationServicePromise);
dialogService = jasmine.createSpyObj('dialogService',
['showBlockingMessage', 'dismiss']
['showBlockingMessage']
);
mockDialog = jasmine.createSpyObj("dialog", ["dismiss"]);
dialogService.showBlockingMessage.andReturn(mockDialog);
notification = jasmine.createSpyObj('notification',
['dismiss', 'model']
);