From 17fcc4292319e5d5a0e9a665bb09e7a230fd37f5 Mon Sep 17 00:00:00 2001 From: Garen Torikian Date: Fri, 17 Aug 2012 12:27:56 -0700 Subject: [PATCH] Update API docs --- api/ace.html | 2 +- api/anchor.html | 22 +- api/background_tokenizer.html | 68 +- api/document.html | 61 +- api/edit_session.html | 428 ++++---- api/editor.html | 1003 ++++++++---------- api/index.html | 4 +- api/placeholder.html | 26 +- api/range.html | 62 +- api/resources/javascripts/ux.js | 8 - api/scrollbar.html | 25 +- api/search.html | 51 +- api/selection.html | 276 +++-- api/split.html | 28 +- api/token_iterator.html | 12 +- api/tokenizer.html | 4 +- api/undomanager.html | 36 +- api/virtual_renderer.html | 205 ++-- doc/build.js | 2 +- doc/package.json | 2 +- doc/resources/ace/skeleton/csses/ace_api.css | 4 +- doc/resources/ace/templates/lib.jade | 6 +- lib/ace/background_tokenizer.js | 5 +- lib/ace/edit_session.js | 3 +- lib/ace/editor.js | 14 +- lib/ace/scrollbar.js | 2 +- package.json | 3 +- 27 files changed, 1176 insertions(+), 1186 deletions(-) diff --git a/api/ace.html b/api/ace.html index 555ad9ff..68aead6f 100644 --- a/api/ace.html +++ b/api/ace.html @@ -151,7 +151,7 @@
-

This method embeds the Ace editor into the DOM, at the element provided by el. ...

+

This method embeds the Ace editor into the DOM, at the element provided by el.

This method embeds the Ace editor into the DOM, at the element provided by el.

diff --git a/api/anchor.html b/api/anchor.html index 4b8d347d..851ccc56 100644 --- a/api/anchor.html +++ b/api/anchor.html @@ -104,7 +104,7 @@
-

Creates a new Anchor and associates it with a document. ...

+

Creates a new Anchor and associates it with a document.

Creates a new Anchor and associates it with a document.

@@ -175,14 +175,14 @@

Events

-
+
    • -
    • Anchor.on("onChange", function(Event e))
      • +
    • Anchor.on("change", function(Event e))
    @@ -190,13 +190,13 @@
-

