Merge pull request #217 from sobisht/gh-pages.1.13

Add api docs for 1.13 brackets release

Author: nethip

docs/current/modules/LiveDevelopment/LiveDevelopment.html

@@ -556,6 +556,7 @@ <h3>Dependencies</h3>
         <li><a href="..&#x2F;../modules/file/FileUtils.html">FileUtils</a></li>
         <li><a href="..&#x2F;../modules/utils/Global.html">Global</a></li>
         <li><a href="..&#x2F;../modules/LiveDevelopment/Agents/GotoAgent.html">GotoAgent</a></li>
+        <li><a href="..&#x2F;../modules/utils/HealthLogger.html">HealthLogger</a></li>
         <li><a href="..&#x2F;../modules/LiveDevelopment/Agents/HighlightAgent.html">HighlightAgent</a></li>
         <li><a href="..&#x2F;../modules/LiveDevelopment/Documents/HTMLDocument.html">HTMLDocument</a></li>
         <li><a href="..&#x2F;../modules/LiveDevelopment/Inspector/Inspector.html">Inspector</a></li>
@@ -2520,6 +2521,13 @@ <h4>
                 });
             }
         }
+        &#x2F;&#x2F; Send analytics data when Live Preview is opened
+        HealthLogger.sendAnalyticsData(
+            &quot;livePreviewOpen&quot;,
+            &quot;usage&quot;,
+            &quot;livePreview&quot;,
+            &quot;open&quot;
+        );
 
         &#x2F;&#x2F; Register user defined server provider and keep handlers for further clean-up
         _regServers.push(LiveDevServerManager.registerServer({ create: _createUserServer }, 99));

docs/current/modules/command/Menus.html

@@ -2571,7 +2571,7 @@ <h4>
             posLeft += 3;
 
             if (clip.right &gt; 0) {
-                posLeft = Math.max(0, posLeft - 2 * $parentMenuItem.outerWidth());
+                posLeft = Math.max(0, posLeft - $parentMenuItem.outerWidth() - $menuWindow.outerWidth());
             }
         } else {
             this.trigger(&quot;beforeContextMenuOpen&quot;);

docs/current/modules/document/Document.html

@@ -610,6 +610,7 @@ <h4>
             <button class="btn btn-small show-code">Show code</button>
             <pre class="code language-javascript"><code class="language-javascript">    function Document(file, initialTimestamp, rawText) {
         this.file = file;
+        this.editable = !file.readOnly;
         this._updateLanguage();
         this.refreshText(rawText, initialTimestamp, true);
         &#x2F;&#x2F; List of full editors which are initialized as master editors for this doc.

docs/current/modules/document/DocumentCommandHandlers.html

@@ -518,6 +518,7 @@ <h3>Dependencies</h3>
         <li><a href="..&#x2F;../modules/widgets/Dialogs.html">Dialogs</a></li>
         <li><a href="..&#x2F;../modules/document/DocumentManager.html">DocumentManager</a></li>
         <li><a href="..&#x2F;../modules/editor/EditorManager.html">EditorManager</a></li>
+        <li><a href="..&#x2F;../modules/utils/EventDispatcher.html">EventDispatcher</a></li>
         <li><a href="..&#x2F;../modules/filesystem/FileSystem.html">FileSystem</a></li>
         <li><a href="..&#x2F;../modules/filesystem/FileSystemError.html">FileSystemError</a></li>
         <li><a href="..&#x2F;../modules/file/FileUtils.html">FileUtils</a></li>
@@ -549,7 +550,25 @@ <h3>Variables
     <input class="toggle-public" type="checkbox"> Show Private Members
 </label>    </h3>
 
-<div class="member">
+<div class="member public">
+
+<span class="pull-right scope">
+    
+    Public API
+</span>
+    <h4>
+        APP_QUIT_CANCELLED 
+        <a class="anchor" href="#-APP_QUIT_CANCELLED" id="-APP_QUIT_CANCELLED"><span class="icon-link"></span></a>
+    </h4>
+
+    
+    <div class="description"><p>Event triggered when File Save is cancelled, when prompted to save dirty files</p>
+</div>
+    
+<dl>
+</dl><dl>
+<dl><button class="btn btn-small show-code">Show code</button>
+<pre class="code language-javascript"><code class="language-javascript">    var APP_QUIT_CANCELLED = &quot;appQuitCancelled&quot;;</code></pre></div><div class="member">
 
 <span class="pull-right scope">
 
@@ -571,7 +590,8 @@ <h4>
 
     PreferencesManager.definePreference(&quot;defaultExtension&quot;, &quot;string&quot;, &quot;&quot;, {
         excludeFromHints: true
-    });</code></pre></div><div class="member">
+    });
+    EventDispatcher.makeEventDispatcher(exports);</code></pre></div><div class="member">
 
 <span class="pull-right scope">
 
