From be35d27c953b1516f2c1601620faa32d329fbca1 Mon Sep 17 00:00:00 2001 From: nightwing Date: Sun, 18 Nov 2012 01:44:42 +0400 Subject: [PATCH 1/6] improve ace.js api --- lib/ace/ace.js | 51 ++++++++++++++++++++++++++++---------------------- 1 file changed, 29 insertions(+), 22 deletions(-) diff --git a/lib/ace/ace.js b/lib/ace/ace.js index d31ceb3a..69c21274 100644 --- a/lib/ace/ace.js +++ b/lib/ace/ace.js @@ -39,8 +39,8 @@ define(function(require, exports, module) { require("./lib/fixoldbrowsers"); -var Dom = require("./lib/dom"); -var Event = require("./lib/event"); +var dom = require("./lib/dom"); +var event = require("./lib/event"); var Editor = require("./editor").Editor; var EditSession = require("./edit_session").EditSession; @@ -54,41 +54,48 @@ require("./keyboard/hash_handler"); require("./placeholder"); require("./mode/folding/fold_mode"); exports.config = require("./config"); - /** - * Embeds the Ace editor into the DOM, at the element provided by `el`. - * @param {String | DOMElement} el Either the id of an element, or the element itself - * - **/ + +/** + * Embeds the Ace editor into the DOM, at the element provided by `el`. + * @param {String | DOMElement} el Either the id of an element, or the element itself + * + * This method embeds the Ace editor into the DOM, at the element provided by `el`. + * + **/ exports.edit = function(el) { if (typeof(el) == "string") { var _id = el; - if (!(el = document.getElementById(el))) + var el = document.getElementById(_id); + if (!el) throw "ace.edit can't find div #" + _id; } if (el.env && el.env.editor instanceof Editor) return el.env.editor; - var doc = new EditSession(Dom.getInnerText(el)); - doc.setUndoManager(new UndoManager()); + var doc = exports.createEditSession(dom.getInnerText(el)); el.innerHTML = ''; - var editor = new Editor(new Renderer(el, require("./theme/textmate"))); + var editor = new Editor(new Renderer(el)); new MultiSelect(editor); editor.setSession(doc); - var env = {}; - env.document = doc; - env.editor = editor; - editor.resize(); - Event.addListener(window, "resize", function() { - editor.resize(); - }); - el.env = env; - // Store env on editor such that it can be accessed later on from - // the returned object. - editor.env = env; + var env = { + document: doc, + editor: editor, + onResize: editor.resize.bind(editor) + }; + event.addListener(window, "resize", env.onResize); + el.env = editor.env = env; return editor; }; + +exports.createEditSession = function(text, mode) { + var doc = new EditSession(text, doc); + doc.setUndoManager(new UndoManager()); + return doc; +} +exports.EditSession = EditSession; +exports.UndoManager = UndoManager; }); From e5ca6769cd64b9981a59a859d501549712d7916e Mon Sep 17 00:00:00 2001 From: nightwing Date: Sun, 25 Nov 2012 23:48:38 +0400 Subject: [PATCH 2/6] do not override console if worker is mistakenly loaded into window --- lib/ace/worker/worker.js | 3 +++ 1 file changed, 3 insertions(+) diff --git a/lib/ace/worker/worker.js b/lib/ace/worker/worker.js index e8bf0d3e..f3910e2a 100644 --- a/lib/ace/worker/worker.js +++ b/lib/ace/worker/worker.js @@ -1,5 +1,8 @@ "no use strict"; +if (typeof window != "undefined" && window.document) + throw "atempt to load ace worker into main window instead of webWorker"; + var console = { log: function() { var msgs = Array.prototype.slice.call(arguments, 0); From b9417a10be4f636fe964c529c331c6d61611931d Mon Sep 17 00:00:00 2001 From: nightwing Date: Sun, 25 Nov 2012 23:55:53 +0400 Subject: [PATCH 3/6] fix documentation for position --- lib/ace/document.js | 32 ++++++++++++++------------------ lib/ace/edit_session.js | 34 +++++++++++++++++----------------- 2 files changed, 31 insertions(+), 35 deletions(-) diff --git a/lib/ace/document.js b/lib/ace/document.js index 71939009..4d4d757d 100644 --- a/lib/ace/document.js +++ b/lib/ace/document.js @@ -38,14 +38,14 @@ var Anchor = require("./anchor").Anchor; /** * Contains the text of the document. Document can be attached to several [[EditSession `EditSession`]]s. - * + * * At its core, `Document`s are just an array of strings, with each row in the document matching up to the array index. * * @class Document **/ /** - * + * * Creates a new `Document`. If `text` is included, the `Document` contains those strings; otherwise, it's empty. * @param {String | Array} text The starting text * @constructor @@ -104,7 +104,7 @@ var Document = function(text) { * @method $split * @param {String} text The text to work with * @returns {String} A String array, with each index containing a piece of the original `text` string. - * + * * **/ @@ -135,9 +135,9 @@ var Document = function(text) { * If `newLineMode == unix`, `\n` is returned. * If `newLineMode == auto`, the value of `autoNewLine` is returned. * - * * * + * **/ this.getNewLineCharacter = function() { switch (this.$newLineMode) { @@ -189,7 +189,7 @@ var Document = function(text) { /** * Returns a verbatim copy of the given line as it is in the document * @param {Number} row The row index to retrieve - * + * * * **/ @@ -201,7 +201,7 @@ var Document = function(text) { * Returns an array of strings of the rows between `firstRow` and `lastRow`. This function is inclusive of `lastRow`. * @param {Number} firstRow The first row index to retrieve * @param {Number} lastRow The final row index to retrieve - * + * * * **/ @@ -253,11 +253,9 @@ var Document = function(text) { /** * Inserts a block of `text` and the indicated `position`. - * @param {Number} position The position to start inserting at + * @param {Object} position The position to start inserting at * @param {String} text A chunk of text to insert - * @returns {Number} The position of the last line of `text`. If the length of `text` is 0, this function simply returns `position`. - * - * + * @returns {Object} The position ({row, column}) of the last line of `text`. If the length of `text` is 0, this function simply returns `position`. * **/ this.insert = function(position, text) { @@ -350,12 +348,12 @@ var Document = function(text) { /** * Inserts a new line into the document at the current row's `position`. This method also triggers the `'change'` event. - * @param {String} position The position to insert at + * @param {Object} position The position to insert at * @returns {Object} Returns an object containing the final row and column, like this:
* ``` * {row: endRow, column: 0} * ``` - * + * **/ this.insertNewLine = function(position) { position = this.$clipPosition(position); @@ -381,15 +379,13 @@ var Document = function(text) { /** * Inserts `text` into the `position` at the current row. This method also triggers the `'change'` event. - * @param {Number} position The position to insert at + * @param {Object} position The position to insert at * @param {String} text A chunk of text * @returns {Object} Returns an object containing the final row and column, like this: * ``` * {row: endRow, column: 0} * ``` - * @returns {Number} If `text` is empty, this function returns the value of `position` - * - * + * **/ this.insertInLine = function(position, text) { if (text.length == 0) @@ -419,7 +415,7 @@ var Document = function(text) { * Removes the `range` from the document. * @param {Range} range A specified Range to remove * @returns {Object} Returns the new `start` property of the range, which contains `startRow` and `startColumn`. If `range` is empty, this function returns the unmodified value of `range.start`. - * + * * **/ this.remove = function(range) { @@ -507,7 +503,7 @@ var Document = function(text) { /** * Removes the new line between `row` and the row immediately following it. This method also triggers the `'change'` event. * @param {Number} row The row to check - * + * **/ this.removeNewLine = function(row) { var firstLine = this.getLine(row); diff --git a/lib/ace/edit_session.js b/lib/ace/edit_session.js index bfa85335..d580c67a 100644 --- a/lib/ace/edit_session.js +++ b/lib/ace/edit_session.js @@ -104,19 +104,19 @@ var SearchHighlight = require("./search_highlight").SearchHighlight; **/ /** * Emitted when the current mode changes. - * + * * @event changeMode * **/ /** * Emitted when the wrap mode changes. - * + * * @event changeWrapMode * **/ /** * Emitted when the wrapping limit changes. - * + * * @event changeWrapLimit * **/ @@ -138,8 +138,8 @@ var SearchHighlight = require("./search_highlight").SearchHighlight; * * @param {Number} scrollLeft The new scroll left value **/ - - + + /** * * Sets up a new `EditSession` and associates it with the given `Document` and `TextMode`. @@ -172,7 +172,7 @@ var EditSession = function(text, mode) { if (typeof text != "object" || !text.getLine) text = new Document(text); - this.setDocument(text); + this.setDocument(text); this.selection = new Selection(this); this.setMode(mode); @@ -1158,18 +1158,18 @@ var EditSession = function(text, mode) { * Returns an array of strings of the rows between `firstRow` and `lastRow`. This function is inclusive of `lastRow`. * @param {Number} firstRow The first row index to retrieve * @param {Number} lastRow The final row index to retrieve - * + * * @returns [String] - * - **/ + * + **/ this.getLines = function(firstRow, lastRow) { return this.doc.getLines(firstRow, lastRow); }; /** - * Returns the number of rows in the document. + * Returns the number of rows in the document. * @returns {Number} - **/ + **/ this.getLength = function() { return this.doc.getLength(); }; @@ -1177,18 +1177,18 @@ var EditSession = function(text, mode) { /** * {:Document.getTextRange.desc} * @param {Range} range The range to work with - * + * * @returns {Range} - **/ + **/ this.getTextRange = function(range) { return this.doc.getTextRange(range || this.selection.getRange()); }; /** * Inserts a block of `text` and the indicated `position`. - * @param {Number} position The position to start inserting at + * @param {Object} position The position {row, column} to start inserting at * @param {String} text A chunk of text to insert - * @returns {Number} The position of the last line of `text`. If the length of `text` is 0, this function simply returns `position`. + * @returns {Object} The position of the last line of `text`. If the length of `text` is 0, this function simply returns `position`. * * **/ @@ -2027,7 +2027,7 @@ var EditSession = function(text, mode) { * The first position indicates the number of columns for `str` on screen.
* The second value contains the position of the document column that this function read until. * - * + * * * **/ @@ -2076,7 +2076,7 @@ var EditSession = function(text, mode) { /** * Returns the position (on screen) for the last character in the provided screen row. * @param {Number} screenRow The screen row to check - * + * * * @related EditSession.documentToScreenColumn **/ From e576099de7dbf11b9740c0c9fe2eb31039c2d25a Mon Sep 17 00:00:00 2001 From: nightwing Date: Mon, 26 Nov 2012 00:12:12 +0400 Subject: [PATCH 4/6] add documentation for ace.require --- lib/ace/ace.js | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/lib/ace/ace.js b/lib/ace/ace.js index 69c21274..7d09eb24 100644 --- a/lib/ace/ace.js +++ b/lib/ace/ace.js @@ -55,6 +55,15 @@ require("./placeholder"); require("./mode/folding/fold_mode"); exports.config = require("./config"); +/** + * @param {String} moduleName + * @returns {Object} + * + * provides access to require in packed noconflict mode + * + **/ +exports.require = require; + /** * Embeds the Ace editor into the DOM, at the element provided by `el`. * @param {String | DOMElement} el Either the id of an element, or the element itself From ac0a26d33334d4704a306294a09a3b91555daf2a Mon Sep 17 00:00:00 2001 From: Garen Torikian Date: Thu, 29 Nov 2012 15:10:01 -0800 Subject: [PATCH 5/6] Update docs to use undocumented, also incorporate Site branch changes --- api/ace.html | 62 +- api/anchor.html | 2 +- api/document.html | 14 +- api/edit_session.html | 32 +- api/editor.html | 71 +- api/range.html | 2 +- api/resources/csses/ace_api.css | 5 + api/scrollbar.html | 2 +- api/search.html | 2 +- api/selection.html | 1577 ------------------ api/split.html | 35 +- api/virtual_renderer.html | 32 +- doc/resources/ace/skeleton/csses/ace_api.css | 5 + doc/resources/ace/templates/lib.jade | 4 +- lib/ace/ace.js | 5 +- lib/ace/editor.js | 2 - lib/ace/multi_select.js | 114 +- lib/ace/split.js | 3 - 18 files changed, 231 insertions(+), 1738 deletions(-) delete mode 100644 api/selection.html diff --git a/api/ace.html b/api/ace.html index c9a86d36..0144b6ba 100644 --- a/api/ace.html +++ b/api/ace.html @@ -15,10 +15,14 @@ - diff --git a/api/document.html b/api/document.html index 1043bd47..2c6e9f4c 100644 --- a/api/document.html +++ b/api/document.html @@ -448,10 +448,10 @@
  • @@ -466,7 +466,7 @@

    Inserts a block of text and the indicated position.

    -

    Arguments

    positionNumber

    Required. The position to start inserting at

    +

    Arguments

    positionObject

    Required. The position to start inserting at

    textString

    Required. A chunk of text to insert

    @@ -481,7 +481,7 @@
      • -
      • Document.insertInLine(Number position, String text) +
      • Document.insertInLine(Object position, String text)
        • Object
        • @@ -499,7 +499,7 @@

          Inserts text into the position at the current row. This method also triggers the 'change' event.

          -

          Arguments

          positionNumber

          Required. The position to insert at

          +

          Arguments

          positionObject

          Required. The position to insert at

          textString

          Required. A chunk of text

          @@ -547,7 +547,7 @@
            • -
            • Document.insertNewLine(String position) +
            • Document.insertNewLine(Object position)
              • Object
              • @@ -565,7 +565,7 @@

                Inserts a new line into the document at the current row's position. This method also triggers the 'change' event.

                -

                Arguments

                positionString

                Required. The position to insert at

                +

                Arguments

                positionObject

                Required. The position to insert at

                diff --git a/api/edit_session.html b/api/edit_session.html index d83a0e29..ca23f7e5 100644 --- a/api/edit_session.html +++ b/api/edit_session.html @@ -697,7 +697,7 @@
              • EditSession._loadMode
                • -
                • Incomplete
                • +
                • Undocumented
                @@ -2056,7 +2056,7 @@
              • EditSession.highlight
                • -
                • Incomplete
                • +
                • Undocumented
                @@ -2080,7 +2080,7 @@
              • EditSession.highlightLines
                • -
                • Incomplete
                • +
                • Undocumented
                @@ -2131,10 +2131,10 @@
                • @@ -2149,7 +2149,7 @@

                  Inserts a block of text and the indicated position.

                  -

                  Arguments

                  positionNumber

                  Required. The position to start inserting at

                  +

                  Arguments

                  positionObject

                  Required. The position {row, column} to start inserting at

                  textString

                  Required. A chunk of text to insert

                  @@ -2167,7 +2167,7 @@
                • EditSession.isFullWidth
                  • -
                  • Incomplete
                  • +
                  • Undocumented
                  @@ -2319,7 +2319,7 @@
                • EditSession.onChange
                  • -
                  • Incomplete
                  • +
                  • Undocumented
                  @@ -2343,7 +2343,7 @@
                • EditSession.onChangeFold
                  • -
                  • Incomplete
                  • +
                  • Undocumented
                  @@ -2421,7 +2421,7 @@
                • EditSession.redo
                  • -
                  • Incomplete
                  • +
                  • Undocumented
                  @@ -2598,7 +2598,7 @@
                • EditSession.reset
                  • -
                  • Incomplete
                  • +
                  • Undocumented
                  @@ -2622,7 +2622,7 @@
                • EditSession.resetCaches
                  • -
                  • Incomplete
                  • +
                  • Undocumented
                  @@ -2646,7 +2646,7 @@
                • EditSession.screenToDocumentColumn
                  • -
                  • Incomplete
                  • +
                  • Undocumented
                  @@ -2703,7 +2703,7 @@
                • EditSession.screenToDocumentRow
                  • -
                  • Incomplete
                  • +
                  • Undocumented
                  @@ -2836,7 +2836,7 @@
                • EditSession.setMode
                  • -
                  • Incomplete
                  • +
                  • Undocumented
                  @@ -3238,7 +3238,7 @@
                • EditSession.undo
                  • -
                  • Incomplete
                  • +
                  • Undocumented
                  diff --git a/api/editor.html b/api/editor.html index 5261612d..4f659898 100644 --- a/api/editor.html +++ b/api/editor.html @@ -769,7 +769,7 @@
                • Editor.duplicateSelection
                  • -
                  • Incomplete
                  • +
                  • Undocumented
                  @@ -793,7 +793,7 @@
                • Editor.execCommand
                  • -
                  • Incomplete
                  • +
                  • Undocumented
                  @@ -928,7 +928,7 @@
                • Editor.getAnimatedScroll
                  • -
                  • Incomplete
                  • +
                  • Undocumented
                  @@ -1076,7 +1076,7 @@
                • Editor.getDisplayIndentGuides
                  • -
                  • Incomplete
                  • +
                  • Undocumented
                  @@ -1131,7 +1131,7 @@
                • Editor.getFadeFoldWidgets
                  • -
                  • Incomplete
                  • +
                  • Undocumented
                  @@ -1212,7 +1212,7 @@
                • Editor.getHighlightGutterLine
                  • -
                  • Incomplete
                  • +
                  • Undocumented
                  @@ -1796,11 +1796,10 @@
                  -

                  Editor.getWrapBehavioursEnabled() -> Boolean

                  +

                  Returns true if the wrapping behaviors are currently enabled.

                  -

                  Editor.getWrapBehavioursEnabled() -> Boolean

                  -

                  Returns true if the wrapping behaviors are currently enabled.

                  +

                  Returns true if the wrapping behaviors are currently enabled.

                  Arguments

                  @@ -2214,7 +2213,7 @@
                • Editor.moveText
                  • -
                  • Incomplete
                  • +
                  • Undocumented
                  @@ -2530,7 +2529,7 @@
                • Editor.onBlur
                  • -
                  • Incomplete
                  • +
                  • Undocumented
                  @@ -2554,7 +2553,7 @@
                • Editor.onChangeAnnotation
                  • -
                  • Incomplete
                  • +
                  • Undocumented
                  @@ -2578,7 +2577,7 @@
                • Editor.onChangeBackMarker
                  • -
                  • Incomplete
                  • +
                  • Undocumented
                  @@ -2602,7 +2601,7 @@
                • Editor.onChangeBreakpoint
                  • -
                  • Incomplete
                  • +
                  • Undocumented
                  @@ -2626,7 +2625,7 @@
                • Editor.onChangeFold
                  • -
                  • Incomplete
                  • +
                  • Undocumented
                  @@ -2650,7 +2649,7 @@
                • Editor.onChangeFrontMarker
                  • -
                  • Incomplete
                  • +
                  • Undocumented
                  @@ -2674,7 +2673,7 @@
                • Editor.onChangeMode
                  • -
                  • Incomplete
                  • +
                  • Undocumented
                  @@ -2698,7 +2697,7 @@
                • Editor.onChangeWrapLimit
                  • -
                  • Incomplete
                  • +
                  • Undocumented
                  @@ -2722,7 +2721,7 @@
                • Editor.onChangeWrapMode
                  • -
                  • Incomplete
                  • +
                  • Undocumented
                  @@ -2746,7 +2745,7 @@
                • Editor.onCommandKey
                  • -
                  • Incomplete
                  • +
                  • Undocumented
                  @@ -2770,7 +2769,7 @@
                • Editor.onCompositionEnd
                  • -
                  • Incomplete
                  • +
                  • Undocumented
                  @@ -2794,7 +2793,7 @@
                • Editor.onCompositionStart
                  • -
                  • Incomplete
                  • +
                  • Undocumented
                  @@ -2818,7 +2817,7 @@
                • Editor.onCompositionUpdate
                  • -
                  • Incomplete
                  • +
                  • Undocumented
                  @@ -2920,7 +2919,7 @@
                • Editor.onDocumentChange
                  • -
                  • Incomplete
                  • +
                  • Undocumented
                  @@ -2944,7 +2943,7 @@
                • Editor.onFocus
                  • -
                  • Incomplete
                  • +
                  • Undocumented
                  @@ -2995,7 +2994,7 @@
                • Editor.onScrollLeftChange
                  • -
                  • Incomplete
                  • +
                  • Undocumented
                  @@ -3019,7 +3018,7 @@
                • Editor.onScrollTopChange
                  • -
                  • Incomplete
                  • +
                  • Undocumented
                  @@ -3043,7 +3042,7 @@
                • Editor.onSelectionChange
                  • -
                  • Incomplete
                  • +
                  • Undocumented
                  @@ -3067,7 +3066,7 @@
                • Editor.onTextInput
                  • -
                  • Incomplete
                  • +
                  • Undocumented
                  @@ -3091,7 +3090,7 @@
                • Editor.onTokenizerUpdate
                  • -
                  • Incomplete
                  • +
                  • Undocumented
                  @@ -3381,7 +3380,7 @@
                • Editor.revealRange
                  • -
                  • Incomplete
                  • +
                  • Undocumented
                  @@ -3592,7 +3591,7 @@
                • Editor.setAnimatedScroll
                  • -
                  • Incomplete
                  • +
                  • Undocumented
                  @@ -3643,7 +3642,7 @@
                • Editor.setDisplayIndentGuides
                  • -
                  • Incomplete
                  • +
                  • Undocumented
                  @@ -3694,7 +3693,7 @@
                • Editor.setFadeFoldWidgets
                  • -
                  • Incomplete
                  • +
                  • Undocumented
                  @@ -3772,7 +3771,7 @@
                • Editor.setHighlightGutterLine
                  • -
                  • Incomplete
                  • +
                  • Undocumented
                  @@ -4216,7 +4215,7 @@ when such a character is typed in.

                • Editor.sortLines
                  • -
                  • Incomplete
                  • +
                  • Undocumented
                  diff --git a/api/range.html b/api/range.html index 1b89f906..fb447286 100644 --- a/api/range.html +++ b/api/range.html @@ -698,7 +698,7 @@
                • Range.isEmpty
                  • -
                  • Incomplete
                  • +
                  • Undocumented
                  diff --git a/api/resources/csses/ace_api.css b/api/resources/csses/ace_api.css index e90e4131..03b8e114 100644 --- a/api/resources/csses/ace_api.css +++ b/api/resources/csses/ace_api.css @@ -743,6 +743,11 @@ li.signature { text-transform: capitalize; } +.undocumented { + background-color: #B94A48; + color: #ffffff; +} + #documentation .alias a, #documentation .related-to a { color: #ffffff; /* text-decoration: underline; */ diff --git a/api/scrollbar.html b/api/scrollbar.html index a3a8ae2d..6d657f17 100644 --- a/api/scrollbar.html +++ b/api/scrollbar.html @@ -157,7 +157,7 @@
                • ScrollBar.onScroll
                  • -
                  • Incomplete
                  • +
                  • Undocumented
                  diff --git a/api/search.html b/api/search.html index ea462e54..064731bf 100644 --- a/api/search.html +++ b/api/search.html @@ -268,7 +268,7 @@ If options.needle was not found, this function returns nullSearch.setOptions
                    -
                  • Incomplete
                  • +
                  • Undocumented
                  diff --git a/api/selection.html b/api/selection.html deleted file mode 100644 index a7662313..00000000 --- a/api/selection.html +++ /dev/null @@ -1,1577 +0,0 @@ - -
                  -
                  -
                  - -
                  -
                  -

                  Contains the cursor position and the text selection of an edit session.

                  -

                  The row/columns used in the selection are in document coordinates representing ths coordinates as thez appear in the document before applying soft wrap and folding.

                  - -
                  -
                  -
                  -

                  Constructors

                  -
                  -
                  -
                  -
                  - -
                  -
                  -

                  Creates a new Selection object.

                  - -
                  -

                  Creates a new Selection object.

                  - -

                  Arguments

                  sessionEditSession

                  Required. The session to use

                  -
                  -
                  -
                  -
                  -
                  -
                  -

                  Events

                  -
                  -
                  -
                  -
                  -
                    -
                  • -
                      -
                    • Selection.on("changeCursor", function())
                    • -
                    -
                      -
                    -
                  • -
                  -
                  -
                  -

                  Emitted when the cursor position changes.

                  - -
                  -

                  Emitted when the cursor position changes.

                  - -

                  Arguments

                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                    -
                  • -
                      -
                    • Selection.on("changeSelection", function())
                    • -
                    -
                      -
                    -
                  • -
                  -
                  -
                  -

                  Emitted when the cursor selection changes.

                  - -
                  -

                  Emitted when the cursor selection changes.

                  - -

                  Arguments

                  -
                  -
                  -
                  -
                  -
                  -

                  Methods

                  -
                  -
                  -
                  -
                  -
                    -
                  • -
                      -
                    • Selection.clearSelection
                    • -
                    -
                      -
                    -
                  • -
                  -
                  -
                  -

                  Empties the selection (by de-selecting it). This function also emits the 'changeSelection' event.

                  - -
                  -

                  Empties the selection (by de-selecting it). This function also emits the 'changeSelection' event.

                  - -

                  Arguments

                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                    -
                  • -
                      -
                    • Selection.detach
                    • -
                    -
                      -
                    • Incomplete
                    • -
                    -
                  • -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                    -
                  • -
                      -
                    • Selection.fromOrientedRange
                    • -
                    -
                      -
                    • Incomplete
                    • -
                    -
                  • -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                    -
                  • -
                      -
                    • Selection.getCursor -
                    • - -
                    • -
                    -
                      -
                    -
                  • -
                  -
                  -
                  -

                  Gets the current position of the cursor.

                  - -
                  -

                  Gets the current position of the cursor.

                  - -

                  Arguments

                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                    -
                  • -
                      -
                    • Selection.getLineRange
                    • -
                    -
                      -
                    • Incomplete
                    • -
                    -
                  • -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                    -
                  • -
                      -
                    • Selection.getRange -
                    • - -
                    • -
                    -
                      -
                    -
                  • -
                  -
                  -
                  -

                  Returns the Range for the selected text.

                  - -
                  -

                  Returns the Range for the selected text.

                  - -

                  Arguments

                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                    -
                  • -
                      -
                    • Selection.getSelectionAnchor
                    • -
                    -
                      -
                    -
                  • -
                  -
                  -
                  -

                  Returns an object containing the row and column of the calling selection anchor.

                  - -
                  -

                  Returns an object containing the row and column of the calling selection anchor.

                  - -

                  Arguments

                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                    -
                  • -
                      -
                    • Selection.getSelectionLead -
                    • - -
                    • -
                    -
                      -
                    -
                  • -
                  -
                  -
                  -

                  Returns an object containing the row and column of the calling selection lead.

                  - -
                  -

                  Returns an object containing the row and column of the calling selection lead.

                  - -

                  Arguments

                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                    -
                  • - -
                      -
                    -
                  • -
                  -
                  -
                  -

                  Moves the selection to highlight the entire word.

                  - -
                  -

                  Moves the selection to highlight the entire word.

                  - -

                  Arguments

                  rowObject

                  Required.

                  -
                  columnObject

                  Required.

                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                    -
                  • -
                      -
                    • Selection.isBackwards -
                    • - -
                    • -
                    -
                      -
                    -
                  • -
                  -
                  -
                  -

                  Returns true if the selection is going backwards in the document.

                  - -
                  -

                  Returns true if the selection is going backwards in the document.

                  - -

                  Arguments

                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                    -
                  • -
                      -
                    • Selection.isEmpty -
                    • - -
                    • -
                    -
                      -
                    -
                  • -
                  -
                  -
                  -

                  Returns true if the selection is empty.

                  - -
                  -

                  Returns true if the selection is empty.

                  - -

                  Arguments

                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                    -
                  • -
                      -
                    • Selection.isMultiLine -
                    • - -
                    • -
                    -
                      -
                    -
                  • -
                  -
                  -
                  -

                  Returns true if the selection is a multi-line.

                  - -
                  -

                  Returns true if the selection is a multi-line.

                  - -

                  Arguments

                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                    -
                  • - -
                      -
                    -
                  • -
                  -
                  -
                  -

                  Moves the cursor to position indicated by the parameters. Negative numbers move the cursor backwards in the document.

                  - -
                  -

                  Moves the cursor to position indicated by the parameters. Negative numbers move the cursor backwards in the document.

                  - -

                  Arguments

                  rowsNumber

                  Required. The number of rows to move by

                  -
                  charsNumber

                  Required. The number of characters to move by

                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                    -
                  • -
                      -
                    • Selection.moveCursorDown
                    • -
                    -
                      -
                    -
                  • -
                  -
                  -
                  -

                  Moves the cursor down one row.

                  - -
                  -

                  Moves the cursor down one row.

                  - -

                  Arguments

                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                    -
                  • -
                      -
                    • Selection.moveCursorFileEnd
                    • -
                    -
                      -
                    -
                  • -
                  -
                  -
                  -

                  Moves the cursor to the end of the file.

                  - -
                  -

                  Moves the cursor to the end of the file.

                  - -

                  Arguments

                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                    -
                  • -
                      -
                    • Selection.moveCursorFileStart
                    • -
                    -
                      -
                    -
                  • -
                  -
                  -
                  -

                  Moves the cursor to the start of the file.

                  - -
                  -

                  Moves the cursor to the start of the file.

                  - -

                  Arguments

                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                    -
                  • -
                      -
                    • Selection.moveCursorLeft
                    • -
                    -
                      -
                    -
                  • -
                  -
                  -
                  -

                  Moves the cursor left one column.

                  - -
                  -

                  Moves the cursor left one column.

                  - -

                  Arguments

                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                    -
                  • -
                      -
                    • Selection.moveCursorLineEnd
                    • -
                    -
                      -
                    -
                  • -
                  -
                  -
                  -

                  Moves the cursor to the end of the line.

                  - -
                  -

                  Moves the cursor to the end of the line.

                  - -

                  Arguments

                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                    -
                  • -
                      -
                    • Selection.moveCursorLineStart
                    • -
                    -
                      -
                    -
                  • -
                  -
                  -
                  -

                  Moves the cursor to the start of the line.

                  - -
                  -

                  Moves the cursor to the start of the line.

                  - -

                  Arguments

                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                    -
                  • -
                      -
                    • Selection.moveCursorLongWordLeft
                    • -
                    -
                      -
                    -
                  • -
                  -
                  -
                  -

                  Moves the cursor to the word on the left.

                  - -
                  -

                  Moves the cursor to the word on the left.

                  - -

                  Arguments

                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                    -
                  • -
                      -
                    • Selection.moveCursorLongWordRight
                    • -
                    -
                      -
                    -
                  • -
                  -
                  -
                  -

                  Moves the cursor to the word on the right.

                  - -
                  -

                  Moves the cursor to the word on the right.

                  - -

                  Arguments

                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                    -
                  • -
                      -
                    • Selection.moveCursorRight
                    • -
                    -
                      -
                    -
                  • -
                  -
                  -
                  -

                  Moves the cursor right one column.

                  - -
                  -

                  Moves the cursor right one column.

                  - -

                  Arguments

                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                    -
                  • -
                      -
                    • Selection.moveCursorShortWordLeft
                    • -
                    -
                      -
                    • Incomplete
                    • -
                    -
                  • -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                    -
                  • -
                      -
                    • Selection.moveCursorShortWordRight
                    • -
                    -
                      -
                    • Incomplete
                    • -
                    -
                  • -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  - -
                  -
                  -

                  Moves the cursor to the row and column provided. If preventUpdateDesiredColumn is true, then the cursor stays in the same column position as its original point.

                  - -
                  -

                  Moves the cursor to the row and column provided. If preventUpdateDesiredColumn is true, then the cursor stays in the same column position as its original point.

                  - -

                  Arguments

                  rowNumber

                  Required. The row to move to

                  -
                  columnNumber

                  Required. The column to move to

                  -
                  keepDesiredColumnBoolean

                  Required. If true, the cursor move does not respect the previous column

                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                    -
                  • -
                      -
                    • Selection.moveCursorToPosition(Object position)
                    • -
                    -
                      -
                    -
                  • -
                  -
                  -
                  -

                  Moves the selection to the position indicated by its row and column.

                  - -
                  -

                  Moves the selection to the position indicated by its row and column.

                  - -

                  Arguments

                  positionObject

                  Required. The position to move to

                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                    -
                  • - -
                      -
                    -
                  • -
                  -
                  -
                  -

                  Moves the cursor to the screen position indicated by row and column. If preventUpdateDesiredColumn is true, then the cursor stays in the same column position as its original point.

                  - -
                  -

                  Moves the cursor to the screen position indicated by row and column. If preventUpdateDesiredColumn is true, then the cursor stays in the same column position as its original point.

                  - -

                  Arguments

                  rowNumber

                  Required. The row to move to

                  -
                  columnNumber

                  Required. The column to move to

                  -
                  keepDesiredColumnBoolean

                  Required. If true, the cursor move does not respect the previous column

                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                    -
                  • -
                      -
                    • Selection.moveCursorUp
                    • -
                    -
                      -
                    -
                  • -
                  -
                  -
                  -

                  Moves the cursor up one row.

                  - -
                  -

                  Moves the cursor up one row.

                  - -

                  Arguments

                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                    -
                  • -
                      -
                    • Selection.moveCursorWordLeft
                    • -
                    -
                      -
                    • Incomplete
                    • -
                    -
                  • -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                    -
                  • -
                      -
                    • Selection.moveCursorWordRight
                    • -
                    -
                      -
                    • Incomplete
                    • -
                    -
                  • -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                    -
                  • -
                      -
                    • Selection.selectAll
                    • -
                    -
                      -
                    -
                  • -
                  -
                  -
                  -

                  Selects all the text in the document.

                  - -
                  -

                  Selects all the text in the document.

                  - -

                  Arguments

                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                    -
                  • -
                      -
                    • Selection.selectAWord
                    • -
                    -
                      -
                    -
                  • -
                  -
                  -
                  -

                  Selects a word, including its right whitespace.

                  - -
                  -

                  Selects a word, including its right whitespace.

                  - -

                  Arguments

                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                    -
                  • -
                      -
                    • Selection.selectDown
                    • -
                    -
                      -
                    -
                  • -
                  -
                  -
                  -

                  Moves the selection down one row.

                  - -
                  -

                  Moves the selection down one row.

                  - -

                  Arguments

                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                    -
                  • -
                      -
                    • Selection.selectFileEnd
                    • -
                    -
                      -
                    -
                  • -
                  -
                  -
                  -

                  Moves the selection to the end of the file.

                  - -
                  -

                  Moves the selection to the end of the file.

                  - -

                  Arguments

                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                    -
                  • -
                      -
                    • Selection.selectFileStart
                    • -
                    -
                      -
                    -
                  • -
                  -
                  -
                  -

                  Moves the selection to the start of the file.

                  - -
                  -

                  Moves the selection to the start of the file.

                  - -

                  Arguments

                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                    -
                  • -
                      -
                    • Selection.selectLeft
                    • -
                    -
                      -
                    -
                  • -
                  -
                  -
                  -

                  Moves the selection left one column.

                  - -
                  -

                  Moves the selection left one column.

                  - -

                  Arguments

                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                    -
                  • -
                      -
                    • Selection.selectLine
                    • -
                    -
                      -
                    -
                  • -
                  -
                  -
                  -

                  Selects the entire line.

                  - -
                  -

                  Selects the entire line.

                  - -

                  Arguments

                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                    -
                  • -
                      -
                    • Selection.selectLineEnd
                    • -
                    -
                      -
                    -
                  • -
                  -
                  -
                  -

                  Moves the selection to the end of the current line.

                  - -
                  -

                  Moves the selection to the end of the current line.

                  - -

                  Arguments

                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                    -
                  • -
                      -
                    • Selection.selectLineStart
                    • -
                    -
                      -
                    -
                  • -
                  -
                  -
                  -

                  Moves the selection to the beginning of the current line.

                  - -
                  -

                  Moves the selection to the beginning of the current line.

                  - -

                  Arguments

                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                    -
                  • -
                      -
                    • Selection.selectRight
                    • -
                    -
                      -
                    -
                  • -
                  -
                  -
                  -

                  Moves the selection right one column.

                  - -
                  -

                  Moves the selection right one column.

                  - -

                  Arguments

                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                    -
                  • - -
                      -
                    -
                  • -
                  -
                  -
                  -

                  Moves the selection cursor to the indicated row and column.

                  - -
                  -

                  Moves the selection cursor to the indicated row and column.

                  - -

                  Arguments

                  rowNumber

                  Required. The row to select to

                  -
                  columnNumber

                  Required. The column to select to

                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                    -
                  • -
                      -
                    • Selection.selectToPosition(Object pos)
                    • -
                    -
                      -
                    -
                  • -
                  -
                  -
                  -

                  Moves the selection cursor to the row and column indicated by pos.

                  - -
                  -

                  Moves the selection cursor to the row and column indicated by pos.

                  - -

                  Arguments

                  posObject

                  Required. An object containing the row and column

                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                    -
                  • -
                      -
                    • Selection.selectUp
                    • -
                    -
                      -
                    -
                  • -
                  -
                  -
                  -

                  Moves the selection up one row.

                  - -
                  -

                  Moves the selection up one row.

                  - -

                  Arguments

                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                    -
                  • -
                      -
                    • Selection.selectWord
                    • -
                    -
                      -
                    -
                  • -
                  -
                  -
                  -

                  Selects an entire word boundary.

                  - -
                  -

                  Selects an entire word boundary.

                  - -

                  Arguments

                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                    -
                  • -
                      -
                    • Selection.selectWordLeft
                    • -
                    -
                      -
                    -
                  • -
                  -
                  -
                  -

                  Moves the selection to the first word on the left.

                  - -
                  -

                  Moves the selection to the first word on the left.

                  - -

                  Arguments

                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                    -
                  • -
                      -
                    • Selection.selectWordRight
                    • -
                    -
                      -
                    -
                  • -
                  -
                  -
                  -

                  Moves the selection to the first word on the right.

                  - -
                  -

                  Moves the selection to the first word on the right.

                  - -

                  Arguments

                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                    -
                  • -
                      -
                    • Selection.setSelectionAnchor(Number row, Number column)
                    • -
                    -
                      -
                    -
                  • -
                  -
                  -
                  -

                  Sets the row and column position of the anchor. This function also emits the 'changeSelection' event.

                  - -
                  -

                  Sets the row and column position of the anchor. This function also emits the 'changeSelection' event.

                  - -

                  Arguments

                  rowNumber

                  Required. The new row

                  -
                  columnNumber

                  Required. The new column

                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                    -
                  • -
                      -
                    • Selection.setSelectionRange(Range range, Boolean reverse)
                    • -
                    -
                      -
                    -
                  • -
                  -
                  -
                  -

                  Sets the selection to the provided range.

                  - -
                  -

                  Sets the selection to the provided range.

                  - -

                  Arguments

                  rangeRange

                  Required. The range of text to select

                  -
                  reverseBoolean

                  Required. Indicates if the range should go backwards (true) or not

                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                    -
                  • -
                      -
                    • Selection.shiftSelection(Number columns)
                    • -
                    -
                      -
                    -
                  • -
                  -
                  -
                  -

                  Shifts the selection up (or down, if isBackwards() is true) the given number of columns.

                  - -
                  -

                  Shifts the selection up (or down, if isBackwards() is true) the given number of columns.

                  - -

                  Arguments

                  columnsNumber

                  Required. The number of columns to shift by

                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                    -
                  • -
                      -
                    • Selection.toOrientedRange
                    • -
                    -
                      -
                    • Incomplete
                    • -
                    -
                  • -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  -
                  - - - - - -
                  -
                  \ No newline at end of file diff --git a/api/split.html b/api/split.html index b5626ad4..9267306a 100644 --- a/api/split.html +++ b/api/split.html @@ -119,7 +119,7 @@
                • Split.execute
                  • -
                  • Incomplete
                  • +
                  • Undocumented
                  @@ -169,7 +169,7 @@
                • Split.forEach(Function callback, String scope)
                  • -
                  • Incomplete
                  • +
                  • Undocumented
                  @@ -228,7 +228,7 @@
                • Split.getEditor(Number idx)
                  • -
                  • Incomplete
                  • +
                  • Undocumented
                  @@ -312,7 +312,7 @@
                • Split.hasRedo
                  • -
                  • Incomplete
                  • +
                  • Undocumented
                  @@ -336,7 +336,7 @@
                • Split.hasUndo
                  • -
                  • Incomplete
                  • +
                  • Undocumented
                  @@ -360,7 +360,7 @@
                • Split.redo
                  • -
                  • Incomplete
                  • +
                  • Undocumented
                  @@ -384,7 +384,7 @@
                • Split.reset
                  • -
                  • Incomplete
                  • +
                  • Undocumented
                  @@ -413,11 +413,10 @@
                  -

                  Split.resize() -> Void

                  +

                  Resizes the editor.

                  -

                  Split.resize() -> Void

                  -

                  Resizes the editor.

                  +

                  Resizes the editor.

                  Arguments

                  @@ -435,7 +434,7 @@
                • Split.setFontSize(Number size)
                  • -
                  • Incomplete
                  • +
                  • Undocumented
                  @@ -462,7 +461,7 @@
                • Split.setKeyboardHandler(String keybinding)
                  • -
                  • Incomplete
                  • +
                  • Undocumented
                  @@ -488,7 +487,7 @@
                • Split.setOrientation(Number orientation)
                  • -
                  • Incomplete
                  • +
                  • Undocumented
                  @@ -515,7 +514,7 @@
                • Split.setSession(EditSession session, Number idx)
                  • -
                  • Incomplete
                  • +
                  • Undocumented
                  @@ -543,7 +542,7 @@
                • Split.setSplits
                  • -
                  • Incomplete
                  • +
                  • Undocumented
                  @@ -567,7 +566,7 @@
                • Split.setTheme(String theme)
                  • -
                  • Incomplete
                  • +
                  • Undocumented
                  @@ -594,7 +593,7 @@
                • Split.undo
                  • -
                  • Incomplete
                  • +
                  • Undocumented
                  @@ -618,7 +617,7 @@
                • Split.UndoManagerProxy
                  • -
                  • Incomplete
                  • +
                  • Undocumented
                  diff --git a/api/virtual_renderer.html b/api/virtual_renderer.html index d1989466..dfb26a7e 100644 --- a/api/virtual_renderer.html +++ b/api/virtual_renderer.html @@ -229,7 +229,7 @@
                • VirtualRenderer._loadTheme
                  • -
                  • Incomplete
                  • +
                  • Undocumented
                  @@ -307,7 +307,7 @@
                • VirtualRenderer.alignCursor
                  • -
                  • Incomplete
                  • +
                  • Undocumented
                  @@ -331,7 +331,7 @@
                • VirtualRenderer.animateScrolling
                  • -
                  • Incomplete
                  • +
                  • Undocumented
                  @@ -443,7 +443,7 @@
                • VirtualRenderer.getDisplayIndentGuides
                  • -
                  • Incomplete
                  • +
                  • Undocumented
                  @@ -467,7 +467,7 @@
                • VirtualRenderer.getFadeFoldWidgets
                  • -
                  • Incomplete
                  • +
                  • Undocumented
                  @@ -553,7 +553,7 @@
                • VirtualRenderer.getHighlightGutterLine
                  • -
                  • Incomplete
                  • +
                  • Undocumented
                  @@ -1096,7 +1096,7 @@
                • VirtualRenderer.onChangeTabSize
                  • -
                  • Incomplete
                  • +
                  • Undocumented
                  @@ -1150,7 +1150,7 @@
                • VirtualRenderer.pixelToScreenCoordinates
                  • -
                  • Incomplete
                  • +
                  • Undocumented
                  @@ -1202,7 +1202,7 @@
                • VirtualRenderer.screenToTextCoordinates
                  • -
                  • Incomplete
                  • +
                  • Undocumented
                  @@ -1282,7 +1282,7 @@
                • VirtualRenderer.scrollSelectionIntoView
                  • -
                  • Incomplete
                  • +
                  • Undocumented
                  @@ -1481,7 +1481,7 @@
                • VirtualRenderer.setCompositionText(String text)
                  • -
                  • Incomplete
                  • +
                  • Undocumented
                  @@ -1508,7 +1508,7 @@
                • VirtualRenderer.setDisplayIndentGuides
                  • -
                  • Incomplete
                  • +
                  • Undocumented
                  @@ -1532,7 +1532,7 @@
                • VirtualRenderer.setFadeFoldWidgets
                  • -
                  • Incomplete
                  • +
                  • Undocumented
                  @@ -1556,7 +1556,7 @@
                • VirtualRenderer.setHighlightGutterLine
                  • -
                  • Incomplete
                  • +
                  • Undocumented
                  @@ -1769,7 +1769,7 @@
                • VirtualRenderer.setStyle
                  • -
                  • Incomplete
                  • +
                  • Undocumented
                  @@ -1959,7 +1959,7 @@
                • VirtualRenderer.updateCharacterSize
                  • -
                  • Incomplete
                  • +
                  • Undocumented
                  diff --git a/doc/resources/ace/skeleton/csses/ace_api.css b/doc/resources/ace/skeleton/csses/ace_api.css index e90e4131..03b8e114 100644 --- a/doc/resources/ace/skeleton/csses/ace_api.css +++ b/doc/resources/ace/skeleton/csses/ace_api.css @@ -743,6 +743,11 @@ li.signature { text-transform: capitalize; } +.undocumented { + background-color: #B94A48; + color: #ffffff; +} + #documentation .alias a, #documentation .related-to a { color: #ffffff; /* text-decoration: underline; */ diff --git a/doc/resources/ace/templates/lib.jade b/doc/resources/ace/templates/lib.jade index 7b07a50e..24505ac7 100644 --- a/doc/resources/ace/templates/lib.jade +++ b/doc/resources/ace/templates/lib.jade @@ -45,9 +45,9 @@ mixin article(obj, parents) -if (loops == 0) -loops = 1 // ensure that we only print ONE meta info UL per signature (some methods have multiple signatures) ul.metaInfo - if obj.incomplete + if obj.undocumented li - span.label.incomplete Incomplete + span.label.undocumented Undocumented if obj.experimental li span.label.experimental Experimental diff --git a/lib/ace/ace.js b/lib/ace/ace.js index 7d09eb24..d4189de4 100644 --- a/lib/ace/ace.js +++ b/lib/ace/ace.js @@ -56,11 +56,10 @@ require("./mode/folding/fold_mode"); exports.config = require("./config"); /** + * Provides access to require in packed noconflict mode * @param {String} moduleName * @returns {Object} * - * provides access to require in packed noconflict mode - * **/ exports.require = require; @@ -68,8 +67,6 @@ exports.require = require; * Embeds the Ace editor into the DOM, at the element provided by `el`. * @param {String | DOMElement} el Either the id of an element, or the element itself * - * This method embeds the Ace editor into the DOM, at the element provided by `el`. - * **/ exports.edit = function(el) { if (typeof(el) == "string") { diff --git a/lib/ace/editor.js b/lib/ace/editor.js index f874edd6..8a034019 100644 --- a/lib/ace/editor.js +++ b/lib/ace/editor.js @@ -1050,8 +1050,6 @@ var Editor = function(renderer, session) { }; /** - * Editor.getWrapBehavioursEnabled() -> Boolean - * * Returns `true` if the wrapping behaviors are currently enabled. **/ this.getWrapBehavioursEnabled = function () { diff --git a/lib/ace/multi_select.js b/lib/ace/multi_select.js index 377f018c..e1ecd80c 100644 --- a/lib/ace/multi_select.js +++ b/lib/ace/multi_select.js @@ -66,12 +66,11 @@ var EditSession = require("./edit_session").EditSession; // automatically sorted list of ranges this.rangeList = null; - /** extension - * Selection.addRange(range, $blockChangeEvents) - * - range (Range): The new range to add - * - $blockChangeEvents (Boolean): Whether or not to block changing events - * + /** * Adds a range to a selection by entering multiselect mode, if necessary. + * @param {Range} range The new range to add + * @param {Boolean} $blockChangeEvents Whether or not to block changing events + * @method Selection.addRange **/ this.addRange = function(range, $blockChangeEvents) { if (!range) @@ -106,6 +105,10 @@ var EditSession = require("./edit_session").EditSession; return $blockChangeEvents || this.fromOrientedRange(range); }; + /** + * @method Selection.toSingleRange + **/ + this.toSingleRange = function(range) { range = range || this.ranges[0]; var removed = this.rangeList.removeAll(); @@ -115,11 +118,10 @@ var EditSession = require("./edit_session").EditSession; range && this.fromOrientedRange(range); }; - /** extension - * Selection.substractPoint(pos) -> Range - * - pos (Range): The position to remove, as a `{row, column}` object - * + /** * Removes a Range containing pos (if it exists). + * @param {Range} pos The position to remove, as a `{row, column}` object + * @method Selection.substractPoint **/ this.substractPoint = function(pos) { var removed = this.rangeList.substractPoint(pos); @@ -129,10 +131,9 @@ var EditSession = require("./edit_session").EditSession; } }; - /** extension - * Selection.mergeOverlappingRanges() - * + /** * Merges overlapping ranges ensuring consistency after changes + * @method Selection.mergeOverlappingRanges **/ this.mergeOverlappingRanges = function() { var removed = this.rangeList.merge(); @@ -185,10 +186,20 @@ var EditSession = require("./edit_session").EditSession; this.rangeCount = 0; }; + /** + * Returns a concatenation of all the ranges. + * @returns Array + * @method Selection.getAllRanges + **/ this.getAllRanges = function() { return this.rangeList.ranges.concat(); }; + /** + * Splits all the ranges into lines. + * @method Selection.splitIntoLines + **/ + this.splitIntoLines = function () { if (this.rangeCount > 1) { var ranges = this.rangeList.ranges; @@ -229,6 +240,9 @@ var EditSession = require("./edit_session").EditSession; } }; + /** + * @method Selection.toggleBlockSelection + **/ this.toggleBlockSelection = function () { if (this.rangeCount > 1) { var ranges = this.rangeList.ranges; @@ -246,14 +260,15 @@ var EditSession = require("./edit_session").EditSession; } }; - /** extension - * Selection.rectangularRangeBlock(screenCursor, screenAnchor, includeEmptyLines) -> Range - * - screenCursor (Cursor): The cursor to use - * - screenAnchor (Anchor): The anchor to use - * - includeEmptyLines (Boolean): If true, this includes ranges inside the block which are empty due to clipping - * + /** + * * Gets list of ranges composing rectangular block on the screen - * + * + * @param {Cursor} screenCursor The cursor to use + * @param {Anchor} screenAnchor The anchor to use + * @param {Boolean} includeEmptyLines If true, this includes ranges inside the block which are empty due to clipping + * @returns Range + * @method Selection.rectangularRangeBlock **/ this.rectangularRangeBlock = function(screenCursor, screenAnchor, includeEmptyLines) { var rectSel = []; @@ -325,9 +340,10 @@ var Editor = require("./editor").Editor; (function() { /** - * Editor.updateSelectionMarkers() - * + * * Updates the cursor and marker layers. + * @method Editor.updateSelectionMarkers + * **/ this.updateSelectionMarkers = function() { this.renderer.updateCursor(); @@ -335,10 +351,10 @@ var Editor = require("./editor").Editor; }; /** - * Editor.addSelectionMarker(orientedRange) -> Range - * - orientedRange (Range): A range containing a cursor - * * Adds the selection and cursor. + * @param {Range} orientedRange A range containing a cursor + * @returns Range + * @method Editor.addSelectionMarker **/ this.addSelectionMarker = function(orientedRange) { if (!orientedRange.cursor) @@ -353,10 +369,9 @@ var Editor = require("./editor").Editor; }; /** - * Editor.removeSelectionMarker(range) - * - range (Range): The selection range added with [[Editor.addSelectionMarker `addSelectionMarker()`]]. - * * Removes the selection marker. + * @param {Range} The selection range added with [[Editor.addSelectionMarker `addSelectionMarker()`]]. + * @method Editor.removeSelectionMarker **/ this.removeSelectionMarker = function(range) { if (!range.marker) @@ -441,12 +456,11 @@ var Editor = require("./editor").Editor; }; /** - * Editor.forEachSelection(cmd, args) - * - cmd (String): The command to execute - * - args (String): Any arguments for the command - * * Executes a command for each selection range. - **/ + * @param {String} cmd The command to execute + * @param {String} args Any arguments for the command + * @method Editor.forEachSelection + **/ this.forEachSelection = function(cmd, args) { if (this.inVirtualSelectionMode) return; @@ -478,9 +492,8 @@ var Editor = require("./editor").Editor; }; /** - * Editor.exitMultiSelectMode() -> Void - * * Removes all the selections except the last added one. + * @method Editor.exitMultiSelectMode **/ this.exitMultiSelectMode = function() { if (this.inVirtualSelectionMode) @@ -529,12 +542,12 @@ var Editor = require("./editor").Editor; }; /** - * Editor.findAll(needle, options, additive) -> Number - * - needle (String): The text to find - * - options (Object): The search options - * - additive (Boolean): keeps - * * Finds and selects all the occurences of `needle`. + * @param {String} The text to find + * @param {Object} The search options + * @param {Boolean} keeps + * @returns Number + * @method Editor.findAll **/ this.findAll = function(needle, options, additive) { options = options || {}; @@ -605,11 +618,10 @@ var Editor = require("./editor").Editor; this.selection.substractPoint(toRemove); }; - /** extension - * Editor.transposeSelections(dir) - * - dir (Number): The direction to rotate selections - * + /** * Transposes the selected ranges. + * @param dir {Number} The direction to rotate selections + * @method Editor.transposeSelections **/ this.transposeSelections = function(dir) { var session = this.session; @@ -648,12 +660,11 @@ var Editor = require("./editor").Editor; } }; - /** extension - * Editor.selectMore(dir, skip) - * - dir (Number): The direction of lines to select: -1 for up, 1 for down - * - skip (Boolean): If `true`, removes the active selection range - * + /** * Finds the next occurence of text in an active selection and adds it to the selections. + * @param {Number} dir The direction of lines to select: -1 for up, 1 for down + * @param {Boolean} skip If `true`, removes the active selection range + * @method Editor.selectMore **/ this.selectMore = function(dir, skip) { var session = this.session; @@ -676,10 +687,9 @@ var Editor = require("./editor").Editor; this.multiSelect.substractPoint(range.cursor); }; - /** extension - * Editor.alignCursors() - * - * aligns cursors or selected text + /** + * Aligns the cursors or selected text. + * @method Editor.alignCursors **/ this.alignCursors = function() { var session = this.session; diff --git a/lib/ace/split.js b/lib/ace/split.js index b2caa3c1..f8446cb4 100644 --- a/lib/ace/split.js +++ b/lib/ace/split.js @@ -299,9 +299,6 @@ var Split = function(container, theme, splits) { }; /** - * Split.resize() -> Void - * - * * Resizes the editor. **/ this.resize = function() { From c0cfe08c283d3447ba127af9a5f5d517cf3f0ef9 Mon Sep 17 00:00:00 2001 From: Garen Torikian Date: Thu, 29 Nov 2012 15:44:51 -0800 Subject: [PATCH 6/6] Fix extensions in multi_select.js --- api/editor.html | 294 ++++- api/selection.html | 1805 ++++++++++++++++++++++++++ doc/resources/ace/templates/lib.jade | 3 - lib/ace/selection.js | 1 - 4 files changed, 2098 insertions(+), 5 deletions(-) create mode 100644 api/selection.html diff --git a/api/editor.html b/api/editor.html index 4f659898..12111be7 100644 --- a/api/editor.html +++ b/api/editor.html @@ -31,8 +31,12 @@ -

                  Methods

                  +
                  +
                  +
                  +
                  +
                    +
                  • +
                      +
                    • Editor.addSelectionMarker(Range orientedRange)
                    • +
                    +
                      +
                    +
                  • +
                  +
                  +
                  +

                  Adds the selection and cursor.

                  + +
                  +

                  Adds the selection and cursor.

                  + +

                  Arguments

                  orientedRangeRange

                  Required. A range containing a cursor

                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                    +
                  • +
                      +
                    • Editor.alignCursors
                    • +
                    +
                      +
                    +
                  • +
                  +
                  +
                  +

                  Aligns the cursors or selected text.

                  + +
                  +

                  Aligns the cursors or selected text.

                  + +

                  Arguments

                  +
                  +
                  +
                  +
                  +
                  @@ -807,6 +880,32 @@
                  +
                  +
                  +
                  +
                  +
                    +
                  • +
                      +
                    • Editor.exitMultiSelectMode
                    • +
                    +
                      +
                    +
                  • +
                  +
                  +
                  +

                  Removes all the selections except the last added one.

                  + +
                  +

                  Removes all the selections except the last added one.

                  + +

                  Arguments

                  +
                  +
                  +
                  +
                  +
                  @@ -830,6 +929,35 @@

                  Arguments

                  needleString

                  Required. The text to search for (optional)

                  optionsObject

                  Required. An object defining various search properties

                  animateBoolean

                  Required. If true animate scrolling

                  +
                  +
                  +
                  +
                  +
                  + +
                  +
                  +
                  +
                  + +
                  +
                  +

                  Finds and selects all the occurences of needle.

                  + +
                  +

                  Finds and selects all the occurences of needle.

                  + +

                  Arguments

                  TheString

                  Required. text to find

                  +
                  TheObject

                  Required. search options

                  +
                  keepsBoolean

                  Required.

                  @@ -918,6 +1046,34 @@
                  +
                  +
                  +
                  +
                  +
                    +
                  • + +
                      +
                    +
                  • +
                  +
                  +
                  +

                  Executes a command for each selection range.

                  + +
                  +

                  Executes a command for each selection range.

                  + +

                  Arguments

                  cmdString

                  Required. The command to execute

                  +
                  argsString

                  Required. Any arguments for the command

                  +
                  +
                  +
                  +
                  +
                  +
                  @@ -3183,6 +3339,33 @@
                  +
                  +
                  +
                  +
                  +
                    +
                  • +
                      +
                    • Editor.removeSelectionMarker(Range The)
                    • +
                    +
                      +
                    +
                  • +
                  +
                  +
                  +

                  Removes the selection marker.

                  + +
                  +

                  Removes the selection marker.

                  + +

                  Arguments

                  TheRange

                  Required. selection range added with addSelectionMarker().

                  +
                  +
                  +
                  +
                  +
                  +
                  @@ -3529,6 +3712,62 @@
                  +
                  +
                  +
                  +
                  + +
                  +
                  +

                  Finds the next occurence of text in an active selection and adds it to the selections.

                  + +
                  +

                  Finds the next occurence of text in an active selection and adds it to the selections.

                  + +

                  Arguments

                  dirNumber

                  Required. The direction of lines to select: -1 for up, 1 for down

                  +
                  skipBoolean

                  Required. If true, removes the active selection range

                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                    +
                  • + +
                      +
                    +
                  • +
                  +
                  +
                  +

                  Adds a cursor above or below the active cursor.

                  + +
                  +

                  Adds a cursor above or below the active cursor.

                  + +

                  Arguments

                  dirNumber

                  Required. The direction of lines to select: -1 for up, 1 for down

                  +
                  skipBoolean

                  Required. If true, removes the active selection range

                  +
                  +
                  +
                  +
                  +
                  +
                  @@ -4385,6 +4624,33 @@ when such a character is typed in.

                  +
                  +
                  +
                  +
                  +
                    +
                  • +
                      +
                    • Editor.transposeSelections(Object dir)
                    • +
                    +
                      +
                    +
                  • +
                  +
                  +
                  +

                  Transposes the selected ranges.

                  + +
                  +

                  Transposes the selected ranges.

                  + +

                  Arguments

                  dirObject

                  Required. {Number} The direction to rotate selections

                  +
                  +
                  +
                  +
                  +
                  +
                  @@ -4438,6 +4704,32 @@ when such a character is typed in.

                  +
                  +
                  +
                  +
                  +
                    +
                  • +
                      +
                    • Editor.updateSelectionMarkers
                    • +
                    +
                      +
                    +
                  • +
                  +
                  +
                  +

                  Updates the cursor and marker layers.

                  + +
                  +

                  Updates the cursor and marker layers.

                  + +

                  Arguments

                  +
                  +
                  +
                  +
                  +
                  diff --git a/api/selection.html b/api/selection.html new file mode 100644 index 00000000..800b7058 --- /dev/null +++ b/api/selection.html @@ -0,0 +1,1805 @@ + +
                  +
                  +
                  + +
                  +
                  +

                  Contains the cursor position and the text selection of an edit session.

                  +

                  The row/columns used in the selection are in document coordinates representing ths coordinates as thez appear in the document before applying soft wrap and folding.

                  + +
                  +
                  +
                  +

                  Constructors

                  +
                  +
                  +
                  +
                  + +
                  +
                  +

                  Creates a new Selection object.

                  + +
                  +

                  Creates a new Selection object.

                  + +

                  Arguments

                  sessionEditSession

                  Required. The session to use

                  +
                  +
                  +
                  +
                  +
                  +
                  +

                  Events

                  +
                  +
                  +
                  +
                  +
                    +
                  • +
                      +
                    • Selection.on("changeCursor", function())
                    • +
                    +
                      +
                    +
                  • +
                  +
                  +
                  +

                  Emitted when the cursor position changes.

                  + +
                  +

                  Emitted when the cursor position changes.

                  + +

                  Arguments

                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                    +
                  • +
                      +
                    • Selection.on("changeSelection", function())
                    • +
                    +
                      +
                    +
                  • +
                  +
                  +
                  +

                  Emitted when the cursor selection changes.

                  + +
                  +

                  Emitted when the cursor selection changes.

                  + +

                  Arguments

                  +
                  +
                  +
                  +
                  +
                  +

                  Methods

                  +
                  +
                  +
                  +
                  +
                    +
                  • +
                      +
                    • Selection.addRange(Range range, Boolean $blockChangeEvents)
                    • +
                    +
                      +
                    +
                  • +
                  +
                  +
                  +

                  Adds a range to a selection by entering multiselect mode, if necessary.

                  + +
                  +

                  Adds a range to a selection by entering multiselect mode, if necessary.

                  + +

                  Arguments

                  rangeRange

                  Required. The new range to add

                  +
                  $blockChangeEventsBoolean

                  Required. Whether or not to block changing events

                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                    +
                  • +
                      +
                    • Selection.clearSelection
                    • +
                    +
                      +
                    +
                  • +
                  +
                  +
                  +

                  Empties the selection (by de-selecting it). This function also emits the 'changeSelection' event.

                  + +
                  +

                  Empties the selection (by de-selecting it). This function also emits the 'changeSelection' event.

                  + +

                  Arguments

                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                    +
                  • +
                      +
                    • Selection.detach
                    • +
                    +
                      +
                    • Undocumented
                    • +
                    +
                  • +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                    +
                  • +
                      +
                    • Selection.fromOrientedRange
                    • +
                    +
                      +
                    • Undocumented
                    • +
                    +
                  • +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                    +
                  • +
                      +
                    • Selection.getAllRanges
                    • +
                    +
                      +
                    +
                  • +
                  +
                  +
                  +

                  Returns a concatenation of all the ranges.

                  + +
                  +

                  Returns a concatenation of all the ranges.

                  + +

                  Arguments

                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                    +
                  • +
                      +
                    • Selection.getCursor +
                    • + +
                    • +
                    +
                      +
                    +
                  • +
                  +
                  +
                  +

                  Gets the current position of the cursor.

                  + +
                  +

                  Gets the current position of the cursor.

                  + +

                  Arguments

                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                    +
                  • +
                      +
                    • Selection.getLineRange
                    • +
                    +
                      +
                    • Undocumented
                    • +
                    +
                  • +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                    +
                  • +
                      +
                    • Selection.getRange +
                    • + +
                    • +
                    +
                      +
                    +
                  • +
                  +
                  +
                  +

                  Returns the Range for the selected text.

                  + +
                  +

                  Returns the Range for the selected text.

                  + +

                  Arguments

                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                    +
                  • +
                      +
                    • Selection.getSelectionAnchor
                    • +
                    +
                      +
                    +
                  • +
                  +
                  +
                  +

                  Returns an object containing the row and column of the calling selection anchor.

                  + +
                  +

                  Returns an object containing the row and column of the calling selection anchor.

                  + +

                  Arguments

                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                    +
                  • +
                      +
                    • Selection.getSelectionLead +
                    • + +
                    • +
                    +
                      +
                    +
                  • +
                  +
                  +
                  +

                  Returns an object containing the row and column of the calling selection lead.

                  + +
                  +

                  Returns an object containing the row and column of the calling selection lead.

                  + +

                  Arguments

                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                    +
                  • + +
                      +
                    +
                  • +
                  +
                  +
                  +

                  Moves the selection to highlight the entire word.

                  + +
                  +

                  Moves the selection to highlight the entire word.

                  + +

                  Arguments

                  rowObject

                  Required.

                  +
                  columnObject

                  Required.

                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                    +
                  • +
                      +
                    • Selection.isBackwards +
                    • + +
                    • +
                    +
                      +
                    +
                  • +
                  +
                  +
                  +

                  Returns true if the selection is going backwards in the document.

                  + +
                  +

                  Returns true if the selection is going backwards in the document.

                  + +

                  Arguments

                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                    +
                  • +
                      +
                    • Selection.isEmpty +
                    • + +
                    • +
                    +
                      +
                    +
                  • +
                  +
                  +
                  +

                  Returns true if the selection is empty.

                  + +
                  +

                  Returns true if the selection is empty.

                  + +

                  Arguments

                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                    +
                  • +
                      +
                    • Selection.isMultiLine +
                    • + +
                    • +
                    +
                      +
                    +
                  • +
                  +
                  +
                  +

                  Returns true if the selection is a multi-line.

                  + +
                  +

                  Returns true if the selection is a multi-line.

                  + +

                  Arguments

                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                    +
                  • +
                      +
                    • Selection.mergeOverlappingRanges
                    • +
                    +
                      +
                    +
                  • +
                  +
                  +
                  +

                  Merges overlapping ranges ensuring consistency after changes

                  + +
                  +

                  Merges overlapping ranges ensuring consistency after changes

                  + +

                  Arguments

                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                    +
                  • + +
                      +
                    +
                  • +
                  +
                  +
                  +

                  Moves the cursor to position indicated by the parameters. Negative numbers move the cursor backwards in the document.

                  + +
                  +

                  Moves the cursor to position indicated by the parameters. Negative numbers move the cursor backwards in the document.

                  + +

                  Arguments

                  rowsNumber

                  Required. The number of rows to move by

                  +
                  charsNumber

                  Required. The number of characters to move by

                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                    +
                  • +
                      +
                    • Selection.moveCursorDown
                    • +
                    +
                      +
                    +
                  • +
                  +
                  +
                  +

                  Moves the cursor down one row.

                  + +
                  +

                  Moves the cursor down one row.

                  + +

                  Arguments

                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                    +
                  • +
                      +
                    • Selection.moveCursorFileEnd
                    • +
                    +
                      +
                    +
                  • +
                  +
                  +
                  +

                  Moves the cursor to the end of the file.

                  + +
                  +

                  Moves the cursor to the end of the file.

                  + +

                  Arguments

                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                    +
                  • +
                      +
                    • Selection.moveCursorFileStart
                    • +
                    +
                      +
                    +
                  • +
                  +
                  +
                  +

                  Moves the cursor to the start of the file.

                  + +
                  +

                  Moves the cursor to the start of the file.

                  + +

                  Arguments

                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                    +
                  • +
                      +
                    • Selection.moveCursorLeft
                    • +
                    +
                      +
                    +
                  • +
                  +
                  +
                  +

                  Moves the cursor left one column.

                  + +
                  +

                  Moves the cursor left one column.

                  + +

                  Arguments

                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                    +
                  • +
                      +
                    • Selection.moveCursorLineEnd
                    • +
                    +
                      +
                    +
                  • +
                  +
                  +
                  +

                  Moves the cursor to the end of the line.

                  + +
                  +

                  Moves the cursor to the end of the line.

                  + +

                  Arguments

                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                    +
                  • +
                      +
                    • Selection.moveCursorLineStart
                    • +
                    +
                      +
                    +
                  • +
                  +
                  +
                  +

                  Moves the cursor to the start of the line.

                  + +
                  +

                  Moves the cursor to the start of the line.

                  + +

                  Arguments

                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                    +
                  • +
                      +
                    • Selection.moveCursorLongWordLeft
                    • +
                    +
                      +
                    +
                  • +
                  +
                  +
                  +

                  Moves the cursor to the word on the left.

                  + +
                  +

                  Moves the cursor to the word on the left.

                  + +

                  Arguments

                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                    +
                  • +
                      +
                    • Selection.moveCursorLongWordRight
                    • +
                    +
                      +
                    +
                  • +
                  +
                  +
                  +

                  Moves the cursor to the word on the right.

                  + +
                  +

                  Moves the cursor to the word on the right.

                  + +

                  Arguments

                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                    +
                  • +
                      +
                    • Selection.moveCursorRight
                    • +
                    +
                      +
                    +
                  • +
                  +
                  +
                  +

                  Moves the cursor right one column.

                  + +
                  +

                  Moves the cursor right one column.

                  + +

                  Arguments

                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                    +
                  • +
                      +
                    • Selection.moveCursorShortWordLeft
                    • +
                    +
                      +
                    • Undocumented
                    • +
                    +
                  • +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                    +
                  • +
                      +
                    • Selection.moveCursorShortWordRight
                    • +
                    +
                      +
                    • Undocumented
                    • +
                    +
                  • +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  + +
                  +
                  +

                  Moves the cursor to the row and column provided. If preventUpdateDesiredColumn is true, then the cursor stays in the same column position as its original point.

                  + +
                  +

                  Moves the cursor to the row and column provided. If preventUpdateDesiredColumn is true, then the cursor stays in the same column position as its original point.

                  + +

                  Arguments

                  rowNumber

                  Required. The row to move to

                  +
                  columnNumber

                  Required. The column to move to

                  +
                  keepDesiredColumnBoolean

                  Required. If true, the cursor move does not respect the previous column

                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                    +
                  • +
                      +
                    • Selection.moveCursorToPosition(Object position)
                    • +
                    +
                      +
                    +
                  • +
                  +
                  +
                  +

                  Moves the selection to the position indicated by its row and column.

                  + +
                  +

                  Moves the selection to the position indicated by its row and column.

                  + +

                  Arguments

                  positionObject

                  Required. The position to move to

                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                    +
                  • + +
                      +
                    +
                  • +
                  +
                  +
                  +

                  Moves the cursor to the screen position indicated by row and column. If preventUpdateDesiredColumn is true, then the cursor stays in the same column position as its original point.

                  + +
                  +

                  Moves the cursor to the screen position indicated by row and column. If preventUpdateDesiredColumn is true, then the cursor stays in the same column position as its original point.

                  + +

                  Arguments

                  rowNumber

                  Required. The row to move to

                  +
                  columnNumber

                  Required. The column to move to

                  +
                  keepDesiredColumnBoolean

                  Required. If true, the cursor move does not respect the previous column

                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                    +
                  • +
                      +
                    • Selection.moveCursorUp
                    • +
                    +
                      +
                    +
                  • +
                  +
                  +
                  +

                  Moves the cursor up one row.

                  + +
                  +

                  Moves the cursor up one row.

                  + +

                  Arguments

                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                    +
                  • +
                      +
                    • Selection.moveCursorWordLeft
                    • +
                    +
                      +
                    • Undocumented
                    • +
                    +
                  • +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                    +
                  • +
                      +
                    • Selection.moveCursorWordRight
                    • +
                    +
                      +
                    • Undocumented
                    • +
                    +
                  • +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                    +
                  • +
                      +
                    • Selection.rectangularRangeBlock(Cursor screenCursor, Anchor screenAnchor, Boolean includeEmptyLines)
                    • +
                    +
                      +
                    +
                  • +
                  +
                  +
                  +

                  Gets list of ranges composing rectangular block on the screen

                  + +
                  +

                  Gets list of ranges composing rectangular block on the screen

                  + +

                  Arguments

                  screenCursorCursor

                  Required. The cursor to use

                  +
                  screenAnchorAnchor

                  Required. The anchor to use

                  +
                  includeEmptyLinesBoolean

                  Required. If true, this includes ranges inside the block which are empty due to clipping

                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                    +
                  • +
                      +
                    • Selection.selectAll
                    • +
                    +
                      +
                    +
                  • +
                  +
                  +
                  +

                  Selects all the text in the document.

                  + +
                  +

                  Selects all the text in the document.

                  + +

                  Arguments

                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                    +
                  • +
                      +
                    • Selection.selectAWord
                    • +
                    +
                      +
                    +
                  • +
                  +
                  +
                  +

                  Selects a word, including its right whitespace.

                  + +
                  +

                  Selects a word, including its right whitespace.

                  + +

                  Arguments

                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                    +
                  • +
                      +
                    • Selection.selectDown
                    • +
                    +
                      +
                    +
                  • +
                  +
                  +
                  +

                  Moves the selection down one row.

                  + +
                  +

                  Moves the selection down one row.

                  + +

                  Arguments

                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                    +
                  • +
                      +
                    • Selection.selectFileEnd
                    • +
                    +
                      +
                    +
                  • +
                  +
                  +
                  +

                  Moves the selection to the end of the file.

                  + +
                  +

                  Moves the selection to the end of the file.

                  + +

                  Arguments

                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                    +
                  • +
                      +
                    • Selection.selectFileStart
                    • +
                    +
                      +
                    +
                  • +
                  +
                  +
                  +

                  Moves the selection to the start of the file.

                  + +
                  +

                  Moves the selection to the start of the file.

                  + +

                  Arguments

                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                    +
                  • +
                      +
                    • Selection.selectLeft
                    • +
                    +
                      +
                    +
                  • +
                  +
                  +
                  +

                  Moves the selection left one column.

                  + +
                  +

                  Moves the selection left one column.

                  + +

                  Arguments

                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                    +
                  • +
                      +
                    • Selection.selectLine
                    • +
                    +
                      +
                    +
                  • +
                  +
                  +
                  +

                  Selects the entire line.

                  + +
                  +

                  Selects the entire line.

                  + +

                  Arguments

                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                    +
                  • +
                      +
                    • Selection.selectLineEnd
                    • +
                    +
                      +
                    +
                  • +
                  +
                  +
                  +

                  Moves the selection to the end of the current line.

                  + +
                  +

                  Moves the selection to the end of the current line.

                  + +

                  Arguments

                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                    +
                  • +
                      +
                    • Selection.selectLineStart
                    • +
                    +
                      +
                    +
                  • +
                  +
                  +
                  +

                  Moves the selection to the beginning of the current line.

                  + +
                  +

                  Moves the selection to the beginning of the current line.

                  + +

                  Arguments

                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                    +
                  • +
                      +
                    • Selection.selectRight
                    • +
                    +
                      +
                    +
                  • +
                  +
                  +
                  +

                  Moves the selection right one column.

                  + +
                  +

                  Moves the selection right one column.

                  + +

                  Arguments

                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                    +
                  • + +
                      +
                    +
                  • +
                  +
                  +
                  +

                  Moves the selection cursor to the indicated row and column.

                  + +
                  +

                  Moves the selection cursor to the indicated row and column.

                  + +

                  Arguments

                  rowNumber

                  Required. The row to select to

                  +
                  columnNumber

                  Required. The column to select to

                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                    +
                  • +
                      +
                    • Selection.selectToPosition(Object pos)
                    • +
                    +
                      +
                    +
                  • +
                  +
                  +
                  +

                  Moves the selection cursor to the row and column indicated by pos.

                  + +
                  +

                  Moves the selection cursor to the row and column indicated by pos.

                  + +

                  Arguments

                  posObject

                  Required. An object containing the row and column

                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                    +
                  • +
                      +
                    • Selection.selectUp
                    • +
                    +
                      +
                    +
                  • +
                  +
                  +
                  +

                  Moves the selection up one row.

                  + +
                  +

                  Moves the selection up one row.

                  + +

                  Arguments

                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                    +
                  • +
                      +
                    • Selection.selectWord
                    • +
                    +
                      +
                    +
                  • +
                  +
                  +
                  +

                  Selects an entire word boundary.

                  + +
                  +

                  Selects an entire word boundary.

                  + +

                  Arguments

                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                    +
                  • +
                      +
                    • Selection.selectWordLeft
                    • +
                    +
                      +
                    +
                  • +
                  +
                  +
                  +

                  Moves the selection to the first word on the left.

                  + +
                  +

                  Moves the selection to the first word on the left.

                  + +

                  Arguments

                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                    +
                  • +
                      +
                    • Selection.selectWordRight
                    • +
                    +
                      +
                    +
                  • +
                  +
                  +
                  +

                  Moves the selection to the first word on the right.

                  + +
                  +

                  Moves the selection to the first word on the right.

                  + +

                  Arguments

                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                    +
                  • +
                      +
                    • Selection.setSelectionAnchor(Number row, Number column)
                    • +
                    +
                      +
                    +
                  • +
                  +
                  +
                  +

                  Sets the row and column position of the anchor. This function also emits the 'changeSelection' event.

                  + +
                  +

                  Sets the row and column position of the anchor. This function also emits the 'changeSelection' event.

                  + +

                  Arguments

                  rowNumber

                  Required. The new row

                  +
                  columnNumber

                  Required. The new column

                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                    +
                  • +
                      +
                    • Selection.setSelectionRange(Range range, Boolean reverse)
                    • +
                    +
                      +
                    +
                  • +
                  +
                  +
                  +

                  Sets the selection to the provided range.

                  + +
                  +

                  Sets the selection to the provided range.

                  + +

                  Arguments

                  rangeRange

                  Required. The range of text to select

                  +
                  reverseBoolean

                  Required. Indicates if the range should go backwards (true) or not

                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                    +
                  • +
                      +
                    • Selection.shiftSelection(Number columns)
                    • +
                    +
                      +
                    +
                  • +
                  +
                  +
                  +

                  Shifts the selection up (or down, if isBackwards() is true) the given number of columns.

                  + +
                  +

                  Shifts the selection up (or down, if isBackwards() is true) the given number of columns.

                  + +

                  Arguments

                  columnsNumber

                  Required. The number of columns to shift by

                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                    +
                  • +
                      +
                    • Selection.splitIntoLines
                    • +
                    +
                      +
                    +
                  • +
                  +
                  +
                  +

                  Splits all the ranges into lines.

                  + +
                  +

                  Splits all the ranges into lines.

                  + +

                  Arguments

                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                    +
                  • +
                      +
                    • Selection.substractPoint(Range pos)
                    • +
                    +
                      +
                    +
                  • +
                  +
                  +
                  +

                  Removes a Range containing pos (if it exists).

                  + +
                  +

                  Removes a Range containing pos (if it exists).

                  + +

                  Arguments

                  posRange

                  Required. The position to remove, as a {row, column} object

                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                    +
                  • +
                      +
                    • Selection.toggleBlockSelection
                    • +
                    +
                      +
                    • Undocumented
                    • +
                    +
                  • +
                  +
                  +
                  +
                  +
                  +
                  +

                  Arguments

                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                    +
                  • +
                      +
                    • Selection.toOrientedRange
                    • +
                    +
                      +
                    • Undocumented
                    • +
                    +
                  • +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                    +
                  • +
                      +
                    • Selection.toSingleRange
                    • +
                    +
                      +
                    • Undocumented
                    • +
                    +
                  • +
                  +
                  +
                  +
                  +
                  +
                  +

                  Arguments

                  +
                  +
                  +
                  +
                  +
                  +
                  + + + + + +
                  +
                  \ No newline at end of file diff --git a/doc/resources/ace/templates/lib.jade b/doc/resources/ace/templates/lib.jade index 24505ac7..508eaf10 100644 --- a/doc/resources/ace/templates/lib.jade +++ b/doc/resources/ace/templates/lib.jade @@ -198,9 +198,6 @@ mixin render_starting_tabs(obj, pos) -methodSection = constructorSection = propertySection = eventSection = false; mixin article(obj, []) -mixin rewriteLink(text) - != text.replace('a', 'bbbb') - mixin short_description_list(collection) ul.method-details-list for obj in collection diff --git a/lib/ace/selection.js b/lib/ace/selection.js index 7cb2c685..71a17f34 100644 --- a/lib/ace/selection.js +++ b/lib/ace/selection.js @@ -38,7 +38,6 @@ var Range = require("./range").Range; /** * - * * Contains the cursor position and the text selection of an edit session. * * The row/columns used in the selection are in document coordinates representing ths coordinates as thez appear in the document before applying soft wrap and folding.