Merge pull request #1017 from adobe/jason-sanjose/ext-load-css

loadStyleSheet proposal for extensions

Author: gruehle

src/brackets.js

@@ -83,6 +83,7 @@ define(function (require, exports, module) {
     require("debug/DebugCommandHandlers");
     require("view/ViewCommandHandlers");
     require("search/FindInFiles");
+    require("utils/ExtensionUtils");
 
     function _callBracketsReadyHandler(handler) {
         try {

src/utils/ExtensionUtils.js

@@ -0,0 +1,67 @@
+/*
+ * Copyright (c) 2012 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, $ */
+
+/**
+ * ExtensionUtils defines utility methods for implementing extensions.
+ */
+define(function (require, exports, module) {
+    'use strict';
+    
+    /**
+     * Loads a style sheet relative to the extension module.
+     *
+     * @param {!module} module Module provided by RequireJS
+     * @param {!string} path Relative path from the extension folder to a CSS file
+     * @return {!$.Promise} A promise object that is resolved if the CSS file can be loaded.
+     */
+    function loadStyleSheet(module, path) {
+        var url = encodeURI(module.uri.replace("main.js", "") + path),
+            result = new $.Deferred();
+        
+        // Make a request for the same file in order to record success or failure.
+        // The link element's onload and onerror events are not consistently supported.
+        $.get(url).done(function () {
+            var $link = $("<link/>");
+            
+            $link.attr({
+                type:       "text/css",
+                rel:        "stylesheet",
+                href:       url
+            });
+            
+            $("head").append($link[0]);
+            
+            result.resolve();
+        }).fail(function (err) {
+            result.reject(err);
+        });
+        
+        return result;
+    }
+    
+    exports.loadStyleSheet = loadStyleSheet;
+});