@@ -903,7 +923,47 @@ <h4>
 <dl>
 </dl><dl>
 <dl><button class="btn btn-small show-code">Show code</button>
-<pre class="code language-javascript"><code class="language-javascript">    var handleReloadWithoutExts = _.partial(handleReload, true);</code></pre></div>
+<pre class="code language-javascript"><code class="language-javascript">    var handleReloadWithoutExts = _.partial(handleReload, true);</code></pre></div><div class="member">
+
+<span class="pull-right scope">
+    
+    
+</span>
+    <h4>
+        isTestWindow 
+        <a class="anchor" href="#-isTestWindow" id="-isTestWindow"><span class="icon-link"></span></a>
+    </h4>
+
+    
+    <div class="description"><p>Attach a beforeunload handler to notify user about unsaved changes and URL redirection in CEF.
+Prevents data loss in scenario reported under #13708
+Make sure we don&#39;t attach this handler if the current window is actually a test window</p>
+</div>
+    
+<dl>
+</dl><dl>
+<dl><button class="btn btn-small show-code">Show code</button>
+<pre class="code language-javascript"><code class="language-javascript">
+    var isTestWindow = (new window.URLSearchParams(window.location.search || &quot;&quot;)).get(&quot;testEnvironment&quot;);
+    if (!isTestWindow) {
+        window.onbeforeunload = function(e) {
+            var openDocs = DocumentManager.getAllOpenDocuments();
+
+            &#x2F;&#x2F; Detect any unsaved changes
+            openDocs = openDocs.filter(function(doc) {
+                return doc &amp;&amp; doc.isDirty;
+            });
+
+            &#x2F;&#x2F; Ensure we are not in normal app-quit or reload workflow
+            if (!_isReloading &amp;&amp; !_windowGoingAway) {
+                if (openDocs.length &gt; 0) {
+                    return Strings.WINDOW_UNLOAD_WARNING_WITH_UNSAVED_CHANGES;
+                } else {
+                    return Strings.WINDOW_UNLOAD_WARNING;
+                }
+            }
+        };
+    }</code></pre></div>
 </section>
 
 <section id="functions">