Fires whenever the anchor position changes. Events that can trigger this function include 'includeText', `'insertL...

+

Fires whenever the anchor position changes. Events that can trigger this function include 'insertText', 'insertLines', 'removeText', and 'removeLines'.

-

Fires whenever the anchor position changes. Events that can trigger this function include 'includeText', 'insertLines', 'removeText', and 'removeLines'.

+

Fires whenever the anchor position changes. Events that can trigger this function include 'insertText', 'insertLines', 'removeText', and 'removeLines'.

-

   

+

   

Arguments

eEventRequired. Contains data about the event
@@ -220,7 +220,7 @@
-

When called, the 'change' event listener is removed. ...

+

When called, the 'change' event listener is removed.

When called, the 'change' event listener is removed.

@@ -253,7 +253,7 @@
-

Returns the current document. ...

+

Returns the current document.

Returns the current document.

@@ -286,7 +286,7 @@
-

Returns an object identifying the row and column position of the current anchor. ...

+

Returns an object identifying the row and column position of the current anchor.

Returns an object identifying the row and column position of the current anchor.

@@ -314,7 +314,7 @@
-

Sets the anchor position to the specified row and column. If noClip is true, the position is not clipped. ...

+

Sets the anchor position to the specified row and column. If noClip is true, the position is not clipped.

Sets the anchor position to the specified row and column. If noClip is true, the position is not clipped.

diff --git a/api/background_tokenizer.html b/api/background_tokenizer.html index f1d0637c..af85f5a6 100644 --- a/api/background_tokenizer.html +++ b/api/background_tokenizer.html @@ -110,10 +110,8 @@ -
  • Functions (8) +
  • Functions (7)
    • -

    Tokenizes the current Document in the background, and caches the tokenized rows for future use. If a certain row is changed, everything below that row is re-tokenized.

    +

    Tokenizes the current Document in the background, and caches the tokenized rows for future use. If a certain row is changed, everything below that row is re-tokenized.

    @@ -164,7 +162,7 @@
    -

    Creates a new BackgroundTokenizer object. ...

    +

    Creates a new BackgroundTokenizer object.

    Creates a new BackgroundTokenizer object.

    @@ -179,41 +177,6 @@

    Methods

    -
    -
    -
    -
    -
      -
    • -
        -
      • BackgroundTokenizer.$tokenizeRows(Number firstRow, Number lastRow) -
      • - -
        • -
      -
        -
      -
      • -
    -
    -
    -

    Tokenizes all the rows within the specified region. ...

    - -
    -

    Tokenizes all the rows within the specified region.

    - -
    -

       

    -
    -

    Arguments

    startRowNumberRequired. The row to start at
    lastRowNumberRequired. The row to finish at
    -

    Returns

    Array of ObjectsA list of the tokenized rows. Each item in the list is an object with two properties, state and start.
    -
    -
    -
    -
    -
    @@ -229,7 +192,7 @@
    -

    Emits the 'update' event. firstRow and lastRow are used to define the boundaries of the region to be updated. ...

    +

    Emits the 'update' event. firstRow and lastRow are used to define the boundaries of the region to be updated.

    Emits the 'update' event. firstRow and lastRow are used to define the boundaries of the region to be updated.

    @@ -263,15 +226,15 @@
    -

    Returns the state of tokenization for a row.

    +

    [Returns the state of tokenization at the end of a row.]{: #BackgroundTokenizer.getState}

    -

    Returns the state of tokenization for a row.

    +

    [Returns the state of tokenization at the end of a row.]{: #BackgroundTokenizer.getState}

       

    -

    Arguments

    rowNumberRequired. The row to start at
    +

    Arguments

    rowNumberRequired. The row to get state at
    @@ -284,7 +247,7 @@
    -

    Starts tokenizing at the row indicated. Returns a list of objects of the tokenized rows. ...

    +

    Gives list of tokens of the row. (tokens are cached)

    -

    Starts tokenizing at the row indicated. Returns a list of objects of the tokenized rows.

    +

    Gives list of tokens of the row. (tokens are cached)

       

    -

    Arguments

    firstRowNumberRequired. The row to start at
    lastRowNumberRequired. The row to finish at
    +

    Arguments

    firstRowNumberRequired. The row to get tokens at
    @@ -327,7 +289,7 @@
    -

    Sets a new document to associate with this object. ...

    +

    Sets a new document to associate with this object.

    Sets a new document to associate with this object.

    @@ -356,7 +318,7 @@
    -

    Sets a new tokenizer for this object. ...

    +

    Sets a new tokenizer for this object.

    Sets a new tokenizer for this object.

    @@ -385,7 +347,7 @@
    -

    Starts tokenizing at the row indicated. ...

    +

    Starts tokenizing at the row indicated.

    Starts tokenizing at the row indicated.

    @@ -414,7 +376,7 @@
    -

    Stops tokenizing. ...

    +

    Stops tokenizing.

    Stops tokenizing.

    diff --git a/api/document.html b/api/document.html index c6a162ee..a302b8ec 100644 --- a/api/document.html +++ b/api/document.html @@ -173,7 +173,7 @@
    -

    Contains the text of the document. Documents are controlled by a single EditSession. At its core, Documents are just an array of strings, with each row in the document matching up to the array index.

    +

    Contains the text of the document. Document can be attached to several EditSessions. At its core, Documents are just an array of strings, with each row in the document matching up to the array index.

    @@ -194,7 +194,7 @@
    -

    Creates a new Document. If text is included, the Document contains those strings; otherwise, it's empty. ...

    +

    Creates a new Document. If text is included, the Document contains those strings; otherwise, it's empty.

    Creates a new Document. If text is included, the Document contains those strings; otherwise, it's empty.

    @@ -229,7 +229,7 @@
    -

    Applies all the changes previously accumulated. These can be either 'includeText', 'insertLines', 'removeText'...

    +

    Applies all the changes previously accumulated. These can be either 'includeText', 'insertLines', 'removeText', and 'removeLines'.

    Applies all the changes previously accumulated. These can be either 'includeText', 'insertLines', 'removeText', and 'removeLines'.

    @@ -262,7 +262,7 @@
    -

    Creates a new Anchor to define a floating point in the document. ...

    +

    Creates a new Anchor to define a floating point in the document.

    Creates a new Anchor to define a floating point in the document.

    @@ -296,7 +296,7 @@
    -

    Returns all lines in the document as string array. Warning: The caller should not modify this array! ...

    +

    Returns all lines in the document as string array. Warning: The caller should not modify this array!

    Returns all lines in the document as string array. Warning: The caller should not modify this array!

    @@ -329,7 +329,7 @@
    -

    Returns the number of rows in the document. ...

    +

    Returns the number of rows in the document.

    Returns the number of rows in the document.

    @@ -362,7 +362,7 @@
    -

    Returns a verbatim copy of the given line as it is in the document ...

    +

    Returns a verbatim copy of the given line as it is in the document

    Returns a verbatim copy of the given line as it is in the document

    @@ -396,7 +396,7 @@
    -

    Returns an array of strings of the rows between firstRow and lastRow. This function is inclusive of lastRow. ...

    +

    Returns an array of strings of the rows between firstRow and lastRow. This function is inclusive of lastRow.

    Returns an array of strings of the rows between firstRow and lastRow. This function is inclusive of lastRow.

    @@ -430,7 +430,7 @@
    -

    Returns the newline character that's being used, depending on the value of newLineMode. ...

    +

    Returns the newline character that's being used, depending on the value of newLineMode.

    Returns the newline character that's being used, depending on the value of newLineMode.

    @@ -464,10 +464,10 @@
    -

    Returns the type of newlines being used; either windows, unix, or auto

    +

    [Returns the type of newlines being used; either windows, unix, or auto]{: #Document.getNewLineMode}

    -

    Returns the type of newlines being used; either windows, unix, or auto

    +

    [Returns the type of newlines being used; either windows, unix, or auto]{: #Document.getNewLineMode}

       

    @@ -497,10 +497,10 @@
    -

    [Given a range within the document, this function returns all the text within that range as a single string.]{: #Doc...

    +

    [Given a range within the document, this function returns all the text within that range as a single string.]{: #Document.getTextRange.desc}

    -

    Given a range within the document, this function returns all the text within that range as a single string.

    +

    [Given a range within the document, this function returns all the text within that range as a single string.]{: #Document.getTextRange.desc}

       

    @@ -531,7 +531,7 @@
    -

    Returns all the lines in the document as a single string, split by the new line character. ...

    +

    Returns all the lines in the document as a single string, split by the new line character.

    Returns all the lines in the document as a single string, split by the new line character.

    @@ -564,11 +564,6 @@
    -

    ...

    - -
    -
    -

       

    Arguments

    positionNumberRequired. The position to start inserting at
    textStringRequired. A chunk of text to insert
    @@ -599,7 +594,7 @@
    -

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

    +

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

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

    @@ -634,7 +629,7 @@
    -

    Inserts the elements in lines into the document, starting at the row index given by row. This method also trigge...

    +

    Inserts the elements in lines into the document, starting at the row index given by row. This method also triggers the 'change' event.

    Inserts the elements in lines into the document, starting at the row index given by row. This method also triggers the 'change' event.

    @@ -669,7 +664,7 @@
    -

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

    +

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

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

    @@ -704,7 +699,7 @@
    -

    Returns true if text is a newline character (either \r\n, \r, or \n). ...

    +

    Returns true if text is a newline character (either \r\n, \r, or \n).

    Returns true if text is a newline character (either \r\n, \r, or \n).

    @@ -738,7 +733,7 @@
    -

    Removes the range from the document. ...

    +

    Removes the range from the document.

    Removes the range from the document.

    @@ -773,7 +768,7 @@
    -

    Removes the specified columns from the row. This method also triggers the 'change' event. ...

    +

    Removes the specified columns from the row. This method also triggers the 'change' event.

    Removes the specified columns from the row. This method also triggers the 'change' event.

    @@ -808,7 +803,7 @@
    -

    Removes a range of full lines. This method also triggers the 'change' event. ...

    +

    Removes a range of full lines. This method also triggers the 'change' event.

    Removes a range of full lines. This method also triggers the 'change' event.

    @@ -843,7 +838,7 @@
    -

    Removes the new line between row and the row immediately following it. This method also triggers the 'change' event. ...

    +

    Removes the new line between row and the row immediately following it. This method also triggers the 'change' event.

    Removes the new line between row and the row immediately following it. This method also triggers the 'change' event.

    @@ -877,7 +872,7 @@
    -

    Replaces a range in the document with the new text. ...

    +

    Replaces a range in the document with the new text.

    Replaces a range in the document with the new text.

    @@ -912,7 +907,7 @@
    -

    Reverts any changes previously applied. These can be either 'includeText', 'insertLines', 'removeText', and `'...

    +

    Reverts any changes previously applied. These can be either 'includeText', 'insertLines', 'removeText', and 'removeLines'.

    Reverts any changes previously applied. These can be either 'includeText', 'insertLines', 'removeText', and 'removeLines'.

    @@ -945,15 +940,15 @@
    -

    Sets the new line mode.

    +

    [Sets the new line mode.]{: #Document.setNewLineMode.desc}

    -

    Sets the new line mode.

    +

    [Sets the new line mode.]{: #Document.setNewLineMode.desc}

       

    -

    Arguments

    newLineModeStringRequired. The newline mode to use; can be either windows, unix, or auto
    +

    Arguments

    newLineModeStringRequired. [The newline mode to use; can be either windows, unix, or auto]{: #Document.setNewLineMode.param}
    @@ -979,7 +974,7 @@
    -

    Replaces all the lines in the current Document with the value of text. ...

    +

    Replaces all the lines in the current Document with the value of text.

    Replaces all the lines in the current Document with the value of text.

    diff --git a/api/edit_session.html b/api/edit_session.html index b5536b53..8841d85a 100644 --- a/api/edit_session.html +++ b/api/edit_session.html @@ -102,13 +102,17 @@

    EditSession[edit]

    -

    Stores various states related to a Document. A single EditSession can be in charge of several Documents.

    +

    Stores all the data about Editor state providing easy way to change editors state. EditSession can be attached to only one Document. Same Document can be attached to several EditSessions.

    @@ -300,7 +304,7 @@
    -

    Sets up a new EditSession and associates it with the given Document and TextMode. ...

    +

    Sets up a new EditSession and associates it with the given Document and TextMode.

    Sets up a new EditSession and associates it with the given Document and TextMode.

    @@ -315,14 +319,14 @@

    Events

    -
    +
      • -
      • EditSession.on("onChange", function(e))
        • +
      • EditSession.on("change", function(e))
      @@ -330,27 +334,27 @@
    -

    Emitted when the document changes. ...

    +

    Emitted when the document changes.

    -

    Emitted when the document changes.

    +

    Emitted when the document changes.

    -

       

    +

       

    -
    +
      • -
      • EditSession.on("onChangeFold", function(e))
        • +
      • EditSession.on("changeFold", function(e))
      @@ -358,27 +362,27 @@
    -

    Emitted when a code fold changes its state. ...

    +

    Emitted when a code fold added or removed.

    -

    Emitted when a code fold changes its state.

    +

    Emitted when a code fold added or removed.

    -

       

    +

       

    -
    +
      • -
      • EditSession.on("onReloadTokenizer", function(e))
        • +
      • EditSession.on("changeScrollLeft", function())
      @@ -386,13 +390,69 @@
    -

    Reloads all the tokens on the current session. This function calls [[BackgroundTokenizer.start `BackgroundTokenizer....

    +

    Emitted when the scroll left changes.

    -

    Reloads all the tokens on the current session. This function calls BackgroundTokenizer.start () to all the rows; it also emits the 'tokenizerUpdate' event.

    +

    Emitted when the scroll left changes.

    -

       

    +

       

    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
      +
    • +
        +
      • EditSession.on("changeScrollTop", function())
        • +
      +
        +
      +
      • +
    +
    +
    +

    Emitted when the scroll top changes.

    + +
    +

    Emitted when the scroll top changes.

    + +
    +

       

    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
      +
    • +
        +
      • EditSession.on("tokenizerUpdate", function(e))
        • +
      +
        +
      +
      • +
    +
    +
    +

    Emitted when a background tokenizer asynchronousely processes new rows.

    + +
    +

    Emitted when a background tokenizer asynchronousely processes new rows.

    + +
    +

       

    @@ -400,6 +460,40 @@

    Methods

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

    Adds a dynamic marker to the session.

    + +
    +

    Adds a dynamic marker to the session.

    + +
    +

       

    +
    +

    Arguments

    markerObjectRequired. object with update method
    inFrontBooleanRequired. Set to true to establish a front marker
    +
    +
    +
    +
    +
    @@ -420,7 +514,7 @@
    -

    Adds a new marker to the given Range. If inFront is true, a front marker is defined, and the `'changeFrontMark...

    +

    Adds a new marker to the given Range. If inFront is true, a front marker is defined, and the 'changeFrontMarker' event fires; otherwise, the 'changeBackMarker' event fires.

    Adds a new marker to the given Range. If inFront is true, a front marker is defined, and the 'changeFrontMarker' event fires; otherwise, the 'changeBackMarker' event fires.

    @@ -449,7 +543,7 @@
    -

    Clears all the annotations for this session. This function also triggers the 'changeAnnotation' event. ...

    +

    Clears all the annotations for this session. This function also triggers the 'changeAnnotation' event.

    Clears all the annotations for this session. This function also triggers the 'changeAnnotation' event.

    @@ -477,7 +571,7 @@
    -

    Removes a breakpoint on the row number given by rows. This function also emites the 'changeBreakpoint' event. ...

    +

    Removes a breakpoint on the row number given by rows. This function also emites the 'changeBreakpoint' event.

    Removes a breakpoint on the row number given by rows. This function also emites the 'changeBreakpoint' event.

    @@ -506,7 +600,7 @@
    -

    Removes all breakpoints on the rows. This function also emites the 'changeBreakpoint' event. ...

    +

    Removes all breakpoints on the rows. This function also emites the 'changeBreakpoint' event.

    Removes all breakpoints on the rows. This function also emites the 'changeBreakpoint' event.

    @@ -540,10 +634,10 @@
    -

    Converts document coordinates to screen coordinates. This takes into account code folding, word wrap, tab size, and any other visual modifications. ...

    +

    Converts document coordinates to screen coordinates. {:conversionConsiderations}

    -

    Converts document coordinates to screen coordinates. This takes into account code folding, word wrap, tab size, and any other visual modifications.

    +

    Converts document coordinates to screen coordinates. {:conversionConsiderations}

       

    @@ -575,7 +669,7 @@
    -

    Duplicates all the text between firstRow and lastRow. ...

    +

    Duplicates all the text between firstRow and lastRow.

    Duplicates all the text between firstRow and lastRow.

    @@ -610,7 +704,7 @@
    -

    Returns the annotations for the EditSession. ...

    +

    Returns the annotations for the EditSession.

    Returns the annotations for the EditSession.

    @@ -643,7 +737,7 @@
    -

    Gets the range of a word, including its right whitespace. ...

    +

    Gets the range of a word, including its right whitespace.

    Gets the range of a word, including its right whitespace.

    @@ -677,7 +771,7 @@
    -

    Returns an array of numbers, indicating which rows have breakpoints. ...

    +

    Returns an array of numbers, indicating which rows have breakpoints.

    Returns an array of numbers, indicating which rows have breakpoints.

    @@ -710,7 +804,7 @@
    -

    Returns the Document associated with this session. ...

    +

    Returns the Document associated with this session.

    Returns the Document associated with this session.

    @@ -744,7 +838,7 @@
    -

    Returns the number of rows in the document. ...

    +

    Returns the number of rows in the document.

    Returns the number of rows in the document.

    @@ -778,7 +872,7 @@
    -

    Returns a verbatim copy of the given line as it is in the document ...

    +

    Returns a verbatim copy of the given line as it is in the document

    Returns a verbatim copy of the given line as it is in the document

    @@ -813,7 +907,7 @@
    -

    Returns an array of strings of the rows between firstRow and lastRow. This function is inclusive of lastRow. ...

    +

    Returns an array of strings of the rows between firstRow and lastRow. This function is inclusive of lastRow.

    Returns an array of strings of the rows between firstRow and lastRow. This function is inclusive of lastRow.

    @@ -847,7 +941,7 @@
    -

    Returns an array containing the IDs of all the markers, either front or back. ...

    +

    Returns an array containing the IDs of all the markers, either front or back.

    Returns an array containing the IDs of all the markers, either front or back.

    @@ -881,7 +975,7 @@
    -

    Returns the current text mode. ...

    +

    Returns the current text mode.

    Returns the current text mode.

    @@ -915,7 +1009,7 @@
    -

    Returns the current new line mode. ...

    +

    Returns the current new line mode.

    Returns the current new line mode.

    @@ -948,7 +1042,7 @@
    -

    Returns true if overwrites are enabled; false otherwise. ...

    +

    Returns true if overwrites are enabled; false otherwise.

    Returns true if overwrites are enabled; false otherwise.

    @@ -961,40 +1055,6 @@
    -
    -
    -
    -
    - -
    -
    -

    Returns the height of the indicated row. This is mostly relevant for situations where wrapping occurs, and a single ...

    - -
    -

    Returns the height of the indicated row. This is mostly relevant for situations where wrapping occurs, and a single line spans across multiple rows.

    - -
    -

       

    -
    -

    Arguments

    configObjectRequired. An object containing a parameter indicating the lineHeight.
    rowNumberRequired. The row number to check
    -
    -
    -
    -
    -
    @@ -1015,10 +1075,10 @@
    -

    Returns the length of the indicated row. ...

    +

    Returns number of screenrows in a wrapped line.

    -

    Returns the length of the indicated row.

    +

    Returns number of screenrows in a wrapped line.

       

    @@ -1049,7 +1109,7 @@
    -

    Returns the length of the screen. ...

    +

    Returns the length of the screen.

    Returns the length of the screen.

    @@ -1082,7 +1142,7 @@
    -

    The distance to the next tab stop at the specified screen column. ...

    +

    The distance to the next tab stop at the specified screen column.

    The distance to the next tab stop at the specified screen column.

    @@ -1116,7 +1176,7 @@
    -

    Returns the width of the screen. ...

    +

    Returns the width of the screen.

    Returns the width of the screen.

    @@ -1149,10 +1209,10 @@
    -

    [Returns the value of the distance between the left of the editor and the leftmost part of the visible content.]{: #...

    +

    [Returns the value of the distance between the left of the editor and the leftmost part of the visible content.]{: #EditSession.getScrollLeft}

    -

    Returns the value of the distance between the left of the editor and the leftmost part of the visible content.

    +

    [Returns the value of the distance between the left of the editor and the leftmost part of the visible content.]{: #EditSession.getScrollLeft}

       

    @@ -1182,10 +1242,10 @@
    -

    [Returns the value of the distance between the top of the editor and the topmost part of the visible content.]{: #Ed...

    +

    [Returns the value of the distance between the top of the editor and the topmost part of the visible content.]{: #EditSession.getScrollTop}

    -

    Returns the value of the distance between the top of the editor and the topmost part of the visible content.

    +

    [Returns the value of the distance between the top of the editor and the topmost part of the visible content.]{: #EditSession.getScrollTop}

       

    @@ -1215,7 +1275,7 @@
    -

    Returns the string of the current selection. ...

    +

    Returns the string of the current selection.

    Returns the string of the current selection.

    @@ -1249,10 +1309,10 @@
    -

    Returns the state of tokenization for a row. ...

    +

    {:BackgroundTokenizer.getState}

    -

    Returns the state of tokenization for a row.

    +

    {:BackgroundTokenizer.getState}

       

    @@ -1283,7 +1343,7 @@
    -

    Returns the current tab size. ...

    +

    Returns the current tab size.

    Returns the current tab size.

    @@ -1316,7 +1376,7 @@
    -

    Returns the current value for tabs. If the user is using soft tabs, this will be a series of spaces (defined by [[Ed...

    +

    Returns the current value for tabs. If the user is using soft tabs, this will be a series of spaces (defined by getTabSize); otherwise it's simply '\t'.

    Returns the current value for tabs. If the user is using soft tabs, this will be a series of spaces (defined by getTabSize); otherwise it's simply '\t'.

    @@ -1350,10 +1410,10 @@
    -

    Given a range within the document, this function returns all the text within that range as a single string. ...

    +

    {:Document.getTextRange.desc}

    -

    Given a range within the document, this function returns all the text within that range as a single string.

    +

    {:Document.getTextRange.desc}

       

    @@ -1384,7 +1444,7 @@
    -

    Returns an array of tokens at the indicated row and column. ...

    +

    Returns an array of tokens at the indicated row and column.

    Returns an array of tokens at the indicated row and column.

    @@ -1405,7 +1465,7 @@
      • -
      • EditSession.getTokens(Number firstRow, Number lastRow) +
      • EditSession.getTokens(Number row)
        • Array
          • @@ -1419,7 +1479,7 @@
    -

    Starts tokenizing at the row indicated. Returns a list of objects of the tokenized rows. ...

    +

    Starts tokenizing at the row indicated. Returns a list of objects of the tokenized rows.

    Starts tokenizing at the row indicated. Returns a list of objects of the tokenized rows.

    @@ -1427,7 +1487,7 @@

       

    -

    Arguments

    firstRowNumberRequired. The row to start at
    lastRowNumberRequired. The row to finish at
    +

    Arguments

    rowNumberRequired. The row to start at
    @@ -1453,7 +1513,7 @@
    -

    Returns the current undo manager. ...

    +

    Returns the current undo manager.

    Returns the current undo manager.

    @@ -1486,7 +1546,7 @@
    -

    Returns true if soft tabs are being used, false otherwise. ...

    +

    Returns true if soft tabs are being used, false otherwise.

    Returns true if soft tabs are being used, false otherwise.

    @@ -1519,7 +1579,7 @@
    -

    Returns true if workers are being used. ...

    +

    Returns true if workers are being used.

    Returns true if workers are being used.

    @@ -1552,7 +1612,7 @@
    -

    Returns true if wrap mode is being used; false otherwise. ...

    +

    Returns true if wrap mode is being used; false otherwise.

    Returns true if wrap mode is being used; false otherwise.

    @@ -1586,10 +1646,10 @@
    -

    Returns the current Document as a string. ...

    +

    Returns the current Document as a string.

    -

    Returns the current Document as a string.

    +

    Returns the current Document as a string.

       

    @@ -1599,39 +1659,6 @@
    -
    -
    -
    -
    -
      -
    • -
        -
      • EditSession.getWidth() -
      • - -
        • -
      -
        -
      -
      • -
    -
    -
    -

    Returns the width of the document. ...

    - -
    -

    Returns the width of the document.

    - -
    -

       

    -
    -
    -
    -
    -
    -
    @@ -1652,7 +1679,7 @@
    -

    Given a starting row and column, this method returns the Range of the first word boundary it finds. ...

    +

    Given a starting row and column, this method returns the Range of the first word boundary it finds.

    Given a starting row and column, this method returns the Range of the first word boundary it finds.

    @@ -1686,7 +1713,7 @@
    -

    Returns the value of wrap limit. ...

    +

    Returns the value of wrap limit.

    Returns the value of wrap limit.

    @@ -1719,16 +1746,15 @@
    -

    Returns an object that defines the minimum and maximum of the wrap limit; it looks something like this: - ...

    +

    Returns an object that defines the minimum and maximum of the wrap limit; it looks something like this:

    -

    Returns an object that defines the minimum and maximum of the wrap limit; it looks something like this: -

    +

    Returns an object that defines the minimum and maximum of the wrap limit; it looks something like this:

    +
    { min: wrapLimitRange_min, max: wrapLimitRange_max }

       

    - 
    { min: wrapLimitRange_min, max: wrapLimitRange_max }
    + 
    { min: wrapLimitRange_min, max: wrapLimitRange_max }
    @@ -1750,12 +1776,11 @@
    -

    Indents all the rows, from startRow to endRow (inclusive), by prefixing each row with the token in indentString. - ...

    +

    Indents all the rows, from startRow to endRow (inclusive), by prefixing each row with the token in indentString.

    -

    Indents all the rows, from startRow to endRow (inclusive), by prefixing each row with the token in indentString. -

    +

    Indents all the rows, from startRow to endRow (inclusive), by prefixing each row with the token in indentString.

    +

    If indentString contains the '\t' character, it's replaced by whatever is defined by getTabString.

       

    @@ -1788,7 +1813,7 @@
    -

    Inserts a block of text and the indicated position. ...

    +

    Inserts a block of text and the indicated position.

    Inserts a block of text and the indicated position.

    @@ -1823,7 +1848,7 @@
    -

    Returns true if the character at the position is a soft tab. ...

    +

    Returns true if the character at the position is a soft tab.

    Returns true if the character at the position is a soft tab.

    @@ -1858,11 +1883,6 @@
    -

    ...

    - -
    -
    -

       

    Arguments

    firstRowNumberRequired. The starting row to move down
    lastRowNumberRequired. The final row to move down
    @@ -1893,7 +1913,7 @@
    -

    Shifts all the lines in the document up one, starting from firstRow and ending at lastRow. ...

    +

    Shifts all the lines in the document up one, starting from firstRow and ending at lastRow.

    Shifts all the lines in the document up one, starting from firstRow and ending at lastRow.

    @@ -1928,7 +1948,7 @@
    -

    { row: newRowLocation, column: newColumnLocation } ...

    +

    { row: newRowLocation, column: newColumnLocation }

    { row: newRowLocation, column: newColumnLocation }

    @@ -1943,6 +1963,34 @@
    +
    +
    +
    +
    +
      +
    • +
        +
      • EditSession.onReloadTokenizer(e)
        • +
      +
        +
      +
      • +
    +
    +
    +

    Reloads all the tokens on the current session. This function calls start to all the rows; it also emits the 'tokenizerUpdate' event.

    + +
    +

    Reloads all the tokens on the current session. This function calls start to all the rows; it also emits the 'tokenizerUpdate' event.

    + +
    +

       

    +
    +
    +
    +
    +
    +
    @@ -1958,7 +2006,7 @@
    -

    Outdents all the rows defined by the start and end properties of range. ...

    +

    Outdents all the rows defined by the start and end properties of range.

    Outdents all the rows defined by the start and end properties of range.

    @@ -1992,7 +2040,7 @@
    -

    Re-implements a previously undone change to your document. ...

    +

    Re-implements a previously undone change to your document.

    Re-implements a previously undone change to your document.

    @@ -2000,7 +2048,7 @@

       

    -

    Arguments

    deltasArrayRequired. An array of previous changes
    dontSelectBooleanRequired. If true, doesn't select the range of where the change occured
    +

    Arguments

    deltasArrayRequired. An array of previous changes
    dontSelectBooleanRequired. {:dontSelect}
    @@ -2027,7 +2075,7 @@
    -

    Removes the range from the document. ...

    +

    Removes the range from the document.

    Removes the range from the document.

    @@ -2057,7 +2105,7 @@
    -

    Removes the marker with the specified ID. If this marker was in front, the 'changeFrontMarker' event is emitted. I...

    +

    Removes the marker with the specified ID. If this marker was in front, the 'changeFrontMarker' event is emitted. If the marker was in the back, the 'changeBackMarker' event is emitted.

    Removes the marker with the specified ID. If this marker was in front, the 'changeFrontMarker' event is emitted. If the marker was in the back, the 'changeBackMarker' event is emitted.

    @@ -2092,7 +2140,7 @@
    -

    Replaces a range in the document with the new text. ...

    +

    Replaces a range in the document with the new text.

    Replaces a range in the document with the new text.

    @@ -2128,10 +2176,10 @@
    -

    Converts characters coordinates on the screen to characters coordinates within the document. [This takes into accoun...

    +

    Converts characters coordinates on the screen to characters coordinates within the document. [This takes into account code folding, word wrap, tab size, and any other visual modifications.]{: #conversionConsiderations}

    -

    This takes into account code folding, word wrap, tab size, and any other visual modifications.

    +

    Converts characters coordinates on the screen to characters coordinates within the document. [This takes into account code folding, word wrap, tab size, and any other visual modifications.]{: #conversionConsiderations}

       

    @@ -2158,7 +2206,7 @@
    -

    Sets annotations for the EditSession. This functions emits the 'changeAnnotation' event. ...

    +

    Sets annotations for the EditSession. This functions emits the 'changeAnnotation' event.

    Sets annotations for the EditSession. This functions emits the 'changeAnnotation' event.

    @@ -2187,7 +2235,7 @@
    -

    Sets a breakpoint on the row number given by rows. This function also emites the 'changeBreakpoint' event. ...

    +

    Sets a breakpoint on the row number given by rows. This function also emites the 'changeBreakpoint' event.

    Sets a breakpoint on the row number given by rows. This function also emites the 'changeBreakpoint' event.

    @@ -2216,7 +2264,7 @@
    -

    Sets a breakpoint on every row number given by rows. This function also emites the 'changeBreakpoint' event. ...

    +

    Sets a breakpoint on every row number given by rows. This function also emites the 'changeBreakpoint' event.

    Sets a breakpoint on every row number given by rows. This function also emites the 'changeBreakpoint' event.

    @@ -2245,7 +2293,7 @@
    -

    Sets the EditSession to point to a new Document. If a BackgroundTokenizer exists, it also points to doc. ...

    +

    Sets the EditSession to point to a new Document. If a BackgroundTokenizer exists, it also points to doc.

    Sets the EditSession to point to a new Document. If a BackgroundTokenizer exists, it also points to doc.

    @@ -2274,10 +2322,10 @@
    -

    Sets a new text mode for the EditSession. This method also emits the 'changeMode' event. If a [[BackgroundTokeni...

    +

    Sets a new text mode for the EditSession. This method also emits the 'changeMode' event. If a BackgroundTokenizer is set, the 'tokenizerUpdate' event is also emitted.

    -

    Sets a new text mode for the EditSession. This method also emits the 'changeMode' event. If a BackgroundTokenizer is set, the 'tokenizerUpdate' event is also emitted.

    +

    Sets a new text mode for the EditSession. This method also emits the 'changeMode' event. If a BackgroundTokenizer is set, the 'tokenizerUpdate' event is also emitted.

       

    @@ -2304,15 +2352,15 @@
    -

    Sets the new line mode. ...

    +

    {:Document.setNewLineMode.desc}

    -

    Sets the new line mode.

    +

    {:Document.setNewLineMode.desc}

       

    -

    Arguments

    newLineModeStringRequired. The newline mode to use; can be either windows, unix, or auto
    +

    Arguments

    newLineModeStringRequired. {:Document.setNewLineMode.param}
    @@ -2333,7 +2381,7 @@
    -

    Pass in true to enable overwrites in your session, or false to disable. If overwrites is enabled, any text you e...

    +

    Pass in true to enable overwrites in your session, or false to disable. If overwrites is enabled, any text you enter will type over any text after it. If the value of overwrite changes, this function also emites the changeOverwrite event.

    Pass in true to enable overwrites in your session, or false to disable. If overwrites is enabled, any text you enter will type over any text after it. If the value of overwrite changes, this function also emites the changeOverwrite event.

    @@ -2362,10 +2410,10 @@
    -

    [Sets the value of the distance between the left of the editor and the leftmost part of the visible content.]{: #Edi...

    +

    [Sets the value of the distance between the left of the editor and the leftmost part of the visible content.]{: #EditSession.setScrollLeft}

    -

    Sets the value of the distance between the left of the editor and the leftmost part of the visible content.

    +

    [Sets the value of the distance between the left of the editor and the leftmost part of the visible content.]{: #EditSession.setScrollLeft}

       

    @@ -2390,7 +2438,7 @@
    -

    This function sets the scroll top value. It also emits the 'changeScrollTop' event. ...

    +

    This function sets the scroll top value. It also emits the 'changeScrollTop' event.

    This function sets the scroll top value. It also emits the 'changeScrollTop' event.

    @@ -2419,7 +2467,7 @@
    -

    Set the number of spaces that define a soft tab; for example, passing in 4 transforms the soft tabs to be equivale...

    +

    Set the number of spaces that define a soft tab; for example, passing in 4 transforms the soft tabs to be equivalent to four spaces. This function also emits the changeTabSize event.

    Set the number of spaces that define a soft tab; for example, passing in 4 transforms the soft tabs to be equivalent to four spaces. This function also emits the changeTabSize event.

    @@ -2448,7 +2496,7 @@
    -

    Sets the undo manager. ...

    +

    Sets the undo manager.

    Sets the undo manager.

    @@ -2477,7 +2525,7 @@
    -

    ENables or disables highlighting of the range where an undo occured. ...

    +

    ENables or disables highlighting of the range where an undo occured.

    ENables or disables highlighting of the range where an undo occured.

    @@ -2506,7 +2554,7 @@
    -

    Pass true to enable the use of soft tabs. Soft tabs means you're using spaces instead of the tab character ('\t'). ...

    +

    Pass true to enable the use of soft tabs. Soft tabs means you're using spaces instead of the tab character ('\t').

    Pass true to enable the use of soft tabs. Soft tabs means you're using spaces instead of the tab character ('\t').

    @@ -2535,7 +2583,7 @@
    -

    Identifies if you want to use a worker for the EditSession. ...

    +

    Identifies if you want to use a worker for the EditSession.

    Identifies if you want to use a worker for the EditSession.

    @@ -2564,7 +2612,7 @@
    -

    Sets whether or not line wrapping is enabled. If useWrapMode is different than the current value, the `'changeWrap...

    +

    Sets whether or not line wrapping is enabled. If useWrapMode is different than the current value, the 'changeWrapMode' event is emitted.

    Sets whether or not line wrapping is enabled. If useWrapMode is different than the current value, the 'changeWrapMode' event is emitted.

    @@ -2593,7 +2641,7 @@
    -

    Sets the session text. ...

    +

    Sets the session text.

    Sets the session text.

    @@ -2622,7 +2670,7 @@
    -

    Sets the boundaries of wrap. Either value can be null to have an unconstrained wrap, or, they can be the same numb...

    +

    Sets the boundaries of wrap. Either value can be null to have an unconstrained wrap, or, they can be the same number to pin the limit. If the wrap limits for min or max are different, this method also emits the 'changeWrapMode' event.

    Sets the boundaries of wrap. Either value can be null to have an unconstrained wrap, or, they can be the same number to pin the limit. If the wrap limits for min or max are different, this method also emits the 'changeWrapMode' event.

    @@ -2651,7 +2699,7 @@
    -

    Sets the value of overwrite to the opposite of whatever it currently is. ...

    +

    Sets the value of overwrite to the opposite of whatever it currently is.

    Sets the value of overwrite to the opposite of whatever it currently is.

    @@ -2685,10 +2733,10 @@
    -

    Returns the current Document as a string. ...

    +

    Returns the current Document as a string.

    -

    Returns the current Document as a string.

    +

    Returns the current Document as a string.

       

    @@ -2718,7 +2766,7 @@
    -

    Reverts previous changes to your document. ...

    +

    Reverts previous changes to your document.

    Reverts previous changes to your document.

    @@ -2726,7 +2774,7 @@

       

    -

    Arguments

    deltasArrayRequired. An array of previous changes
    dontSelectBooleanRequired. If true, doesn't select the range of where the change occured
    +

    Arguments

    deltasArrayRequired. An array of previous changes
    dontSelectBooleanRequired. [If true, doesn't select the range of where the change occured]{: #dontSelect}
    diff --git a/api/editor.html b/api/editor.html index c5725498..80c82407 100644 --- a/api/editor.html +++ b/api/editor.html @@ -102,43 +102,33 @@

    Editor[edit]

    -
  • Functions (115) +
  • Functions (117)
    • -

    Creates a new Editor object. ...

    +

    Creates a new Editor object.

    Creates a new Editor object.

    @@ -431,14 +425,14 @@

    Events

    -
    +
      • -
      • Editor.on("onBlur", function())
        • +
      • Editor.on("blur", function())
      @@ -446,27 +440,27 @@
    -

    Emitted once the editor has been blurred. ...

    +

    Emitted once the editor has been blurred.

    -

    Emitted once the editor has been blurred.

    +

    Emitted once the editor has been blurred.

    -

       

    +

       

    -
    +
      • -
      • Editor.on("onChangeAnnotation", function())
        • +
      • Editor.on("change", function(Object e))
      @@ -474,293 +468,13 @@
    -

    Emitted when an annotation changes. ...

    +

    Emitted whenever the document is changed.

    -

    Emitted when an annotation changes.

    +

    Emitted whenever the document is changed.

    -

       

    -
    -
    -
    -
    -
    -
    -
    -
    -
    -
    -
      -
    • -
        -
      • Editor.on("onChangeBackMarker", function())
        • -
      -
        -
      -
      • -
    -
    -
    -

    Emitted when a back marker changes. ...

    - -
    -

    Emitted when a back marker changes.

    - -
    -

       

    -
    -
    -
    -
    -
    -
    -
    -
    -
    -
    -
      -
    • -
        -
      • Editor.on("onChangeBreakpoint", function())
        • -
      -
        -
      -
      • -
    -
    -
    -

    Emitted when a breakpoint changes. ...

    - -
    -

    Emitted when a breakpoint changes.

    - -
    -

       

    -
    -
    -
    -
    -
    -
    -
    -
    -
    -
    -
      -
    • -
        -
      • Editor.on("onChangeFold", function())
        • -
      -
        -
      -
      • -
    -
    -
    -

    Emitted when the code folds change. ...

    - -
    -

    Emitted when the code folds change.

    - -
    -

       

    -
    -
    -
    -
    -
    -
    -
    -
    -
    -
    -
      -
    • -
        -
      • Editor.on("onChangeFrontMarker", function())
        • -
      -
        -
      -
      • -
    -
    -
    -

    Emitted when a front marker changes. ...

    - -
    -

    Emitted when a front marker changes.

    - -
    -

       

    -
    -
    -
    -
    -
    -
    -
    -
    -
    -
    -
      -
    • -
        -
      • Editor.on("onChangeMode", function())
        • -
      -
        -
      -
      • -
    -
    -
    -

    Emitted when the mode changes. ...

    - -
    -

    Emitted when the mode changes.

    - -
    -

       

    -
    -
    -
    -
    -
    -
    -
    -
    -
    -
    -
      -
    • -
        -
      • Editor.on("onChangeWrapLimit", function())
        • -
      -
        -
      -
      • -
    -
    -
    -

    Emitted when the wrap limit changes. ...

    - -
    -

    Emitted when the wrap limit changes.

    - -
    -

       

    -
    -
    -
    -
    -
    -
    -
    -
    -
    -
    -
      -
    • -
        -
      • Editor.on("onChangeWrapMode", function())
        • -
      -
        -
      -
      • -
    -
    -
    -

    Emitted when the wrap mode changes. ...

    - -
    -

    Emitted when the wrap mode changes.

    - -
    -

       

    -
    -
    -
    -
    -
    -
    -
    -
    -
    -
    -
      -
    • -
        -
      • Editor.on("onCommandKey", function(e, hashId, keyCode))
        • -
      -
        -
      -
      • -
    -
    -
    -

    Emitted when the command-key is pressed. ...

    - -
    -

    Emitted when the command-key is pressed.

    - -
    -

       

    -
    -
    -
    -
    -
    -
    -
    -
    -
    -
    -
      -
    • -
        -
      • Editor.on("onCursorChange", function())
        • -
      -
        -
      -
      • -
    -
    -
    -

    Emitted when the cursor changes. ...

    - -
    -

    Emitted when the cursor changes.

    - -
    -

       

    -
    -
    -
    -
    -
    -
    -
    -
    -
    -
    -
      -
    • -
        -
      • Editor.on("onDocumentChange", function(Object e))
        • -
      -
        -
      -
      • -
    -
    -
    -

    Emitted whenever the document is changed. ...

    - -
    -

    Emitted whenever the document is changed.

    - -
    -

       

    +

       

    Arguments

    eObjectRequired. Contains a single property, data, which has the delta of changes
    @@ -768,14 +482,14 @@
    -
    +
      • -
      • Editor.on("onFocus", function())
        • +
      • Editor.on("changeAnnotation", function())
      @@ -783,27 +497,27 @@
    -

    Emitted once the editor comes into focus. ...

    +

    Emitted when an annotation changes.

    -

    Emitted once the editor comes into focus.

    +

    Emitted when an annotation changes.

    -

       

    +

       

    -
    +
      • -
      • Editor.on("onScrollLeftChange", function())
        • +
      • Editor.on("changeBackMarker", function())
      @@ -811,27 +525,27 @@
    -

    Emitted when the scroll left changes. ...

    +

    Emitted when a back marker changes.

    -

    Emitted when the scroll left changes.

    +

    Emitted when a back marker changes.

    -

       

    +

       

    -
    +
      • -
      • Editor.on("onScrollTopChange", function())
        • +
      • Editor.on("changeBreakpoint", function())
      @@ -839,27 +553,27 @@
    -

    Emitted when the scroll top changes. ...

    +

    Emitted when a breakpoint changes.

    -

    Emitted when the scroll top changes.

    +

    Emitted when a breakpoint changes.

    -

       

    +

       

    -
    +
      • -
      • Editor.on("onSelectionChange", function(Object e))
        • +
      • Editor.on("changeFold", function())
      @@ -867,13 +581,209 @@
    -

    Emitted when a selection has changed. ...

    +

    Emitted when the code folds change.

    -

    Emitted when a selection has changed.

    +

    Emitted when the code folds change.

    -

       

    +

       

    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
      +
    • +
        +
      • Editor.on("changeFrontMarker", function())
        • +
      +
        +
      +
      • +
    +
    +
    +

    Emitted when a front marker changes.

    + +
    +

    Emitted when a front marker changes.

    + +
    +

       

    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
      +
    • +
        +
      • Editor.on("changeMode", function())
        • +
      +
        +
      +
      • +
    +
    +
    +

    Emitted when the mode changes.

    + +
    +

    Emitted when the mode changes.

    + +
    +

       

    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
      +
    • +
        +
      • Editor.on("changeWrapLimit", function())
        • +
      +
        +
      +
      • +
    +
    +
    +

    Emitted when the wrap limit changes.

    + +
    +

    Emitted when the wrap limit changes.

    + +
    +

       

    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
      +
    • +
        +
      • Editor.on("changeWrapMode", function())
        • +
      +
        +
      +
      • +
    +
    +
    +

    Emitted when the wrap mode changes.

    + +
    +

    Emitted when the wrap mode changes.

    + +
    +

       

    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
      +
    • +
        +
      • Editor.on("cursorChange", function())
        • +
      +
        +
      +
      • +
    +
    +
    +

    Emitted when the cursor changes.

    + +
    +

    Emitted when the cursor changes.

    + +
    +

       

    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
      +
    • +
        +
      • Editor.on("focus", function())
        • +
      +
        +
      +
      • +
    +
    +
    +

    Emitted once the editor comes into focus.

    + +
    +

    Emitted once the editor comes into focus.

    + +
    +

       

    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
      +
    • +
        +
      • Editor.on("selectionChange", function(Object e))
        • +
      +
        +
      +
      • +
    +
    +
    +

    Emitted when a selection has changed.

    + +
    +

    Emitted when a selection has changed.

    + +
    +

       

    Arguments

    eObjectRequired. Contains a single property, data, which has the delta of changes
    @@ -881,64 +791,6 @@
    -
    -
    -
    -
    -
      -
    • -
        -
      • Editor.on("onTextInput", function(String text, Boolean pasted))
        • -
      -
        -
      -
      • -
    -
    -
    -

    Emitted when text is entered. ...

    - -
    -

    Emitted when text is entered.

    - -
    -

       

    -
    -

    Arguments

    textStringRequired. The text entered
    pastedBooleanRequired. Identifies whether the text was pasted (true) or not
    -
    -
    -
    -
    -
    -
    -
    -
    -
    -
      -
    • -
        -
      • Editor.on("onTokenizerUpdate", function(Object e))
        • -
      -
        -
      -
      • -
    -
    -
    -

    Emitted when the a tokenizer is updated. ...

    - -
    -

    Emitted when the a tokenizer is updated.

    - -
    -

       

    -
    -

    Arguments

    eObjectRequired. Contains a single property, data, which indicates the changed rows
    -
    -
    -
    -
    -

    Methods

    @@ -960,12 +812,11 @@
    -

    Returns an object indicating the currently selected rows. The object looks like this: - ...

    +

    Returns an object indicating the currently selected rows. The object looks like this:

    -

    Returns an object indicating the currently selected rows. The object looks like this: -

    +

    Returns an object indicating the currently selected rows. The object looks like this:

    +

    { first: range.start.row, last: range.end.row }

       

    @@ -996,7 +847,7 @@
    -

    Returns the number of currently visibile rows. ...

    +

    Returns the number of currently visibile rows.

    Returns the number of currently visibile rows.

    @@ -1024,7 +875,7 @@
    -

    Executes a specific function, which can be anything that manipulates selected lines, such as copying them, duplicati...

    +

    Executes a specific function, which can be anything that manipulates selected lines, such as copying them, duplicating them, or shifting them.

    Executes a specific function, which can be anything that manipulates selected lines, such as copying them, duplicating them, or shifting them.

    @@ -1058,7 +909,7 @@
    -

    Adds the selection and cursor. ...

    +

    Adds the selection and cursor.

    Adds the selection and cursor.

    @@ -1088,7 +939,7 @@
    -

    Outdents the current line. ...

    +

    Outdents the current line.

    Outdents the current line.

    @@ -1116,7 +967,7 @@
    -

    Blurs the current textInput. ...

    +

    Blurs the current textInput.

    Blurs the current textInput.

    @@ -1144,7 +995,7 @@
    -

    Attempts to center the current selection on the screen. ...

    +

    Attempts to center the current selection on the screen.

    Attempts to center the current selection on the screen.

    @@ -1173,10 +1024,10 @@
    -

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

    +

    {:Selection.clearSelection}

    -

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

    +

    {:Selection.clearSelection}

       

    @@ -1207,7 +1058,7 @@
    -

    Copies all the selected lines down one row. ...

    +

    Copies all the selected lines down one row.

    Copies all the selected lines down one row.

    @@ -1242,7 +1093,7 @@
    -

    Copies all the selected lines up one row. ...

    +

    Copies all the selected lines up one row.

    Copies all the selected lines up one row.

    @@ -1271,7 +1122,7 @@
    -

    Cleans up the entire editor. ...

    +

    Cleans up the entire editor.

    Cleans up the entire editor.

    @@ -1304,7 +1155,7 @@
    -

    Removes all the selections except the last added one. ...

    +

    Removes all the selections except the last added one.

    Removes all the selections except the last added one.

    @@ -1324,7 +1175,7 @@
    -

    Attempts to find needle within the document. For more information on options, see Search. ...

    +

    Attempts to find needle within the document. For more information on options, see Search.

    -

    Attempts to find needle within the document. For more information on options, see Search.

    +

    Attempts to find needle within the document. For more information on options, see Search.

       

    -

    Arguments

    needleStringRequired. The text to search for
    optionsObjectRequired. An object defining various search properties
    animateBooleanRequired. If true animate scrolling
    +

    Arguments

    needleStringRequired. The text to search for (optional)
    optionsObjectRequired. An object defining various search properties
    animateBooleanRequired. If true animate scrolling
    @@ -1367,7 +1218,7 @@
    -

    Finds and selects all the occurences of needle. ...

    +

    Finds and selects all the occurences of needle.

    Finds and selects all the occurences of needle.

    @@ -1388,7 +1239,7 @@
    -

    Performs another search for needle in the document. For more information on options, see Search. ...

    +

    Performs another search for needle in the document. For more information on options, see Search.

    -

    Performs another search for needle in the document. For more information on options, see Search.

    +

    Performs another search for needle in the document. For more information on options, see Search.

       

    @@ -1418,7 +1269,7 @@
    -

    Performs a search for needle backwards. For more information on options, see Search. ...

    +

    Performs a search for needle backwards. For more information on options, see Search.

    -

    Performs a search for needle backwards. For more information on options, see Search.

    +

    Performs a search for needle backwards. For more information on options, see Search.

       

    @@ -1456,7 +1307,7 @@
    -

    Brings the current textInput into focus. ...

    +

    Brings the current textInput into focus.

    Brings the current textInput into focus.

    @@ -1484,7 +1335,7 @@
    -

    Executes a command for each selection range. ...

    +

    Executes a command for each selection range.

    Executes a command for each selection range.

    @@ -1518,10 +1369,10 @@
    -

    Returns true if the behaviors are currently enabled. "Behaviors" in this case is the auto-pairing of special characters, like quotation marks, parenthesis, or brackets. ...

    +

    Returns true if the behaviors are currently enabled. {:BehaviorsDef}

    -

    Returns true if the behaviors are currently enabled. "Behaviors" in this case is the auto-pairing of special characters, like quotation marks, parenthesis, or brackets.

    +

    Returns true if the behaviors are currently enabled. {:BehaviorsDef}

       

    @@ -1551,7 +1402,7 @@
    -

    Returns the string of text currently highlighted. ...

    +

    Returns the string of text currently highlighted.

    Returns the string of text currently highlighted.

    @@ -1585,7 +1436,7 @@
    -

    Gets the current position of the cursor. ...

    +

    Gets the current position of the cursor.

    Gets the current position of the cursor.

    @@ -1620,7 +1471,7 @@
    -

    Returns the screen position of the cursor. ...

    +

    Returns the screen position of the cursor.

    Returns the screen position of the cursor.

    @@ -1653,7 +1504,7 @@
    -

    Returns the current mouse drag delay. ...

    +

    Returns the current mouse drag delay.

    Returns the current mouse drag delay.

    @@ -1687,10 +1538,10 @@
    -

    Returns the index of the first visible row. ...

    +

    {:VirtualRenderer.getFirstVisibleRow}

    -

    Returns the index of the first visible row.

    +

    {:VirtualRenderer.getFirstVisibleRow}

       

    @@ -1720,7 +1571,7 @@
    -

    Returns true if current lines are always highlighted. ...

    +

    Returns true if current lines are always highlighted.

    Returns true if current lines are always highlighted.

    @@ -1753,7 +1604,7 @@
    -

    Returns true if currently highlighted words are to be highlighted. ...

    +

    Returns true if currently highlighted words are to be highlighted.

    Returns true if currently highlighted words are to be highlighted.

    @@ -1787,7 +1638,7 @@
    -

    Returns the keyboard handler. ...

    +

    Returns the keyboard handler.

    Returns the keyboard handler.

    @@ -1821,10 +1672,10 @@
    -

    Returns an object containing all the search options. For more information on options, see Search. ...

    +

    {:Search.getOptions} For more information on options, see Search.

    -

    Returns an object containing all the search options. For more information on options, see Search.

    +

    {:Search.getOptions} For more information on options, see Search.

       

    @@ -1855,10 +1706,10 @@
    -

    Returns the index of the last visible row. ...

    +

    {:VirtualRenderer.getLastVisibleRow}

    -

    Returns the index of the last visible row.

    +

    {:VirtualRenderer.getLastVisibleRow}

       

    @@ -1889,7 +1740,7 @@
    -

    Returns true if overwrites are enabled; false otherwise. ...

    +

    Returns true if overwrites are enabled; false otherwise.

    Returns true if overwrites are enabled; false otherwise.

    @@ -1922,7 +1773,7 @@
    -

    Returns the column number of where the print margin is. ...

    +

    Returns the column number of where the print margin is.

    Returns the column number of where the print margin is.

    @@ -1955,7 +1806,7 @@
    -

    Returns true if the editor is set to read-only mode. ...

    +

    Returns true if the editor is set to read-only mode.

    Returns true if the editor is set to read-only mode.

    @@ -1988,7 +1839,7 @@
    -

    Returns the value indicating how fast the mouse scroll speed is. ...

    +

    Returns the value indicating how fast the mouse scroll speed is.

    Returns the value indicating how fast the mouse scroll speed is.

    @@ -2021,7 +1872,7 @@
    -

    Returns the currently highlighted selection. ...

    +

    Returns the currently highlighted selection.

    Returns the currently highlighted selection.

    @@ -2055,10 +1906,10 @@
    -

    Returns the Range for the selected text. ...

    +

    {:Selection.getRange}

    -

    Returns the Range for the selected text.

    +

    {:Selection.getRange}

       

    @@ -2088,7 +1939,7 @@
    -

    Returns the current selection style. ...

    +

    Returns the current selection style.

    Returns the current selection style.

    @@ -2121,7 +1972,7 @@
    -

    Returns the current session being used. ...

    +

    Returns the current session being used.

    Returns the current session being used.

    @@ -2154,7 +2005,7 @@
    -

    Returns true if the fold widgets are shown. ...

    +

    Returns true if the fold widgets are shown.

    Returns true if the fold widgets are shown.

    @@ -2187,7 +2038,7 @@
    -

    Returns true if invisible characters are being shown. ...

    +

    Returns true if invisible characters are being shown.

    Returns true if invisible characters are being shown.

    @@ -2220,7 +2071,7 @@
    -

    Returns true if the print margin is being shown. ...

    +

    Returns true if the print margin is being shown.

    Returns true if the print margin is being shown.

    @@ -2254,10 +2105,10 @@
    -

    Returns the path of the current theme. ...

    +

    {:VirtualRenderer.getTheme}

    -

    Returns the path of the current theme.

    +

    {:VirtualRenderer.getTheme}

       

    @@ -2267,6 +2118,40 @@
    +
    +
    +
    +
    + +
    +
    +

    Returns the current session's content.

    + +
    +

    Returns the current session's content.

    + +
    +

       

    +
    +
    +
    +
    +
    +
    @@ -2274,7 +2159,7 @@
    -

    Moves the cursor to the specified line number, and also into the indiciated column. ...

    +

    Moves the cursor to the specified line number, and also into the indiciated column.

    Moves the cursor to the specified line number, and also into the indiciated column.

    @@ -2311,7 +2196,7 @@
    -

    Shifts the document to wherever "page down" is, as well as moving the cursor position. ...

    +

    Shifts the document to wherever "page down" is, as well as moving the cursor position.

    Shifts the document to wherever "page down" is, as well as moving the cursor position.

    @@ -2339,7 +2224,7 @@
    -

    Shifts the document to wherever "page up" is, as well as moving the cursor position. ...

    +

    Shifts the document to wherever "page up" is, as well as moving the cursor position.

    Shifts the document to wherever "page up" is, as well as moving the cursor position.

    @@ -2368,7 +2253,7 @@
    -

    Indents the current line. ...

    +

    Indents the current line.

    Indents the current line.

    @@ -2396,7 +2281,7 @@
    -

    Inserts text into wherever the cursor is pointing. ...

    +

    Inserts text into wherever the cursor is pointing.

    Inserts text into wherever the cursor is pointing.

    @@ -2430,7 +2315,7 @@
    -

    Returns true if the current textInput is in focus. ...

    +

    Returns true if the current textInput is in focus.

    Returns true if the current textInput is in focus.

    @@ -2463,7 +2348,7 @@
    -

    Indicates if the entire row is currently visible on the screen. ...

    +

    Indicates if the entire row is currently visible on the screen.

    Indicates if the entire row is currently visible on the screen.

    @@ -2497,7 +2382,7 @@
    -

    Indicates if the row is currently visible on the screen. ...

    +

    Indicates if the row is currently visible on the screen.

    Indicates if the row is currently visible on the screen.

    @@ -2526,7 +2411,7 @@
    -

    Moves the cursor's row and column to the next matching bracket. ...

    +

    Moves the cursor's row and column to the next matching bracket.

    Moves the cursor's row and column to the next matching bracket.

    @@ -2555,7 +2440,7 @@
    -

    Moves the cursor to the specified row and column. Note that this does not de-select the current selection. ...

    +

    Moves the cursor to the specified row and column. Note that this does not de-select the current selection.

    Moves the cursor to the specified row and column. Note that this does not de-select the current selection.

    @@ -2585,7 +2470,7 @@
    -

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

    +

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

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

    @@ -2620,7 +2505,7 @@
    -

    Shifts all the selected lines down one row. ...

    +

    Shifts all the selected lines down one row.

    Shifts all the selected lines down one row.

    @@ -2655,7 +2540,7 @@
    -

    Shifts all the selected lines up one row. ...

    +

    Shifts all the selected lines up one row.

    Shifts all the selected lines up one row.

    @@ -2690,12 +2575,11 @@
    -

    Moves a range of text from the given range to the given position. toPosition is an object that looks like this: - ...

    +

    Moves a range of text from the given range to the given position. toPosition is an object that looks like this:

    -

    Moves a range of text from the given range to the given position. toPosition is an object that looks like this: -

    +

    Moves a range of text from the given range to the given position. toPosition is an object that looks like this:

    +

    { row: newRowLocation, column: newColumnLocation }

       

    @@ -2723,7 +2607,7 @@
    -

    Moves the cursor down in the document the specified number of times. Note that this does de-select the current selec...

    +

    Moves the cursor down in the document the specified number of times. Note that this does de-select the current selection.

    Moves the cursor down in the document the specified number of times. Note that this does de-select the current selection.

    @@ -2752,7 +2636,7 @@
    -

    Moves the cursor to the end of the current file. Note that this does de-select the current selection. ...

    +

    Moves the cursor to the end of the current file. Note that this does de-select the current selection.

    Moves the cursor to the end of the current file. Note that this does de-select the current selection.

    @@ -2780,7 +2664,7 @@
    -

    Moves the cursor to the start of the current file. Note that this does de-select the current selection. ...

    +

    Moves the cursor to the start of the current file. Note that this does de-select the current selection.

    Moves the cursor to the start of the current file. Note that this does de-select the current selection.

    @@ -2808,7 +2692,7 @@
    -

    Moves the cursor left in the document the specified number of times. Note that this does de-select the current selec...

    +

    Moves the cursor left in the document the specified number of times. Note that this does de-select the current selection.

    Moves the cursor left in the document the specified number of times. Note that this does de-select the current selection.

    @@ -2837,7 +2721,7 @@
    -

    Moves the cursor to the end of the current line. Note that this does de-select the current selection. ...

    +

    Moves the cursor to the end of the current line. Note that this does de-select the current selection.

    Moves the cursor to the end of the current line. Note that this does de-select the current selection.

    @@ -2865,7 +2749,7 @@
    -

    Moves the cursor to the start of the current line. Note that this does de-select the current selection. ...

    +

    Moves the cursor to the start of the current line. Note that this does de-select the current selection.

    Moves the cursor to the start of the current line. Note that this does de-select the current selection.

    @@ -2893,7 +2777,7 @@
    -

    Moves the cursor right in the document the specified number of times. Note that this does de-select the current sele...

    +

    Moves the cursor right in the document the specified number of times. Note that this does de-select the current selection.

    Moves the cursor right in the document the specified number of times. Note that this does de-select the current selection.

    @@ -2923,7 +2807,7 @@
    -

    Moves the cursor to the specified row and column. Note that this does de-select the current selection. ...

    +

    Moves the cursor to the specified row and column. Note that this does de-select the current selection.

    Moves the cursor to the specified row and column. Note that this does de-select the current selection.

    @@ -2952,7 +2836,7 @@
    -

    Moves the cursor up in the document the specified number of times. Note that this does de-select the current selection. ...

    +

    Moves the cursor up in the document the specified number of times. Note that this does de-select the current selection.

    Moves the cursor up in the document the specified number of times. Note that this does de-select the current selection.

    @@ -2981,7 +2865,7 @@
    -

    Moves the cursor to the word immediately to the left of the current position. Note that this does de-select the curr...

    +

    Moves the cursor to the word immediately to the left of the current position. Note that this does de-select the current selection.

    Moves the cursor to the word immediately to the left of the current position. Note that this does de-select the current selection.

    @@ -3009,7 +2893,7 @@
    -

    Moves the cursor to the word immediately to the right of the current position. Note that this does de-select the cur...

    +

    Moves the cursor to the word immediately to the right of the current position. Note that this does de-select the current selection.

    Moves the cursor to the word immediately to the right of the current position. Note that this does de-select the current selection.

    @@ -3037,7 +2921,7 @@
    -

    Removes the selection marker. ...

    +

    Removes the selection marker.

    Removes the selection marker.

    @@ -3045,7 +2929,7 @@

       

    -

    Arguments

    rangeRangeRequired. The selection range added with addSelectionMarker().
    +

    Arguments

    rangeRangeRequired. The selection range added with addSelectionMarker.
    @@ -3066,7 +2950,7 @@
    -

    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.

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

    @@ -3095,7 +2979,7 @@
    -

    Adds a cursor above or below the active cursor. ...

    +

    Adds a cursor above or below the active cursor.

    Adds a cursor above or below the active cursor.

    @@ -3124,7 +3008,7 @@
    -

    Transposes the selected ranges. ...

    +

    Transposes the selected ranges.

    Transposes the selected ranges.

    @@ -3153,7 +3037,7 @@
    -

    Called whenever a text "copy" happens. ...

    +

    Called whenever a text "copy" happens.

    Called whenever a text "copy" happens.

    @@ -3181,7 +3065,7 @@
    -

    called whenever a text "cut" happens. ...

    +

    called whenever a text "cut" happens.

    called whenever a text "cut" happens.

    @@ -3209,7 +3093,7 @@
    -

    called whenever a text "paste" happens. ...

    +

    called whenever a text "paste" happens.

    called whenever a text "paste" happens.

    @@ -3238,10 +3122,10 @@
    -

    Perform a redo operation on the document, reimplementing the last change. ...

    +

    {:UndoManager.redo}

    -

    Perform a redo operation on the document, reimplementing the last change.

    +

    {:UndoManager.redo}

       

    @@ -3266,7 +3150,7 @@
    -

    Removes words of text from the editor. A "word" is defined as a string of characters bookended by whitespace. ...

    +

    Removes words of text from the editor. A "word" is defined as a string of characters bookended by whitespace.

    Removes words of text from the editor. A "word" is defined as a string of characters bookended by whitespace.

    @@ -3296,7 +3180,7 @@
    -

    Removes all the lines in the current selection ...

    +

    Removes all the lines in the current selection

    Removes all the lines in the current selection

    @@ -3324,7 +3208,7 @@
    -

    Removes all the words to the right of the current selection, until the end of the line. ...

    +

    Removes all the words to the right of the current selection, until the end of the line.

    Removes all the words to the right of the current selection, until the end of the line.

    @@ -3352,7 +3236,7 @@
    -

    Removes all the words to the left of the current selection, until the start of the line. ...

    +

    Removes all the words to the left of the current selection, until the start of the line.

    Removes all the words to the left of the current selection, until the start of the line.

    @@ -3380,7 +3264,7 @@
    -

    Removes the word directly to the left of the current selection. ...

    +

    Removes the word directly to the left of the current selection.

    Removes the word directly to the left of the current selection.

    @@ -3408,7 +3292,7 @@
    -

    Removes the word directly to the right of the current selection. ...

    +

    Removes the word directly to the right of the current selection.

    Removes the word directly to the right of the current selection.

    @@ -3436,7 +3320,7 @@
    -

    Replaces the first occurance of options.needle with the value in replacement. ...

    +

    Replaces the first occurance of options.needle with the value in replacement.

    Replaces the first occurance of options.needle with the value in replacement.

    @@ -3444,7 +3328,7 @@

       

    -

    Arguments

    replacementStringRequired. The text to replace with
    optionsObjectRequired. The Search options to use
    +

    Arguments

    replacementStringRequired. The text to replace with
    optionsObjectRequired. The Search options to use
    @@ -3465,7 +3349,7 @@
    -

    Replaces all occurances of options.needle with the value in replacement. ...

    +

    Replaces all occurances of options.needle with the value in replacement.

    Replaces all occurances of options.needle with the value in replacement.

    @@ -3473,7 +3357,7 @@

       

    -

    Arguments

    replacementStringRequired. The text to replace with
    optionsObjectRequired. The Search options to use
    +

    Arguments

    replacementStringRequired. The text to replace with
    optionsObjectRequired. The Search options to use
    @@ -3495,10 +3379,10 @@
    -

    Triggers a resize of the editor. ...

    +

    {:VirtualRenderer.onResize}

    -

    Triggers a resize of the editor.

    +

    {:VirtualRenderer.onResize}

       

    @@ -3523,7 +3407,7 @@
    -

    Scrolls the document to wherever "page down" is, without changing the cursor position. ...

    +

    Scrolls the document to wherever "page down" is, without changing the cursor position.

    Scrolls the document to wherever "page down" is, without changing the cursor position.

    @@ -3551,7 +3435,7 @@
    -

    Scrolls the document to wherever "page up" is, without changing the cursor position. ...

    +

    Scrolls the document to wherever "page up" is, without changing the cursor position.

    Scrolls the document to wherever "page up" is, without changing the cursor position.

    @@ -3571,7 +3455,7 @@
    -

    TODO scrolls a to line, if center == true, puts line in middle of screen or attempts to) ...

    +

    TODO scrolls a to line, if center == true, puts line in middle of screen or attempts to)

    TODO scrolls a to line, if center == true, puts line in middle of screen or attempts to)

    @@ -3610,7 +3494,7 @@
    -

    Moves the editor to the specified row. ...

    +

    Moves the editor to the specified row.

    Moves the editor to the specified row.

    @@ -3640,7 +3524,7 @@
    -

    Selects all the text in editor. ...

    +

    Selects all the text in editor.

    Selects all the text in editor.

    @@ -3668,7 +3552,7 @@
    -

    Selects the text from the current position of the document until where a "page down" finishes. ...

    +

    Selects the text from the current position of the document until where a "page down" finishes.

    Selects the text from the current position of the document until where a "page down" finishes.

    @@ -3696,7 +3580,7 @@
    -

    Selects the text from the current position of the document until where a "page up" finishes. ...

    +

    Selects the text from the current position of the document until where a "page up" finishes.

    Selects the text from the current position of the document until where a "page up" finishes.

    @@ -3716,7 +3600,7 @@
      • -
      • Editor.setBehavioursEnabled()
        • +
      • Editor.setBehavioursEnabled(Boolean enabled)
      @@ -3724,10 +3608,10 @@
    -

    Specifies whether to use behaviors or not. ["Behaviors" in this case is the auto-pairing of special characters, like...

    +

    Specifies whether to use behaviors or not. ["Behaviors" in this case is the auto-pairing of special characters, like quotation marks, parenthesis, or brackets.]{: #BehaviorsDef}

    -

    "Behaviors" in this case is the auto-pairing of special characters, like quotation marks, parenthesis, or brackets.

    +

    Specifies whether to use behaviors or not. ["Behaviors" in this case is the auto-pairing of special characters, like quotation marks, parenthesis, or brackets.]{: #BehaviorsDef}

       

    @@ -3753,7 +3637,7 @@
    -

    Sets the delay (in milliseconds) of the mouse drag. ...

    +

    Sets the delay (in milliseconds) of the mouse drag.

    Sets the delay (in milliseconds) of the mouse drag.

    @@ -3782,7 +3666,7 @@
    -

    Set a new font size (in pixels) for the editor text. ...

    +

    Set a new font size (in pixels) for the editor text.

    Set a new font size (in pixels) for the editor text.

    @@ -3811,7 +3695,7 @@
    -

    Determines whether or not the current line should be highlighted. ...

    +

    Determines whether or not the current line should be highlighted.

    Determines whether or not the current line should be highlighted.

    @@ -3840,7 +3724,7 @@
    -

    Determines if the currently selected word should be highlighted. ...

    +

    Determines if the currently selected word should be highlighted.

    Determines if the currently selected word should be highlighted.

    @@ -3869,7 +3753,7 @@
    -

    Sets a new keyboard handler. ...

    +

    Sets a new keyboard handler.

    Sets a new keyboard handler.

    @@ -3898,7 +3782,7 @@
    -

    Pass in true to enable overwrites in your session, or false to disable. If overwrites is enabled, any text you e...

    +

    Pass in true to enable overwrites in your session, or false to disable. If overwrites is enabled, any text you enter will type over any text after it. If the value of overwrite changes, this function also emites the changeOverwrite event.

    Pass in true to enable overwrites in your session, or false to disable. If overwrites is enabled, any text you enter will type over any text after it. If the value of overwrite changes, this function also emites the changeOverwrite event.

    @@ -3927,7 +3811,7 @@
    -

    Sets the column defining where the print margin should be. ...

    +

    Sets the column defining where the print margin should be.

    Sets the column defining where the print margin should be.

    @@ -3956,7 +3840,7 @@
    -

    If readOnly is true, then the editor is set to read-only mode, and none of the content can change. ...

    +

    If readOnly is true, then the editor is set to read-only mode, and none of the content can change.

    If readOnly is true, then the editor is set to read-only mode, and none of the content can change.

    @@ -3985,7 +3869,7 @@
    -

    Sets how fast the mouse scrolling should do. ...

    +

    Sets how fast the mouse scrolling should do.

    Sets how fast the mouse scrolling should do.

    @@ -4014,7 +3898,7 @@
    -

    Indicates how selections should occur. By default, selections are set to "line". This function also emits the `'chan...

    +

    Indicates how selections should occur. By default, selections are set to "line". This function also emits the 'changeSelectionStyle' event.

    Indicates how selections should occur. By default, selections are set to "line". This function also emits the 'changeSelectionStyle' event.

    @@ -4043,7 +3927,7 @@
    -

    Sets a new editsession to use. This method also emits the 'changeSession' event. ...

    +

    Sets a new editsession to use. This method also emits the 'changeSession' event.

    Sets a new editsession to use. This method also emits the 'changeSession' event.

    @@ -4072,7 +3956,7 @@
    -

    Indicates whether the fold widgets are shown or not. ...

    +

    Indicates whether the fold widgets are shown or not.

    Indicates whether the fold widgets are shown or not.

    @@ -4101,7 +3985,7 @@
    -

    If showInvisibiles is set to true, invisible characters—like spaces or new lines—are show in the editor. ...

    +

    If showInvisibiles is set to true, invisible characters—like spaces or new lines—are show in the editor.

    If showInvisibiles is set to true, invisible characters—like spaces or new lines—are show in the editor.

    @@ -4130,7 +4014,7 @@
    -

    If showPrintMargin is set to true, the print margin is shown in the editor. ...

    +

    If showPrintMargin is set to true, the print margin is shown in the editor.

    If showPrintMargin is set to true, the print margin is shown in the editor.

    @@ -4160,10 +4044,10 @@
    -

    Adds a new class, style, to the editor. ...

    +

    {:VirtualRenderer.setStyle}

    -

    Adds a new class, style, to the editor.

    +

    {:VirtualRenderer.setStyle}

       

    @@ -4188,10 +4072,10 @@
    -

    Sets a new theme for the editor. theme should exist, and be a directory path, like ace/theme/textmate. ...

    +

    {:VirtualRenderer.setTheme}

    -

    Sets a new theme for the editor. theme should exist, and be a directory path, like ace/theme/textmate.

    +

    {:VirtualRenderer.setTheme}

       

    @@ -4201,6 +4085,41 @@
    +
    +
    +
    +
    + +
    +
    +

    Sets the current document to val.

    + +
    +

    Sets the current document to val.

    + +
    +

       

    +
    +

    Arguments

    valStringRequired. The new value to set for the document
    cursorPosNumberRequired. 0: selectAll, -1 document start, 1 end
    +
    +
    +
    +
    +
    @@ -4216,7 +4135,7 @@
    -

    Splits the line at the current selection (by inserting an '\n'). ...

    +

    Splits the line at the current selection (by inserting an '\n').

    Splits the line at the current selection (by inserting an '\n').

    @@ -4244,7 +4163,7 @@
    -

    Given the currently selected range, this function either comments all lines or uncomments all lines (depending on wh...

    +

    Given the currently selected range, this function either comments all lines or uncomments all lines (depending on whether it's commented or not).

    Given the currently selected range, this function either comments all lines or uncomments all lines (depending on whether it's commented or not).

    @@ -4273,7 +4192,7 @@
    -

    Sets the value of overwrite to the opposite of whatever it currently is. ...

    +

    Sets the value of overwrite to the opposite of whatever it currently is.

    Sets the value of overwrite to the opposite of whatever it currently is.

    @@ -4301,7 +4220,7 @@
    -

    Converts the current selection entirely into lowercase. ...

    +

    Converts the current selection entirely into lowercase.

    Converts the current selection entirely into lowercase.

    @@ -4329,7 +4248,7 @@
    -

    Converts the current selection entirely into uppercase. ...

    +

    Converts the current selection entirely into uppercase.

    Converts the current selection entirely into uppercase.

    @@ -4357,7 +4276,7 @@
    -

    Transposes current line. ...

    +

    Transposes current line.

    Transposes current line.

    @@ -4386,10 +4305,10 @@
    -

    Perform an undo operation on the document, reverting the last change. Returns the range of the undo. ...

    +

    {:UndoManager.undo}

    -

    Perform an undo operation on the document, reverting the last change. Returns the range of the undo.

    +

    {:UndoManager.undo}

       

    @@ -4415,10 +4334,10 @@
    -

    Removes the class style from the editor. ...

    +

    {:VirtualRenderer.unsetStyle}

    -

    Removes the class style from the editor.

    +

    {:VirtualRenderer.unsetStyle}

       

    diff --git a/api/index.html b/api/index.html index e1572a3a..75cbe2a4 100644 --- a/api/index.html +++ b/api/index.html @@ -95,9 +95,7 @@

    Ace API Reference

    -

    Welcome to the Ace API Reference Guide. Ace is a standalone code editor written in JavaScript that you can embed onto any website. We're used in a bunch of places already, like GitHub, Google, and Facebook. - -

    +

    Welcome to the Ace API Reference Guide. Ace is a standalone code editor written in JavaScript that you can embed onto any website. We're used in a bunch of places already, like GitHub, Google, and Facebook.

    On the left, you'll find a list of all of our currently documented classes. There are plenty more to do, but these represent the "core" set. For more information on how to work with Ace, check out the main Ace website.

    diff --git a/api/placeholder.html b/api/placeholder.html index 661efe05..6a4ad2dc 100644 --- a/api/placeholder.html +++ b/api/placeholder.html @@ -104,9 +104,9 @@
    -

    TODO ...

    +

    TODO

    TODO

    @@ -186,7 +186,7 @@
      • -
      • PlaceHolder.on("onCursorChange", function(e))
        • +
      • PlaceHolder.on("onCursorChange", function(e))
      @@ -194,7 +194,7 @@
    -

    Emitted when the cursor changes. ...

    +

    Emitted when the cursor changes.

    Emitted when the cursor changes.

    @@ -214,7 +214,7 @@
      • -
      • PlaceHolder.on("onUpdate", function(e))
        • +
      • PlaceHolder.on("onUpdate", function(e))
      @@ -222,7 +222,7 @@
    -

    Emitted when the place holder updates. ...

    +

    Emitted when the place holder updates.

    Emitted when the place holder updates.

    @@ -251,7 +251,7 @@
    -

    TODO ...

    +

    TODO

    TODO

    @@ -279,7 +279,7 @@
    -

    TODO ...

    +

    TODO

    TODO

    @@ -307,10 +307,10 @@
    -

    Hides all over markers in the EditSession that are not the currently selected one. ...

    +

    Hides all over markers in the EditSession that are not the currently selected one.

    -

    Hides all over markers in the EditSession that are not the currently selected one.

    +

    Hides all over markers in the EditSession that are not the currently selected one.

       

    @@ -335,7 +335,7 @@
    -

    TODO ...

    +

    TODO

    TODO

    @@ -363,7 +363,7 @@
    -

    TODO ...

    +

    TODO

    TODO

    diff --git a/api/range.html b/api/range.html index b00a1b67..34c38018 100644 --- a/api/range.html +++ b/api/range.html @@ -198,7 +198,7 @@
    -

    Creates a new Range object with the given starting and ending row and column points. ...

    +

    Creates a new Range object with the given starting and ending row and column points.

    Creates a new Range object with the given starting and ending row and column points.

    @@ -233,7 +233,7 @@
    -

    Returns the part of the current Range that occurs within the boundaries of firstRow and lastRow as a new `Rang...

    +

    Returns the part of the current Range that occurs within the boundaries of firstRow and lastRow as a new Range object.

    Returns the part of the current Range that occurs within the boundaries of firstRow and lastRow as a new Range object.

    @@ -267,7 +267,7 @@
    -

    Returns a duplicate of the calling range. ...

    +

    Returns a duplicate of the calling range.

    Returns a duplicate of the calling range.

    @@ -300,7 +300,7 @@
    -

    Returns a range containing the starting and ending rows of the original range, but with a column value of 0. ...

    +

    Returns a range containing the starting and ending rows of the original range, but with a column value of 0.

    Returns a range containing the starting and ending rows of the original range, but with a column value of 0.

    @@ -333,7 +333,7 @@
    -

    Checks the row and column points with the row and column points of the calling range. ...

    +

    Checks the row and column points with the row and column points of the calling range.

    Checks the row and column points with the row and column points of the calling range.

    @@ -368,7 +368,7 @@
    -

    Checks the row and column points with the row and column points of the calling range. ...

    +

    Checks the row and column points with the row and column points of the calling range.

    Checks the row and column points with the row and column points of the calling range.

    @@ -403,7 +403,7 @@
    -

    Checks the row and column points with the row and column points of the calling range. ...

    +

    Checks the row and column points with the row and column points of the calling range.

    Checks the row and column points with the row and column points of the calling range.

    @@ -439,7 +439,7 @@
    -

    Checks the row and column points of p with the row and column points of the calling range. ...

    +

    Checks the row and column points of p with the row and column points of the calling range.

    Checks the row and column points of p with the row and column points of the calling range.

    @@ -475,7 +475,7 @@
    -

    Compares this range (A) with another range (B). ...

    +

    Compares this range (A) with another range (B).

    Compares this range (A) with another range (B).

    @@ -510,7 +510,7 @@
    -

    Checks the row and column points with the row and column points of the calling range. ...

    +

    Checks the row and column points with the row and column points of the calling range.

    Checks the row and column points with the row and column points of the calling range.

    @@ -546,11 +546,12 @@
    -

    Returns true if the row and column provided are within the given range. This can better be expressed as return...

    +

    Returns true if the row and column provided are within the given range. This can better be expressed as returning true if:

    -

    Returns true if the row and column provided are within the given range. This can better be expressed as returning true if: -

    +

    Returns true if the row and column provided are within the given range. This can better be expressed as returning true if:

    +

    this.start.row <= row <= this.end.row && + this.start.column <= column <= this.end.column

       

    @@ -584,7 +585,7 @@
    -

    Checks the start and end points of range and compares them to the calling range. Returns true if the range is ...

    +

    Checks the start and end points of range and compares them to the calling range. Returns true if the range is contained within the caller's range.

    Checks the start and end points of range and compares them to the calling range. Returns true if the range is contained within the caller's range.

    @@ -618,7 +619,7 @@
    -

    Changes the row and column points for the calling range for both the starting and ending points. This method returns...

    +

    Changes the row and column points for the calling range for both the starting and ending points. This method returns that range with a new row.

    Changes the row and column points for the calling range for both the starting and ending points. This method returns that range with a new row.

    @@ -652,7 +653,7 @@
    -

    Creates and returns a new Range based on the row and column of the given parameters. ...

    +

    Creates and returns a new Range based on the row and column of the given parameters.

    Creates and returns a new Range based on the row and column of the given parameters.

    @@ -687,7 +688,7 @@
    -

    Returns true if the row and column are within the given range. ...

    +

    Returns true if the row and column are within the given range.

    Returns true if the row and column are within the given range.

    @@ -722,7 +723,7 @@
    -

    Returns true if the row and column are within the given range's ending points. ...

    +

    Returns true if the row and column are within the given range's ending points.

    Returns true if the row and column are within the given range's ending points.

    @@ -757,7 +758,7 @@
    -

    Returns true if the row and column are within the given range's starting points. ...

    +

    Returns true if the row and column are within the given range's starting points.

    Returns true if the row and column are within the given range's starting points.

    @@ -791,7 +792,7 @@
    -

    Returns true if passed in range intersects with the one calling this method. ...

    +

    Returns true if passed in range intersects with the one calling this method.

    Returns true if passed in range intersects with the one calling this method.

    @@ -825,7 +826,7 @@
    -

    Returns true if the caller's ending row point is the same as row, and if the caller's ending column is the same ...

    +

    Returns true if the caller's ending row point is the same as row, and if the caller's ending column is the same as column.

    Returns true if the caller's ending row point is the same as row, and if the caller's ending column is the same as column.

    @@ -859,7 +860,7 @@
    -

    Returns true if and only if the starting row and column, and ending tow and column, are equivalent to those given ...

    +

    Returns true if and only if the starting row and column, and ending tow and column, are equivalent to those given by range.

    Returns true if and only if the starting row and column, and ending tow and column, are equivalent to those given by range.

    @@ -893,7 +894,7 @@
    -

    Returns true if the range spans across multiple lines. ...

    +

    Returns true if the range spans across multiple lines.

    Returns true if the range spans across multiple lines.

    @@ -926,7 +927,7 @@
    -

    Returns true if the caller's starting row point is the same as row, and if the caller's starting column is the s...

    +

    Returns true if the caller's starting row point is the same as row, and if the caller's starting column is the same as column.

    Returns true if the caller's starting row point is the same as row, and if the caller's starting column is the same as column.

    @@ -955,7 +956,7 @@
    -

    Sets the starting row and column for the range. ...

    +

    Sets the starting row and column for the range.

    Sets the starting row and column for the range.

    @@ -984,7 +985,7 @@
    -

    Sets the starting row and column for the range. ...

    +

    Sets the starting row and column for the range.

    Sets the starting row and column for the range.

    @@ -1018,7 +1019,7 @@
    -

    Given the current Range, this function converts those starting and ending points into screen positions, and then r...

    +

    Given the current Range, this function converts those starting and ending points into screen positions, and then returns a new Range object.

    Given the current Range, this function converts those starting and ending points into screen positions, and then returns a new Range object.

    @@ -1052,12 +1053,11 @@
    -

    Returns a string containing the range's row and column information, given like this: - ...

    +

    Returns a string containing the range's row and column information, given like this:

    -

    Returns a string containing the range's row and column information, given like this: -

    +

    Returns a string containing the range's row and column information, given like this:

    +

    [start.row/start.column] -> [end.row/end.column]

       

    diff --git a/api/resources/javascripts/ux.js b/api/resources/javascripts/ux.js index 53e6c0fe..1d03e091 100644 --- a/api/resources/javascripts/ux.js +++ b/api/resources/javascripts/ux.js @@ -9,14 +9,6 @@ $(function () { if (window.addEventListener) window.addEventListener('load', loadCallback, true); else window.attachEvent('load', loadCallback, true); - // sticky footer stuff - if ($('#mainContent').height() > $('#sidebarContainer').height()) { - $('#nonFooter').css( { - 'min-height': '100%' - }); - $('#nonFooter').height("auto"); - } - function loadCallback(evt) { var form = document.getElementById("searchbox"); var input = form.query; diff --git a/api/scrollbar.html b/api/scrollbar.html index 917b5279..c2b18a4e 100644 --- a/api/scrollbar.html +++ b/api/scrollbar.html @@ -104,7 +104,7 @@
    -

    Creates a new ScrollBar. parent is the owner of the scroll bar. ...

    +

    Creates a new ScrollBar. parent is the owner of the scroll bar.

    Creates a new ScrollBar. parent is the owner of the scroll bar.

    @@ -178,8 +178,19 @@
    +
    +
      +
    • +
        +
      • ScrollBar.on("onScroll", function())
        • +
      +
        +
      +
      • +
    +
    -

    Emitted when the scroll bar, well, scrolls. ...

    +

    Emitted when the scroll bar, well, scrolls.

    Emitted when the scroll bar, well, scrolls.

    @@ -213,7 +224,7 @@
    -

    Returns the width of the scroll bar. ...

    +

    Returns the width of the scroll bar.

    Returns the width of the scroll bar.

    @@ -241,7 +252,7 @@
    -

    Sets the height of the scroll bar, in pixels. ...

    +

    Sets the height of the scroll bar, in pixels.

    Sets the height of the scroll bar, in pixels.

    @@ -270,7 +281,7 @@
    -

    Sets the inner height of the scroll bar, in pixels. ...

    +

    Sets the inner height of the scroll bar, in pixels.

    Sets the inner height of the scroll bar, in pixels.

    @@ -299,7 +310,7 @@
    -

    Sets the scroll top of the scroll bar. ...

    +

    Sets the scroll top of the scroll bar.

    Sets the scroll top of the scroll bar.

    diff --git a/api/search.html b/api/search.html index 80a9656b..fc38db24 100644 --- a/api/search.html +++ b/api/search.html @@ -137,7 +137,7 @@
    -

    A class designed to handle all sorts of text searches within a Document.

    +

    A class designed to handle all sorts of text searches within a Document.

    @@ -158,23 +158,34 @@
    -