From efc42aa8f28139e89e5417f18d182fa79e5482bc Mon Sep 17 00:00:00 2001
From: Victor Woeltjen <victor.woeltjen@nasa.gov>
Date: Mon, 10 Aug 2015 12:53:55 -0700
Subject: [PATCH] [Code Style] Use prototypes in Dialog bundle
WTD-1482.
---
platform/commonUI/dialog/src/DialogService.js | 237 +++++++++---------
.../commonUI/dialog/src/OverlayService.js | 81 +++---
2 files changed, 157 insertions(+), 161 deletions(-)
diff --git a/platform/commonUI/dialog/src/DialogService.js b/platform/commonUI/dialog/src/DialogService.js
index e23d0d7c8e..25e8943c06 100644
--- a/platform/commonUI/dialog/src/DialogService.js
+++ b/platform/commonUI/dialog/src/DialogService.js
@@ -38,127 +38,126 @@ define(
* @constructor
*/
function DialogService(overlayService, $q, $log) {
- var overlay,
- dialogVisible = false;
-
- // Stop showing whatever overlay is currently active
- // (e.g. because the user hit cancel)
- function dismiss() {
- if (overlay) {
- overlay.dismiss();
- }
- dialogVisible = false;
- }
-
- function getDialogResponse(key, model, resultGetter) {
- // We will return this result as a promise, because user
- // input is asynchronous.
- var deferred = $q.defer(),
- overlayModel;
-
- // Confirm function; this will be passed in to the
- // overlay-dialog template and associated with a
- // OK button click
- function confirm(value) {
- // Pass along the result
- deferred.resolve(resultGetter ? resultGetter() : value);
-
- // Stop showing the dialog
- dismiss();
- }
-
- // Cancel function; this will be passed in to the
- // overlay-dialog template and associated with a
- // Cancel or X button click
- function cancel() {
- deferred.reject();
- dismiss();
- }
-
- // Add confirm/cancel callbacks
- model.confirm = confirm;
- model.cancel = cancel;
-
- if (dialogVisible) {
- // Only one dialog should be shown at a time.
- // The application design should be such that
- // we never even try to do this.
- $log.warn([
- "Dialog already showing; ",
- "unable to show ",
- model.name
- ].join(""));
- deferred.reject();
- } else {
- // Add the overlay using the OverlayService, which
- // will handle actual insertion into the DOM
- overlay = overlayService.createOverlay(
- key,
- model
- );
-
- // Track that a dialog is already visible, to
- // avoid spawning multiple dialogs at once.
- dialogVisible = true;
- }
-
- return deferred.promise;
- }
-
- function getUserInput(formModel, value) {
- var overlayModel = {
- title: formModel.name,
- message: formModel.message,
- structure: formModel,
- value: value
- };
-
- // Provide result from the model
- function resultGetter() {
- return overlayModel.value;
- }
-
- // Show the overlay-dialog
- return getDialogResponse(
- "overlay-dialog",
- overlayModel,
- resultGetter
- );
- }
-
- function getUserChoice(dialogModel) {
- // Show the overlay-options dialog
- return getDialogResponse(
- "overlay-options",
- { dialog: dialogModel }
- );
- }
-
- 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)
- * @memberof platform/commonUI/dialog.DialogService#
- */
- getUserInput: getUserInput,
- /**
- * Request that the user chooses from a set of options,
- * which will be shown as buttons.
- *
- * @param dialogModel a description of the dialog to show
- * @memberof platform/commonUI/dialog.DialogService#
- */
- getUserChoice: getUserChoice
- };
+ this.overlayService = overlayService;
+ this.$q = $q;
+ this.$log = $log;
+ this.overlay = undefined;
+ this.dialogVisible = false;
}
+ // Stop showing whatever overlay is currently active
+ // (e.g. because the user hit cancel)
+ DialogService.prototype.dismiss = function () {
+ var overlay = this.overlay;
+ if (overlay) {
+ overlay.dismiss();
+ }
+ this.dialogVisible = false;
+ };
+
+ DialogService.prototype.getDialogResponse = function (key, model, resultGetter) {
+ // We will return this result as a promise, because user
+ // input is asynchronous.
+ var deferred = this.$q.defer(),
+ self = this;
+
+ // Confirm function; this will be passed in to the
+ // overlay-dialog template and associated with a
+ // OK button click
+ function confirm(value) {
+ // Pass along the result
+ deferred.resolve(resultGetter ? resultGetter() : value);
+
+ // Stop showing the dialog
+ self.dismiss();
+ }
+
+ // Cancel function; this will be passed in to the
+ // overlay-dialog template and associated with a
+ // Cancel or X button click
+ function cancel() {
+ deferred.reject();
+ self.dismiss();
+ }
+
+ // Add confirm/cancel callbacks
+ model.confirm = confirm;
+ model.cancel = cancel;
+
+ if (this.dialogVisible) {
+ // Only one dialog should be shown at a time.
+ // The application design should be such that
+ // we never even try to do this.
+ this.$log.warn([
+ "Dialog already showing; ",
+ "unable to show ",
+ model.name
+ ].join(""));
+ deferred.reject();
+ } else {
+ // Add the overlay using the OverlayService, which
+ // will handle actual insertion into the DOM
+ this.overlay = this.overlayService.createOverlay(
+ key,
+ model
+ );
+
+ // Track that a dialog is already visible, to
+ // avoid spawning multiple dialogs at once.
+ this.dialogVisible = true;
+ }
+
+ return deferred.promise;
+ };
+
+ /**
+ * 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 promise 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)
+ */
+ DialogService.prototype.getUserInput = function (formModel, value) {
+ var overlayModel = {
+ title: formModel.name,
+ message: formModel.message,
+ structure: formModel,
+ value: value
+ };
+
+ // Provide result from the model
+ function resultGetter() {
+ return overlayModel.value;
+ }
+
+ // Show the overlay-dialog
+ return this.getDialogResponse(
+ "overlay-dialog",
+ overlayModel,
+ resultGetter
+ );
+ };
+
+ /**
+ * Request that the user chooses from a set of options,
+ * which will be shown as buttons.
+ *
+ * @param dialogModel a description of the dialog to show
+ * @return {Promise} a promise for the user's choice
+ */
+ DialogService.prototype.getUserChoice = function (dialogModel) {
+ // Show the overlay-options dialog
+ return this.getDialogResponse(
+ "overlay-options",
+ { dialog: dialogModel }
+ );
+ };
+
+
return DialogService;
}
);
diff --git a/platform/commonUI/dialog/src/OverlayService.js b/platform/commonUI/dialog/src/OverlayService.js
index 4611a96148..043f638700 100644
--- a/platform/commonUI/dialog/src/OverlayService.js
+++ b/platform/commonUI/dialog/src/OverlayService.js
@@ -47,54 +47,51 @@ define(
* @constructor
*/
function OverlayService($document, $compile, $rootScope) {
- function createOverlay(key, overlayModel) {
- // Create a new scope for this overlay
- var scope = $rootScope.$new(),
- element;
+ this.$document = $document;
+ this.$compile = $compile;
+ this.$rootScope = $rootScope;
+ }
- // Stop showing the overlay; additionally, release the scope
- // that it uses.
- function dismiss() {
- scope.$destroy();
- element.remove();
- }
+ /**
+ * Add a new overlay to the document. This will be
+ * prepended to the document body; the overlay's
+ * template (as pointed to by the `key` argument) is
+ * responsible for having a useful z-order, and for
+ * blocking user interactions if appropriate.
+ *
+ * @param {string} key the symbolic key which identifies
+ * the template of the overlay to be shown
+ * @param {object} overlayModel the model to pass to the
+ * included overlay template (this will be passed
+ * in via ng-model)
+ */
+ OverlayService.prototype.createOverlay = function (key, overlayModel) {
+ // Create a new scope for this overlay
+ var scope = this.$rootScope.$new(),
+ element;
- // If no model is supplied, just fill in a default "cancel"
- overlayModel = overlayModel || { cancel: dismiss };
-
- // Populate the scope; will be passed directly to the template
- scope.overlay = overlayModel;
- scope.key = key;
-
- // Create the overlay element and add it to the document's body
- element = $compile(TEMPLATE)(scope);
- $document.find('body').prepend(element);
-
-
-
- return {
- dismiss: dismiss
- };
+ // Stop showing the overlay; additionally, release the scope
+ // that it uses.
+ function dismiss() {
+ scope.$destroy();
+ element.remove();
}
+ // If no model is supplied, just fill in a default "cancel"
+ overlayModel = overlayModel || { cancel: dismiss };
+
+ // Populate the scope; will be passed directly to the template
+ scope.overlay = overlayModel;
+ scope.key = key;
+
+ // Create the overlay element and add it to the document's body
+ element = this.$compile(TEMPLATE)(scope);
+ this.$document.find('body').prepend(element);
+
return {
- /**
- * Add a new overlay to the document. This will be
- * prepended to the document body; the overlay's
- * template (as pointed to by the `key` argument) is
- * responsible for having a useful z-order, and for
- * blocking user interactions if appropriate.
- *
- * @param {string} key the symbolic key which identifies
- * the template of the overlay to be shown
- * @param {object} overlayModel the model to pass to the
- * included overlay template (this will be passed
- * in via ng-model)
- * @memberof platform/commonUI/dialog.OverlayService#
- */
- createOverlay: createOverlay
+ dismiss: dismiss
};
- }
+ };
return OverlayService;
}