From c9ca76b918149d9023772c7fde9fffe443b4e7c9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tom=C3=A1s=20Malbr=C3=A1n?= Date: Sat, 9 Mar 2013 20:16:19 -0300 Subject: [PATCH 1/5] Improving the Dialog API --- src/LiveDevelopment/LiveDevelopment.js | 2 +- src/LiveDevelopment/main.js | 2 +- src/document/DocumentCommandHandlers.js | 6 +- .../htmlContent/sampleHTMLFragment.html | 24 +-- .../samples/LocalizationExample/main.js | 8 +- src/file/FileUtils.js | 2 +- src/htmlContent/dialog-template.html | 14 ++ src/htmlContent/main-view.html | 62 ------ src/preferences/PreferencesDialogs.js | 2 +- src/project/FileIndexManager.js | 77 ++++---- src/project/FileSyncManager.js | 4 +- src/project/ProjectManager.js | 2 +- src/styles/brackets_patterns_override.less | 10 + src/utils/UpdateNotification.js | 2 +- src/widgets/Dialogs.js | 180 +++++++++++------- src/widgets/default-dialogs.json | 82 ++++++++ 16 files changed, 269 insertions(+), 210 deletions(-) create mode 100644 src/htmlContent/dialog-template.html create mode 100644 src/widgets/default-dialogs.json diff --git a/src/LiveDevelopment/LiveDevelopment.js b/src/LiveDevelopment/LiveDevelopment.js index 07eb68ebe07..25bc70e2258 100644 --- a/src/LiveDevelopment/LiveDevelopment.js +++ b/src/LiveDevelopment/LiveDevelopment.js @@ -529,7 +529,7 @@ define(function LiveDevelopment(require, exports, module) { Dialogs.DIALOG_ID_LIVE_DEVELOPMENT, Strings.LIVE_DEVELOPMENT_RELAUNCH_TITLE, Strings.LIVE_DEVELOPMENT_ERROR_MESSAGE - ).done(function (id) { + ).getPromise().done(function (id) { if (id === Dialogs.DIALOG_BTN_OK) { // User has chosen to reload Chrome, quit the running instance _setStatus(STATUS_INACTIVE); diff --git a/src/LiveDevelopment/main.js b/src/LiveDevelopment/main.js index d10939d7cf4..aa6c712ceda 100644 --- a/src/LiveDevelopment/main.js +++ b/src/LiveDevelopment/main.js @@ -126,7 +126,7 @@ define(function main(require, exports, module) { Dialogs.DIALOG_ID_INFO, Strings.LIVE_DEVELOPMENT_INFO_TITLE, Strings.LIVE_DEVELOPMENT_INFO_MESSAGE - ).done(function (id) { + ).getPromise().done(function (id) { LiveDevelopment.open(); }); } else { diff --git a/src/document/DocumentCommandHandlers.js b/src/document/DocumentCommandHandlers.js index 9cfb87fd866..02a0c849cfd 100644 --- a/src/document/DocumentCommandHandlers.js +++ b/src/document/DocumentCommandHandlers.js @@ -375,7 +375,7 @@ define(function (require, exports, module) { StringUtils.htmlEscape(path), FileUtils.getFileErrorString(name) ) - ); + ).getPromise(); } /** Note: if there is an error, the promise is not rejected until the user has dimissed the dialog */ @@ -562,7 +562,7 @@ define(function (require, exports, module) { Dialogs.DIALOG_ID_SAVE_CLOSE, Strings.SAVE_CLOSE_TITLE, StringUtils.format(Strings.SAVE_CLOSE_MESSAGE, StringUtils.htmlEscape(filename)) - ).done(function (id) { + ).getPromise().done(function (id) { if (id === Dialogs.DIALOG_BTN_CANCEL) { result.reject(); } else if (id === Dialogs.DIALOG_BTN_OK) { @@ -654,7 +654,7 @@ define(function (require, exports, module) { Dialogs.DIALOG_ID_SAVE_CLOSE, Strings.SAVE_CLOSE_TITLE, message - ).done(function (id) { + ).getPromise().done(function (id) { if (id === Dialogs.DIALOG_BTN_CANCEL) { result.reject(); } else if (id === Dialogs.DIALOG_BTN_OK) { diff --git a/src/extensions/samples/LocalizationExample/htmlContent/sampleHTMLFragment.html b/src/extensions/samples/LocalizationExample/htmlContent/sampleHTMLFragment.html index 10a35c2ef88..9cde6a38eb5 100644 --- a/src/extensions/samples/LocalizationExample/htmlContent/sampleHTMLFragment.html +++ b/src/extensions/samples/LocalizationExample/htmlContent/sampleHTMLFragment.html @@ -1,26 +1,4 @@ - - -
+

{{DIALOG_TITLE}}

diff --git a/src/extensions/samples/LocalizationExample/main.js b/src/extensions/samples/LocalizationExample/main.js index 45621b14e26..5e279b81c2a 100644 --- a/src/extensions/samples/LocalizationExample/main.js +++ b/src/extensions/samples/LocalizationExample/main.js @@ -57,7 +57,9 @@ define(function (require, exports, module) { function testCommand() { alert(Strings.ALERT_MESSAGE); - Dialogs.showModalDialog("sample-localized-dialog"); + // Localize the dialog using Strings as the datasource and use it as the dialog template + var localizedTemplate = Mustache.render(browserWrapperHtml, Strings); + Dialogs.showModalDialogUsingTemplate(localizedTemplate); } @@ -68,8 +70,4 @@ define(function (require, exports, module) { var menu = Menus.getMenu(Menus.AppMenuBar.EDIT_MENU); menu.addMenuItem(myCommandID, null, Menus.AFTER, myCommandID); - - // Localize the dialog using Strings as the datasource and insert it into the DOM - var localizedHTML = $(Mustache.render(browserWrapperHtml, Strings)); - $('body').append(localizedHTML); }); diff --git a/src/file/FileUtils.js b/src/file/FileUtils.js index 0d04346ac1a..0cb3bd0386d 100644 --- a/src/file/FileUtils.js +++ b/src/file/FileUtils.js @@ -184,7 +184,7 @@ define(function (require, exports, module) { StringUtils.htmlEscape(path), getFileErrorString(name) ) - ); + ).getPromise(); } /** diff --git a/src/htmlContent/dialog-template.html b/src/htmlContent/dialog-template.html new file mode 100644 index 00000000000..6d723ca45a7 --- /dev/null +++ b/src/htmlContent/dialog-template.html @@ -0,0 +1,14 @@ +
+
+ × +

{{{title}}}

+
+
+

{{{message}}}

+
+
+ {{#buttons}} + {{{text}}} + {{/buttons}} +
+
diff --git a/src/htmlContent/main-view.html b/src/htmlContent/main-view.html index aeaf3fdd2e6..619f2f23f70 100644 --- a/src/htmlContent/main-view.html +++ b/src/htmlContent/main-view.html @@ -118,68 +118,6 @@
-
-
- × -

Error

-
-
-

Message goes here

-
-
- {{OK}} -
-
-
-
- × -

{{SAVE_CHANGES}}

-
-
-

Message goes here

-
-
- {{DONT_SAVE}} - {{SAVE}} - {{CANCEL}} -
-
-
-
-

Title goes here

-
-
-

Message goes here

-
-
- {{RELOAD_FROM_DISK}} - {{KEEP_CHANGES_IN_EDITOR}} -
-
-
-
-

Title goes here

-
-
-

Message goes here

-
-
- {{CLOSE_DONT_SAVE}} - {{KEEP_CHANGES_IN_EDITOR}} -
-
-
-
-

Title goes here

-
-
-

Message goes here

-
-
- {{CANCEL}} - {{RELAUNCH_CHROME}} -
-
    diff --git a/src/preferences/PreferencesDialogs.js b/src/preferences/PreferencesDialogs.js index fed8dae2306..20ea7307818 100644 --- a/src/preferences/PreferencesDialogs.js +++ b/src/preferences/PreferencesDialogs.js @@ -86,7 +86,7 @@ define(function (require, exports, module) { $baseUrlControl, promise; - promise = Dialogs.showModalDialogUsingTemplate(Mustache.render(SettingsDialogTemplate, Strings)) + promise = Dialogs.showModalDialogUsingTemplate(Mustache.render(SettingsDialogTemplate, Strings)).getPromise() .done(function (id) { if (id === Dialogs.DIALOG_BTN_OK) { var baseUrlValue = $baseUrlControl.val(); diff --git a/src/project/FileIndexManager.js b/src/project/FileIndexManager.js index 1b08620dc5e..1cf0cea67f0 100644 --- a/src/project/FileIndexManager.js +++ b/src/project/FileIndexManager.js @@ -87,17 +87,16 @@ define(function (require, exports, module) { /** - * Adds a new index to _indexList and marks the list dirty - * - * A future performance optimization is to only build the new index rather than - * marking them all dirty - * - * @private - * @param {!string} indexName must be unque - * @param {!function({entry} filterFunction should return true to include an - * entry in the index - - */ + * Adds a new index to _indexList and marks the list dirty + * + * A future performance optimization is to only build the new index rather than + * marking them all dirty + * + * @private + * @param {!string} indexName must be unque + * @param {!function({entry} filterFunction should return true to include an + * entry in the index + */ function _addIndex(indexName, filterFunction) { if (_indexList.hasOwnProperty(indexName)) { console.error("Duplicate index name"); @@ -115,13 +114,13 @@ define(function (require, exports, module) { /** - * Checks the entry against the filterFunction for each index and adds - * a fileInfo to the index if the entry meets the criteria. FileInfo's are - * shared between indexes. - * - * @private - * @param {!entry} entry to be added to the indexes - */ + * Checks the entry against the filterFunction for each index and adds + * a fileInfo to the index if the entry meets the criteria. FileInfo's are + * shared between indexes. + * + * @private + * @param {!entry} entry to be added to the indexes + */ // future use when files are incrementally added // function _addFileToIndexes(entry) { @@ -141,23 +140,23 @@ define(function (require, exports, module) { }); } - /** - * Error dialog when max files in index is hit - */ + /** + * Error dialog when max files in index is hit + */ function _showMaxFilesDialog() { return Dialogs.showModalDialog( Dialogs.DIALOG_ID_ERROR, Strings.ERROR_MAX_FILES_TITLE, Strings.ERROR_MAX_FILES - ); + ).getPromise(); } /* Recursively visits all files that are descendent of dirEntry and adds - * files files to each index when the file matches the filter critera - * @private - * @param {!DirectoryEntry} dirEntry - * @returns {$.Promise} - */ + * files files to each index when the file matches the filter critera + * @private + * @param {!DirectoryEntry} dirEntry + * @returns {$.Promise} + */ function _scanDirectorySubTree(dirEntry) { if (!dirEntry) { console.error("Bad dirEntry passed to _scanDirectorySubTree"); @@ -260,9 +259,9 @@ define(function (require, exports, module) { /** - * Clears the fileInfo array for all the indexes in _indexList - * @private - */ + * Clears the fileInfo array for all the indexes in _indexList + * @private + */ function _clearIndexes() { $.each(_indexList, function (indexName, index) { index.fileInfos = []; @@ -283,9 +282,9 @@ define(function (require, exports, module) { var _ongoingSyncPromise = null; /** - * Clears and rebuilds all of the fileIndexes and sets _indexListDirty to false - * @return {$.Promise} resolved when index has been updated - */ + * Clears and rebuilds all of the fileIndexes and sets _indexListDirty to false + * @return {$.Promise} resolved when index has been updated + */ function syncFileIndex() { // If we're already syncing, don't kick off a second one @@ -315,10 +314,10 @@ define(function (require, exports, module) { } /** - * Returns the FileInfo array for the specified index - * @param {!string} indexname - * @return {$.Promise} a promise that is resolved with an Array of FileInfo's - */ + * Returns the FileInfo array for the specified index + * @param {!string} indexname + * @return {$.Promise} a promise that is resolved with an Array of FileInfo's + */ function getFileInfoList(indexName) { var result = new $.Deferred(); @@ -379,8 +378,8 @@ define(function (require, exports, module) { } /** - * Add the indexes - */ + * Add the indexes + */ _addIndex( "all", diff --git a/src/project/FileSyncManager.js b/src/project/FileSyncManager.js index 61553b850aa..e32f50a31fa 100644 --- a/src/project/FileSyncManager.js +++ b/src/project/FileSyncManager.js @@ -218,7 +218,7 @@ define(function (require, exports, module) { StringUtils.htmlEscape(doc.file.fullPath), FileUtils.getFileErrorString(error.name) ) - ); + ).getPromise(); } @@ -276,7 +276,7 @@ define(function (require, exports, module) { ); } - Dialogs.showModalDialog(dialogId, Strings.EXT_MODIFIED_TITLE, message) + Dialogs.showModalDialog(dialogId, Strings.EXT_MODIFIED_TITLE, message).getPromise() .done(function (id) { if (id === Dialogs.DIALOG_BTN_DONTSAVE) { if (toClose) { diff --git a/src/project/ProjectManager.js b/src/project/ProjectManager.js index dbb19537e24..880b86ac308 100644 --- a/src/project/ProjectManager.js +++ b/src/project/ProjectManager.js @@ -822,7 +822,7 @@ define(function (require, exports, module) { StringUtils.htmlEscape(rootPath), error.name ) - ).done(function () { + ).getPromise().done(function () { // The project folder stored in preference doesn't exist, so load the default // project directory. // TODO (issue #267): When Brackets supports having no project directory diff --git a/src/styles/brackets_patterns_override.less b/src/styles/brackets_patterns_override.less index 0cb4be69809..a8a81d39c18 100644 --- a/src/styles/brackets_patterns_override.less +++ b/src/styles/brackets_patterns_override.less @@ -335,6 +335,16 @@ float: left; } +.platform-win { + /* Reverse Save/Cancel button order on Win */ + .modal-footer { + text-align: right; + } + .modal-footer .btn:not(.left) { + float: none; + } +} + .modal-body ul { /* Bootstrap's type.less defines a heavy margin-bottom on ul/ol that we don't want in dialogs since they have heavy padding instead. */ diff --git a/src/utils/UpdateNotification.js b/src/utils/UpdateNotification.js index 7ea50e8ce71..bb9ddc0b0be 100644 --- a/src/utils/UpdateNotification.js +++ b/src/utils/UpdateNotification.js @@ -188,7 +188,7 @@ define(function (require, exports, module) { * Show a dialog that shows the update */ function _showUpdateNotificationDialog(updates) { - Dialogs.showModalDialogUsingTemplate(Mustache.render(UpdateDialogTemplate, Strings)) + Dialogs.showModalDialogUsingTemplate(Mustache.render(UpdateDialogTemplate, Strings)).getPromise() .done(function (id) { if (id === Dialogs.DIALOG_BTN_DOWNLOAD) { // The first entry in the updates array has the latest download link diff --git a/src/widgets/Dialogs.js b/src/widgets/Dialogs.js index e8820d1d5ce..c6deaa13012 100644 --- a/src/widgets/Dialogs.js +++ b/src/widgets/Dialogs.js @@ -23,7 +23,7 @@ /*jslint vars: true, plusplus: true, devel: true, nomen: true, indent: 4, maxerr: 50 */ -/*global define, $, brackets, window */ +/*global define, $, brackets, window, Mustache */ /** * Utilities for creating and managing standard modal dialogs. @@ -35,23 +35,27 @@ define(function (require, exports, module) { var KeyBindingManager = require("command/KeyBindingManager"), KeyEvent = require("utils/KeyEvent"), - NativeApp = require("utils/NativeApp"); - - var DIALOG_BTN_CANCEL = "cancel", - DIALOG_BTN_OK = "ok", - DIALOG_BTN_DONTSAVE = "dontsave", - DIALOG_CANCELED = "_canceled", - DIALOG_BTN_DOWNLOAD = "download"; + NativeApp = require("utils/NativeApp"), + Strings = require("strings"), + DialogTemplate = require("text!htmlContent/dialog-template.html"); + + var DefaultDialogs = JSON.parse(require("text!widgets/default-dialogs.json")); + - // TODO: (issue #258) In future, we should templatize the HTML for the dialogs rather than having - // it live directly in the HTML. - var DIALOG_ID_ERROR = "error-dialog", - DIALOG_ID_INFO = "error-dialog", // uses the same template for now--could be different in future - DIALOG_ID_SAVE_CLOSE = "save-close-dialog", - DIALOG_ID_EXT_CHANGED = "ext-changed-dialog", - DIALOG_ID_EXT_DELETED = "ext-deleted-dialog", + var DIALOG_BTN_CANCEL = "cancel", + DIALOG_BTN_OK = "ok", + DIALOG_BTN_DONTSAVE = "dontsave", + DIALOG_CANCELED = "_canceled", + DIALOG_BTN_DOWNLOAD = "download"; + + var DIALOG_ID_ERROR = "error-dialog", + DIALOG_ID_INFO = "error-dialog", // uses the same template for now--could be different in future + DIALOG_ID_SAVE_CLOSE = "save-close-dialog", + DIALOG_ID_EXT_CHANGED = "ext-changed-dialog", + DIALOG_ID_EXT_DELETED = "ext-deleted-dialog", DIALOG_ID_LIVE_DEVELOPMENT = "live-development-error-dialog"; - + + function _dismissDialog(dlg, buttonId) { dlg.data("buttonId", buttonId); $(".clickable-link", dlg).off("click"); @@ -110,20 +114,50 @@ define(function (require, exports, module) { } }; + + /** - * Like showModalDialog(), but takes a template as a parameter rather than assuming the template is embedded - * in the current DOM. The template can either be a string or a jQuery object representing a DOM node that is - * *not* in the current DOM. + * @constructor + * @private * - * @param {string} template A string template or jQuery object to use as the dialog HTML. - * @param {string=} title The title of the error dialog. Can contain HTML markup. If unspecified, title in - * the HTML template is used unchanged. - * @param {string=} message The message to display in the error dialog. Can contain HTML markup. If - * unspecified, body in the HTML template is used unchanged. - * @return {$.Promise} a promise that will be resolved with the ID of the clicked button when the dialog + * @param {$.Element} $dlg - The dialog jQuery element + * @param {$.Promise} promise - A promise that will be resolved with the ID of the clicked button when the dialog * is dismissed. Never rejected. */ - function showModalDialogUsingTemplate(template, title, message) { + function Dialog($dlg, promise) { + this._$dlg = $dlg; + this._promise = promise; + } + + /** @type {$.Element} The dialog jQuery element */ + Dialog.prototype.getElement = function () { + return this._$dlg; + }; + + /** @type {$.Promise} The dialog promise */ + Dialog.prototype.getPromise = function () { + return this._promise; + }; + + /** + * Closes the dialog if is visible + */ + Dialog.prototype.close = function () { + if (this._$dlg.is(":visible")) { // Bootstrap breaks if try to hide dialog that's already hidden + _dismissDialog(this._$dlg, DIALOG_CANCELED); + } + }; + + + + /** + * Creates a new modal dialog from a given template. + * The template can either be a string or a jQuery object representing a DOM node that is *not* in the current DOM. + * + * @param {string} template - A string template or jQuery object to use as the dialog HTML. + * @return {Dialog} + */ + function showModalDialogUsingTemplate(template) { var result = $.Deferred(), promise = result.promise(); @@ -134,14 +168,6 @@ define(function (require, exports, module) { // Save the dialog promise for unit tests $dlg.data("promise", promise); - // Set title and message - if (title) { - $(".dialog-title", $dlg).html(title); - } - if (message) { - $(".dialog-message", $dlg).html(message); - } - $(".clickable-link", $dlg).on("click", function _handleLink(e) { // Links use data-href (not href) attribute so Brackets itself doesn't redirect if (e.target.dataset && e.target.dataset.href) { @@ -171,6 +197,7 @@ define(function (require, exports, module) { // Remove keydown event handler window.document.body.removeEventListener("keydown", handleKeyDown, true); KeyBindingManager.setEnabled(true); + }).one("shown", function () { // Set focus to the default button var primaryBtn = $dlg.find(".primary"); @@ -196,37 +223,48 @@ define(function (require, exports, module) { keyboard: true }); - return promise; + return (new Dialog($dlg, promise)); } + /** - * General purpose modal dialog. Assumes that: - * -- the root tag of the dialog is marked with a unique class name (passed as dlgClass), as well as the - * classes "template modal hide". - * -- the HTML for the dialog contains elements with "title" and "message" classes, as well as a number - * of elements with "dialog-button" class, each of which has a "data-button-id". + * Creates a new modal dialog using the default template and the template variables given in JSON + * or a JavaScript object where: + * -- It has a "title" and "message" keys that are uses for the title and message of the dialog + * -- It has an array of buttons where each button has a class, id and text property. The id is + * used in "data-button-id". * - * @param {string} dlgClass The class of the dialog node in the HTML. - * @param {string=} title The title of the error dialog. Can contain HTML markup. If unspecified, title in - * the HTML template is used unchanged. - * @param {string=} message The message to display in the error dialog. Can contain HTML markup. If - * unspecified, body in the HTML template is used unchanged. - * @return {$.Promise} a promise that will be resolved with the ID of the clicked button when the dialog - * is dismissed. Never rejected. + * @param {string} dlgClass - A class to identify the dialog in the HTML. + * @param {{title: string, message: string, buttons: Array.}} templateVars - The dialog + * dialog variable strings as described above. + * @return {Dialog} + */ + function showModalDialogUsingJSON(dlgClass, templateVars) { + var template = Mustache.render(DialogTemplate, $.extend(templateVars, {dlgClass: dlgClass})); + template = Mustache.render(template, Strings); + + return showModalDialogUsingTemplate(template); + } + + /** + * Creates a new general purpose modal dialog using the template variables from "default-dialogs.json" + * and a new title and/or message if specified. + * + * @param {string} dlgClass - The key of the dialog in the JSON file. + * @param {string=} title - The title of the dialog. Can contain HTML markup. If unspecified, the title + * in the JSON file is used unchanged. + * @param {string=} message - The message to display in the dialog. Can contain HTML markup. If + * unspecified, the message in the JSON file is used. + * @return {Dialog} */ function showModalDialog(dlgClass, title, message) { - // We clone the HTML rather than using it directly so that if two dialogs of the same - // type happen to show up, they can appear at the same time. (This is an edge case that - // shouldn't happen often, but we can't prevent it from happening since everything is - // asynchronous.) - var $template = $("." + dlgClass + ".template") - .clone() - .removeClass("template"); - if ($template.length === 0) { - console.error("Dialog id " + dlgClass + " does not exist"); - return; + if (DefaultDialogs[dlgClass]) { + var templateVars = DefaultDialogs[dlgClass]; + templateVars.title = title || templateVars.title; + templateVars.message = message || templateVars.message; + + return showModalDialogUsingJSON(dlgClass, templateVars); } - return showModalDialogUsingTemplate($template, title, message); } /** @@ -241,20 +279,22 @@ define(function (require, exports, module) { }); } - exports.DIALOG_BTN_CANCEL = DIALOG_BTN_CANCEL; - exports.DIALOG_BTN_OK = DIALOG_BTN_OK; - exports.DIALOG_BTN_DONTSAVE = DIALOG_BTN_DONTSAVE; - exports.DIALOG_CANCELED = DIALOG_CANCELED; - exports.DIALOG_BTN_DOWNLOAD = DIALOG_BTN_DOWNLOAD; - exports.DIALOG_ID_ERROR = DIALOG_ID_ERROR; - exports.DIALOG_ID_INFO = DIALOG_ID_INFO; - exports.DIALOG_ID_SAVE_CLOSE = DIALOG_ID_SAVE_CLOSE; - exports.DIALOG_ID_EXT_CHANGED = DIALOG_ID_EXT_CHANGED; - exports.DIALOG_ID_EXT_DELETED = DIALOG_ID_EXT_DELETED; - exports.DIALOG_ID_LIVE_DEVELOPMENT = DIALOG_ID_LIVE_DEVELOPMENT; + exports.DIALOG_BTN_CANCEL = DIALOG_BTN_CANCEL; + exports.DIALOG_BTN_OK = DIALOG_BTN_OK; + exports.DIALOG_BTN_DONTSAVE = DIALOG_BTN_DONTSAVE; + exports.DIALOG_CANCELED = DIALOG_CANCELED; + exports.DIALOG_BTN_DOWNLOAD = DIALOG_BTN_DOWNLOAD; + + exports.DIALOG_ID_ERROR = DIALOG_ID_ERROR; + exports.DIALOG_ID_INFO = DIALOG_ID_INFO; + exports.DIALOG_ID_SAVE_CLOSE = DIALOG_ID_SAVE_CLOSE; + exports.DIALOG_ID_EXT_CHANGED = DIALOG_ID_EXT_CHANGED; + exports.DIALOG_ID_EXT_DELETED = DIALOG_ID_EXT_DELETED; + exports.DIALOG_ID_LIVE_DEVELOPMENT = DIALOG_ID_LIVE_DEVELOPMENT; exports.showModalDialog = showModalDialog; + exports.showModalDialogUsingJSON = showModalDialogUsingJSON; exports.showModalDialogUsingTemplate = showModalDialogUsingTemplate; exports.cancelModalDialogIfOpen = cancelModalDialogIfOpen; -}); \ No newline at end of file +}); diff --git a/src/widgets/default-dialogs.json b/src/widgets/default-dialogs.json new file mode 100644 index 00000000000..d853344f65a --- /dev/null +++ b/src/widgets/default-dialogs.json @@ -0,0 +1,82 @@ +{ + "error-dialog": { + "title": "Error", + "message": "", + "buttons": [ + { + "class": "primary", + "id": "ok", + "text": "{{OK}}" + } + ] + }, + "save-close-dialog": { + "title": "", + "message": "", + "buttons": [ + { + "class": "left", + "id": "dontsave", + "text": "{{RELOAD_FROM_DISK}}" + }, + { + "class": "primary", + "id": "ok", + "text": "{{SAVE}}" + }, + { + "class": "", + "id": "cancel", + "text": "{{CANCEL}}" + } + ] + }, + "ext-changed-dialog": { + "title": "", + "message": "", + "buttons": [ + { + "class": "left", + "id": "dontsave", + "text": "{{RELOAD_FROM_DISK}}" + }, + { + "class": "primary", + "id": "cancel", + "text": "{{KEEP_CHANGES_IN_EDITOR}}" + } + ] + }, + "ext-deleted-dialog": { + "title": "", + "message": "", + "buttons": [ + { + "class": "left", + "id": "dontsave", + "text": "{{CLOSE_DONT_SAVE}}" + }, + { + "class": "primary", + "id": "cancel", + "text": "{{KEEP_CHANGES_IN_EDITOR}}" + } + ] + }, + "live-development-error-dialog": { + "title": "", + "message": "", + "buttons": [ + { + "class": "left", + "id": "cancel", + "text": "{{CANCEL}}" + }, + { + "class": "primary", + "id": "ok", + "text": "{{RELAUNCH_CHROME}}" + } + ] + } +} \ No newline at end of file From e95df02482d691c41e0e470551fcfab4d3312a50 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tom=C3=A1s=20Malbr=C3=A1n?= Date: Sat, 9 Mar 2013 20:41:25 -0300 Subject: [PATCH 2/5] Reversing the buttons order --- src/styles/brackets_patterns_override.less | 8 ++++++-- src/widgets/default-dialogs.json | 10 +++++----- 2 files changed, 11 insertions(+), 7 deletions(-) diff --git a/src/styles/brackets_patterns_override.less b/src/styles/brackets_patterns_override.less index a8a81d39c18..7b7b1f9cfc2 100644 --- a/src/styles/brackets_patterns_override.less +++ b/src/styles/brackets_patterns_override.less @@ -328,9 +328,13 @@ } .modal-footer { + text-align: right; white-space: nowrap; } +.modal-footer .btn { + float: none; +} .modal-footer .btn.left { float: left; } @@ -338,10 +342,10 @@ .platform-win { /* Reverse Save/Cancel button order on Win */ .modal-footer { - text-align: right; + text-align: left; } .modal-footer .btn:not(.left) { - float: none; + float: right; } } diff --git a/src/widgets/default-dialogs.json b/src/widgets/default-dialogs.json index d853344f65a..050a3fdb01e 100644 --- a/src/widgets/default-dialogs.json +++ b/src/widgets/default-dialogs.json @@ -19,15 +19,15 @@ "id": "dontsave", "text": "{{RELOAD_FROM_DISK}}" }, - { - "class": "primary", - "id": "ok", - "text": "{{SAVE}}" - }, { "class": "", "id": "cancel", "text": "{{CANCEL}}" + }, + { + "class": "primary", + "id": "ok", + "text": "{{SAVE}}" } ] }, From 064b108a9ba94a3febff213ab6db1a4a766d6c06 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tom=C3=A1s=20Malbr=C3=A1n?= Date: Sat, 18 May 2013 20:49:39 -0300 Subject: [PATCH 3/5] Updates to address the review comments --- src/LiveDevelopment/LiveDevelopment.js | 8 +- src/LiveDevelopment/main.js | 2 +- src/document/DocumentCommandHandlers.js | 22 +++-- src/extensibility/ExtensionManagerDialog.js | 2 +- src/extensibility/ExtensionManagerView.js | 58 +++++++------ src/extensibility/InstallExtensionDialog.js | 7 +- src/file/FileUtils.js | 2 +- src/htmlContent/about-dialog.html | 2 +- src/htmlContent/dialog-template.html | 2 +- src/htmlContent/project-settings-dialog.html | 4 +- src/htmlContent/update-dialog.html | 4 +- src/preferences/PreferencesDialogs.js | 2 +- src/project/FileIndexManager.js | 2 +- src/project/FileSyncManager.js | 21 +++-- src/project/ProjectManager.js | 2 +- src/utils/UpdateNotification.js | 2 +- src/widgets/Dialogs.js | 86 +++++++++----------- src/widgets/default-dialogs.json | 82 ------------------- 18 files changed, 123 insertions(+), 187 deletions(-) delete mode 100644 src/widgets/default-dialogs.json diff --git a/src/LiveDevelopment/LiveDevelopment.js b/src/LiveDevelopment/LiveDevelopment.js index 71254734c15..95dfea58666 100644 --- a/src/LiveDevelopment/LiveDevelopment.js +++ b/src/LiveDevelopment/LiveDevelopment.js @@ -644,8 +644,12 @@ define(function LiveDevelopment(require, exports, module) { Dialogs.showModalDialog( Dialogs.DIALOG_ID_LIVE_DEVELOPMENT, Strings.LIVE_DEVELOPMENT_RELAUNCH_TITLE, - Strings.LIVE_DEVELOPMENT_ERROR_MESSAGE - ).getPromise().done(function (id) { + Strings.LIVE_DEVELOPMENT_ERROR_MESSAGE, + [ + { className: "left", id: "cancel", text: Strings.CANCEL }, + { className: "primary", id: "ok", text: Strings.RELAUNCH_CHROME } + ] + ).done(function (id) { if (id === Dialogs.DIALOG_BTN_OK) { // User has chosen to reload Chrome, quit the running instance _setStatus(STATUS_INACTIVE); diff --git a/src/LiveDevelopment/main.js b/src/LiveDevelopment/main.js index 311614b28c9..d431b0de336 100644 --- a/src/LiveDevelopment/main.js +++ b/src/LiveDevelopment/main.js @@ -123,7 +123,7 @@ define(function main(require, exports, module) { Dialogs.DIALOG_ID_INFO, Strings.LIVE_DEVELOPMENT_INFO_TITLE, Strings.LIVE_DEVELOPMENT_INFO_MESSAGE - ).getPromise().done(function (id) { + ).done(function (id) { LiveDevelopment.open(); }); } else { diff --git a/src/document/DocumentCommandHandlers.js b/src/document/DocumentCommandHandlers.js index cd03b10f30b..88182b4603d 100644 --- a/src/document/DocumentCommandHandlers.js +++ b/src/document/DocumentCommandHandlers.js @@ -392,7 +392,7 @@ define(function (require, exports, module) { StringUtils.breakableUrl(path), FileUtils.getFileErrorString(name) ) - ).getPromise(); + ); } /** Note: if there is an error, the promise is not rejected until the user has dimissed the dialog */ @@ -401,7 +401,7 @@ define(function (require, exports, module) { function handleError(error, fileEntry) { showSaveFileError(error.name, fileEntry.fullPath) - .always(function () { + .done(function () { result.reject(error); }); } @@ -581,8 +581,13 @@ define(function (require, exports, module) { StringUtils.format( Strings.SAVE_CLOSE_MESSAGE, StringUtils.breakableUrl(filename) - ) - ).getPromise().done(function (id) { + ), + [ + { className: "left", id: "dontsave", text: Strings.DONT_SAVE }, + { className: "", id: "cancel", text: Strings.CANCEL }, + { className: "primary", id: "ok", text: Strings.SAVE } + ] + ).done(function (id) { if (id === Dialogs.DIALOG_BTN_CANCEL) { result.reject(); } else if (id === Dialogs.DIALOG_BTN_OK) { @@ -673,8 +678,13 @@ define(function (require, exports, module) { Dialogs.showModalDialog( Dialogs.DIALOG_ID_SAVE_CLOSE, Strings.SAVE_CLOSE_TITLE, - message - ).getPromise().done(function (id) { + message, + [ + { className: "left", id: "dontsave", text: Strings.DONT_SAVE }, + { className: "", id: "cancel", text: Strings.CANCEL }, + { className: "primary", id: "ok", text: Strings.SAVE } + ] + ).done(function (id) { if (id === Dialogs.DIALOG_BTN_CANCEL) { result.reject(); } else if (id === Dialogs.DIALOG_BTN_OK) { diff --git a/src/extensibility/ExtensionManagerDialog.js b/src/extensibility/ExtensionManagerDialog.js index f2b77f0b79e..6407f54572f 100644 --- a/src/extensibility/ExtensionManagerDialog.js +++ b/src/extensibility/ExtensionManagerDialog.js @@ -47,7 +47,7 @@ define(function (require, exports, module) { // Open the dialog. Dialogs.showModalDialogUsingTemplate( Mustache.render(dialogTemplate, Strings) - ).always(function () { + ).done(function () { view.dispose(); }); diff --git a/src/extensibility/ExtensionManagerView.js b/src/extensibility/ExtensionManagerView.js index bb3e1bb1e57..28d93e8127a 100644 --- a/src/extensibility/ExtensionManagerView.js +++ b/src/extensibility/ExtensionManagerView.js @@ -271,33 +271,41 @@ define(function (require, exports, module) { // If an extension was removed, prompt the user to quit Brackets. if (!_skipRemoval && this.model.hasExtensionsToRemove()) { - Dialogs.showModalDialog("remove-marked-extensions", Strings.REMOVE_AND_QUIT_TITLE, - Strings.REMOVE_AND_QUIT_MESSAGE) - .done(function (buttonId) { - if (buttonId === "ok") { - self.model.removeMarkedExtensions() - .done(function () { - self.model.dispose(); + Dialogs.showModalDialog( + Dialogs.DIALOG_ID_REMOVE_EXTENSIONS, + Strings.REMOVE_AND_QUIT_TITLE, + Strings.REMOVE_AND_QUIT_MESSAGE, + [ + { className: "", id: "cancel", text: Strings.CANCEL }, + { className: "primary", id: "ok", text: Strings.REMOVE_AND_QUIT } + ] + ).done(function (buttonId) { + if (buttonId === "ok") { + self.model.removeMarkedExtensions() + .done(function () { + self.model.dispose(); + CommandManager.execute(Commands.FILE_QUIT); + }) + .fail(function (errorArray) { + self.model.dispose(); + + var ids = []; + errorArray.forEach(function (errorObj) { + ids.push(errorObj.item); + }); + Dialogs.showModalDialog( + Dialogs.DIALOG_ID_ERROR, + Strings.EXTENSION_MANAGER_REMOVE, + StringUtils.format(Strings.EXTENSION_MANAGER_REMOVE_ERROR, ids.join(", ")) + ).done(function () { + // We still have to quit even if some of the removals failed. CommandManager.execute(Commands.FILE_QUIT); - }) - .fail(function (errorArray) { - self.model.dispose(); - - var ids = []; - errorArray.forEach(function (errorObj) { - ids.push(errorObj.item); - }); - Dialogs.showModalDialog("error-dialog", Strings.EXTENSION_MANAGER_REMOVE, - StringUtils.format(Strings.EXTENSION_MANAGER_REMOVE_ERROR, ids.join(", "))) - .done(function () { - // We still have to quit even if some of the removals failed. - CommandManager.execute(Commands.FILE_QUIT); - }); }); - } else { - self.model.dispose(); - } - }); + }); + } else { + self.model.dispose(); + } + }); } else { this.model.dispose(); } diff --git a/src/extensibility/InstallExtensionDialog.js b/src/extensibility/InstallExtensionDialog.js index bcc14759cca..222eaabb17f 100644 --- a/src/extensibility/InstallExtensionDialog.js +++ b/src/extensibility/InstallExtensionDialog.js @@ -286,12 +286,7 @@ define(function (require, exports, module) { // We ignore the promise returned by showModalDialogUsingTemplate, since we're managing the // lifecycle of the dialog ourselves. - Dialogs.showModalDialogUsingTemplate( - Mustache.render(InstallDialogTemplate, Strings), - null, - null, - false - ); + Dialogs.showModalDialogUsingTemplate(Mustache.render(InstallDialogTemplate, Strings), false); this.$dlg = $(".install-extension-dialog.instance"); this.$url = this.$dlg.find(".url").focus(); diff --git a/src/file/FileUtils.js b/src/file/FileUtils.js index 6a48eee800e..04ea29ee7e5 100644 --- a/src/file/FileUtils.js +++ b/src/file/FileUtils.js @@ -184,7 +184,7 @@ define(function (require, exports, module) { StringUtils.breakableUrl(path), getFileErrorString(name) ) - ).getPromise(); + ); } /** diff --git a/src/htmlContent/about-dialog.html b/src/htmlContent/about-dialog.html index 5380ff2dbac..e66eedef6f2 100644 --- a/src/htmlContent/about-dialog.html +++ b/src/htmlContent/about-dialog.html @@ -22,6 +22,6 @@

    {{APP_NAME_ABOUT_BOX}}

    - {{CLOSE}} +
    diff --git a/src/htmlContent/dialog-template.html b/src/htmlContent/dialog-template.html index cf9c8e68f9b..531379d4ba4 100644 --- a/src/htmlContent/dialog-template.html +++ b/src/htmlContent/dialog-template.html @@ -8,7 +8,7 @@

    {{{title}}}

    {{#buttons}} - {{{text}}} + {{/buttons}}
    diff --git a/src/htmlContent/project-settings-dialog.html b/src/htmlContent/project-settings-dialog.html index 72ba7358d2e..a4db1135951 100644 --- a/src/htmlContent/project-settings-dialog.html +++ b/src/htmlContent/project-settings-dialog.html @@ -8,7 +8,7 @@

    - {{OK}} - {{CANCEL}} + +
    diff --git a/src/htmlContent/update-dialog.html b/src/htmlContent/update-dialog.html index ad79727ac62..b15a3c42625 100644 --- a/src/htmlContent/update-dialog.html +++ b/src/htmlContent/update-dialog.html @@ -11,7 +11,7 @@

    {{UPDATE_AVAILABLE_TITLE}}

    - {{CANCEL}} - {{GET_IT_NOW}} + +
    diff --git a/src/preferences/PreferencesDialogs.js b/src/preferences/PreferencesDialogs.js index 656b25e7117..74292b00d2a 100644 --- a/src/preferences/PreferencesDialogs.js +++ b/src/preferences/PreferencesDialogs.js @@ -86,7 +86,7 @@ define(function (require, exports, module) { $baseUrlControl, promise; - promise = Dialogs.showModalDialogUsingTemplate(Mustache.render(SettingsDialogTemplate, Strings)).getPromise() + promise = Dialogs.showModalDialogUsingTemplate(Mustache.render(SettingsDialogTemplate, Strings)) .done(function (id) { if (id === Dialogs.DIALOG_BTN_OK) { var baseUrlValue = $baseUrlControl.val(); diff --git a/src/project/FileIndexManager.js b/src/project/FileIndexManager.js index 69207acf4e5..72e1f201af6 100644 --- a/src/project/FileIndexManager.js +++ b/src/project/FileIndexManager.js @@ -156,7 +156,7 @@ define(function (require, exports, module) { Dialogs.DIALOG_ID_ERROR, Strings.ERROR_MAX_FILES_TITLE, Strings.ERROR_MAX_FILES - ).getPromise(); + ); } /* Recursively visits all files that are descendent of dirEntry and adds diff --git a/src/project/FileSyncManager.js b/src/project/FileSyncManager.js index 6d478e3764f..cb552043fae 100644 --- a/src/project/FileSyncManager.js +++ b/src/project/FileSyncManager.js @@ -207,7 +207,7 @@ define(function (require, exports, module) { /** * @param {FileError} error * @param {!Document} doc - * @return {$.Promise} + * @return {Dialog} */ function showReloadError(error, doc) { return Dialogs.showModalDialog( @@ -218,7 +218,7 @@ define(function (require, exports, module) { StringUtils.breakableUrl(doc.file.fullPath), FileUtils.getFileErrorString(error.name) ) - ).getPromise(); + ); } @@ -254,9 +254,10 @@ define(function (require, exports, module) { return promise; } - var message; - var dialogId; var toClose; + var dialogId; + var message; + var buttons; // Prompt UI varies depending on whether the file on disk was modified vs. deleted if (i < editConflicts.length) { @@ -268,6 +269,10 @@ define(function (require, exports, module) { ProjectManager.makeProjectRelativeIfPossible(doc.file.fullPath) ) ); + buttons = [ + { className: "left", id: "dontsave", text: Strings.RELOAD_FROM_DISK }, + { className: "primary", id: "cancel", text: Strings.KEEP_CHANGES_IN_EDITOR } + ]; } else { toClose = true; @@ -278,9 +283,13 @@ define(function (require, exports, module) { ProjectManager.makeProjectRelativeIfPossible(doc.file.fullPath) ) ); + buttons = [ + { className: "left", id: "dontsave", text: Strings.CLOSE_DONT_SAVE }, + { className: "primary", id: "cancel", text: Strings.KEEP_CHANGES_IN_EDITOR } + ]; } - Dialogs.showModalDialog(dialogId, Strings.EXT_MODIFIED_TITLE, message).getPromise() + Dialogs.showModalDialog(dialogId, Strings.EXT_MODIFIED_TITLE, message, buttons) .done(function (id) { if (id === Dialogs.DIALOG_BTN_DONTSAVE) { if (toClose) { @@ -296,7 +305,7 @@ define(function (require, exports, module) { .fail(function (error) { // Unable to load changed version from disk - show error UI showReloadError(error, doc) - .always(function () { + .done(function () { // After user dismisses, move on to next conflict prompt result.reject(); }); diff --git a/src/project/ProjectManager.js b/src/project/ProjectManager.js index 0174c3ba165..496a8016749 100644 --- a/src/project/ProjectManager.js +++ b/src/project/ProjectManager.js @@ -865,7 +865,7 @@ define(function (require, exports, module) { StringUtils.breakableUrl(rootPath), error.name ) - ).getPromise().done(function () { + ).done(function () { // The project folder stored in preference doesn't exist, so load the default // project directory. // TODO (issue #267): When Brackets supports having no project directory diff --git a/src/utils/UpdateNotification.js b/src/utils/UpdateNotification.js index 885625adb1a..0b66e41e962 100644 --- a/src/utils/UpdateNotification.js +++ b/src/utils/UpdateNotification.js @@ -193,7 +193,7 @@ define(function (require, exports, module) { * Show a dialog that shows the update */ function _showUpdateNotificationDialog(updates) { - Dialogs.showModalDialogUsingTemplate(Mustache.render(UpdateDialogTemplate, Strings)).getPromise() + Dialogs.showModalDialogUsingTemplate(Mustache.render(UpdateDialogTemplate, Strings)) .done(function (id) { if (id === Dialogs.DIALOG_BTN_DOWNLOAD) { // The first entry in the updates array has the latest download link diff --git a/src/widgets/Dialogs.js b/src/widgets/Dialogs.js index da8a4706cad..c993df7afbe 100644 --- a/src/widgets/Dialogs.js +++ b/src/widgets/Dialogs.js @@ -39,28 +39,27 @@ define(function (require, exports, module) { Strings = require("strings"), DialogTemplate = require("text!htmlContent/dialog-template.html"); - var DefaultDialogs = JSON.parse(require("text!widgets/default-dialogs.json")); + var DIALOG_BTN_CANCEL = "cancel", + DIALOG_BTN_OK = "ok", + DIALOG_BTN_DONTSAVE = "dontsave", + DIALOG_CANCELED = "_canceled", + DIALOG_BTN_DOWNLOAD = "download"; - var DIALOG_BTN_CANCEL = "cancel", - DIALOG_BTN_OK = "ok", - DIALOG_BTN_DONTSAVE = "dontsave", - DIALOG_CANCELED = "_canceled", - DIALOG_BTN_DOWNLOAD = "download"; - - var DIALOG_ID_ERROR = "error-dialog", - DIALOG_ID_INFO = "error-dialog", // uses the same template for now--could be different in future - DIALOG_ID_SAVE_CLOSE = "save-close-dialog", - DIALOG_ID_EXT_CHANGED = "ext-changed-dialog", - DIALOG_ID_EXT_DELETED = "ext-deleted-dialog", - DIALOG_ID_LIVE_DEVELOPMENT = "live-development-error-dialog"; + var DIALOG_ID_ERROR = "error-dialog", + DIALOG_ID_INFO = "error-dialog", // uses the same template for now--could be different in future + DIALOG_ID_SAVE_CLOSE = "save-close-dialog", + DIALOG_ID_EXT_CHANGED = "ext-changed-dialog", + DIALOG_ID_EXT_DELETED = "ext-deleted-dialog", + DIALOG_ID_LIVE_DEVELOPMENT = "live-development-error-dialog", + DIALOG_ID_REMOVE_EXTENSIONS = "remove-marked-extensions"; /** * A stack of keydown event handler functions that corresponds to the * current stack of modal dialogs. * - * @type {Array.} + * @type {Array.} */ var _keydownListeners = []; @@ -128,8 +127,8 @@ define(function (require, exports, module) { * @constructor * @private * - * @param {$.Element} $dlg - The dialog jQuery element - * @param {$.Promise} promise - A promise that will be resolved with the ID of the clicked button when the dialog + * @param {$.Element} $dlg The dialog jQuery element + * @param {$.Promise} promise A promise that will be resolved with the ID of the clicked button when the dialog * is dismissed. Never rejected. */ function Dialog($dlg, promise) { @@ -156,6 +155,13 @@ define(function (require, exports, module) { } }; + /** + * Adds a done callback to the dialog promise + */ + Dialog.prototype.done = function (callback) { + this._promise.done(callback); + }; + /** @@ -269,49 +275,35 @@ define(function (require, exports, module) { } - /** - * Creates a new modal dialog using the default template and the template variables given in JSON - * or a JavaScript object where: - * -- It has a "title" and "message" keys that are uses for the title and message of the dialog - * -- It has an array of buttons where each button has a class, id and text property. The id is - * used in "data-button-id". - * - * @param {string} dlgClass - A class to identify the dialog in the HTML. - * @param {{title: string, message: string, buttons: Array.}} templateVars - The dialog - * dialog variable strings as described above. - * @return {Dialog} - */ - function showModalDialogUsingJSON(dlgClass, templateVars) { - var template = Mustache.render(DialogTemplate, $.extend(templateVars, {dlgClass: dlgClass})); - template = Mustache.render(template, Strings); - - return showModalDialogUsingTemplate(template); - } - /** * Creates a new general purpose modal dialog using the template variables from "default-dialogs.json" * and a new title and/or message if specified. * - * @param {string} dlgClass - The key of the dialog in the JSON file. - * @param {string=} title - The title of the dialog. Can contain HTML markup. If unspecified, the title + * @param {string} dlgClass A class name identifier for the dialog. + * @param {string=} title The title of the dialog. Can contain HTML markup. If unspecified, the title * in the JSON file is used unchanged. - * @param {string=} message - The message to display in the dialog. Can contain HTML markup. If + * @param {string=} message The message to display in the dialog. Can contain HTML markup. If * unspecified, the message in the JSON file is used. + * @param {Array.<{className: string, id: string, text: string>=} buttons An array of buttons where each button + * has a class, id and text property. The id is used in "data-button-id". It defaults to an Ok button * @return {Dialog} */ - function showModalDialog(dlgClass, title, message) { - if (DefaultDialogs[dlgClass]) { - var templateVars = DefaultDialogs[dlgClass]; - templateVars.title = title || templateVars.title; - templateVars.message = message || templateVars.message; - - return showModalDialogUsingJSON(dlgClass, templateVars); - } + function showModalDialog(dlgClass, title, message, buttons) { + var templateVars = { + dlgClass: dlgClass, + title: title || "", + message: message || "", + buttons: buttons || [{ className: "primary", id: "ok", text: Strings.OK }] + }; + var template = Mustache.render(DialogTemplate, templateVars); + + return showModalDialogUsingTemplate(template); } /** * Immediately closes any dialog instances with the given class. The dialog callback for each instance will * be called with the special buttonId DIALOG_CANCELED (note: callback is run asynchronously). + * @param {string} dlgClass The class name identifier for the dialog. */ function cancelModalDialogIfOpen(dlgClass) { $("." + dlgClass + ".instance").each(function (index, dlg) { @@ -334,9 +326,9 @@ define(function (require, exports, module) { exports.DIALOG_ID_EXT_CHANGED = DIALOG_ID_EXT_CHANGED; exports.DIALOG_ID_EXT_DELETED = DIALOG_ID_EXT_DELETED; exports.DIALOG_ID_LIVE_DEVELOPMENT = DIALOG_ID_LIVE_DEVELOPMENT; + exports.DIALOG_ID_REMOVE_EXTENSIONS = DIALOG_ID_REMOVE_EXTENSIONS; exports.showModalDialog = showModalDialog; - exports.showModalDialogUsingJSON = showModalDialogUsingJSON; exports.showModalDialogUsingTemplate = showModalDialogUsingTemplate; exports.cancelModalDialogIfOpen = cancelModalDialogIfOpen; }); diff --git a/src/widgets/default-dialogs.json b/src/widgets/default-dialogs.json deleted file mode 100644 index 050a3fdb01e..00000000000 --- a/src/widgets/default-dialogs.json +++ /dev/null @@ -1,82 +0,0 @@ -{ - "error-dialog": { - "title": "Error", - "message": "", - "buttons": [ - { - "class": "primary", - "id": "ok", - "text": "{{OK}}" - } - ] - }, - "save-close-dialog": { - "title": "", - "message": "", - "buttons": [ - { - "class": "left", - "id": "dontsave", - "text": "{{RELOAD_FROM_DISK}}" - }, - { - "class": "", - "id": "cancel", - "text": "{{CANCEL}}" - }, - { - "class": "primary", - "id": "ok", - "text": "{{SAVE}}" - } - ] - }, - "ext-changed-dialog": { - "title": "", - "message": "", - "buttons": [ - { - "class": "left", - "id": "dontsave", - "text": "{{RELOAD_FROM_DISK}}" - }, - { - "class": "primary", - "id": "cancel", - "text": "{{KEEP_CHANGES_IN_EDITOR}}" - } - ] - }, - "ext-deleted-dialog": { - "title": "", - "message": "", - "buttons": [ - { - "class": "left", - "id": "dontsave", - "text": "{{CLOSE_DONT_SAVE}}" - }, - { - "class": "primary", - "id": "cancel", - "text": "{{KEEP_CHANGES_IN_EDITOR}}" - } - ] - }, - "live-development-error-dialog": { - "title": "", - "message": "", - "buttons": [ - { - "class": "left", - "id": "cancel", - "text": "{{CANCEL}}" - }, - { - "class": "primary", - "id": "ok", - "text": "{{RELAUNCH_CHROME}}" - } - ] - } -} \ No newline at end of file From f37ebd0e1473b03e4217ad9dbef738b157c526a7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tom=C3=A1s=20Malbr=C3=A1n?= Date: Sat, 18 May 2013 21:13:28 -0300 Subject: [PATCH 4/5] JSHint indentation fixes --- src/LiveDevelopment/LiveDevelopment.js | 41 +++++------ src/document/DocumentCommandHandlers.js | 88 +++++++++++------------ src/extensibility/ExtensionManagerView.js | 51 ++++++------- 3 files changed, 90 insertions(+), 90 deletions(-) diff --git a/src/LiveDevelopment/LiveDevelopment.js b/src/LiveDevelopment/LiveDevelopment.js index 95dfea58666..3dee6f5273d 100644 --- a/src/LiveDevelopment/LiveDevelopment.js +++ b/src/LiveDevelopment/LiveDevelopment.js @@ -649,27 +649,28 @@ define(function LiveDevelopment(require, exports, module) { { className: "left", id: "cancel", text: Strings.CANCEL }, { className: "primary", id: "ok", text: Strings.RELAUNCH_CHROME } ] - ).done(function (id) { - if (id === Dialogs.DIALOG_BTN_OK) { - // User has chosen to reload Chrome, quit the running instance - _setStatus(STATUS_INACTIVE); - NativeApp.closeLiveBrowser() - .done(function () { - browserStarted = false; - window.setTimeout(function () { - open().done(result.resolve).fail(result.reject); + ) + .done(function (id) { + if (id === Dialogs.DIALOG_BTN_OK) { + // User has chosen to reload Chrome, quit the running instance + _setStatus(STATUS_INACTIVE); + NativeApp.closeLiveBrowser() + .done(function () { + browserStarted = false; + window.setTimeout(function () { + open().done(result.resolve).fail(result.reject); + }); + }) + .fail(function (err) { + // Report error? + _setStatus(STATUS_ERROR); + browserStarted = false; + result.reject("CLOSE_LIVE_BROWSER"); }); - }) - .fail(function (err) { - // Report error? - _setStatus(STATUS_ERROR); - browserStarted = false; - result.reject("CLOSE_LIVE_BROWSER"); - }); - } else { - result.reject("CANCEL"); - } - }); + } else { + result.reject("CANCEL"); + } + }); return; } retryCount++; diff --git a/src/document/DocumentCommandHandlers.js b/src/document/DocumentCommandHandlers.js index 88182b4603d..411051a89d8 100644 --- a/src/document/DocumentCommandHandlers.js +++ b/src/document/DocumentCommandHandlers.js @@ -34,12 +34,10 @@ define(function (require, exports, module) { var AppInit = require("utils/AppInit"), CommandManager = require("command/CommandManager"), Commands = require("command/Commands"), - KeyBindingManager = require("command/KeyBindingManager"), NativeFileSystem = require("file/NativeFileSystem").NativeFileSystem, ProjectManager = require("project/ProjectManager"), DocumentManager = require("document/DocumentManager"), EditorManager = require("editor/EditorManager"), - FileViewController = require("project/FileViewController"), FileUtils = require("file/FileUtils"), StringUtils = require("utils/StringUtils"), Async = require("utils/Async"), @@ -209,8 +207,6 @@ define(function (require, exports, module) { // Prompt the user with a dialog NativeFileSystem.showOpenDialog(true, false, Strings.OPEN_FILE, _defaultOpenDialogFullPath, null, function (paths) { - var i; - if (paths.length > 0) { // Add all files to the working set without verifying that // they still exist on disk (for faster opening) @@ -587,35 +583,36 @@ define(function (require, exports, module) { { className: "", id: "cancel", text: Strings.CANCEL }, { className: "primary", id: "ok", text: Strings.SAVE } ] - ).done(function (id) { - if (id === Dialogs.DIALOG_BTN_CANCEL) { - result.reject(); - } else if (id === Dialogs.DIALOG_BTN_OK) { - // "Save" case: wait until we confirm save has succeeded before closing - doSave(doc) - .done(function () { - doClose(file); - result.resolve(); - }) - .fail(function () { - result.reject(); - }); - } else { - // "Don't Save" case: even though we're closing the main editor, other views of - // the Document may remain in the UI. So we need to revert the Document to a clean - // copy of whatever's on disk. - doClose(file); - - // Only reload from disk if we've executed the Close for real, - // *and* if at least one other view still exists - if (!promptOnly && DocumentManager.getOpenDocumentForPath(file.fullPath)) { - doRevert(doc) - .pipe(result.resolve, result.reject); + ) + .done(function (id) { + if (id === Dialogs.DIALOG_BTN_CANCEL) { + result.reject(); + } else if (id === Dialogs.DIALOG_BTN_OK) { + // "Save" case: wait until we confirm save has succeeded before closing + doSave(doc) + .done(function () { + doClose(file); + result.resolve(); + }) + .fail(function () { + result.reject(); + }); } else { - result.resolve(); + // "Don't Save" case: even though we're closing the main editor, other views of + // the Document may remain in the UI. So we need to revert the Document to a clean + // copy of whatever's on disk. + doClose(file); + + // Only reload from disk if we've executed the Close for real, + // *and* if at least one other view still exists + if (!promptOnly && DocumentManager.getOpenDocumentForPath(file.fullPath)) { + doRevert(doc) + .pipe(result.resolve, result.reject); + } else { + result.resolve(); + } } - } - }); + }); result.always(function () { EditorManager.focusEditor(); }); @@ -684,21 +681,22 @@ define(function (require, exports, module) { { className: "", id: "cancel", text: Strings.CANCEL }, { className: "primary", id: "ok", text: Strings.SAVE } ] - ).done(function (id) { - if (id === Dialogs.DIALOG_BTN_CANCEL) { - result.reject(); - } else if (id === Dialogs.DIALOG_BTN_OK) { - // Save all unsaved files, then if that succeeds, close all - saveAll().done(function () { - result.resolve(); - }).fail(function () { + ) + .done(function (id) { + if (id === Dialogs.DIALOG_BTN_CANCEL) { result.reject(); - }); - } else { - // "Don't Save" case--we can just go ahead and close all files. - result.resolve(); - } - }); + } else if (id === Dialogs.DIALOG_BTN_OK) { + // Save all unsaved files, then if that succeeds, close all + saveAll().done(function () { + result.resolve(); + }).fail(function () { + result.reject(); + }); + } else { + // "Don't Save" case--we can just go ahead and close all files. + result.resolve(); + } + }); } // If all the unsaved-changes confirmations pan out above, then go ahead & close all editors diff --git a/src/extensibility/ExtensionManagerView.js b/src/extensibility/ExtensionManagerView.js index 28d93e8127a..c427f1d52dd 100644 --- a/src/extensibility/ExtensionManagerView.js +++ b/src/extensibility/ExtensionManagerView.js @@ -279,33 +279,34 @@ define(function (require, exports, module) { { className: "", id: "cancel", text: Strings.CANCEL }, { className: "primary", id: "ok", text: Strings.REMOVE_AND_QUIT } ] - ).done(function (buttonId) { - if (buttonId === "ok") { - self.model.removeMarkedExtensions() - .done(function () { - self.model.dispose(); - CommandManager.execute(Commands.FILE_QUIT); - }) - .fail(function (errorArray) { - self.model.dispose(); - - var ids = []; - errorArray.forEach(function (errorObj) { - ids.push(errorObj.item); - }); - Dialogs.showModalDialog( - Dialogs.DIALOG_ID_ERROR, - Strings.EXTENSION_MANAGER_REMOVE, - StringUtils.format(Strings.EXTENSION_MANAGER_REMOVE_ERROR, ids.join(", ")) - ).done(function () { - // We still have to quit even if some of the removals failed. + ) + .done(function (buttonId) { + if (buttonId === "ok") { + self.model.removeMarkedExtensions() + .done(function () { + self.model.dispose(); CommandManager.execute(Commands.FILE_QUIT); + }) + .fail(function (errorArray) { + self.model.dispose(); + + var ids = []; + errorArray.forEach(function (errorObj) { + ids.push(errorObj.item); + }); + Dialogs.showModalDialog( + Dialogs.DIALOG_ID_ERROR, + Strings.EXTENSION_MANAGER_REMOVE, + StringUtils.format(Strings.EXTENSION_MANAGER_REMOVE_ERROR, ids.join(", ")) + ).done(function () { + // We still have to quit even if some of the removals failed. + CommandManager.execute(Commands.FILE_QUIT); + }); }); - }); - } else { - self.model.dispose(); - } - }); + } else { + self.model.dispose(); + } + }); } else { this.model.dispose(); } From bd08117111e0a846e4b272e7ce450da15e3f2050 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tom=C3=A1s=20Malbr=C3=A1n?= Date: Tue, 21 May 2013 04:21:06 -0300 Subject: [PATCH 5/5] Fixes after review --- src/LiveDevelopment/LiveDevelopment.js | 26 +++++---- src/LiveDevelopment/main.js | 3 +- src/brackets.js | 3 +- src/document/DocumentCommandHandlers.js | 56 +++++++++++++++----- src/extensibility/ExtensionManagerView.js | 17 ++++-- src/extensions/default/DebugCommands/main.js | 2 +- src/file/FileUtils.js | 3 +- src/preferences/PreferencesDialogs.js | 21 ++++---- src/project/FileIndexManager.js | 4 +- src/project/FileSyncManager.js | 35 ++++++++---- src/project/ProjectManager.js | 16 +++--- src/utils/UpdateNotification.js | 5 +- src/widgets/DefaultDialogs.js | 41 ++++++++++++++ src/widgets/Dialogs.js | 35 ++++++------ 14 files changed, 189 insertions(+), 78 deletions(-) create mode 100644 src/widgets/DefaultDialogs.js diff --git a/src/LiveDevelopment/LiveDevelopment.js b/src/LiveDevelopment/LiveDevelopment.js index 3dee6f5273d..1e9b8f527ab 100644 --- a/src/LiveDevelopment/LiveDevelopment.js +++ b/src/LiveDevelopment/LiveDevelopment.js @@ -75,6 +75,7 @@ define(function LiveDevelopment(require, exports, module) { var Async = require("utils/Async"), Dialogs = require("widgets/Dialogs"), + DefaultDialogs = require("widgets/DefaultDialogs"), DocumentManager = require("document/DocumentManager"), EditorManager = require("editor/EditorManager"), FileUtils = require("file/FileUtils"), @@ -595,7 +596,7 @@ define(function LiveDevelopment(require, exports, module) { function showWrongDocError() { Dialogs.showModalDialog( - Dialogs.DIALOG_ID_ERROR, + DefaultDialogs.DIALOG_ID_ERROR, Strings.LIVE_DEVELOPMENT_ERROR_TITLE, Strings.LIVE_DEV_NEED_HTML_MESSAGE ); @@ -612,15 +613,12 @@ define(function LiveDevelopment(require, exports, module) { } else { result.reject(); } - }) - .fail(function () { - result.reject(); }); } function showLiveDevServerNotReadyError() { Dialogs.showModalDialog( - Dialogs.DIALOG_ID_ERROR, + DefaultDialogs.DIALOG_ID_ERROR, Strings.LIVE_DEVELOPMENT_ERROR_TITLE, Strings.LIVE_DEV_SERVER_NOT_READY_MESSAGE ); @@ -642,12 +640,20 @@ define(function LiveDevelopment(require, exports, module) { if (retryCount > 6) { _setStatus(STATUS_ERROR); Dialogs.showModalDialog( - Dialogs.DIALOG_ID_LIVE_DEVELOPMENT, + DefaultDialogs.DIALOG_ID_LIVE_DEVELOPMENT, Strings.LIVE_DEVELOPMENT_RELAUNCH_TITLE, Strings.LIVE_DEVELOPMENT_ERROR_MESSAGE, [ - { className: "left", id: "cancel", text: Strings.CANCEL }, - { className: "primary", id: "ok", text: Strings.RELAUNCH_CHROME } + { + className: Dialogs.DIALOG_BTN_CLASS_LEFT, + id: Dialogs.DIALOG_BTN_CANCEL, + text: Strings.CANCEL + }, + { + className: Dialogs.DIALOG_BTN_CLASS_PRIMARY, + id: Dialogs.DIALOG_BTN_OK, + text: Strings.RELAUNCH_CHROME + } ] ) .done(function (id) { @@ -699,7 +705,7 @@ define(function LiveDevelopment(require, exports, module) { } Dialogs.showModalDialog( - Dialogs.DIALOG_ID_ERROR, + DefaultDialogs.DIALOG_ID_ERROR, Strings.ERROR_LAUNCHING_BROWSER_TITLE, message ); @@ -872,7 +878,7 @@ define(function LiveDevelopment(require, exports, module) { .fail(function () { close(); Dialogs.showModalDialog( - Dialogs.DIALOG_ID_ERROR, + DefaultDialogs.DIALOG_ID_ERROR, Strings.LIVE_DEVELOPMENT_ERROR_TITLE, Strings.LIVE_DEV_LOADING_ERROR_MESSAGE ); diff --git a/src/LiveDevelopment/main.js b/src/LiveDevelopment/main.js index d431b0de336..6da20ce84d4 100644 --- a/src/LiveDevelopment/main.js +++ b/src/LiveDevelopment/main.js @@ -46,6 +46,7 @@ define(function main(require, exports, module) { CommandManager = require("command/CommandManager"), PreferencesManager = require("preferences/PreferencesManager"), Dialogs = require("widgets/Dialogs"), + DefaultDialogs = require("widgets/DefaultDialogs"), UrlParams = require("utils/UrlParams").UrlParams, Strings = require("strings"), ExtensionUtils = require("utils/ExtensionUtils"), @@ -120,7 +121,7 @@ define(function main(require, exports, module) { if (!params.get("skipLiveDevelopmentInfo") && !prefs.getValue("afterFirstLaunch")) { prefs.setValue("afterFirstLaunch", "true"); Dialogs.showModalDialog( - Dialogs.DIALOG_ID_INFO, + DefaultDialogs.DIALOG_ID_INFO, Strings.LIVE_DEVELOPMENT_INFO_TITLE, Strings.LIVE_DEVELOPMENT_INFO_MESSAGE ).done(function (id) { diff --git a/src/brackets.js b/src/brackets.js index 53d480d93f8..1d0a0768d86 100644 --- a/src/brackets.js +++ b/src/brackets.js @@ -83,6 +83,7 @@ define(function (require, exports, module) { MainViewHTML = require("text!htmlContent/main-view.html"), Strings = require("strings"), Dialogs = require("widgets/Dialogs"), + DefaultDialogs = require("widgets/DefaultDialogs"), ExtensionLoader = require("utils/ExtensionLoader"), SidebarView = require("project/SidebarView"), Async = require("utils/Async"), @@ -165,7 +166,7 @@ define(function (require, exports, module) { // Let the user know Brackets doesn't run in a web browser yet if (brackets.inBrowser) { Dialogs.showModalDialog( - Dialogs.DIALOG_ID_ERROR, + DefaultDialogs.DIALOG_ID_ERROR, Strings.ERROR_IN_BROWSER_TITLE, Strings.ERROR_IN_BROWSER ); diff --git a/src/document/DocumentCommandHandlers.js b/src/document/DocumentCommandHandlers.js index 411051a89d8..d8ad6ab9e4d 100644 --- a/src/document/DocumentCommandHandlers.js +++ b/src/document/DocumentCommandHandlers.js @@ -42,6 +42,7 @@ define(function (require, exports, module) { StringUtils = require("utils/StringUtils"), Async = require("utils/Async"), Dialogs = require("widgets/Dialogs"), + DefaultDialogs = require("widgets/DefaultDialogs"), Strings = require("strings"), PreferencesManager = require("preferences/PreferencesManager"), PerfUtils = require("utils/PerfUtils"), @@ -379,9 +380,16 @@ define(function (require, exports, module) { _handleNewItemInProject(true); } - function showSaveFileError(name, path) { + /** + * @private + * Shows an Error modal dialog + * @param {string} name + * @param {string} path + * @return {Dialog} + */ + function _showSaveFileError(name, path) { return Dialogs.showModalDialog( - Dialogs.DIALOG_ID_ERROR, + DefaultDialogs.DIALOG_ID_ERROR, Strings.ERROR_SAVING_FILE_TITLE, StringUtils.format( Strings.ERROR_SAVING_FILE, @@ -396,7 +404,7 @@ define(function (require, exports, module) { var result = new $.Deferred(); function handleError(error, fileEntry) { - showSaveFileError(error.name, fileEntry.fullPath) + _showSaveFileError(error.name, fileEntry.fullPath) .done(function () { result.reject(error); }); @@ -513,7 +521,7 @@ define(function (require, exports, module) { }) .fail(function (error) { FileUtils.showFileOpenError(error.name, doc.file.fullPath) - .always(function () { + .done(function () { result.reject(error); }); }); @@ -572,16 +580,28 @@ define(function (require, exports, module) { var filename = PathUtils.parseUrl(doc.file.fullPath).filename; Dialogs.showModalDialog( - Dialogs.DIALOG_ID_SAVE_CLOSE, + DefaultDialogs.DIALOG_ID_SAVE_CLOSE, Strings.SAVE_CLOSE_TITLE, StringUtils.format( Strings.SAVE_CLOSE_MESSAGE, StringUtils.breakableUrl(filename) ), [ - { className: "left", id: "dontsave", text: Strings.DONT_SAVE }, - { className: "", id: "cancel", text: Strings.CANCEL }, - { className: "primary", id: "ok", text: Strings.SAVE } + { + className : Dialogs.DIALOG_BTN_CLASS_LEFT, + id : Dialogs.DIALOG_BTN_DONTSAVE, + text : Strings.DONT_SAVE + }, + { + className : Dialogs.DIALOG_BTN_CLASS_NORMAL, + id : Dialogs.DIALOG_BTN_CANCEL, + text : Strings.CANCEL + }, + { + className : Dialogs.DIALOG_BTN_CLASS_PRIMARY, + id : Dialogs.DIALOG_BTN_OK, + text : Strings.SAVE + } ] ) .done(function (id) { @@ -673,13 +693,25 @@ define(function (require, exports, module) { message += ""; Dialogs.showModalDialog( - Dialogs.DIALOG_ID_SAVE_CLOSE, + DefaultDialogs.DIALOG_ID_SAVE_CLOSE, Strings.SAVE_CLOSE_TITLE, message, [ - { className: "left", id: "dontsave", text: Strings.DONT_SAVE }, - { className: "", id: "cancel", text: Strings.CANCEL }, - { className: "primary", id: "ok", text: Strings.SAVE } + { + className : Dialogs.DIALOG_BTN_CLASS_LEFT, + id : Dialogs.DIALOG_BTN_DONTSAVE, + text : Strings.DONT_SAVE + }, + { + className : Dialogs.DIALOG_BTN_CLASS_NORMAL, + id : Dialogs.DIALOG_BTN_CANCEL, + text : Strings.CANCEL + }, + { + className : Dialogs.DIALOG_BTN_CLASS_PRIMARY, + id : Dialogs.DIALOG_BTN_OK, + text : Strings.SAVE + } ] ) .done(function (id) { diff --git a/src/extensibility/ExtensionManagerView.js b/src/extensibility/ExtensionManagerView.js index c427f1d52dd..8f7b8ef41f3 100644 --- a/src/extensibility/ExtensionManagerView.js +++ b/src/extensibility/ExtensionManagerView.js @@ -35,6 +35,7 @@ define(function (require, exports, module) { registry_utils = require("extensibility/registry_utils"), InstallExtensionDialog = require("extensibility/InstallExtensionDialog"), Dialogs = require("widgets/Dialogs"), + DefaultDialogs = require("widgets/DefaultDialogs"), StringUtils = require("utils/StringUtils"), CommandManager = require("command/CommandManager"), Commands = require("command/Commands"), @@ -272,12 +273,20 @@ define(function (require, exports, module) { // If an extension was removed, prompt the user to quit Brackets. if (!_skipRemoval && this.model.hasExtensionsToRemove()) { Dialogs.showModalDialog( - Dialogs.DIALOG_ID_REMOVE_EXTENSIONS, + DefaultDialogs.DIALOG_ID_REMOVE_EXTENSIONS, Strings.REMOVE_AND_QUIT_TITLE, Strings.REMOVE_AND_QUIT_MESSAGE, [ - { className: "", id: "cancel", text: Strings.CANCEL }, - { className: "primary", id: "ok", text: Strings.REMOVE_AND_QUIT } + { + className : Dialogs.DIALOG_BTN_CLASS_NORMAL, + id : Dialogs.DIALOG_BTN_CANCEL, + text : Strings.CANCEL + }, + { + className : Dialogs.DIALOG_BTN_CLASS_PRIMARY, + id : Dialogs.DIALOG_BTN_OK, + text : Strings.REMOVE_AND_QUIT + } ] ) .done(function (buttonId) { @@ -295,7 +304,7 @@ define(function (require, exports, module) { ids.push(errorObj.item); }); Dialogs.showModalDialog( - Dialogs.DIALOG_ID_ERROR, + DefaultDialogs.DIALOG_ID_ERROR, Strings.EXTENSION_MANAGER_REMOVE, StringUtils.format(Strings.EXTENSION_MANAGER_REMOVE_ERROR, ids.join(", ")) ).done(function () { diff --git a/src/extensions/default/DebugCommands/main.js b/src/extensions/default/DebugCommands/main.js index 8d982098326..00c1c60fdc7 100644 --- a/src/extensions/default/DebugCommands/main.js +++ b/src/extensions/default/DebugCommands/main.js @@ -198,7 +198,7 @@ define(function (require, exports, module) { }); $dialog = $(".switch-language.instance"); - $submit = $dialog.find(".dialog-button[data-button-id='ok']"); + $submit = $dialog.find(".dialog-button[data-button-id='" + Dialogs.DIALOG_BTN_OK + "']"); $select = $dialog.find("select"); $select.on("change", setLanguage).val(curLocale); diff --git a/src/file/FileUtils.js b/src/file/FileUtils.js index 04ea29ee7e5..ab694e932ec 100644 --- a/src/file/FileUtils.js +++ b/src/file/FileUtils.js @@ -37,6 +37,7 @@ define(function (require, exports, module) { NativeFileError = require("file/NativeFileError"), PerfUtils = require("utils/PerfUtils"), Dialogs = require("widgets/Dialogs"), + DefaultDialogs = require("widgets/DefaultDialogs"), Strings = require("strings"), StringUtils = require("utils/StringUtils"), Encodings = NativeFileSystem.Encodings; @@ -177,7 +178,7 @@ define(function (require, exports, module) { function showFileOpenError(name, path) { return Dialogs.showModalDialog( - Dialogs.DIALOG_ID_ERROR, + DefaultDialogs.DIALOG_ID_ERROR, Strings.ERROR_OPENING_FILE_TITLE, StringUtils.format( Strings.ERROR_OPENING_FILE, diff --git a/src/preferences/PreferencesDialogs.js b/src/preferences/PreferencesDialogs.js index 74292b00d2a..a8d854d244e 100644 --- a/src/preferences/PreferencesDialogs.js +++ b/src/preferences/PreferencesDialogs.js @@ -43,12 +43,12 @@ define(function (require, exports, module) { /** * Validate that text string is a valid base url which should map to a server folder - * @param {String} url - * @return {String} empty string if valid, otherwise error string + * @param {string} url + * @return {string} Empty string if valid, otherwise error string */ function _validateBaseUrl(url) { var result = ""; - // empty url means "no server mapping; use file directly" + // Empty url means "no server mapping; use file directly" if (url === "") { return result; } @@ -74,19 +74,18 @@ define(function (require, exports, module) { /** * Show a dialog that shows the project preferences - * @param {String} baseUrl - initial value - * @param {String} errorMessage - error to display - * @return {$.Promise} A promise object that will be resolved when user successfully enters - * project settings and clicks OK, or rejected if user clicks Cancel. + * @param {string} baseUrl Initial value + * @param {string} errorMessage Error to display + * @return {Dialog} A Dialog object with an internal promise that will be resolved with the ID + * of the clicked button when the dialog is dismissed. Never rejected. */ function showProjectPreferencesDialog(baseUrl, errorMessage) { - var $dlg, $title, $baseUrlControl, - promise; + dialog; - promise = Dialogs.showModalDialogUsingTemplate(Mustache.render(SettingsDialogTemplate, Strings)) + dialog = Dialogs.showModalDialogUsingTemplate(Mustache.render(SettingsDialogTemplate, Strings)) .done(function (id) { if (id === Dialogs.DIALOG_BTN_OK) { var baseUrlValue = $baseUrlControl.val(); @@ -128,7 +127,7 @@ define(function (require, exports, module) { // Give focus to first control $baseUrlControl.focus(); - return promise; + return dialog; } // For unit testing diff --git a/src/project/FileIndexManager.js b/src/project/FileIndexManager.js index 72e1f201af6..e004cc19c42 100644 --- a/src/project/FileIndexManager.js +++ b/src/project/FileIndexManager.js @@ -42,6 +42,7 @@ define(function (require, exports, module) { var PerfUtils = require("utils/PerfUtils"), ProjectManager = require("project/ProjectManager"), Dialogs = require("widgets/Dialogs"), + DefaultDialogs = require("widgets/DefaultDialogs"), CollectionUtils = require("utils/CollectionUtils"), Strings = require("strings"); @@ -150,10 +151,11 @@ define(function (require, exports, module) { /** * Error dialog when max files in index is hit + * @return {Dialog} */ function _showMaxFilesDialog() { return Dialogs.showModalDialog( - Dialogs.DIALOG_ID_ERROR, + DefaultDialogs.DIALOG_ID_ERROR, Strings.ERROR_MAX_FILES_TITLE, Strings.ERROR_MAX_FILES ); diff --git a/src/project/FileSyncManager.js b/src/project/FileSyncManager.js index cb552043fae..1b0f38a02b8 100644 --- a/src/project/FileSyncManager.js +++ b/src/project/FileSyncManager.js @@ -47,6 +47,7 @@ define(function (require, exports, module) { CommandManager = require("command/CommandManager"), Async = require("utils/Async"), Dialogs = require("widgets/Dialogs"), + DefaultDialogs = require("widgets/DefaultDialogs"), Strings = require("strings"), StringUtils = require("utils/StringUtils"), FileUtils = require("file/FileUtils"), @@ -211,7 +212,7 @@ define(function (require, exports, module) { */ function showReloadError(error, doc) { return Dialogs.showModalDialog( - Dialogs.DIALOG_ID_ERROR, + DefaultDialogs.DIALOG_ID_ERROR, Strings.ERROR_RELOADING_FILE_TITLE, StringUtils.format( Strings.ERROR_RELOADING_FILE, @@ -262,7 +263,7 @@ define(function (require, exports, module) { // Prompt UI varies depending on whether the file on disk was modified vs. deleted if (i < editConflicts.length) { toClose = false; - dialogId = Dialogs.DIALOG_ID_EXT_CHANGED; + dialogId = DefaultDialogs.DIALOG_ID_EXT_CHANGED; message = StringUtils.format( Strings.EXT_MODIFIED_MESSAGE, StringUtils.breakableUrl( @@ -270,13 +271,21 @@ define(function (require, exports, module) { ) ); buttons = [ - { className: "left", id: "dontsave", text: Strings.RELOAD_FROM_DISK }, - { className: "primary", id: "cancel", text: Strings.KEEP_CHANGES_IN_EDITOR } + { + className: Dialogs.DIALOG_BTN_CLASS_LEFT, + id: Dialogs.DIALOG_BTN_DONTSAVE, + text: Strings.RELOAD_FROM_DISK + }, + { + className: Dialogs.DIALOG_BTN_CLASS_PRIMARY, + id: Dialogs.DIALOG_BTN_CANCEL, + text: Strings.KEEP_CHANGES_IN_EDITOR + } ]; } else { toClose = true; - dialogId = Dialogs.DIALOG_ID_EXT_DELETED; + dialogId = DefaultDialogs.DIALOG_ID_EXT_DELETED; message = StringUtils.format( Strings.EXT_DELETED_MESSAGE, StringUtils.breakableUrl( @@ -284,8 +293,16 @@ define(function (require, exports, module) { ) ); buttons = [ - { className: "left", id: "dontsave", text: Strings.CLOSE_DONT_SAVE }, - { className: "primary", id: "cancel", text: Strings.KEEP_CHANGES_IN_EDITOR } + { + className: Dialogs.DIALOG_BTN_CLASS_LEFT, + id: Dialogs.DIALOG_BTN_DONTSAVE, + text: Strings.CLOSE_DONT_SAVE + }, + { + className: Dialogs.DIALOG_BTN_CLASS_PRIMARY, + id: Dialogs.DIALOG_BTN_CANCEL, + text: Strings.KEEP_CHANGES_IN_EDITOR + } ]; } @@ -348,8 +365,8 @@ define(function (require, exports, module) { // Close dialog if it was open. This will 'unblock' presentConflict(), which bails back // to us immediately upon seeing _restartPending. We then restart the sync - see below - Dialogs.cancelModalDialogIfOpen(Dialogs.DIALOG_ID_EXT_CHANGED); - Dialogs.cancelModalDialogIfOpen(Dialogs.DIALOG_ID_EXT_DELETED); + Dialogs.cancelModalDialogIfOpen(DefaultDialogs.DIALOG_ID_EXT_CHANGED); + Dialogs.cancelModalDialogIfOpen(DefaultDialogs.DIALOG_ID_EXT_DELETED); return; } diff --git a/src/project/ProjectManager.js b/src/project/ProjectManager.js index 496a8016749..dc941cce2cf 100644 --- a/src/project/ProjectManager.js +++ b/src/project/ProjectManager.js @@ -56,6 +56,7 @@ define(function (require, exports, module) { CommandManager = require("command/CommandManager"), Commands = require("command/Commands"), Dialogs = require("widgets/Dialogs"), + DefaultDialogs = require("widgets/DefaultDialogs"), Menus = require("command/Menus"), StringUtils = require("utils/StringUtils"), Strings = require("strings"), @@ -712,7 +713,7 @@ define(function (require, exports, module) { processEntries(entries); } else { Dialogs.showModalDialog( - Dialogs.DIALOG_ID_ERROR, + DefaultDialogs.DIALOG_ID_ERROR, Strings.ERROR_LOADING_PROJECT, StringUtils.format( Strings.READ_DIRECTORY_ENTRIES_ERROR, @@ -858,7 +859,7 @@ define(function (require, exports, module) { }, function (error) { Dialogs.showModalDialog( - Dialogs.DIALOG_ID_ERROR, + DefaultDialogs.DIALOG_ID_ERROR, Strings.ERROR_LOADING_PROJECT, StringUtils.format( Strings.REQUEST_NATIVE_FILE_SYSTEM_ERROR, @@ -1000,7 +1001,7 @@ define(function (require, exports, module) { }, function (error) { Dialogs.showModalDialog( - Dialogs.DIALOG_ID_ERROR, + DefaultDialogs.DIALOG_ID_ERROR, Strings.ERROR_LOADING_PROJECT, StringUtils.format(Strings.OPEN_DIALOG_ERROR, error.name) ); @@ -1019,6 +1020,7 @@ define(function (require, exports, module) { /** * Invoke project settings dialog. + * @return {Dialog} */ function _projectSettings() { return PreferencesDialogs.showProjectPreferencesDialog(getBaseUrl()); @@ -1037,7 +1039,7 @@ define(function (require, exports, module) { // See http://msdn.microsoft.com/en-us/library/windows/desktop/aa365247(v=vs.85).aspx if (filename.search(/[\/?*:;\{\}<>\\|]+/) !== -1) { Dialogs.showModalDialog( - Dialogs.DIALOG_ID_ERROR, + DefaultDialogs.DIALOG_ID_ERROR, Strings.INVALID_FILENAME_TITLE, Strings.INVALID_FILENAME_MESSAGE ); @@ -1161,7 +1163,7 @@ define(function (require, exports, module) { if ((error.name === NativeFileError.PATH_EXISTS_ERR) || (error.name === NativeFileError.TYPE_MISMATCH_ERR)) { Dialogs.showModalDialog( - Dialogs.DIALOG_ID_ERROR, + DefaultDialogs.DIALOG_ID_ERROR, Strings.INVALID_FILENAME_TITLE, StringUtils.format( Strings.FILE_ALREADY_EXISTS, @@ -1174,7 +1176,7 @@ define(function (require, exports, module) { StringUtils.format(Strings.GENERIC_ERROR, error.name); Dialogs.showModalDialog( - Dialogs.DIALOG_ID_ERROR, + DefaultDialogs.DIALOG_ID_ERROR, Strings.ERROR_CREATING_FILE_TITLE, StringUtils.format( Strings.ERROR_CREATING_FILE, @@ -1301,7 +1303,7 @@ define(function (require, exports, module) { } else { // Show and error alert Dialogs.showModalDialog( - Dialogs.DIALOG_ID_ERROR, + DefaultDialogs.DIALOG_ID_ERROR, Strings.ERROR_RENAMING_FILE_TITLE, StringUtils.format( Strings.ERROR_RENAMING_FILE, diff --git a/src/utils/UpdateNotification.js b/src/utils/UpdateNotification.js index 0b66e41e962..19c22ed91d3 100644 --- a/src/utils/UpdateNotification.js +++ b/src/utils/UpdateNotification.js @@ -32,6 +32,7 @@ define(function (require, exports, module) { "use strict"; var Dialogs = require("widgets/Dialogs"), + DefaultDialogs = require("widgets/DefaultDialogs"), NativeApp = require("utils/NativeApp"), PreferencesManager = require("preferences/PreferencesManager"), Strings = require("strings"), @@ -303,7 +304,7 @@ define(function (require, exports, module) { } else if (force) { // No updates are available. If force == true, let the user know. Dialogs.showModalDialog( - Dialogs.DIALOG_ID_ERROR, + DefaultDialogs.DIALOG_ID_ERROR, Strings.NO_UPDATE_TITLE, Strings.NO_UPDATE_MESSAGE ); @@ -326,7 +327,7 @@ define(function (require, exports, module) { // Error fetching the update data. If this is a forced check, alert the user if (force) { Dialogs.showModalDialog( - Dialogs.DIALOG_ID_ERROR, + DefaultDialogs.DIALOG_ID_ERROR, Strings.ERROR_FETCHING_UPDATE_INFO_TITLE, Strings.ERROR_FETCHING_UPDATE_INFO_MSG ); diff --git a/src/widgets/DefaultDialogs.js b/src/widgets/DefaultDialogs.js new file mode 100644 index 00000000000..d31556f36df --- /dev/null +++ b/src/widgets/DefaultDialogs.js @@ -0,0 +1,41 @@ +/* + * Copyright (c) 2013 Adobe Systems Incorporated. All rights reserved. + * + * Permission is hereby granted, free of charge, to any person obtaining a + * copy of this software and associated documentation files (the "Software"), + * to deal in the Software without restriction, including without limitation + * the rights to use, copy, modify, merge, publish, distribute, sublicense, + * and/or sell copies of the Software, and to permit persons to whom the + * Software is furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING + * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER + * DEALINGS IN THE SOFTWARE. + * + */ + + +/*jslint vars: true, plusplus: true, devel: true, nomen: true, indent: 4, maxerr: 50 */ +/*global define */ + +define(function (require, exports, module) { + "use strict"; + + /** + * List of constants for the default dialogs IDs. + */ + exports.DIALOG_ID_ERROR = "error-dialog"; + exports.DIALOG_ID_INFO = "error-dialog"; // uses the same template for now--could be different in future + exports.DIALOG_ID_SAVE_CLOSE = "save-close-dialog"; + exports.DIALOG_ID_EXT_CHANGED = "ext-changed-dialog"; + exports.DIALOG_ID_EXT_DELETED = "ext-deleted-dialog"; + exports.DIALOG_ID_LIVE_DEVELOPMENT = "live-development-error-dialog"; + exports.DIALOG_ID_REMOVE_EXTENSIONS = "remove-marked-extensions"; +}); diff --git a/src/widgets/Dialogs.js b/src/widgets/Dialogs.js index c993df7afbe..921e1298af3 100644 --- a/src/widgets/Dialogs.js +++ b/src/widgets/Dialogs.js @@ -39,20 +39,23 @@ define(function (require, exports, module) { Strings = require("strings"), DialogTemplate = require("text!htmlContent/dialog-template.html"); - + /** + * Dialog Buttons IDs + * @const {string} + */ var DIALOG_BTN_CANCEL = "cancel", DIALOG_BTN_OK = "ok", DIALOG_BTN_DONTSAVE = "dontsave", DIALOG_CANCELED = "_canceled", DIALOG_BTN_DOWNLOAD = "download"; - var DIALOG_ID_ERROR = "error-dialog", - DIALOG_ID_INFO = "error-dialog", // uses the same template for now--could be different in future - DIALOG_ID_SAVE_CLOSE = "save-close-dialog", - DIALOG_ID_EXT_CHANGED = "ext-changed-dialog", - DIALOG_ID_EXT_DELETED = "ext-deleted-dialog", - DIALOG_ID_LIVE_DEVELOPMENT = "live-development-error-dialog", - DIALOG_ID_REMOVE_EXTENSIONS = "remove-marked-extensions"; + /** + * Dialog Buttons Class Names + * @const {string} + */ + var DIALOG_BTN_CLASS_PRIMARY = "primary", + DIALOG_BTN_CLASS_NORMAL = "", + DIALOG_BTN_CLASS_LEFT = "left"; /** @@ -276,8 +279,8 @@ define(function (require, exports, module) { /** - * Creates a new general purpose modal dialog using the template variables from "default-dialogs.json" - * and a new title and/or message if specified. + * Creates a new general purpose modal dialog using the default template and the template variables given + * as parameters as described. * * @param {string} dlgClass A class name identifier for the dialog. * @param {string=} title The title of the dialog. Can contain HTML markup. If unspecified, the title @@ -293,7 +296,7 @@ define(function (require, exports, module) { dlgClass: dlgClass, title: title || "", message: message || "", - buttons: buttons || [{ className: "primary", id: "ok", text: Strings.OK }] + buttons: buttons || [{ className: DIALOG_BTN_CLASS_PRIMARY, id: DIALOG_BTN_OK, text: Strings.OK }] }; var template = Mustache.render(DialogTemplate, templateVars); @@ -320,13 +323,9 @@ define(function (require, exports, module) { exports.DIALOG_CANCELED = DIALOG_CANCELED; exports.DIALOG_BTN_DOWNLOAD = DIALOG_BTN_DOWNLOAD; - exports.DIALOG_ID_ERROR = DIALOG_ID_ERROR; - exports.DIALOG_ID_INFO = DIALOG_ID_INFO; - exports.DIALOG_ID_SAVE_CLOSE = DIALOG_ID_SAVE_CLOSE; - exports.DIALOG_ID_EXT_CHANGED = DIALOG_ID_EXT_CHANGED; - exports.DIALOG_ID_EXT_DELETED = DIALOG_ID_EXT_DELETED; - exports.DIALOG_ID_LIVE_DEVELOPMENT = DIALOG_ID_LIVE_DEVELOPMENT; - exports.DIALOG_ID_REMOVE_EXTENSIONS = DIALOG_ID_REMOVE_EXTENSIONS; + exports.DIALOG_BTN_CLASS_PRIMARY = DIALOG_BTN_CLASS_PRIMARY; + exports.DIALOG_BTN_CLASS_NORMAL = DIALOG_BTN_CLASS_NORMAL; + exports.DIALOG_BTN_CLASS_LEFT = DIALOG_BTN_CLASS_LEFT; exports.showModalDialog = showModalDialog; exports.showModalDialogUsingTemplate = showModalDialogUsingTemplate;