@@ -1004,6 +1064,7 @@ <h4>
             )
                 .done(function (id) {
                     if (id === Dialogs.DIALOG_BTN_CANCEL) {
+                        dispatchAppQuitCancelledEvent();
                         result.reject();
                     } else if (id === Dialogs.DIALOG_BTN_OK) {
                         &#x2F;&#x2F; Save all unsaved files, then if that succeeds, close all
@@ -1510,6 +1571,7 @@ <h4>
                     if (selectedPath) {
                         _doSaveAfterSaveDialog(selectedPath);
                     } else {
+                        dispatchAppQuitCancelledEvent();
                         result.reject(USER_CANCELED);
                     }
                 } else {
@@ -1914,7 +1976,9 @@ <h4>
 <pre class="code language-javascript"><code class="language-javascript">    function _updateTitle() {
         var currentDoc          = DocumentManager.getCurrentDocument(),
             windowTitle         = brackets.config.app_title,
-            currentlyViewedPath = MainViewManager.getCurrentlyViewedPath(MainViewManager.ACTIVE_PANE);
+            currentlyViewedFile = MainViewManager.getCurrentlyViewedFile(MainViewManager.ACTIVE_PANE),
+            currentlyViewedPath = currentlyViewedFile &amp;&amp; currentlyViewedFile.fullPath,
+            readOnlyString      = (currentlyViewedFile &amp;&amp; currentlyViewedFile.readOnly) ? &quot;[Read Only] - &quot; : &quot;&quot;;
 
         if (!brackets.nativeMenus) {
             if (currentlyViewedPath) {
@@ -1954,7 +2018,7 @@ <h4>
             var projectName = projectRoot.name;
             &#x2F;&#x2F; Construct shell&#x2F;browser window title, e.g. &quot;• index.html (myProject) — Brackets&quot;
             if (currentlyViewedPath) {
-                windowTitle = StringUtils.format(WINDOW_TITLE_STRING_DOC, _currentTitlePath, projectName, brackets.config.app_title);
+                windowTitle = StringUtils.format(WINDOW_TITLE_STRING_DOC, readOnlyString + _currentTitlePath, projectName, brackets.config.app_title);
                 &#x2F;&#x2F; Display dirty dot when there are unsaved changes
                 if (currentDoc &amp;&amp; currentDoc.isDirty) {
                     windowTitle = &quot;• &quot; + windowTitle;
@@ -2066,6 +2130,28 @@ <h4>
 <span class="pull-right scope">
 
 
+</span>
+    <h4>
+        dispatchAppQuitCancelledEvent 
+        <a class="anchor" href="#-dispatchAppQuitCancelledEvent" id="-dispatchAppQuitCancelledEvent"><span class="icon-link"></span></a>
+    </h4>
+
+    
+    <div class="description"><p>Dispatches the app quit cancelled event</p>
+</div>
+    
+<dl>
+</dl><dl>
+</dl><dl>
+</dl><dl>
+<dl><button class="btn btn-small show-code">Show code</button>
+<pre class="code language-javascript"><code class="language-javascript">    function dispatchAppQuitCancelledEvent() {
+        exports.trigger(exports.APP_QUIT_CANCELLED);
+    }</code></pre></div><div class="member">
+
+<span class="pull-right scope">
+    
+    
 </span>
     <h4>
         doSave 
@@ -2570,6 +2656,7 @@ <h4>
             )
                 .done(function (id) {
                     if (id === Dialogs.DIALOG_BTN_CANCEL) {
+                        dispatchAppQuitCancelledEvent();
                         result.reject();
                     } else if (id === Dialogs.DIALOG_BTN_OK) {
                         &#x2F;&#x2F; &quot;Save&quot; case: wait until we confirm save has succeeded before closing

docs/current/modules/document/DocumentManager.html

@@ -1121,13 +1121,19 @@ <h4>
         <span class="label label-info">string</span>
     </dt>
     <dd></dd>
+    <dt>
+        fileObj
+        <span class="label label-non-nullable">non-nullable</span>
+        <span class="label label-info">object</span>
+    </dt>
+    <dd>actual File|RemoteFile or some other protocol adapter handle</dd>
 </dl><dl>
     <dt>Returns: <span class="label label-info">$.Promise</span></dt>
     <dd>A promise object that will be resolved with the Document, or rejected with a FileSystemError if the file is not yet open and can't be read from disk.</dd>
 </dl><dl>
 </dl><dl>
 <dl><button class="btn btn-small show-code">Show code</button>
-<pre class="code language-javascript"><code class="language-javascript">    function getDocumentForPath(fullPath) {
+<pre class="code language-javascript"><code class="language-javascript">    function getDocumentForPath(fullPath, fileObj) {
         var doc = getOpenDocumentForPath(fullPath);
 
         if (doc) {
@@ -1143,7 +1149,7 @@ <h4>
                 return promise;
             }
 
-            var file            = FileSystem.getFileForPath(fullPath),
+            var file            = fileObj || FileSystem.getFileForPath(fullPath),
                 pendingPromise  = getDocumentForPath._pendingDocumentPromises[file.id];
 
             if (pendingPromise) {

docs/current/modules/editor/CSSInlineEditor.html

@@ -517,6 +517,7 @@ <h3>Dependencies</h3>
         <li><a href="..&#x2F;../modules/editor/Editor.html">Editor</a></li>
         <li><a href="..&#x2F;../modules/editor/EditorManager.html">EditorManager</a></li>
         <li><a href="..&#x2F;../modules/file/FileUtils.html">FileUtils</a></li>
+        <li><a href="..&#x2F;../modules/utils/HealthLogger.html">HealthLogger</a></li>
         <li><a href="..&#x2F;../modules/language/HTMLUtils.html">HTMLUtils</a></li>
         <li><a href="..&#x2F;../modules/language/LanguageManager.html">LanguageManager</a></li>
         <li><a href="..&#x2F;../modules/thirdparty/lodash.html">lodash</a></li>
@@ -1023,6 +1024,14 @@ <h4>
             return null;
         }
 
+        &#x2F;&#x2F;Send analytics data for QuickEdit open
+        HealthLogger.sendAnalyticsData(
+            &quot;QuickEditOpen&quot;,
+            &quot;usage&quot;,
+            &quot;quickEdit&quot;,
+            &quot;open&quot;
+        );
+
         &#x2F;&#x2F; Only provide CSS editor if the selection is within a single line
         var sel = hostEditor.getSelection();
         if (sel.start.line !== sel.end.line) {

docs/current/modules/editor/CodeHintList.html

@@ -922,6 +922,10 @@ <h4>
 
             $item.find(&quot;a&quot;).addClass(&quot;highlight&quot;);
             ViewUtils.scrollElementIntoView($view, $item, false);
+
+            if (this.handleHighlight) {
+                this.handleHighlight($item.find(&quot;a&quot;));
+            }
         }
     };</code></pre></div><div class="member">
 
@@ -1118,6 +1122,33 @@ <h4>
 <span class="pull-right scope">
 
 
+</span>
+    <h4>
+        onHighlight 
+        <a class="anchor" href="#CodeHintList-onHighlight" id="CodeHintList-onHighlight"><span class="icon-link"></span></a>
+    </h4>
+
+    
+    <div class="description"><p>Set the hint list highlight callback function</p>
+</div>
+    
+<dl>
+    <dt>
+        callback
+        <span class="label label-info">Function</span>
+    </dt>
+    <dd></dd>
+</dl><dl>
+</dl><dl>
+</dl><dl>
+<dl><button class="btn btn-small show-code">Show code</button>
+<pre class="code language-javascript"><code class="language-javascript">    CodeHintList.prototype.onHighlight = function (callback) {
+        this.handleHighlight = callback;
+    };</code></pre></div><div class="member">
+
+<span class="pull-right scope">
+    
+    
 </span>
     <h4>
         onSelect 

docs/current/modules/editor/Editor.html

@@ -643,6 +643,8 @@ <h4>
         UPPERCASE_COLORS    = &quot;uppercaseColors&quot;,
         USE_TAB_CHAR        = &quot;useTabChar&quot;,
         WORD_WRAP           = &quot;wordWrap&quot;,
+        AUTO_HIDE_SEARCH    = &quot;autoHideSearch&quot;,
+        INDENT_LINE_COMMENT   = &quot;indentLineComment&quot;,
         INDENT_LINE_COMMENT = &quot;indentLineComment&quot;,
         INPUT_STYLE         = &quot;inputStyle&quot;;</code></pre></div><div class="member">
 
@@ -777,6 +779,11 @@ <h4>
     PreferencesManager.definePreference(WORD_WRAP,          &quot;boolean&quot;, true, {
         description: Strings.DESCRIPTION_WORD_WRAP
     });
+  
+    PreferencesManager.definePreference(AUTO_HIDE_SEARCH,   &quot;boolean&quot;, true, {
+        description: Strings.DESCRIPTION_SEARCH_AUTOHIDE
+    });
+
     PreferencesManager.definePreference(INDENT_LINE_COMMENT,  &quot;boolean&quot;, false, {
         description: Strings.DESCRIPTION_INDENT_LINE_COMMENT
     });
@@ -1032,7 +1039,7 @@ <h4>
             <pre class="code language-javascript"><code class="language-javascript">    function Editor(document, makeMasterEditor, container, range, options) {
         var self = this;
 
-        var isReadOnly = options &amp;&amp; options.isReadOnly;
+        var isReadOnly = (options &amp;&amp; options.isReadOnly) || !document.editable;
 
         _instances.push(this);
 

docs/current/modules/editor/EditorOptionHandlers.html

@@ -547,7 +547,8 @@ <h4>
     _optionMapping[SHOW_LINE_NUMBERS] = Commands.TOGGLE_LINE_NUMBERS;
     _optionMapping[STYLE_ACTIVE_LINE] = Commands.TOGGLE_ACTIVE_LINE;
     _optionMapping[WORD_WRAP] = Commands.TOGGLE_WORD_WRAP;
-    _optionMapping[CLOSE_BRACKETS] = Commands.TOGGLE_CLOSE_BRACKETS;</code></pre></div>
+    _optionMapping[CLOSE_BRACKETS] = Commands.TOGGLE_CLOSE_BRACKETS;
+    _optionMapping[AUTO_HIDE_SEARCH] = Commands.TOGGLE_SEARCH_AUTOHIDE;</code></pre></div>
 </section>
 
 <section id="functions">
@@ -601,6 +602,7 @@ <h4>
     CommandManager.register(Strings.CMD_TOGGLE_ACTIVE_LINE, Commands.TOGGLE_ACTIVE_LINE, _getToggler(STYLE_ACTIVE_LINE));
     CommandManager.register(Strings.CMD_TOGGLE_WORD_WRAP, Commands.TOGGLE_WORD_WRAP, _getToggler(WORD_WRAP));
     CommandManager.register(Strings.CMD_TOGGLE_CLOSE_BRACKETS, Commands.TOGGLE_CLOSE_BRACKETS, _getToggler(CLOSE_BRACKETS));
+    CommandManager.register(Strings.CMD_TOGGLE_SEARCH_AUTOHIDE, Commands.TOGGLE_SEARCH_AUTOHIDE, _getToggler(AUTO_HIDE_SEARCH));
 
     AppInit.htmlReady(_init);
 });</code></pre></div><div class="member private">

docs/current/modules/editor/EditorStatusBar.html

@@ -523,6 +523,7 @@ <h3>Dependencies</h3>
         <li><a href="..&#x2F;../modules/editor/EditorManager.html">EditorManager</a></li>
         <li><a href="..&#x2F;../modules/filesystem/FileSystem.html">FileSystem</a></li>
         <li><a href="..&#x2F;../modules/file/FileUtils.html">FileUtils</a></li>
+        <li><a href="..&#x2F;../modules/utils/HealthLogger.html">HealthLogger</a></li>
         <li><a href="..&#x2F;../modules/document/InMemoryFile.html">InMemoryFile</a></li>
         <li><a href="..&#x2F;../modules/utils/KeyEvent.html">KeyEvent</a></li>
         <li><a href="..&#x2F;../modules/language/LanguageManager.html">LanguageManager</a></li>
@@ -1189,6 +1190,13 @@ <h4>
             selStr = &quot;&quot;;
 
         if (sels.length &gt; 1) {
+            &#x2F;&#x2F;Send analytics data for multicursor use
+            HealthLogger.sendAnalyticsData(
+                &quot;multiCursor&quot;,
+                &quot;usage&quot;,
+                &quot;multiCursor&quot;,
+                &quot;use&quot;
+            );
             selStr = StringUtils.format(Strings.STATUSBAR_SELECTION_MULTIPLE, sels.length);
         } else if (editor.hasSelection()) {
             var sel = sels[0];