alihan/openmct
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Updated

Browse Source
This commit is contained in:
Henry
2015-10-09 15:27:40 -07:00
parent 82ae9e72c1
commit 60dda8a7a4
10 changed files with 101 additions and 53 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
platform/commonUI/notification/bundle.json
View File

@@ -4,6 +4,10 @@
{
"key": "DEFAULT_AUTO_DISMISS",
"value": 3000
},
{
"key": "FORCE_AUTO_DISMISS",
"value": 1000
}
],
"controllers": [
@@ -17,7 +21,8 @@
{
"key": "notificationService",
"implementation": "NotificationService.js",
"depends": [ "$timeout", "DEFAULT_AUTO_DISMISS" ]
"depends": [ "$timeout", "DEFAULT_AUTO_DISMISS",
"FORCE_AUTO_DISMISS" ]
}
]
}

21
platform/commonUI/notification/src/NotificationService.js
View File

@@ -59,7 +59,7 @@ define(
* @property {number} progress The completion status of a task
* represented numerically
* @property {MessageSeverity} messageSeverity The importance of the
* message (eg. error, success)
* message (eg. error, info)
* @property {boolean} unknownProgress a boolean indicating self the
* progress of the underlying task is unknown. This will result in a
* visually distinct progress bar.
@@ -84,10 +84,11 @@ define(
* @memberof platform/commonUI/notification
* @constructor
*/
function NotificationService($timeout, DEFAULT_AUTO_DISMISS) {
function NotificationService($timeout, DEFAULT_AUTO_DISMISS, FORCE_AUTO_DISMISS) {
this.notifications = [];
this.$timeout = $timeout;
this.DEFAULT_AUTO_DISMISS = DEFAULT_AUTO_DISMISS;
this.FORCE_AUTO_DISMISS = FORCE_AUTO_DISMISS;
/*
* A context in which to hold the active notification and a
@@ -105,12 +106,12 @@ define(
};
/**
* A convenience method for success notifications. Notifications
* A convenience method for info notifications. Notifications
* created via this method will be auto-dismissed after a default
* wait period
* @param {Notification} notification The notification to display
*/
NotificationService.prototype.success = function (notification) {
NotificationService.prototype.info = function (notification) {
notification.autoDismiss = notification.autoDismiss || true;
notification.severity = MessageSeverity.INFO;
this.notify(notification);
@@ -145,17 +146,15 @@ define(
If there is already an active notification, time it out. If it's
already got a timeout in progress (either because it has had
timeout forced because of a queue of messages, or it had an
autodismiss specified), leave it to run.
autodismiss specified), leave it to run. Otherwise force a
timeout.
This notifcation has been added to queue and will be
serviced as soon as possible.
*/
timeout = notification.autoDismiss ?
notification.autoDismiss :
this.DEFAULT_AUTO_DISMISS;
this.active.timeout = this.$timeout(function () {
self.dismissOrMinimize(self.active.notification);
}, timeout);
}, this.FORCE_AUTO_DISMISS);
}
};
@@ -217,7 +216,7 @@ define(
/**
* Minimize a notification. The notification will still be available
* from the notification list. Typically notifications with a
* severity of 'success' should not be minimized, but rather
* severity of 'info' should not be minimized, but rather
* dismissed. If you're not sure which is appropriate,
* use {@link NotificationService#dismissOrMinimize}
* @see dismiss
@@ -236,7 +235,7 @@ define(
/**
* Completely removes a notification. This will dismiss it from the
* message banner and remove it from the list of notifications.
* Typically only notifications with a severity of success should be
* Typically only notifications with a severity of info should be
* dismissed. If you're not sure whether to dismiss or minimize a
* notification, use {@link NotificationService#dismissOrMinimize}.
* dismiss

16
platform/commonUI/notification/test/NotificationServiceSpec.js
View File

@@ -43,7 +43,7 @@ define(
* 3) Calling .notify with autoDismiss results in an ERROR notification
* being MINIMIZED after a timeout has elapsed DONE
*
* 4) Calling .notify with an active success notification results in that
* 4) Calling .notify with an active info notification results in that
* notification being auto-dismissed, and the new notification becoming
* active. DONE
*
@@ -80,7 +80,7 @@ define(
mockTimeout, mockAutoDismiss);
successModel = {
title: "Mock Success Notification",
severity: MessageSeverity.SUCCESS
severity: MessageSeverity.INFO
};
errorModel = {
title: "Mock Error Notification",
@@ -124,11 +124,11 @@ define(
it("auto-dismisses the previously active notification, making" +
" the new notification active", function() {
var activeNotification;
//First pre-load with a success message
//First pre-load with a info message
notificationService.notify(successModel);
activeNotification =
notificationService.getActiveNotification();
//Initially expect the active notification to be success
//Initially expect the active notification to be info
expect(activeNotification).toBe(successModel);
//Then notify of an error
notificationService.notify(errorModel);
@@ -140,20 +140,20 @@ define(
});
it("auto-dismisses an active success notification, removing" +
" it completely", function() {
//First pre-load with a success message
//First pre-load with a info message
notificationService.notify(successModel);
//Then notify of an error
notificationService.notify(errorModel);
expect(notificationService.notifications.length).toEqual(2);
mockTimeout.mostRecentCall.args[0]();
//Previous success message should be completely dismissed
//Previous info message should be completely dismissed
expect(notificationService.notifications.length).toEqual(1);
});
it("auto-minimizes an active error notification", function() {
var activeNotification;
//First pre-load with an error message
notificationService.notify(errorModel);
//Then notify of success
//Then notify of info
notificationService.notify(successModel);
expect(notificationService.notifications.length).toEqual(2);
//Mock the auto-minimize
@@ -178,7 +178,7 @@ define(
severity: MessageSeverity.ERROR
};
//First pre-load with a success message
//First pre-load with a info message
notificationService.notify(errorModel);
//Then notify of a third error
notificationService.notify(error2);