From 039e04c16031222109aa515fa67c428df183804c Mon Sep 17 00:00:00 2001 From: Garen Torikian Date: Thu, 30 Aug 2012 11:30:59 -0700 Subject: [PATCH] Update Events documentation --- api/ace.html | 3 +- api/anchor.html | 27 ++- api/background_tokenizer.html | 28 ++- api/command_manager.html | 4 +- api/document.html | 94 +++++++--- api/edit_session.html | 249 +++++++++++++++++++-------- api/editor.html | 227 +++++++++++++++--------- api/placeholder.html | 12 +- api/range.html | 84 ++++++--- api/renderloop.html | 3 +- api/scrollbar.html | 19 +- api/search.html | 26 +-- api/selection.html | 62 +++++-- api/split.html | 29 +++- api/token_iterator.html | 7 +- api/tokenizer.html | 4 +- api/undomanager.html | 11 +- api/virtual_renderer.html | 109 +++++++----- doc/package.json | 2 +- doc/resources/ace/templates/lib.jade | 4 +- lib/ace/anchor.js | 9 +- lib/ace/background_tokenizer.js | 7 + lib/ace/document.js | 24 +++ lib/ace/edit_session.js | 76 +++++++- lib/ace/editor.js | 88 ++++------ lib/ace/scrollbar.js | 3 +- lib/ace/selection.js | 12 ++ lib/ace/virtual_renderer.js | 72 ++++---- 28 files changed, 891 insertions(+), 404 deletions(-) diff --git a/api/ace.html b/api/ace.html index db3f017e..eb2ecc96 100644 --- a/api/ace.html +++ b/api/ace.html @@ -4,7 +4,8 @@ Ace - Ace API

Ace[edit]

The main class required to set up an Ace instance in the browser.

Methods

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.

-

Arguments

elString | DOMElementRequired. Either the id of an element, or the element itself
+

Arguments

elString | DOMElement

Required. Either the id of an element, or the element itself

+
diff --git a/api/anchor.html b/api/anchor.html index 8e7c78de..515c299a 100644 --- a/api/anchor.html +++ b/api/anchor.html @@ -4,11 +4,25 @@ Anchor - Ace API

Anchor[edit]

Defines the floating pointer in the document. Whenever text is inserted or deleted before the cursor, the position of the cursor is updated

Constructors

Creates a new Anchor and associates it with a document.

   

Creates a new Anchor and associates it with a document.

-

Arguments

docDocumentRequired. The document to associate with the anchor
rowNumberRequired. The starting row position
columnNumberRequired. The starting column position

Events

    • Anchor.on("change", function(Event e))

    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 'insertText', 'insertLines', 'removeText', and 'removeLines'.

    -

    Arguments

    eEventRequired. Contains data about the event

    Methods

      • Internal

    Clips the anchor position to the specified row and column.

    +

    Arguments

    docDocument

    Required. The document to associate with the anchor

    +
    rowNumber

    Required. The starting row position

    +
    columnNumber

    Required. The starting column position

    +

    Events

      • Anchor.on("change", function(Object e))

      Fires whenever the anchor position changes.

      +

         

      Fires whenever the anchor position changes.

      +

      Events that can trigger this function include setPosition().

      +

      Arguments

      eObject

      Required. An object containing information about the anchor position. It has two properties:

      +
        +

      • old: An object describing the old Anchor position

        +
        • +

      • value: An object describing the new Anchor position

        +

        Both of these objects have a row and column property corresponding to the position.

        +
        • +
      +

      Methods

        • Internal

      Clips the anchor position to the specified row and column.

         

      Clips the anchor position to the specified row and column.

      -

      Arguments

      rowNumberRequired. The row index to clip the anchor to
      columnNumberRequired. The column index to clip the anchor to
        • Anchor.detach()

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

        +

        Arguments

        rowNumber

        Required. The row index to clip the anchor to

        +
        columnNumber

        Required. The column index to clip the anchor to

        +
          • Anchor.detach()

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

             

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

          Returns the current document.

             

          Returns the current document.

          @@ -16,7 +30,10 @@

             

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

          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.

          -

          Arguments

          rowNumberRequired. The row index to move the anchor to
          columnNumberRequired. The column index to move the anchor to
          noClipBooleanRequired. Identifies if you want the position to be clipped
          +

          Arguments

          rowNumber

          Required. The row index to move the anchor to

          +
          columnNumber

          Required. The column index to move the anchor to

          +
          noClipBoolean

          Required. Identifies if you want the position to be clipped

          +
          diff --git a/api/background_tokenizer.html b/api/background_tokenizer.html index 3e49b546..077a4acc 100644 --- a/api/background_tokenizer.html +++ b/api/background_tokenizer.html @@ -1,22 +1,34 @@ - BackgroundTokenizer - Ace API

          BackgroundTokenizer[edit]

          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.

          + BackgroundTokenizer - Ace API

          BackgroundTokenizer[edit]

          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.

          Constructors

          Creates a new BackgroundTokenizer object.

             

          Creates a new BackgroundTokenizer object.

          -

          Arguments

          tokenizerTokenizerRequired. The tokenizer to use
          editorEditorRequired. The editor to associate with

          Methods

            • BackgroundTokenizer.fireUpdateEvent(Number firstRow, Number lastRow)

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

            +

            Arguments

            tokenizerTokenizer

            Required. The tokenizer to use

            +
            editorEditor

            Required. The editor to associate with

            +

            Events

              • BackgroundTokenizer.on("update", function(Object e))

              Fires whenever the background tokeniziers between a range of rows are going to be updated.

              +

                 

              Fires whenever the background tokeniziers between a range of rows are going to be updated.

              +

              Arguments

              eObject

              Required. An object containing two properties, first and last, which indicate the rows of the region being updated.

              +

              Methods

                • BackgroundTokenizer.fireUpdateEvent(Number firstRow, Number lastRow)

                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.

                -

                Arguments

                firstRowNumberRequired. The starting row region
                lastRowNumberRequired. The final row region

                Returns the state of tokenization at the end of a row.

                +

                Arguments

                firstRowNumber

                Required. The starting row region

                +
                lastRowNumber

                Required. The final row region

                +

                Returns the state of tokenization at the end of a row.

                   

                Returns the state of tokenization at the end of a row.

                -

                Arguments

                rowNumberRequired. The row to get state at

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

                +

                Arguments

                rowNumber

                Required. The row to get state at

                +

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

                   

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

                -

                Arguments

                rowNumberRequired. The row to get tokens at
                  • BackgroundTokenizer.setDocument(Document doc)

                  Sets a new document to associate with this object.

                  +

                  Arguments

                  rowNumber

                  Required. The row to get tokens at

                  +
                    • BackgroundTokenizer.setDocument(Document doc)

                    Sets a new document to associate with this object.

                       

                    Sets a new document to associate with this object.

                    -

                    Arguments

                    docDocumentRequired. The new document to associate with
                      • BackgroundTokenizer.setTokenizer(Tokenizer tokenizer)

                      Sets a new tokenizer for this object.

                      +

                      Arguments

                      docDocument

                      Required. The new document to associate with

                      +
                        • BackgroundTokenizer.setTokenizer(Tokenizer tokenizer)

                        Sets a new tokenizer for this object.

                           

                        Sets a new tokenizer for this object.

                        -

                        Arguments

                        tokenizerTokenizerRequired. The new tokenizer to use
                          • BackgroundTokenizer.start(Number startRow)

                          Starts tokenizing at the row indicated.

                          +

                          Arguments

                          tokenizerTokenizer

                          Required. The new tokenizer to use

                          +
                            • BackgroundTokenizer.start(Number startRow)

                            Starts tokenizing at the row indicated.

                               

                            Starts tokenizing at the row indicated.

                            -

                            Arguments

                            startRowNumberRequired. The row to start at
                              • BackgroundTokenizer.stop()

                              Stops tokenizing.

                              +

                              Arguments

                              startRowNumber

                              Required. The row to start at

                              +
                                • BackgroundTokenizer.stop()

                                Stops tokenizing.

                                   

                                Stops tokenizing.

                                diff --git a/api/command_manager.html b/api/command_manager.html index 77143c13..6ac9425f 100644 --- a/api/command_manager.html +++ b/api/command_manager.html @@ -3,7 +3,9 @@ CommandManager - Ace API

                                CommandManager[edit]

                                Constructors

                                TODO

                                   

                                TODO

                                -

                                Arguments

                                platformStringRequired. Identifier for the platform; must be either 'mac' or 'win'
                                commandsArrayRequired. A list of commands
                                +

                                Arguments

                                platformString

                                Required. Identifier for the platform; must be either 'mac' or 'win'

                                +
                                commandsArray

                                Required. A list of commands

                                +
                                diff --git a/api/document.html b/api/document.html index 3fe3280a..5d24bf24 100644 --- a/api/document.html +++ b/api/document.html @@ -1,56 +1,110 @@ - Document - Ace API

                                Document[edit]

                                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.

                                + Document - Ace API

                                Document[edit]

                                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.

                                Constructors

                                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.

                                -

                                Arguments

                                textString | ArrayRequired. The starting text

                                Methods

                                  • Document.$clipPosition(position)
                                  • Internal

                                   

                                  • Document.$detectNewLine(text)
                                    • Void
                                  • Internal

                                   

                                Splits a string of text on any newline (\n) or carriage-return ('\r') characters.

                                +

                                Arguments

                                textString | Array

                                Required. The starting text

                                +

                                Events

                                  • Document.on("change", function(Object e))

                                  Fires whenever the document changes.

                                  +

                                     

                                  Fires whenever the document changes.

                                  +

                                  Several methods trigger different "change" events. Below is a list of each action type, followed by each property that's also available:

                                  + +

                                  Arguments

                                  eObject

                                  Required. Contains at least one property called "action". "action" indicates the action that triggered the change. Each action also has a set of additional properties.

                                  +

                                  Methods

                                    • Document.$clipPosition(position)
                                    • Internal

                                     

                                    • Document.$detectNewLine(text)
                                      • Void
                                    • Internal

                                     

                                  Splits a string of text on any newline (\n) or carriage-return ('\r') characters.

                                     

                                  Splits a string of text on any newline (\n) or carriage-return ('\r') characters.

                                  -

                                  Arguments

                                  textStringRequired. The text to work with
                                    • Document.applyDeltas(deltas)
                                      • Void

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

                                    +

                                    Arguments

                                    textString

                                    Required. The text to work with

                                    +

                                    Returns

                                    Array of StringsA String array, with each index containing a piece of the original text string.
                                      • Document.applyDeltas(deltas)
                                        • Void

                                      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'.

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

                                         

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

                                      -

                                      Arguments

                                      rowNumberRequired. The row number to use
                                      columnNumberRequired. The column number to use
                                        • Document.getAllLines()

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

                                        +

                                        Arguments

                                        rowNumber

                                        Required. The row number to use

                                        +
                                        columnNumber

                                        Required. The column number to use

                                        +
                                          • Document.getAllLines()

                                          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 the number of rows in the document.

                                             

                                          Returns the number of rows 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

                                          -

                                          Arguments

                                          rowNumberRequired. The row index to retrieve

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

                                          +

                                          Arguments

                                          rowNumber

                                          Required. The row index to retrieve

                                          +

                                          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.

                                          -

                                          Arguments

                                          firstRowNumberRequired. The first row index to retrieve
                                          lastRowNumberRequired. The final row index to retrieve
                                            • Document.getNewLineCharacter()

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

                                            +

                                            Arguments

                                            firstRowNumber

                                            Required. The first row index to retrieve

                                            +
                                            lastRowNumber

                                            Required. The final row index to retrieve

                                            +
                                              • Document.getNewLineCharacter()

                                              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.

                                              -
                                                • Document.getNewLineMode()

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

                                                +

                                                Returns

                                                StringIf newLineMode == windows, \r\n is returned.
                                                If newLineMode == unix, \n is returned.
                                                If newLineMode == auto, the value of autoNewLine is returned.
                                                  • 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

                                                  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.

                                                  -

                                                  Arguments

                                                  rangeRangeRequired. The range to work with

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

                                                  +

                                                  Arguments

                                                  rangeRange

                                                  Required. The range to work with

                                                  +

                                                  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.

                                                  -

                                                     

                                                  Arguments

                                                  positionNumberRequired. The position to start inserting at
                                                  textStringRequired. A chunk of text to insert

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

                                                  +

                                                     

                                                  Arguments

                                                  positionNumber

                                                  Required. The position to start inserting at

                                                  +
                                                  textString

                                                  Required. A chunk of text to insert

                                                  +

                                                  Returns

                                                  NumberThe position of the last line of text. If the length of text is 0, this function simply returns position. Inserts a block of text and the indicated position.

                                                  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.

                                                  -

                                                  Arguments

                                                  positionNumberRequired. The position to insert at
                                                  textStringRequired. A chunk of text

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

                                                  +

                                                  Arguments

                                                  positionNumber

                                                  Required. The position to insert at

                                                  +
                                                  textString

                                                  Required. A chunk of text

                                                  +

                                                  Returns

                                                  ObjectReturns an object containing the final row and column, like this:
                                                  {row: endRow, column: 0}
                                                  NumberIf text is empty, this function returns the value of position

                                                  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.

                                                  -

                                                  Arguments

                                                  rowNumberRequired. The index of the row to insert at
                                                  linesArrayRequired. An array of strings

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

                                                  +

                                                  Arguments

                                                  rowNumber

                                                  Required. The index of the row to insert at

                                                  +
                                                  linesArray

                                                  Required. An array of strings

                                                  +

                                                  Returns

                                                  ObjectReturns an object containing the final row and column, like this:
                                                  {row: endRow, column: 0}
                                                  If lines is empty, this function returns an object containing the current row, and column, like this:
                                                  {row: row, column: 0}

                                                  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.

                                                  -

                                                  Arguments

                                                  positionStringRequired. The position to insert at

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

                                                  +

                                                  Arguments

                                                  positionString

                                                  Required. The position to insert at

                                                  +

                                                  Returns

                                                  ObjectReturns an object containing the final row and column, like this:
                                                  {row: endRow, column: 0}

                                                  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).

                                                  -

                                                  Arguments

                                                  textStringRequired. The text to check

                                                  Removes the range from the document.

                                                  +

                                                  Arguments

                                                  textString

                                                  Required. The text to check

                                                  +

                                                  Removes the range from the document.

                                                     

                                                  Removes the range from the document.

                                                  -

                                                  Arguments

                                                  rangeRangeRequired. A specified Range to remove

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

                                                  +

                                                  Arguments

                                                  rangeRange

                                                  Required. A specified Range to remove

                                                  +

                                                  Returns

                                                  ObjectReturns the new start property of the range, which contains startRow and startColumn. If range is empty, this function returns the unmodified value of range.start.

                                                  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.

                                                  -

                                                  Arguments

                                                  rowNumberRequired. The row to remove from
                                                  startColumnNumberRequired. The column to start removing at
                                                  endColumnNumberRequired. The column to stop removing at

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

                                                  +

                                                  Arguments

                                                  rowNumber

                                                  Required. The row to remove from

                                                  +
                                                  startColumnNumber

                                                  Required. The column to start removing at

                                                  +
                                                  endColumnNumber

                                                  Required. The column to stop removing at

                                                  +

                                                  Returns

                                                  ObjectReturns an object containing startRow and startColumn, indicating the new row and column values.
                                                  If startColumn is equal to endColumn, this function returns nothing.

                                                  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.

                                                  -

                                                  Arguments

                                                  firstRowNumberRequired. The first row to be removed
                                                  lastRowNumberRequired. The last row to be removed
                                                    • Document.removeNewLine(Number row)
                                                      • Void

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

                                                    +

                                                    Arguments

                                                    firstRowNumber

                                                    Required. The first row to be removed

                                                    +
                                                    lastRowNumber

                                                    Required. The last row to be removed

                                                    +

                                                    Returns

                                                    Array of StringsReturns all the removed lines.
                                                      • Document.removeNewLine(Number row)
                                                        • Void

                                                      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.

                                                      -

                                                      Arguments

                                                      rowNumberRequired. The row to check

                                                      Replaces a range in the document with the new text.

                                                      +

                                                      Arguments

                                                      rowNumber

                                                      Required. The row to check

                                                      +

                                                      Replaces a range in the document with the new text.

                                                         

                                                      Replaces a range in the document with the new text.

                                                      -

                                                      Arguments

                                                      rangeRangeRequired. A specified Range to replace
                                                      textStringRequired. The new text to use as a replacement
                                                        • Document.revertDeltas(deltas)
                                                          • Void

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

                                                        +

                                                        Arguments

                                                        rangeRange

                                                        Required. A specified Range to replace

                                                        +
                                                        textString

                                                        Required. The new text to use as a replacement

                                                        +

                                                        Returns

                                                        ObjectReturns an object containing the final row and column, like this: {row: endRow, column: 0} If the text and range are empty, this function returns an object containing the current range.start value. If the text is the exact same as what currently exists, this function returns an object containing the current range.end value.
                                                          • Document.revertDeltas(deltas)
                                                            • Void

                                                          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'.

                                                            • Document.setNewLineMode(String newLineMode)
                                                              • Void

                                                            Sets the new line mode.

                                                               

                                                            Sets the new line mode.

                                                            -

                                                            Arguments

                                                            newLineModeStringRequired. The newline mode to use; can be either windows, unix, or auto
                                                              • Document.setValue(String text)
                                                                • Void

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

                                                              +

                                                              Arguments

                                                              newLineModeString

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

                                                              +
                                                                • Document.setValue(String text)
                                                                  • Void

                                                                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.

                                                                -

                                                                Arguments

                                                                textStringRequired. The text to use
                                                                +

                                                                Arguments

                                                                textString

                                                                Required. The text to use

                                                                +
                                                                diff --git a/api/edit_session.html b/api/edit_session.html index d924a865..e4c63d2a 100644 --- a/api/edit_session.html +++ b/api/edit_session.html @@ -1,60 +1,113 @@ - EditSession - Ace API

                                                                EditSession[edit]

                                                                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.

                                                                + EditSession - Ace API

                                                                EditSession[edit]

                                                                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.

                                                                Constructors

                                                                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.

                                                                -

                                                                Arguments

                                                                textDocument | StringRequired. If text is a Document, it associates the EditSession with it. Otherwise, a new Document is created, with the initial text
                                                                modeTextModeRequired. The inital language mode to use for the document

                                                                Events

                                                                  • EditSession.on("change", function(e))

                                                                  Emitted when the document changes.

                                                                  +

                                                                  Arguments

                                                                  textDocument | String

                                                                  Required. If text is a Document, it associates the EditSession with it. Otherwise, a new Document is created, with the initial text

                                                                  +
                                                                  modeTextMode

                                                                  Required. The inital language mode to use for the document

                                                                  +

                                                                  Events

                                                                    • EditSession.on("change", function(Object e))

                                                                    Emitted when the document changes.

                                                                       

                                                                    Emitted when the document changes.

                                                                    -
                                                                      • EditSession.on("changeFold", function(e))

                                                                      Emitted when a code fold added or removed.

                                                                      -

                                                                         

                                                                      Emitted when a code fold added or removed.

                                                                      -
                                                                        • EditSession.on("changeScrollLeft", function())

                                                                        Emitted when the scroll left changes.

                                                                        +

                                                                        Arguments

                                                                        eObject

                                                                        Required. An object containing a delta of information about the change.

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

                                                                          Emitted when a back marker changes.

                                                                          +

                                                                             

                                                                          Emitted when a back marker changes.

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

                                                                            Emitted when the gutter changes, either by setting or removing breakpoints, or when the gutter decorations change.

                                                                            +

                                                                               

                                                                            Emitted when the gutter changes, either by setting or removing breakpoints, or when the gutter decorations change.

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

                                                                              Emitted when a code fold is added or removed.

                                                                              +

                                                                                 

                                                                              Emitted when a code fold is added or removed.

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

                                                                                Emitted when a front marker changes.

                                                                                +

                                                                                   

                                                                                Emitted when a front marker changes.

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

                                                                                  Emitted when the current mode changes.

                                                                                  +

                                                                                     

                                                                                  Emitted when the current mode changes.

                                                                                  +
                                                                                    • EditSession.on("changeScrollLeft", function(Number scrollLeft))

                                                                                    Emitted when the scroll left changes.

                                                                                       

                                                                                    Emitted when the scroll left changes.

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

                                                                                      Emitted when the scroll top changes.

                                                                                      +

                                                                                      Arguments

                                                                                      scrollLeftNumber

                                                                                      Required. The new scroll left value

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

                                                                                        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.

                                                                                          -

                                                                                          Methods

                                                                                            • EditSession.$computeWrapSplits(tokens, wrapLimit)
                                                                                            • Internal

                                                                                             

                                                                                            • EditSession.$constrainWrapLimit(wrapLimit)
                                                                                            • Internal

                                                                                             

                                                                                            • EditSession.$detectNewLine(String text)
                                                                                            • Internal

                                                                                          If text contains either the newline (\n) or carriage-return ('\r') characters, $autoNewLine stores that value.

                                                                                          +

                                                                                          Arguments

                                                                                          scrollTopNumber

                                                                                          Required. The new scroll top value

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

                                                                                            Emitted when the wrapping limit changes.

                                                                                            +

                                                                                               

                                                                                            Emitted when the wrapping limit changes.

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

                                                                                              Emitted when the wrap mode changes.

                                                                                              +

                                                                                                 

                                                                                              Emitted when the wrap mode changes.

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

                                                                                                   

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

                                                                                                  Emitted when a background tokenizer asynchronously processes new rows.

                                                                                                  +

                                                                                                     

                                                                                                  Emitted when a background tokenizer asynchronously processes new rows.

                                                                                                  +

                                                                                                  Arguments

                                                                                                  eObject

                                                                                                  Required. An object containing one property, "data", that contains information about the changing rows

                                                                                                  +

                                                                                                  Methods

                                                                                                    • EditSession.$computeWrapSplits(tokens, wrapLimit)
                                                                                                    • Internal

                                                                                                     

                                                                                                    • EditSession.$constrainWrapLimit(wrapLimit)
                                                                                                    • Internal

                                                                                                     

                                                                                                    • EditSession.$detectNewLine(String text)
                                                                                                    • Internal

                                                                                                  If text contains either the newline (\n) or carriage-return ('\r') characters, $autoNewLine stores that value.

                                                                                                     

                                                                                                  If text contains either the newline (\n) or carriage-return ('\r') characters, $autoNewLine stores that value.

                                                                                                  -

                                                                                                  Arguments

                                                                                                  textStringRequired. A block of text

                                                                                                  Given a string, returns an array of the display characters, including tabs and spaces.

                                                                                                  +

                                                                                                  Arguments

                                                                                                  textString

                                                                                                  Required. A block of text

                                                                                                  +

                                                                                                  Given a string, returns an array of the display characters, including tabs and spaces.

                                                                                                     

                                                                                                  Given a string, returns an array of the display characters, including tabs and spaces.

                                                                                                  -

                                                                                                  Arguments

                                                                                                  strStringRequired. The string to check
                                                                                                  offsetNumberRequired. The value to start at

                                                                                                  Calculates the width of the string str on the screen while assuming that the string starts at the first column on the screen.

                                                                                                  +

                                                                                                  Arguments

                                                                                                  strString

                                                                                                  Required. The string to check

                                                                                                  +
                                                                                                  offsetNumber

                                                                                                  Required. The value to start at

                                                                                                  +

                                                                                                  Calculates the width of the string str on the screen while assuming that the string starts at the first column on the screen.

                                                                                                     

                                                                                                  Calculates the width of the string str on the screen while assuming that the string starts at the first column on the screen.

                                                                                                  -

                                                                                                  Arguments

                                                                                                  strStringRequired. The string to calculate the screen width of
                                                                                                  maxScreenColumnNumberRequired.
                                                                                                  screenColumnNumberRequired.
                                                                                                    • EditSession.$getUndoSelection(deltas, isUndo, lastUndoRange)
                                                                                                    • Internal

                                                                                                     

                                                                                                    • EditSession.$resetRowCache(Number row)
                                                                                                    • Internal

                                                                                                     

                                                                                                  Arguments

                                                                                                  rowNumberRequired. The row to work with
                                                                                                    • EditSession.$startWorker()
                                                                                                    • Internal

                                                                                                     

                                                                                                    • EditSession.$syncInformUndoManager()
                                                                                                    • Internal

                                                                                                     

                                                                                                    • EditSession.$updateInternalDataOnChange()
                                                                                                    • Internal

                                                                                                     

                                                                                                    • EditSession.$updateWrapData(firstRow, lastRow)
                                                                                                    • Internal

                                                                                                     

                                                                                                  Adds a dynamic marker to the session.

                                                                                                  +

                                                                                                  Arguments

                                                                                                  strString

                                                                                                  Required. The string to calculate the screen width of

                                                                                                  +
                                                                                                  maxScreenColumnNumber

                                                                                                  Required.

                                                                                                  +
                                                                                                  screenColumnNumber

                                                                                                  Required.

                                                                                                  +

                                                                                                  Returns

                                                                                                  Array of NumbersReturns an int[] array with two elements:
                                                                                                  The first position indicates the number of columns for str on screen.
                                                                                                  The second value contains the position of the document column that this function read until.
                                                                                                    • EditSession.$getUndoSelection(deltas, isUndo, lastUndoRange)
                                                                                                    • Internal

                                                                                                     

                                                                                                    • EditSession.$resetRowCache(Number row)
                                                                                                    • Internal

                                                                                                     

                                                                                                  Arguments

                                                                                                  rowNumber

                                                                                                  Required. The row to work with

                                                                                                  +
                                                                                                    • EditSession.$startWorker()
                                                                                                    • Internal

                                                                                                     

                                                                                                    • EditSession.$syncInformUndoManager()
                                                                                                    • Internal

                                                                                                     

                                                                                                    • EditSession.$updateInternalDataOnChange()
                                                                                                    • Internal

                                                                                                     

                                                                                                    • EditSession.$updateWrapData(firstRow, lastRow)
                                                                                                    • Internal

                                                                                                     

                                                                                                  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
                                                                                                    • EditSession.addGutterDecoration(Number row, String className)
                                                                                                      • Void

                                                                                                    Adds className to the row, to be used for CSS stylings and whatnot.

                                                                                                    +

                                                                                                    Arguments

                                                                                                    markerObject

                                                                                                    Required. object with update method

                                                                                                    +
                                                                                                    inFrontBoolean

                                                                                                    Required. Set to true to establish a front marker

                                                                                                    +
                                                                                                      • EditSession.addGutterDecoration(Number row, String className)
                                                                                                        • Void

                                                                                                      Adds className to the row, to be used for CSS stylings and whatnot.

                                                                                                         

                                                                                                      Adds className to the row, to be used for CSS stylings and whatnot.

                                                                                                      -

                                                                                                      Arguments

                                                                                                      rowNumberRequired. The row number
                                                                                                      classNameStringRequired. The class to add

                                                                                                      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.

                                                                                                      +

                                                                                                      Arguments

                                                                                                      rowNumber

                                                                                                      Required. The row number

                                                                                                      +
                                                                                                      classNameString

                                                                                                      Required. The class to add

                                                                                                      +

                                                                                                      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.

                                                                                                      -

                                                                                                      Arguments

                                                                                                      rangeRangeRequired. Define the range of the marker
                                                                                                      clazzStringRequired. Set the CSS class for the marker
                                                                                                      typeFunction | StringRequired. Identify the type of the marker
                                                                                                      inFrontBooleanRequired. Set to true to establish a front marker

                                                                                                      This should generally only be called by the renderer when a resize is detected.

                                                                                                      +

                                                                                                      Arguments

                                                                                                      rangeRange

                                                                                                      Required. Define the range of the marker

                                                                                                      +
                                                                                                      clazzString

                                                                                                      Required. Set the CSS class for the marker

                                                                                                      +
                                                                                                      typeFunction | String

                                                                                                      Required. Identify the type of the marker

                                                                                                      +
                                                                                                      inFrontBoolean

                                                                                                      Required. Set to true to establish a front marker

                                                                                                      +

                                                                                                      This should generally only be called by the renderer when a resize is detected.

                                                                                                         

                                                                                                      This should generally only be called by the renderer when a resize is detected.

                                                                                                      -

                                                                                                      Arguments

                                                                                                      desiredLimitNumberRequired. The new wrap limit
                                                                                                        • EditSession.clearAnnotations()

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

                                                                                                        +

                                                                                                        Arguments

                                                                                                        desiredLimitNumber

                                                                                                        Required. The new wrap limit

                                                                                                        +
                                                                                                          • EditSession.clearAnnotations()

                                                                                                          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.

                                                                                                            • EditSession.clearBreakpoint(Number row)

                                                                                                            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.

                                                                                                            -

                                                                                                            Arguments

                                                                                                            rowNumberRequired. A row index
                                                                                                              • EditSession.clearBreakpoints()

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

                                                                                                              +

                                                                                                              Arguments

                                                                                                              rowNumber

                                                                                                              Required. A row index

                                                                                                              +
                                                                                                                • EditSession.clearBreakpoints()

                                                                                                                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.

                                                                                                                  • EditSession.documentToScreenColumn(row, docColumn)
                                                                                                                  • Internal

                                                                                                                   

                                                                                                                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. This takes into account code folding, word wrap, tab size, and any other visual modifications.

                                                                                                                -

                                                                                                                Arguments

                                                                                                                docRowNumberRequired. The document row to check
                                                                                                                docColumnNumberRequired. The document column to check
                                                                                                                  • EditSession.documentToScreenRow(docRow, docColumn)
                                                                                                                  • Internal

                                                                                                                   

                                                                                                                Duplicates all the text between firstRow and lastRow.

                                                                                                                +

                                                                                                                Arguments

                                                                                                                docRowNumber

                                                                                                                Required. The document row to check

                                                                                                                +
                                                                                                                docColumnNumber

                                                                                                                Required. The document column to check

                                                                                                                +

                                                                                                                Returns

                                                                                                                ObjectThe object returned by this method has two properties: row and column.
                                                                                                                  • EditSession.documentToScreenRow(docRow, docColumn)
                                                                                                                  • Internal

                                                                                                                   

                                                                                                                Duplicates all the text between firstRow and lastRow.

                                                                                                                   

                                                                                                                Duplicates all the text between firstRow and lastRow.

                                                                                                                -

                                                                                                                Arguments

                                                                                                                firstRowNumberRequired. The starting row to duplicate
                                                                                                                lastRowNumberRequired. The final row to duplicate
                                                                                                                  • EditSession.getAnnotations()

                                                                                                                  Returns the annotations for the EditSession.

                                                                                                                  +

                                                                                                                  Arguments

                                                                                                                  firstRowNumber

                                                                                                                  Required. The starting row to duplicate

                                                                                                                  +
                                                                                                                  lastRowNumber

                                                                                                                  Required. The final row to duplicate

                                                                                                                  +

                                                                                                                  Returns

                                                                                                                  NumberReturns the number of new rows added; in other words, lastRow - firstRow + 1.
                                                                                                                    • EditSession.getAnnotations()

                                                                                                                    Returns the annotations for the EditSession.

                                                                                                                       

                                                                                                                    Returns the annotations for the EditSession.

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

                                                                                                                       

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

                                                                                                                    -

                                                                                                                    Arguments

                                                                                                                    rowNumberRequired. The row number to start from
                                                                                                                    columnNumberRequired. The column number to start from
                                                                                                                      • EditSession.getBreakpoints()

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

                                                                                                                      +

                                                                                                                      Arguments

                                                                                                                      rowNumber

                                                                                                                      Required. The row number to start from

                                                                                                                      +
                                                                                                                      columnNumber

                                                                                                                      Required. The column number to start from

                                                                                                                      +
                                                                                                                        • EditSession.getBreakpoints()

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

                                                                                                                           

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

                                                                                                                        Returns the Document associated with this session.

                                                                                                                           

                                                                                                                        Returns the Document associated with this session.

                                                                                                                        -
                                                                                                                          • EditSession.getDocumentLastRowColumnPosition(docRow, docColumn)
                                                                                                                          • Internal

                                                                                                                           

                                                                                                                          • EditSession.getDocumentLastRowColumnPosition(docRow, docColumn)
                                                                                                                          • Internal

                                                                                                                           

                                                                                                                        Returns the number of rows in the document.

                                                                                                                           

                                                                                                                        Returns the number of rows 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

                                                                                                                        -

                                                                                                                        Arguments

                                                                                                                        rowNumberRequired. The row to retrieve from

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

                                                                                                                        +

                                                                                                                        Arguments

                                                                                                                        rowNumber

                                                                                                                        Required. The row to retrieve from

                                                                                                                        +

                                                                                                                        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.

                                                                                                                        -

                                                                                                                        Arguments

                                                                                                                        firstRowNumberRequired. The first row index to retrieve
                                                                                                                        lastRowNumberRequired. The final row index to retrieve

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

                                                                                                                        +

                                                                                                                        Arguments

                                                                                                                        firstRowNumber

                                                                                                                        Required. The first row index to retrieve

                                                                                                                        +
                                                                                                                        lastRowNumber

                                                                                                                        Required. The final row index to retrieve

                                                                                                                        +

                                                                                                                        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.

                                                                                                                        -

                                                                                                                        Arguments

                                                                                                                        inFrontBooleanRequired. If true, indicates you only want front markers; false indicates only back markers

                                                                                                                        Returns the current text mode.

                                                                                                                        +

                                                                                                                        Arguments

                                                                                                                        inFrontBoolean

                                                                                                                        Required. If true, indicates you only want front markers; false indicates only back markers

                                                                                                                        +

                                                                                                                        Returns the current text mode.

                                                                                                                           

                                                                                                                        Returns the current text mode.

                                                                                                                        Returns the current new line mode.

                                                                                                                           

                                                                                                                        Returns the current new line mode.

                                                                                                                        @@ -62,13 +115,16 @@

                                                                                                                           

                                                                                                                        Returns true if overwrites are enabled; false otherwise.

                                                                                                                        Returns number of screenrows in a wrapped line.

                                                                                                                           

                                                                                                                        Returns number of screenrows in a wrapped line.

                                                                                                                        -

                                                                                                                        Arguments

                                                                                                                        rowNumberRequired. The row number to check
                                                                                                                          • EditSession.getRowSplitData(row)
                                                                                                                          • Internal

                                                                                                                           

                                                                                                                          • EditSession.getRowSplitData(row)
                                                                                                                          • Internal

                                                                                                                           

                                                                                                                        Returns the column position (on screen) for the last character in the provided row.

                                                                                                                           

                                                                                                                        Returns the column position (on screen) for the last character in the provided row.

                                                                                                                        -

                                                                                                                        Arguments

                                                                                                                        screenRowNumberRequired. The screen row to check
                                                                                                                          • EditSession.getScreenLength()

                                                                                                                          Returns the length of the screen.

                                                                                                                          +

                                                                                                                          Arguments

                                                                                                                          screenRowNumber

                                                                                                                          Required. The screen row to check

                                                                                                                          +
                                                                                                                            • EditSession.getScreenLength()

                                                                                                                            Returns the length of the screen.

                                                                                                                               

                                                                                                                            Returns the length of the screen.

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

                                                                                                                               

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

                                                                                                                            -

                                                                                                                            Arguments

                                                                                                                            screenColumnNumberRequired. The screen column to check
                                                                                                                              • EditSession.getScreenWidth()

                                                                                                                              Returns the width of the screen.

                                                                                                                              +

                                                                                                                              Arguments

                                                                                                                              screenColumnNumber

                                                                                                                              Required. The screen column to check

                                                                                                                              +
                                                                                                                                • EditSession.getScreenWidth()

                                                                                                                                Returns the width of the screen.

                                                                                                                                   

                                                                                                                                Returns the width of the screen.

                                                                                                                                  • 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.

                                                                                                                                  @@ -78,17 +134,22 @@

                                                                                                                                     

                                                                                                                                  Returns the string of the current selection.

                                                                                                                                  Returns the state of tokenization at the end of a row.

                                                                                                                                     

                                                                                                                                  Returns the state of tokenization at the end of a row.

                                                                                                                                  -

                                                                                                                                  Arguments

                                                                                                                                  rowNumberRequired. The row to start at
                                                                                                                                    • EditSession.getTabSize()

                                                                                                                                    Returns the current tab size.

                                                                                                                                    +

                                                                                                                                    Arguments

                                                                                                                                    rowNumber

                                                                                                                                    Required. The row to start at

                                                                                                                                    +
                                                                                                                                      • EditSession.getTabSize()

                                                                                                                                      Returns the current tab size.

                                                                                                                                         

                                                                                                                                      Returns the current tab size.

                                                                                                                                      -
                                                                                                                                        • EditSession.getTabString()

                                                                                                                                        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'.

                                                                                                                                        +
                                                                                                                                          • EditSession.getTabString()

                                                                                                                                          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'.

                                                                                                                                          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.

                                                                                                                                          -

                                                                                                                                          Arguments

                                                                                                                                          rangeStringRequired. The range to work with

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

                                                                                                                                          +

                                                                                                                                          Arguments

                                                                                                                                          rangeString

                                                                                                                                          Required. The range to work with

                                                                                                                                          +

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

                                                                                                                                             

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

                                                                                                                                          -

                                                                                                                                          Arguments

                                                                                                                                          rowNumberRequired. The row number to retrieve from
                                                                                                                                          columnNumberRequired. The column number to retrieve from

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

                                                                                                                                          +

                                                                                                                                          Arguments

                                                                                                                                          rowNumber

                                                                                                                                          Required. The row number to retrieve from

                                                                                                                                          +
                                                                                                                                          columnNumber

                                                                                                                                          Required. The column number to retrieve from

                                                                                                                                          +

                                                                                                                                          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.

                                                                                                                                          -

                                                                                                                                          Arguments

                                                                                                                                          rowNumberRequired. The row to start at

                                                                                                                                          Returns the current undo manager.

                                                                                                                                          +

                                                                                                                                          Arguments

                                                                                                                                          rowNumber

                                                                                                                                          Required. The row to start at

                                                                                                                                          +

                                                                                                                                          Returns the current undo manager.

                                                                                                                                             

                                                                                                                                          Returns the current undo manager.

                                                                                                                                            • EditSession.getUseSoftTabs()

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

                                                                                                                                               

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

                                                                                                                                            @@ -96,83 +157,129 @@

                                                                                                                                               

                                                                                                                                            Returns true if workers are being used.

                                                                                                                                              • EditSession.getUseWrapMode()

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

                                                                                                                                                 

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

                                                                                                                                              -

                                                                                                                                              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.

                                                                                                                                              -

                                                                                                                                              Arguments

                                                                                                                                              rowNumberRequired. The row to start at
                                                                                                                                              columnNumberRequired. The column to start at
                                                                                                                                                • EditSession.getWrapLimit()

                                                                                                                                                Returns the value of wrap limit.

                                                                                                                                                +

                                                                                                                                                Arguments

                                                                                                                                                rowNumber

                                                                                                                                                Required. The row to start at

                                                                                                                                                +
                                                                                                                                                columnNumber

                                                                                                                                                Required. The column to start at

                                                                                                                                                +
                                                                                                                                                  • EditSession.getWrapLimit()

                                                                                                                                                  Returns the value of wrap limit.

                                                                                                                                                     

                                                                                                                                                  Returns the value of wrap limit.

                                                                                                                                                    • EditSession.getWrapLimitRange()

                                                                                                                                                    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 }

                                                                                                                                                    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.

                                                                                                                                                    -

                                                                                                                                                    Arguments

                                                                                                                                                    startRowNumberRequired. Starting row
                                                                                                                                                    endRowNumberRequired. Ending row
                                                                                                                                                    indentStringStringRequired. The indent token

                                                                                                                                                    Inserts a block of text and the indicated position.

                                                                                                                                                    +

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

                                                                                                                                                    +

                                                                                                                                                    Arguments

                                                                                                                                                    startRowNumber

                                                                                                                                                    Required. Starting row

                                                                                                                                                    +
                                                                                                                                                    endRowNumber

                                                                                                                                                    Required. Ending row

                                                                                                                                                    +
                                                                                                                                                    indentStringString

                                                                                                                                                    Required. The indent token

                                                                                                                                                    +

                                                                                                                                                    Inserts a block of text and the indicated position.

                                                                                                                                                       

                                                                                                                                                    Inserts a block of text and the indicated position.

                                                                                                                                                    -

                                                                                                                                                    Arguments

                                                                                                                                                    positionNumberRequired. The position to start inserting at
                                                                                                                                                    textStringRequired. A chunk of text to insert

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

                                                                                                                                                    +

                                                                                                                                                    Arguments

                                                                                                                                                    positionNumber

                                                                                                                                                    Required. The position to start inserting at

                                                                                                                                                    +
                                                                                                                                                    textString

                                                                                                                                                    Required. A chunk of text to insert

                                                                                                                                                    +

                                                                                                                                                    Returns

                                                                                                                                                    NumberThe position of the last line of text. If the length of text is 0, this function simply returns position.

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

                                                                                                                                                       

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

                                                                                                                                                    -

                                                                                                                                                    Arguments

                                                                                                                                                    positionObjectRequired. The position to check

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

                                                                                                                                                    +

                                                                                                                                                    Arguments

                                                                                                                                                    positionObject

                                                                                                                                                    Required. The position to check

                                                                                                                                                    +

                                                                                                                                                       

                                                                                                                                                    Arguments

                                                                                                                                                    firstRowNumber

                                                                                                                                                    Required. The starting row to move down

                                                                                                                                                    +
                                                                                                                                                    lastRowNumber

                                                                                                                                                    Required. The final row to move down

                                                                                                                                                    +

                                                                                                                                                    Returns

                                                                                                                                                    NumberIf firstRow is less-than or equal to 0, this function returns 0. Otherwise, on success, it returns -1.

                                                                                                                                                    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.

                                                                                                                                                    -

                                                                                                                                                    Arguments

                                                                                                                                                    firstRowNumberRequired. The starting row to move up
                                                                                                                                                    lastRowNumberRequired. The final row to move up

                                                                                                                                                    { row: newRowLocation, column: newColumnLocation }

                                                                                                                                                    +

                                                                                                                                                    Arguments

                                                                                                                                                    firstRowNumber

                                                                                                                                                    Required. The starting row to move up

                                                                                                                                                    +
                                                                                                                                                    lastRowNumber

                                                                                                                                                    Required. The final row to move up

                                                                                                                                                    +

                                                                                                                                                    Returns

                                                                                                                                                    NumberIf firstRow is less-than or equal to 0, this function returns 0. Otherwise, on success, it returns -1.

                                                                                                                                                    { row: newRowLocation, column: newColumnLocation }

                                                                                                                                                       

                                                                                                                                                    { row: newRowLocation, column: newColumnLocation }

                                                                                                                                                    -

                                                                                                                                                    Arguments

                                                                                                                                                    fromRangeRangeRequired. The range of text you want moved within the document
                                                                                                                                                    toPositionObjectRequired. The location (row and column) where you want to move the text to
                                                                                                                                                      • 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.

                                                                                                                                                      +

                                                                                                                                                      Arguments

                                                                                                                                                      fromRangeRange

                                                                                                                                                      Required. The range of text you want moved within the document

                                                                                                                                                      +
                                                                                                                                                      toPositionObject

                                                                                                                                                      Required. The location (row and column) where you want to move the text to

                                                                                                                                                      +

                                                                                                                                                      Returns

                                                                                                                                                      RangeThe new range where the text was moved to. Moves a range of text from the given range to the given position. toPosition is an object that looks like this:
                                                                                                                                                        • EditSession.onReloadTokenizer(e)

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

                                                                                                                                                        +

                                                                                                                                                           

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

                                                                                                                                                          • EditSession.outdentRows(Range 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.

                                                                                                                                                          -

                                                                                                                                                          Arguments

                                                                                                                                                          rangeRangeRequired. A range of rows

                                                                                                                                                          Re-implements a previously undone change to your document.

                                                                                                                                                          +

                                                                                                                                                          Arguments

                                                                                                                                                          rangeRange

                                                                                                                                                          Required. A range of rows

                                                                                                                                                          +

                                                                                                                                                          Re-implements a previously undone change to your document.

                                                                                                                                                             

                                                                                                                                                          Re-implements a previously undone change to your document.

                                                                                                                                                          -

                                                                                                                                                          Arguments

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

                                                                                                                                                          Removes the range from the document.

                                                                                                                                                          +

                                                                                                                                                          Arguments

                                                                                                                                                          deltasArray

                                                                                                                                                          Required. An array of previous changes

                                                                                                                                                          +
                                                                                                                                                          dontSelectBoolean

                                                                                                                                                          Required. If true, doesn't select the range of where the change occured

                                                                                                                                                          +

                                                                                                                                                          Removes the range from the document.

                                                                                                                                                             

                                                                                                                                                          Removes the range from the document.

                                                                                                                                                          -

                                                                                                                                                          Arguments

                                                                                                                                                          rangeRangeRequired. A specified Range to remove
                                                                                                                                                            • EditSession.removeGutterDecoration(Number row, String className)
                                                                                                                                                              • Void

                                                                                                                                                            Removes className from the row.

                                                                                                                                                            +

                                                                                                                                                            Arguments

                                                                                                                                                            rangeRange

                                                                                                                                                            Required. A specified Range to remove

                                                                                                                                                            +

                                                                                                                                                            Returns

                                                                                                                                                            ObjectThe new start property of the range, which contains startRow and startColumn. If range is empty, this function returns the unmodified value of range.start.
                                                                                                                                                              • EditSession.removeGutterDecoration(Number row, String className)
                                                                                                                                                                • Void

                                                                                                                                                              Removes className from the row.

                                                                                                                                                                 

                                                                                                                                                              Removes className from the row.

                                                                                                                                                              -

                                                                                                                                                              Arguments

                                                                                                                                                              rowNumberRequired. The row number
                                                                                                                                                              classNameStringRequired. The class to add
                                                                                                                                                                • EditSession.removeMarker(Number markerId)

                                                                                                                                                                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.

                                                                                                                                                                +

                                                                                                                                                                Arguments

                                                                                                                                                                rowNumber

                                                                                                                                                                Required. The row number

                                                                                                                                                                +
                                                                                                                                                                classNameString

                                                                                                                                                                Required. The class to add

                                                                                                                                                                +
                                                                                                                                                                  • EditSession.removeMarker(Number markerId)

                                                                                                                                                                  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.

                                                                                                                                                                  -

                                                                                                                                                                  Arguments

                                                                                                                                                                  markerIdNumberRequired. A number representing a marker

                                                                                                                                                                  Replaces a range in the document with the new text.

                                                                                                                                                                  +

                                                                                                                                                                  Arguments

                                                                                                                                                                  markerIdNumber

                                                                                                                                                                  Required. A number representing a marker

                                                                                                                                                                  +

                                                                                                                                                                  Replaces a range in the document with the new text.

                                                                                                                                                                     

                                                                                                                                                                  Replaces a range in the document with the new text.

                                                                                                                                                                  -

                                                                                                                                                                  Arguments

                                                                                                                                                                  rangeRangeRequired. A specified Range to replace
                                                                                                                                                                  textStringRequired. The new text to use as a replacement
                                                                                                                                                                    • EditSession.screenToDocumentColumn(screenRow, screenColumn)
                                                                                                                                                                    • Internal

                                                                                                                                                                     

                                                                                                                                                                  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.

                                                                                                                                                                  +

                                                                                                                                                                  Arguments

                                                                                                                                                                  rangeRange

                                                                                                                                                                  Required. A specified Range to replace

                                                                                                                                                                  +
                                                                                                                                                                  textString

                                                                                                                                                                  Required. The new text to use as a replacement

                                                                                                                                                                  +

                                                                                                                                                                  Returns

                                                                                                                                                                  ObjectReturns an object containing the final row and column, like this:
                                                                                                                                                                  {row: endRow, column: 0}
                                                                                                                                                                  If the text and range are empty, this function returns an object containing the current range.start value.
                                                                                                                                                                  If the text is the exact same as what currently exists, this function returns an object containing the current range.end value.
                                                                                                                                                                    • EditSession.screenToDocumentColumn(screenRow, screenColumn)
                                                                                                                                                                    • Internal

                                                                                                                                                                     

                                                                                                                                                                  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.

                                                                                                                                                                     

                                                                                                                                                                  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.

                                                                                                                                                                  -

                                                                                                                                                                  Arguments

                                                                                                                                                                  screenRowNumberRequired. The screen row to check
                                                                                                                                                                  screenColumnNumberRequired. The screen column to check
                                                                                                                                                                    • EditSession.screenToDocumentRow(screenRow, screenColumn)
                                                                                                                                                                    • Internal

                                                                                                                                                                     

                                                                                                                                                                    • EditSession.setAnnotations(Array annotations)

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

                                                                                                                                                                    +

                                                                                                                                                                    Arguments

                                                                                                                                                                    screenRowNumber

                                                                                                                                                                    Required. The screen row to check

                                                                                                                                                                    +
                                                                                                                                                                    screenColumnNumber

                                                                                                                                                                    Required. The screen column to check

                                                                                                                                                                    +

                                                                                                                                                                    Returns

                                                                                                                                                                    ObjectThe object returned has two properties: row and column.
                                                                                                                                                                      • EditSession.screenToDocumentRow(screenRow, screenColumn)
                                                                                                                                                                      • Internal

                                                                                                                                                                       

                                                                                                                                                                      • EditSession.setAnnotations(Array annotations)

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

                                                                                                                                                                         

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

                                                                                                                                                                      -

                                                                                                                                                                      Arguments

                                                                                                                                                                      annotationsArrayRequired. A list of annotations

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

                                                                                                                                                                      +

                                                                                                                                                                      Arguments

                                                                                                                                                                      annotationsArray

                                                                                                                                                                      Required. A list of annotations

                                                                                                                                                                      +

                                                                                                                                                                      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.

                                                                                                                                                                      -

                                                                                                                                                                      Arguments

                                                                                                                                                                      rowNumberRequired. A row index
                                                                                                                                                                      classNameStringRequired. Class of the breakpoint
                                                                                                                                                                        • EditSession.setBreakpoints(Array rows)

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

                                                                                                                                                                        +

                                                                                                                                                                        Arguments

                                                                                                                                                                        rowNumber

                                                                                                                                                                        Required. A row index

                                                                                                                                                                        +
                                                                                                                                                                        classNameString

                                                                                                                                                                        Required. Class of the breakpoint

                                                                                                                                                                        +
                                                                                                                                                                          • EditSession.setBreakpoints(Array rows)

                                                                                                                                                                          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.

                                                                                                                                                                          -

                                                                                                                                                                          Arguments

                                                                                                                                                                          rowsArrayRequired. An array of row indicies

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

                                                                                                                                                                          +

                                                                                                                                                                          Arguments

                                                                                                                                                                          rowsArray

                                                                                                                                                                          Required. An array of row indicies

                                                                                                                                                                          +

                                                                                                                                                                          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.

                                                                                                                                                                          -

                                                                                                                                                                          Arguments

                                                                                                                                                                          docDocumentRequired. The new Document to use

                                                                                                                                                                          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.

                                                                                                                                                                          -

                                                                                                                                                                          Arguments

                                                                                                                                                                          modeTextModeRequired. Set a new text mode

                                                                                                                                                                          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.

                                                                                                                                                                          +

                                                                                                                                                                          Arguments

                                                                                                                                                                          modeTextMode

                                                                                                                                                                          Required. Set a new text mode

                                                                                                                                                                          +

                                                                                                                                                                          Sets the new line mode.

                                                                                                                                                                             

                                                                                                                                                                          Sets the new line mode.

                                                                                                                                                                          -

                                                                                                                                                                          Arguments

                                                                                                                                                                          newLineModeStringRequired. The newline mode to use; can be either windows, unix, or auto
                                                                                                                                                                            • EditSession.setOverwrite(Boolean overwrite)

                                                                                                                                                                            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.

                                                                                                                                                                            -

                                                                                                                                                                            Arguments

                                                                                                                                                                            overwriteBooleanRequired. Defines wheter or not to set overwrites
                                                                                                                                                                              • EditSession.setScrollLeft(scrollLeft)

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

                                                                                                                                                                              +

                                                                                                                                                                              Arguments

                                                                                                                                                                              newLineModeString

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

                                                                                                                                                                              +
                                                                                                                                                                                • EditSession.setOverwrite(Boolean overwrite)

                                                                                                                                                                                Pass in true to enable overwrites in your session, or false to disable.

                                                                                                                                                                                +

                                                                                                                                                                                   

                                                                                                                                                                                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.

                                                                                                                                                                                +

                                                                                                                                                                                Arguments

                                                                                                                                                                                overwriteBoolean

                                                                                                                                                                                Required. Defines wheter or not to set overwrites

                                                                                                                                                                                +
                                                                                                                                                                                  • EditSession.setScrollLeft(scrollLeft)

                                                                                                                                                                                  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.setScrollTop(Number scrollTop)

                                                                                                                                                                                    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.

                                                                                                                                                                                    -

                                                                                                                                                                                    Arguments

                                                                                                                                                                                    scrollTopNumberRequired. The new scroll top value
                                                                                                                                                                                      • EditSession.setTabSize(Number tabSize)

                                                                                                                                                                                      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.

                                                                                                                                                                                      +

                                                                                                                                                                                      Arguments

                                                                                                                                                                                      scrollTopNumber

                                                                                                                                                                                      Required. The new scroll top value

                                                                                                                                                                                      +
                                                                                                                                                                                        • EditSession.setTabSize(Number tabSize)

                                                                                                                                                                                        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.

                                                                                                                                                                                        -

                                                                                                                                                                                        Arguments

                                                                                                                                                                                        tabSizeNumberRequired. The new tab size

                                                                                                                                                                                        Sets the undo manager.

                                                                                                                                                                                        +

                                                                                                                                                                                        Arguments

                                                                                                                                                                                        tabSizeNumber

                                                                                                                                                                                        Required. The new tab size

                                                                                                                                                                                        +

                                                                                                                                                                                        Sets the undo manager.

                                                                                                                                                                                           

                                                                                                                                                                                        Sets the undo manager.

                                                                                                                                                                                        -

                                                                                                                                                                                        Arguments

                                                                                                                                                                                        undoManagerUndoManagerRequired. The new undo manager
                                                                                                                                                                                          • EditSession.setUndoSelect(Boolean enable)

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

                                                                                                                                                                                          +

                                                                                                                                                                                          Arguments

                                                                                                                                                                                          undoManagerUndoManager

                                                                                                                                                                                          Required. The new undo manager

                                                                                                                                                                                          +
                                                                                                                                                                                            • EditSession.setUndoSelect(Boolean enable)

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

                                                                                                                                                                                               

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

                                                                                                                                                                                            -

                                                                                                                                                                                            Arguments

                                                                                                                                                                                            enableBooleanRequired. If true, selects the range of the reinserted change
                                                                                                                                                                                              • EditSession.setUseSoftTabs(Boolean useSoftTabs)

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

                                                                                                                                                                                              +

                                                                                                                                                                                              Arguments

                                                                                                                                                                                              enableBoolean

                                                                                                                                                                                              Required. If true, selects the range of the reinserted change

                                                                                                                                                                                              +
                                                                                                                                                                                                • EditSession.setUseSoftTabs(Boolean useSoftTabs)

                                                                                                                                                                                                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').

                                                                                                                                                                                                -

                                                                                                                                                                                                Arguments

                                                                                                                                                                                                useSoftTabsBooleanRequired. Value indicating whether or not to use soft tabs
                                                                                                                                                                                                  • EditSession.setUseWorker(Boolean useWorker)

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

                                                                                                                                                                                                  +

                                                                                                                                                                                                  Arguments

                                                                                                                                                                                                  useSoftTabsBoolean

                                                                                                                                                                                                  Required. Value indicating whether or not to use soft tabs

                                                                                                                                                                                                  +
                                                                                                                                                                                                    • EditSession.setUseWorker(Boolean useWorker)

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

                                                                                                                                                                                                       

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

                                                                                                                                                                                                    -

                                                                                                                                                                                                    Arguments

                                                                                                                                                                                                    useWorkerBooleanRequired. Set to true to use a worker
                                                                                                                                                                                                      • EditSession.setUseWrapMode(Boolean useWrapMode)

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

                                                                                                                                                                                                      +

                                                                                                                                                                                                      Arguments

                                                                                                                                                                                                      useWorkerBoolean

                                                                                                                                                                                                      Required. Set to true to use a worker

                                                                                                                                                                                                      +
                                                                                                                                                                                                        • EditSession.setUseWrapMode(Boolean useWrapMode)

                                                                                                                                                                                                        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.

                                                                                                                                                                                                        -

                                                                                                                                                                                                        Arguments

                                                                                                                                                                                                        useWrapModeBooleanRequired. Enable (or disable) wrap mode
                                                                                                                                                                                                          • EditSession.setValue(String text)

                                                                                                                                                                                                          Sets the session text.

                                                                                                                                                                                                          +

                                                                                                                                                                                                          Arguments

                                                                                                                                                                                                          useWrapModeBoolean

                                                                                                                                                                                                          Required. Enable (or disable) wrap mode

                                                                                                                                                                                                          +
                                                                                                                                                                                                            • EditSession.setValue(String text)

                                                                                                                                                                                                            Sets the session text.

                                                                                                                                                                                                               

                                                                                                                                                                                                            Sets the session text.

                                                                                                                                                                                                            -

                                                                                                                                                                                                            Arguments

                                                                                                                                                                                                            textStringRequired. The new text to place

                                                                                                                                                                                                            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.

                                                                                                                                                                                                            +

                                                                                                                                                                                                            Arguments

                                                                                                                                                                                                            textString

                                                                                                                                                                                                            Required. The new text to place

                                                                                                                                                                                                            +

                                                                                                                                                                                                            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.

                                                                                                                                                                                                            -

                                                                                                                                                                                                            Arguments

                                                                                                                                                                                                            minNumberRequired. The minimum wrap value (the left side wrap)
                                                                                                                                                                                                            maxNumberRequired. The maximum wrap value (the right side wrap)
                                                                                                                                                                                                              • EditSession.stopWorker()
                                                                                                                                                                                                              • Internal

                                                                                                                                                                                                               

                                                                                                                                                                                                              • EditSession.toggleOverwrite()

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

                                                                                                                                                                                                              +

                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                              minNumber

                                                                                                                                                                                                              Required. The minimum wrap value (the left side wrap)

                                                                                                                                                                                                              +
                                                                                                                                                                                                              maxNumber

                                                                                                                                                                                                              Required. The maximum wrap value (the right side wrap)

                                                                                                                                                                                                              +
                                                                                                                                                                                                                • EditSession.stopWorker()
                                                                                                                                                                                                                • Internal

                                                                                                                                                                                                                 

                                                                                                                                                                                                                • EditSession.toggleOverwrite()

                                                                                                                                                                                                                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.

                                                                                                                                                                                                                -

                                                                                                                                                                                                                Reverts previous changes to your document.

                                                                                                                                                                                                                   

                                                                                                                                                                                                                Reverts previous changes to your document.

                                                                                                                                                                                                                -

                                                                                                                                                                                                                Arguments

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

                                                                                                                                                                                                                Arguments

                                                                                                                                                                                                                deltasArray

                                                                                                                                                                                                                Required. An array of previous changes

                                                                                                                                                                                                                +
                                                                                                                                                                                                                dontSelectBoolean

                                                                                                                                                                                                                Required. If true, doesn't select the range of where the change occured

                                                                                                                                                                                                                +
                                                                                                                                                                                                                diff --git a/api/editor.html b/api/editor.html index e2b7c172..e3df27f9 100644 --- a/api/editor.html +++ b/api/editor.html @@ -1,45 +1,44 @@ - Editor - Ace API

                                                                                                                                                                                                                Editor[edit]

                                                                                                                                                                                                                The main entry point into the Ace functionality. The Editor manages the EditSession (which manages Documents), as well as the VirtualRenderer, which draws everything to the screen. Event sessions dealing with the mouse and keyboard are bubbled up from Document to the Editor, which decides what to do with them.

                                                                                                                                                                                                                + Editor - Ace API

                                                                                                                                                                                                                Editor[edit]

                                                                                                                                                                                                                The main entry point into the Ace functionality. The Editor manages the EditSession (which manages Documents), as well as the VirtualRenderer, which draws everything to the screen. Event sessions dealing with the mouse and keyboard are bubbled up from Document to the Editor, which decides what to do with them.

                                                                                                                                                                                                                Constructors

                                                                                                                                                                                                                Creates a new Editor object.

                                                                                                                                                                                                                   

                                                                                                                                                                                                                Creates a new Editor object.

                                                                                                                                                                                                                -

                                                                                                                                                                                                                Arguments

                                                                                                                                                                                                                rendererVirtualRendererRequired. Associated VirtualRenderer that draws everything
                                                                                                                                                                                                                sessionEditSessionRequired. The EditSession to refer to

                                                                                                                                                                                                                Events

                                                                                                                                                                                                                  • Editor.on("blur", function())

                                                                                                                                                                                                                  Emitted once the editor has been blurred.

                                                                                                                                                                                                                  +

                                                                                                                                                                                                                  Arguments

                                                                                                                                                                                                                  rendererVirtualRenderer

                                                                                                                                                                                                                  Required. Associated VirtualRenderer that draws everything

                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  sessionEditSession

                                                                                                                                                                                                                  Required. The EditSession to refer to

                                                                                                                                                                                                                  +

                                                                                                                                                                                                                  Events

                                                                                                                                                                                                                    • Editor.on("blur", function())

                                                                                                                                                                                                                    Emitted once the editor has been blurred.

                                                                                                                                                                                                                       

                                                                                                                                                                                                                    Emitted once the editor has been blurred.

                                                                                                                                                                                                                      • Editor.on("change", 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
                                                                                                                                                                                                                        • Editor.on("changeAnnotation", function())

                                                                                                                                                                                                                        Emitted when an annotation changes.

                                                                                                                                                                                                                        -

                                                                                                                                                                                                                           

                                                                                                                                                                                                                        Emitted when an annotation changes.

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

                                                                                                                                                                                                                          Emitted when a back marker changes.

                                                                                                                                                                                                                          -

                                                                                                                                                                                                                             

                                                                                                                                                                                                                          Emitted when a back marker changes.

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

                                                                                                                                                                                                                            Emitted when a breakpoint changes.

                                                                                                                                                                                                                            -

                                                                                                                                                                                                                               

                                                                                                                                                                                                                            Emitted when a breakpoint changes.

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

                                                                                                                                                                                                                              Emitted when the code folds change.

                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                 

                                                                                                                                                                                                                              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.

                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                          Arguments

                                                                                                                                                                                                                                          eObject

                                                                                                                                                                                                                                          Required. Contains a single property, data, which has the delta of changes

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

                                                                                                                                                                                                                                            Emitted when the selection changes.

                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                               

                                                                                                                                                                                                                                            Emitted when the selection changes.

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                              • Editor.on("changeSelectionStyle", function(Object data))

                                                                                                                                                                                                                                              Emitted when the selection style changes, via Editor.setSelectionStyle.

                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                 

                                                                                                                                                                                                                                              Emitted when the selection style changes, via Editor.setSelectionStyle.

                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                                                              dataObject

                                                                                                                                                                                                                                              Required. Contains one property, data, which indicates the new selection style

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

                                                                                                                                                                                                                                                Emitted whenever the EditSession changes.

                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                   

                                                                                                                                                                                                                                                Emitted whenever the EditSession changes.

                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                Arguments

                                                                                                                                                                                                                                                eObject

                                                                                                                                                                                                                                                Required. An object with two properties, oldSession and session, that represent the old and new EditSessions.

                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                  • Editor.on("copy", function(String text))

                                                                                                                                                                                                                                                  Emitted when text is copied.

                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                     

                                                                                                                                                                                                                                                  Emitted when text is copied.

                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                  Arguments

                                                                                                                                                                                                                                                  textString

                                                                                                                                                                                                                                                  Required. The copied text

                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                    • 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

                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                        • Editor.$getSelectedRows()

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

                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                          • Editor.on("paste", function(String text))

                                                                                                                                                                                                                                                          Emitted when text is pasted.

                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                             

                                                                                                                                                                                                                                                          Emitted when text is pasted.

                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                          Arguments

                                                                                                                                                                                                                                                          textString

                                                                                                                                                                                                                                                          Required. The pasted text

                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                            • Editor.$getSelectedRows()

                                                                                                                                                                                                                                                            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 }

                                                                                                                                                                                                                                                              • Editor.$getVisibleRowCount()

                                                                                                                                                                                                                                                              Returns the number of currently visibile rows.

                                                                                                                                                                                                                                                                 

                                                                                                                                                                                                                                                              Returns the number of currently visibile rows.

                                                                                                                                                                                                                                                                • Editor.$highlightBrackets()
                                                                                                                                                                                                                                                                • Internal

                                                                                                                                                                                                                                                                 

                                                                                                                                                                                                                                                              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.

                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                                                                              moverFunctionRequired. A method to call on each selected row
                                                                                                                                                                                                                                                                • Editor.$updateHighlightActiveLine()
                                                                                                                                                                                                                                                                • Internal

                                                                                                                                                                                                                                                                 

                                                                                                                                                                                                                                                                • Editor.addSelectionMarker(Range orientedRange)

                                                                                                                                                                                                                                                                Adds the selection and cursor.

                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                Arguments

                                                                                                                                                                                                                                                                moverFunction

                                                                                                                                                                                                                                                                Required. A method to call on each selected row

                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                  • Editor.$updateHighlightActiveLine()
                                                                                                                                                                                                                                                                  • Internal

                                                                                                                                                                                                                                                                   

                                                                                                                                                                                                                                                                  • Editor.addSelectionMarker(Range orientedRange)

                                                                                                                                                                                                                                                                  Adds the selection and cursor.

                                                                                                                                                                                                                                                                     

                                                                                                                                                                                                                                                                  Adds the selection and cursor.

                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                  Arguments

                                                                                                                                                                                                                                                                  orientedRangeRangeRequired. A range containing a cursor

                                                                                                                                                                                                                                                                  Outdents the current line.

                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                  Arguments

                                                                                                                                                                                                                                                                  orientedRangeRange

                                                                                                                                                                                                                                                                  Required. A range containing a cursor

                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                  Outdents the current line.

                                                                                                                                                                                                                                                                     

                                                                                                                                                                                                                                                                  Outdents the current line.

                                                                                                                                                                                                                                                                    • Editor.blur()

                                                                                                                                                                                                                                                                    Blurs the current textInput.

                                                                                                                                                                                                                                                                       

                                                                                                                                                                                                                                                                    Blurs the current textInput.

                                                                                                                                                                                                                                                                    @@ -49,31 +48,43 @@

                                                                                                                                                                                                                                                                       

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

                                                                                                                                                                                                                                                                    Copies all the selected lines down one row.

                                                                                                                                                                                                                                                                       

                                                                                                                                                                                                                                                                    Copies all the selected lines down one row.

                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                    Copies all the selected lines up one row.

                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Returns

                                                                                                                                                                                                                                                                    NumberOn success, returns the number of new rows added; in other words, lastRow - firstRow + 1.
                                                                                                                                                                                                                                                                      • Editor.destroy()

                                                                                                                                                                                                                                                                      Cleans up the entire editor.

                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                      Returns

                                                                                                                                                                                                                                                                      NumberOn success, returns 0.
                                                                                                                                                                                                                                                                        • Editor.destroy()

                                                                                                                                                                                                                                                                        Cleans up the entire editor.

                                                                                                                                                                                                                                                                           

                                                                                                                                                                                                                                                                        Cleans up the entire editor.

                                                                                                                                                                                                                                                                          • Editor.exitMultiSelectMode()
                                                                                                                                                                                                                                                                            • Void

                                                                                                                                                                                                                                                                          Removes all the selections except the last added one.

                                                                                                                                                                                                                                                                             

                                                                                                                                                                                                                                                                          Removes all the selections except the last added one.

                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                          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 (optional)
                                                                                                                                                                                                                                                                          optionsObjectRequired. An object defining various search properties
                                                                                                                                                                                                                                                                          animateBooleanRequired. If true animate scrolling

                                                                                                                                                                                                                                                                          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

                                                                                                                                                                                                                                                                          needleString

                                                                                                                                                                                                                                                                          Required. The text to search for (optional)

                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          optionsObject

                                                                                                                                                                                                                                                                          Required. An object defining various search properties

                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          animateBoolean

                                                                                                                                                                                                                                                                          Required. If true animate scrolling

                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                          Finds and selects all the occurences of needle.

                                                                                                                                                                                                                                                                             

                                                                                                                                                                                                                                                                          Finds and selects all the occurences of needle.

                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                          Arguments

                                                                                                                                                                                                                                                                          needleStringRequired. The text to find
                                                                                                                                                                                                                                                                          optionsObjectRequired. The search options
                                                                                                                                                                                                                                                                          additiveBooleanRequired. keeps

                                                                                                                                                                                                                                                                          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.

                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                          Arguments

                                                                                                                                                                                                                                                                          optionsObjectRequired. search options
                                                                                                                                                                                                                                                                          animateBooleanRequired. If true animate scrolling

                                                                                                                                                                                                                                                                          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.

                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                          Arguments

                                                                                                                                                                                                                                                                          optionsObjectRequired. search options
                                                                                                                                                                                                                                                                          animateBooleanRequired. If true animate scrolling
                                                                                                                                                                                                                                                                            • Editor.focus()

                                                                                                                                                                                                                                                                            Brings the current textInput into focus.

                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                            Arguments

                                                                                                                                                                                                                                                                            needleString

                                                                                                                                                                                                                                                                            Required. The text to find

                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            optionsObject

                                                                                                                                                                                                                                                                            Required. The search options

                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            additiveBoolean

                                                                                                                                                                                                                                                                            Required. keeps

                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                            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.

                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                            Arguments

                                                                                                                                                                                                                                                                            optionsObject

                                                                                                                                                                                                                                                                            Required. search options

                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            animateBoolean

                                                                                                                                                                                                                                                                            Required. If true animate scrolling

                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                            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.

                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                            Arguments

                                                                                                                                                                                                                                                                            optionsObject

                                                                                                                                                                                                                                                                            Required. search options

                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            animateBoolean

                                                                                                                                                                                                                                                                            Required. If true animate scrolling

                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                              • Editor.focus()

                                                                                                                                                                                                                                                                              Brings the current textInput into focus.

                                                                                                                                                                                                                                                                                 

                                                                                                                                                                                                                                                                              Brings the current textInput into focus.

                                                                                                                                                                                                                                                                              Executes a command for each selection range.

                                                                                                                                                                                                                                                                                 

                                                                                                                                                                                                                                                                              Executes a command for each selection range.

                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                                                                                              cmdStringRequired. The command to execute
                                                                                                                                                                                                                                                                              argsStringRequired. Any arguments for the command
                                                                                                                                                                                                                                                                                • Editor.getBehavioursEnabled()

                                                                                                                                                                                                                                                                                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.

                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                Arguments

                                                                                                                                                                                                                                                                                cmdString

                                                                                                                                                                                                                                                                                Required. The command to execute

                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                argsString

                                                                                                                                                                                                                                                                                Required. Any arguments for the command

                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                  • Editor.getBehavioursEnabled()

                                                                                                                                                                                                                                                                                  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. "Behaviors" in this case is the auto-pairing of special characters, like quotation marks, parenthesis, or brackets.

                                                                                                                                                                                                                                                                                  Returns the string of text currently highlighted.

                                                                                                                                                                                                                                                                                     

                                                                                                                                                                                                                                                                                  Returns the string of text currently highlighted.

                                                                                                                                                                                                                                                                                  Gets the current position of the cursor.

                                                                                                                                                                                                                                                                                     

                                                                                                                                                                                                                                                                                  Gets the current position of the cursor.

                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                  Returns the current mouse drag delay.

                                                                                                                                                                                                                                                                                     

                                                                                                                                                                                                                                                                                  Returns the current mouse drag delay.

                                                                                                                                                                                                                                                                                  @@ -85,8 +96,8 @@

                                                                                                                                                                                                                                                                                     

                                                                                                                                                                                                                                                                                  Returns true if currently highlighted words are to be highlighted.

                                                                                                                                                                                                                                                                                  Returns the keyboard handler.

                                                                                                                                                                                                                                                                                     

                                                                                                                                                                                                                                                                                  Returns the keyboard handler.

                                                                                                                                                                                                                                                                                  -

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

                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                     

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

                                                                                                                                                                                                                                                                                  +

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

                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                     

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

                                                                                                                                                                                                                                                                                  Returns true if overwrites are enabled; false otherwise.

                                                                                                                                                                                                                                                                                  @@ -99,8 +110,8 @@

                                                                                                                                                                                                                                                                                     

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

                                                                                                                                                                                                                                                                                  Returns the currently highlighted selection.

                                                                                                                                                                                                                                                                                     

                                                                                                                                                                                                                                                                                  Returns the currently highlighted selection.

                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                    • Editor.getSelectionStyle()

                                                                                                                                                                                                                                                                                    Returns the current selection style.

                                                                                                                                                                                                                                                                                       

                                                                                                                                                                                                                                                                                    Returns the current selection style.

                                                                                                                                                                                                                                                                                    Returns the current session being used.

                                                                                                                                                                                                                                                                                    @@ -117,7 +128,10 @@

                                                                                                                                                                                                                                                                                       

                                                                                                                                                                                                                                                                                    Returns the current session's content.

                                                                                                                                                                                                                                                                                    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.

                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                    Arguments

                                                                                                                                                                                                                                                                                    lineNumberNumberRequired. The line number to go to
                                                                                                                                                                                                                                                                                    columnNumberRequired. A column number to go to
                                                                                                                                                                                                                                                                                    animateBooleanRequired. If true animates scolling
                                                                                                                                                                                                                                                                                      • Editor.gotoPageDown()

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

                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                      Arguments

                                                                                                                                                                                                                                                                                      lineNumberNumber

                                                                                                                                                                                                                                                                                      Required. The line number to go to

                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      columnNumber

                                                                                                                                                                                                                                                                                      Required. A column number to go to

                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      animateBoolean

                                                                                                                                                                                                                                                                                      Required. If true animates scolling

                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                        • Editor.gotoPageDown()

                                                                                                                                                                                                                                                                                        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.

                                                                                                                                                                                                                                                                                          • Editor.gotoPageUp()

                                                                                                                                                                                                                                                                                          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.

                                                                                                                                                                                                                                                                                          @@ -125,44 +139,58 @@

                                                                                                                                                                                                                                                                                             

                                                                                                                                                                                                                                                                                          Indents the current line.

                                                                                                                                                                                                                                                                                          Inserts text into wherever the cursor is pointing.

                                                                                                                                                                                                                                                                                             

                                                                                                                                                                                                                                                                                          Inserts text into wherever the cursor is pointing.

                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                          Arguments

                                                                                                                                                                                                                                                                                          textStringRequired. The new text to add

                                                                                                                                                                                                                                                                                          Returns true if the current textInput is in focus.

                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                          Arguments

                                                                                                                                                                                                                                                                                          textString

                                                                                                                                                                                                                                                                                          Required. The new text to add

                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                          Returns true if the current textInput is in focus.

                                                                                                                                                                                                                                                                                             

                                                                                                                                                                                                                                                                                          Returns true if the current textInput is in focus.

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

                                                                                                                                                                                                                                                                                             

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

                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                          Arguments

                                                                                                                                                                                                                                                                                          rowNumberRequired. The row to check

                                                                                                                                                                                                                                                                                          Indicates if the row is currently visible on the screen.

                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                          Arguments

                                                                                                                                                                                                                                                                                          rowNumber

                                                                                                                                                                                                                                                                                          Required. The row to check

                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                          Indicates if the row is currently visible on the screen.

                                                                                                                                                                                                                                                                                             

                                                                                                                                                                                                                                                                                          Indicates if the row is currently visible on the screen.

                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                          Arguments

                                                                                                                                                                                                                                                                                          rowNumberRequired. The row to check
                                                                                                                                                                                                                                                                                            • Editor.jumpToMatching()

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

                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                            Arguments

                                                                                                                                                                                                                                                                                            rowNumber

                                                                                                                                                                                                                                                                                            Required. The row to check

                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                              • Editor.jumpToMatching()

                                                                                                                                                                                                                                                                                              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 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.

                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                                                                                                              rowNumberRequired. The new row number
                                                                                                                                                                                                                                                                                              columnNumberRequired. The new column number

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

                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                                                                                                              rowNumber

                                                                                                                                                                                                                                                                                              Required. The new row number

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              columnNumber

                                                                                                                                                                                                                                                                                              Required. The new column number

                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              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.

                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                                                                                                              posObjectRequired. An object with two properties, row and column

                                                                                                                                                                                                                                                                                              Shifts all the selected lines down one row.

                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                                                                                                              posObject

                                                                                                                                                                                                                                                                                              Required. An object with two properties, row and column

                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Shifts all the selected lines down one row.

                                                                                                                                                                                                                                                                                                 

                                                                                                                                                                                                                                                                                              Shifts all the selected lines down one row.

                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                              Shifts all the selected lines up one row.

                                                                                                                                                                                                                                                                                                 

                                                                                                                                                                                                                                                                                              Shifts all the selected lines up one row.

                                                                                                                                                                                                                                                                                              -

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

                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Returns

                                                                                                                                                                                                                                                                                              NumberOn success, it returns -1.

                                                                                                                                                                                                                                                                                              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 }

                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                                                                                                              fromRangeRangeRequired. The range of text you want moved within the document
                                                                                                                                                                                                                                                                                              toPositionObjectRequired. The location (row and column) where you want to move the text to
                                                                                                                                                                                                                                                                                                • Editor.navigateDown(Number times)

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

                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                Arguments

                                                                                                                                                                                                                                                                                                fromRangeRange

                                                                                                                                                                                                                                                                                                Required. The range of text you want moved within the document

                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                toPositionObject

                                                                                                                                                                                                                                                                                                Required. The location (row and column) where you want to move the text to

                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                Returns

                                                                                                                                                                                                                                                                                                RangeThe new range where the text was moved to.
                                                                                                                                                                                                                                                                                                  • Editor.navigateDown(Number times)

                                                                                                                                                                                                                                                                                                  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.

                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                  Arguments

                                                                                                                                                                                                                                                                                                  timesNumberRequired. The number of times to change navigation
                                                                                                                                                                                                                                                                                                    • Editor.navigateFileEnd()

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

                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                    Arguments

                                                                                                                                                                                                                                                                                                    timesNumber

                                                                                                                                                                                                                                                                                                    Required. The number of times to change navigation

                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                      • Editor.navigateFileEnd()

                                                                                                                                                                                                                                                                                                      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.

                                                                                                                                                                                                                                                                                                        • Editor.navigateFileStart()

                                                                                                                                                                                                                                                                                                        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.

                                                                                                                                                                                                                                                                                                          • Editor.navigateLeft(Number times)

                                                                                                                                                                                                                                                                                                          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.

                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                          Arguments

                                                                                                                                                                                                                                                                                                          timesNumberRequired. The number of times to change navigation
                                                                                                                                                                                                                                                                                                            • Editor.navigateLineEnd()

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

                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                            Arguments

                                                                                                                                                                                                                                                                                                            timesNumber

                                                                                                                                                                                                                                                                                                            Required. The number of times to change navigation

                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                              • Editor.navigateLineEnd()

                                                                                                                                                                                                                                                                                                              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.

                                                                                                                                                                                                                                                                                                                • Editor.navigateLineStart()

                                                                                                                                                                                                                                                                                                                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.

                                                                                                                                                                                                                                                                                                                  • Editor.navigateRight(Number times)

                                                                                                                                                                                                                                                                                                                  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.

                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                  Arguments

                                                                                                                                                                                                                                                                                                                  timesNumberRequired. The number of times to change navigation

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

                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                  Arguments

                                                                                                                                                                                                                                                                                                                  timesNumber

                                                                                                                                                                                                                                                                                                                  Required. The number of times to change navigation

                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                  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.

                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                  Arguments

                                                                                                                                                                                                                                                                                                                  rowNumberRequired. The new row number
                                                                                                                                                                                                                                                                                                                  columnNumberRequired. The new column number
                                                                                                                                                                                                                                                                                                                    • Editor.navigateUp(Number times)

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

                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                    Arguments

                                                                                                                                                                                                                                                                                                                    rowNumber

                                                                                                                                                                                                                                                                                                                    Required. The new row number

                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    columnNumber

                                                                                                                                                                                                                                                                                                                    Required. The new column number

                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                      • Editor.navigateUp(Number times)

                                                                                                                                                                                                                                                                                                                      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.

                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                      Arguments

                                                                                                                                                                                                                                                                                                                      timesNumberRequired. The number of times to change navigation
                                                                                                                                                                                                                                                                                                                        • Editor.navigateWordLeft()

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

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        Arguments

                                                                                                                                                                                                                                                                                                                        timesNumber

                                                                                                                                                                                                                                                                                                                        Required. The number of times to change navigation

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                          • Editor.navigateWordLeft()

                                                                                                                                                                                                                                                                                                                          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.

                                                                                                                                                                                                                                                                                                                            • Editor.navigateWordRight()

                                                                                                                                                                                                                                                                                                                            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.

                                                                                                                                                                                                                                                                                                                            @@ -170,17 +198,20 @@

                                                                                                                                                                                                                                                                                                                               

                                                                                                                                                                                                                                                                                                                            Called whenever a text "copy" happens.

                                                                                                                                                                                                                                                                                                                              • Editor.onCut()

                                                                                                                                                                                                                                                                                                                              called whenever a text "cut" happens.

                                                                                                                                                                                                                                                                                                                                 

                                                                                                                                                                                                                                                                                                                              called whenever a text "cut" happens.

                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                • Editor.onPaste()

                                                                                                                                                                                                                                                                                                                                called whenever a text "paste" happens.

                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                   

                                                                                                                                                                                                                                                                                                                                called whenever a text "paste" happens.

                                                                                                                                                                                                                                                                                                                                -

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

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                Called whenever a text "paste" happens.

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                   

                                                                                                                                                                                                                                                                                                                                Called whenever a text "paste" happens.

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                Arguments

                                                                                                                                                                                                                                                                                                                                textString

                                                                                                                                                                                                                                                                                                                                Required. The pasted text

                                                                                                                                                                                                                                                                                                                                +

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

                                                                                                                                                                                                                                                                                                                                   

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

                                                                                                                                                                                                                                                                                                                                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.

                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                Arguments

                                                                                                                                                                                                                                                                                                                                dirStringRequired. The direction of the deletion to occur, either "left" or "right"

                                                                                                                                                                                                                                                                                                                                Removes all the lines in the current selection

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                Arguments

                                                                                                                                                                                                                                                                                                                                dirString

                                                                                                                                                                                                                                                                                                                                Required. The direction of the deletion to occur, either "left" or "right"

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                Removes all the lines in the current selection

                                                                                                                                                                                                                                                                                                                                   

                                                                                                                                                                                                                                                                                                                                Removes all the lines in the current selection

                                                                                                                                                                                                                                                                                                                                  • Editor.removeSelectionMarker(Range range)

                                                                                                                                                                                                                                                                                                                                  Removes the selection marker.

                                                                                                                                                                                                                                                                                                                                     

                                                                                                                                                                                                                                                                                                                                  Removes the selection marker.

                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                  Arguments

                                                                                                                                                                                                                                                                                                                                  rangeRangeRequired. The selection range added with addSelectionMarker.
                                                                                                                                                                                                                                                                                                                                    • Editor.removeToLineEnd()

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

                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                    Arguments

                                                                                                                                                                                                                                                                                                                                    rangeRange

                                                                                                                                                                                                                                                                                                                                    Required. The selection range added with addSelectionMarker().

                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                      • Editor.removeToLineEnd()

                                                                                                                                                                                                                                                                                                                                      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.

                                                                                                                                                                                                                                                                                                                                        • Editor.removeToLineStart()

                                                                                                                                                                                                                                                                                                                                        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.

                                                                                                                                                                                                                                                                                                                                        @@ -190,9 +221,13 @@

                                                                                                                                                                                                                                                                                                                                           

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

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

                                                                                                                                                                                                                                                                                                                                           

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

                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                        Arguments

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

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

                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        Arguments

                                                                                                                                                                                                                                                                                                                                        replacementString

                                                                                                                                                                                                                                                                                                                                        Required. The text to replace with

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        optionsObject

                                                                                                                                                                                                                                                                                                                                        Required. The Search options to use

                                                                                                                                                                                                                                                                                                                                        +

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

                                                                                                                                                                                                                                                                                                                                           

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

                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                        Arguments

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

                                                                                                                                                                                                                                                                                                                                        Triggers a resize of the editor.

                                                                                                                                                                                                                                                                                                                                           

                                                                                                                                                                                                                                                                                                                                        Triggers a resize of the editor.

                                                                                                                                                                                                                                                                                                                                          • Editor.scrollPageDown()

                                                                                                                                                                                                                                                                                                                                          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.

                                                                                                                                                                                                                                                                                                                                          @@ -200,55 +235,80 @@

                                                                                                                                                                                                                                                                                                                                             

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

                                                                                                                                                                                                                                                                                                                                          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)

                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                          Arguments

                                                                                                                                                                                                                                                                                                                                          lineNumberRequired. The line to scroll to
                                                                                                                                                                                                                                                                                                                                          centerBooleanRequired. If true
                                                                                                                                                                                                                                                                                                                                          animateBooleanRequired. If true animates scrolling
                                                                                                                                                                                                                                                                                                                                          callbackFunctionRequired. Function to be called when the animation has finished

                                                                                                                                                                                                                                                                                                                                          Moves the editor to the specified row.

                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                          Arguments

                                                                                                                                                                                                                                                                                                                                          lineNumber

                                                                                                                                                                                                                                                                                                                                          Required. The line to scroll to

                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          centerBoolean

                                                                                                                                                                                                                                                                                                                                          Required. If true

                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          animateBoolean

                                                                                                                                                                                                                                                                                                                                          Required. If true animates scrolling

                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          callbackFunction

                                                                                                                                                                                                                                                                                                                                          Required. Function to be called when the animation has finished

                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                          Moves the editor to the specified row.

                                                                                                                                                                                                                                                                                                                                             

                                                                                                                                                                                                                                                                                                                                          Moves the editor to the specified row.

                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                          Arguments

                                                                                                                                                                                                                                                                                                                                          rowNumberRequired. The row to move to

                                                                                                                                                                                                                                                                                                                                          Selects all the text in editor.

                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                          Arguments

                                                                                                                                                                                                                                                                                                                                          rowNumber

                                                                                                                                                                                                                                                                                                                                          Required. The row to move to

                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                          Selects all the text in editor.

                                                                                                                                                                                                                                                                                                                                             

                                                                                                                                                                                                                                                                                                                                          Selects all the text in editor.

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

                                                                                                                                                                                                                                                                                                                                             

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

                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                          Arguments

                                                                                                                                                                                                                                                                                                                                          dirNumberRequired. The direction of lines to select: -1 for up, 1 for down
                                                                                                                                                                                                                                                                                                                                          skipBooleanRequired. If true, removes the active selection range

                                                                                                                                                                                                                                                                                                                                          Adds a cursor above or below the active cursor.

                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                          Arguments

                                                                                                                                                                                                                                                                                                                                          dirNumber

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

                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          skipBoolean

                                                                                                                                                                                                                                                                                                                                          Required. If true, removes the active selection range

                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                          Adds a cursor above or below the active cursor.

                                                                                                                                                                                                                                                                                                                                             

                                                                                                                                                                                                                                                                                                                                          Adds a cursor above or below the active cursor.

                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                          Arguments

                                                                                                                                                                                                                                                                                                                                          dirNumberRequired. The direction of lines to select: -1 for up, 1 for down
                                                                                                                                                                                                                                                                                                                                          skipBooleanRequired. If true, removes the active selection range
                                                                                                                                                                                                                                                                                                                                            • Editor.selectPageDown()

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

                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                            Arguments

                                                                                                                                                                                                                                                                                                                                            dirNumber

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

                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            skipBoolean

                                                                                                                                                                                                                                                                                                                                            Required. If true, removes the active selection range

                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                              • Editor.selectPageDown()

                                                                                                                                                                                                                                                                                                                                              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.

                                                                                                                                                                                                                                                                                                                                                • Editor.selectPageUp()

                                                                                                                                                                                                                                                                                                                                                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.

                                                                                                                                                                                                                                                                                                                                                  • Editor.setBehavioursEnabled(Boolean enabled)

                                                                                                                                                                                                                                                                                                                                                  Specifies whether to use behaviors or not. "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.

                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                  Arguments

                                                                                                                                                                                                                                                                                                                                                  enabledBooleanRequired. Enables or disables behaviors
                                                                                                                                                                                                                                                                                                                                                    • Editor.setDragDelay(Number dragDelay)

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

                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    Arguments

                                                                                                                                                                                                                                                                                                                                                    enabledBoolean

                                                                                                                                                                                                                                                                                                                                                    Required. Enables or disables behaviors

                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                      • Editor.setDragDelay(Number dragDelay)

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

                                                                                                                                                                                                                                                                                                                                                         

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

                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                      Arguments

                                                                                                                                                                                                                                                                                                                                                      dragDelayNumberRequired. A value indicating the new delay
                                                                                                                                                                                                                                                                                                                                                        • Editor.setFontSize(Number size)

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

                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                        Arguments

                                                                                                                                                                                                                                                                                                                                                        dragDelayNumber

                                                                                                                                                                                                                                                                                                                                                        Required. A value indicating the new delay

                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                          • Editor.setFontSize(Number size)

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

                                                                                                                                                                                                                                                                                                                                                             

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

                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                          Arguments

                                                                                                                                                                                                                                                                                                                                                          sizeNumberRequired. A font size
                                                                                                                                                                                                                                                                                                                                                            • Editor.setHighlightActiveLine(Boolean shouldHighlight)

                                                                                                                                                                                                                                                                                                                                                            Determines whether or not the current line should be highlighted.

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            Arguments

                                                                                                                                                                                                                                                                                                                                                            sizeNumber

                                                                                                                                                                                                                                                                                                                                                            Required. A font size

                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                              • Editor.setHighlightActiveLine(Boolean shouldHighlight)

                                                                                                                                                                                                                                                                                                                                                              Determines whether or not the current line should be highlighted.

                                                                                                                                                                                                                                                                                                                                                                 

                                                                                                                                                                                                                                                                                                                                                              Determines whether or not the current line should be highlighted.

                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                                                                                                                                                                              shouldHighlightBooleanRequired. Set to true to highlight the current line
                                                                                                                                                                                                                                                                                                                                                                • Editor.setHighlightSelectedWord(Boolean shouldHighlight)

                                                                                                                                                                                                                                                                                                                                                                Determines if the currently selected word should be highlighted.

                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                Arguments

                                                                                                                                                                                                                                                                                                                                                                shouldHighlightBoolean

                                                                                                                                                                                                                                                                                                                                                                Required. Set to true to highlight the current line

                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                  • Editor.setHighlightSelectedWord(Boolean shouldHighlight)

                                                                                                                                                                                                                                                                                                                                                                  Determines if the currently selected word should be highlighted.

                                                                                                                                                                                                                                                                                                                                                                     

                                                                                                                                                                                                                                                                                                                                                                  Determines if the currently selected word should be highlighted.

                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                  Arguments

                                                                                                                                                                                                                                                                                                                                                                  shouldHighlightBooleanRequired. Set to true to highlight the currently selected word
                                                                                                                                                                                                                                                                                                                                                                    • Editor.setKeyboardHandler(keyboardHandler)

                                                                                                                                                                                                                                                                                                                                                                    Sets a new keyboard handler.

                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                    Arguments

                                                                                                                                                                                                                                                                                                                                                                    shouldHighlightBoolean

                                                                                                                                                                                                                                                                                                                                                                    Required. Set to true to highlight the currently selected word

                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                      • Editor.setKeyboardHandler(keyboardHandler)

                                                                                                                                                                                                                                                                                                                                                                      Sets a new keyboard handler.

                                                                                                                                                                                                                                                                                                                                                                         

                                                                                                                                                                                                                                                                                                                                                                      Sets a new keyboard handler.

                                                                                                                                                                                                                                                                                                                                                                      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.

                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                      Arguments

                                                                                                                                                                                                                                                                                                                                                                      overwriteBooleanRequired. Defines wheter or not to set overwrites
                                                                                                                                                                                                                                                                                                                                                                        • Editor.setPrintMarginColumn(Number showPrintMargin)

                                                                                                                                                                                                                                                                                                                                                                        Sets the column defining where the print margin should be.

                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                        Arguments

                                                                                                                                                                                                                                                                                                                                                                        overwriteBoolean

                                                                                                                                                                                                                                                                                                                                                                        Required. Defines wheter or not to set overwrites

                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                          • Editor.setPrintMarginColumn(Number showPrintMargin)

                                                                                                                                                                                                                                                                                                                                                                          Sets the column defining where the print margin should be.

                                                                                                                                                                                                                                                                                                                                                                             

                                                                                                                                                                                                                                                                                                                                                                          Sets the column defining where the print margin should be.

                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                          Arguments

                                                                                                                                                                                                                                                                                                                                                                          showPrintMarginNumberRequired. Specifies the new print margin
                                                                                                                                                                                                                                                                                                                                                                            • Editor.setReadOnly(Boolean readOnly)

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

                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                            Arguments

                                                                                                                                                                                                                                                                                                                                                                            showPrintMarginNumber

                                                                                                                                                                                                                                                                                                                                                                            Required. Specifies the new print margin

                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                              • Editor.setReadOnly(Boolean readOnly)

                                                                                                                                                                                                                                                                                                                                                                              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.

                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                                                                                                                                                                                              readOnlyBooleanRequired. Specifies whether the editor can be modified or not
                                                                                                                                                                                                                                                                                                                                                                                • Editor.setScrollSpeed(Number speed)

                                                                                                                                                                                                                                                                                                                                                                                Sets how fast the mouse scrolling should do.

                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                Arguments

                                                                                                                                                                                                                                                                                                                                                                                readOnlyBoolean

                                                                                                                                                                                                                                                                                                                                                                                Required. Specifies whether the editor can be modified or not

                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                  • Editor.setScrollSpeed(Number speed)

                                                                                                                                                                                                                                                                                                                                                                                  Sets how fast the mouse scrolling should do.

                                                                                                                                                                                                                                                                                                                                                                                     

                                                                                                                                                                                                                                                                                                                                                                                  Sets how fast the mouse scrolling should do.

                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                  Arguments

                                                                                                                                                                                                                                                                                                                                                                                  speedNumberRequired. A value indicating the new speed
                                                                                                                                                                                                                                                                                                                                                                                    • Editor.setSelectionStyle(String style)

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

                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                    Arguments

                                                                                                                                                                                                                                                                                                                                                                                    speedNumber

                                                                                                                                                                                                                                                                                                                                                                                    Required. A value indicating the new speed

                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                      • Editor.setSelectionStyle(String style)

                                                                                                                                                                                                                                                                                                                                                                                      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.

                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                      Arguments

                                                                                                                                                                                                                                                                                                                                                                                      styleStringRequired. The new selection style

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

                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                      Arguments

                                                                                                                                                                                                                                                                                                                                                                                      styleString

                                                                                                                                                                                                                                                                                                                                                                                      Required. The new selection style

                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                      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.

                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                      Arguments

                                                                                                                                                                                                                                                                                                                                                                                      sessionEditSessionRequired. The new session to use
                                                                                                                                                                                                                                                                                                                                                                                        • Editor.setShowFoldWidgets(Boolean show)

                                                                                                                                                                                                                                                                                                                                                                                        Indicates whether the fold widgets are shown or not.

                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                        Arguments

                                                                                                                                                                                                                                                                                                                                                                                        sessionEditSession

                                                                                                                                                                                                                                                                                                                                                                                        Required. The new session to use

                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                          • Editor.setShowFoldWidgets(Boolean show)

                                                                                                                                                                                                                                                                                                                                                                                          Indicates whether the fold widgets are shown or not.

                                                                                                                                                                                                                                                                                                                                                                                             

                                                                                                                                                                                                                                                                                                                                                                                          Indicates whether the fold widgets are shown or not.

                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                          Arguments

                                                                                                                                                                                                                                                                                                                                                                                          showBooleanRequired. Specifies whether the fold widgets are shown
                                                                                                                                                                                                                                                                                                                                                                                            • Editor.setShowInvisibles(Boolean showInvisibles)

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

                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                            Arguments

                                                                                                                                                                                                                                                                                                                                                                                            showBoolean

                                                                                                                                                                                                                                                                                                                                                                                            Required. Specifies whether the fold widgets are shown

                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                              • Editor.setShowInvisibles(Boolean showInvisibles)

                                                                                                                                                                                                                                                                                                                                                                                              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.

                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                                                                                                                                                                                                              showInvisiblesBooleanRequired. Specifies whether or not to show invisible characters
                                                                                                                                                                                                                                                                                                                                                                                                • Editor.setShowPrintMargin(Boolean showPrintMargin)

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

                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                Arguments

                                                                                                                                                                                                                                                                                                                                                                                                showInvisiblesBoolean

                                                                                                                                                                                                                                                                                                                                                                                                Required. Specifies whether or not to show invisible characters

                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                  • Editor.setShowPrintMargin(Boolean showPrintMargin)

                                                                                                                                                                                                                                                                                                                                                                                                  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.

                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                  Arguments

                                                                                                                                                                                                                                                                                                                                                                                                  showPrintMarginBooleanRequired. Specifies whether or not to show the print margin

                                                                                                                                                                                                                                                                                                                                                                                                  Adds a new class, style, to the editor.

                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                  Arguments

                                                                                                                                                                                                                                                                                                                                                                                                  showPrintMarginBoolean

                                                                                                                                                                                                                                                                                                                                                                                                  Required. Specifies whether or not to show the print margin

                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                  Adds a new class, style, to the editor.

                                                                                                                                                                                                                                                                                                                                                                                                     

                                                                                                                                                                                                                                                                                                                                                                                                  Adds a new class, style, to the editor.

                                                                                                                                                                                                                                                                                                                                                                                                    • Editor.setTheme(theme)

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

                                                                                                                                                                                                                                                                                                                                                                                                       

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

                                                                                                                                                                                                                                                                                                                                                                                                    Sets the current document to val.

                                                                                                                                                                                                                                                                                                                                                                                                       

                                                                                                                                                                                                                                                                                                                                                                                                    Sets the current document to val.

                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                    Arguments

                                                                                                                                                                                                                                                                                                                                                                                                    valStringRequired. The new value to set for the document
                                                                                                                                                                                                                                                                                                                                                                                                    cursorPosNumberRequired. Where to set the new value. undefined or 0 is selectAll, -1 is at the document start, and 1 is at the end
                                                                                                                                                                                                                                                                                                                                                                                                      • Editor.splitLine()

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

                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                      Arguments

                                                                                                                                                                                                                                                                                                                                                                                                      valString

                                                                                                                                                                                                                                                                                                                                                                                                      Required. The new value to set for the document

                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      cursorPosNumber

                                                                                                                                                                                                                                                                                                                                                                                                      Required. Where to set the new value. undefined or 0 is selectAll, -1 is at the document start, and 1 is at the end

                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                        • Editor.splitLine()

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

                                                                                                                                                                                                                                                                                                                                                                                                           

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

                                                                                                                                                                                                                                                                                                                                                                                                          • Editor.toggleCommentLines()

                                                                                                                                                                                                                                                                                                                                                                                                          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).

                                                                                                                                                                                                                                                                                                                                                                                                          @@ -262,7 +322,8 @@

                                                                                                                                                                                                                                                                                                                                                                                                             

                                                                                                                                                                                                                                                                                                                                                                                                          Transposes current line.

                                                                                                                                                                                                                                                                                                                                                                                                            • Editor.transposeSelections(Number dir)

                                                                                                                                                                                                                                                                                                                                                                                                            Transposes the selected ranges.

                                                                                                                                                                                                                                                                                                                                                                                                               

                                                                                                                                                                                                                                                                                                                                                                                                            Transposes the selected ranges.

                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                            Arguments

                                                                                                                                                                                                                                                                                                                                                                                                            dirNumberRequired. The direction to rotate selections

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

                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                            Arguments

                                                                                                                                                                                                                                                                                                                                                                                                            dirNumber

                                                                                                                                                                                                                                                                                                                                                                                                            Required. The direction to rotate selections

                                                                                                                                                                                                                                                                                                                                                                                                            +

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

                                                                                                                                                                                                                                                                                                                                                                                                               

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

                                                                                                                                                                                                                                                                                                                                                                                                            Removes the class style from the editor.

                                                                                                                                                                                                                                                                                                                                                                                                               

                                                                                                                                                                                                                                                                                                                                                                                                            Removes the class style from the editor.

                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/api/placeholder.html b/api/placeholder.html index 627e7abf..8f21583a 100644 --- a/api/placeholder.html +++ b/api/placeholder.html @@ -4,7 +4,13 @@ PlaceHolder - Ace API

                                                                                                                                                                                                                                                                                                                                                                                                            PlaceHolder[edit]

                                                                                                                                                                                                                                                                                                                                                                                                            TODO

                                                                                                                                                                                                                                                                                                                                                                                                            Constructors

                                                                                                                                                                                                                                                                                                                                                                                                            Events

                                                                                                                                                                                                                                                                                                                                                                                                              • PlaceHolder.on("onCursorChange", function(e))

                                                                                                                                                                                                                                                                                                                                                                                                              Emitted when the cursor changes.

                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                                                                                                                                                                                                                              sessionDocument

                                                                                                                                                                                                                                                                                                                                                                                                              Required. The document to associate with the anchor

                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                              lengthNumber

                                                                                                                                                                                                                                                                                                                                                                                                              Required. The starting row position

                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                              posNumber

                                                                                                                                                                                                                                                                                                                                                                                                              Required. The starting column position

                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                              othersString

                                                                                                                                                                                                                                                                                                                                                                                                              Required.

                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                              mainClassString

                                                                                                                                                                                                                                                                                                                                                                                                              Required.

                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                              othersClassString

                                                                                                                                                                                                                                                                                                                                                                                                              Required.

                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                              Events

                                                                                                                                                                                                                                                                                                                                                                                                                • PlaceHolder.on("onCursorChange", function(e))

                                                                                                                                                                                                                                                                                                                                                                                                                Emitted when the cursor changes.

                                                                                                                                                                                                                                                                                                                                                                                                                   

                                                                                                                                                                                                                                                                                                                                                                                                                Emitted when the cursor changes.

                                                                                                                                                                                                                                                                                                                                                                                                                  • PlaceHolder.on("onUpdate", function(e))

                                                                                                                                                                                                                                                                                                                                                                                                                  Emitted when the place holder updates.

                                                                                                                                                                                                                                                                                                                                                                                                                     

                                                                                                                                                                                                                                                                                                                                                                                                                  Emitted when the place holder updates.

                                                                                                                                                                                                                                                                                                                                                                                                                  @@ -12,8 +18,8 @@

                                                                                                                                                                                                                                                                                                                                                                                                                     

                                                                                                                                                                                                                                                                                                                                                                                                                  TODO

                                                                                                                                                                                                                                                                                                                                                                                                                    • PlaceHolder.detach()

                                                                                                                                                                                                                                                                                                                                                                                                                    TODO

                                                                                                                                                                                                                                                                                                                                                                                                                       

                                                                                                                                                                                                                                                                                                                                                                                                                    TODO

                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                      • PlaceHolder.hideOtherMarkers()

                                                                                                                                                                                                                                                                                                                                                                                                                      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.

                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                        • PlaceHolder.hideOtherMarkers()

                                                                                                                                                                                                                                                                                                                                                                                                                        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.

                                                                                                                                                                                                                                                                                                                                                                                                                          • PlaceHolder.setup()

                                                                                                                                                                                                                                                                                                                                                                                                                          TODO

                                                                                                                                                                                                                                                                                                                                                                                                                             

                                                                                                                                                                                                                                                                                                                                                                                                                          TODO

                                                                                                                                                                                                                                                                                                                                                                                                                            • PlaceHolder.showOtherMarkers()

                                                                                                                                                                                                                                                                                                                                                                                                                            TODO

                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/api/range.html b/api/range.html index d37137e4..3738d8eb 100644 --- a/api/range.html +++ b/api/range.html @@ -4,57 +4,97 @@ Range - Ace API

                                                                                                                                                                                                                                                                                                                                                                                                                            Range[edit]

                                                                                                                                                                                                                                                                                                                                                                                                                            This object is used in various places to indicate a region within the editor. To better visualize how this works, imagine a rectangle. Each quadrant of the rectangle is analogus to a range, as ranges contain a starting row and starting column, and an ending row, and ending column.

                                                                                                                                                                                                                                                                                                                                                                                                                            Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                            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.

                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                            Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                            startRowNumberRequired. The starting row
                                                                                                                                                                                                                                                                                                                                                                                                                            startColumnNumberRequired. The starting column
                                                                                                                                                                                                                                                                                                                                                                                                                            endRowNumberRequired. The ending row
                                                                                                                                                                                                                                                                                                                                                                                                                            endColumnNumberRequired. The ending column

                                                                                                                                                                                                                                                                                                                                                                                                                            Methods

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

                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                            Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                            startRowNumber

                                                                                                                                                                                                                                                                                                                                                                                                                            Required. The starting row

                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            startColumnNumber

                                                                                                                                                                                                                                                                                                                                                                                                                            Required. The starting column

                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            endRowNumber

                                                                                                                                                                                                                                                                                                                                                                                                                            Required. The ending row

                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            endColumnNumber

                                                                                                                                                                                                                                                                                                                                                                                                                            Required. The ending column

                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                                                                                                                                                                                                            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.

                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                            Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                            firstRowNumberRequired. The starting row
                                                                                                                                                                                                                                                                                                                                                                                                                            lastRowNumberRequired. The ending row

                                                                                                                                                                                                                                                                                                                                                                                                                            Returns a duplicate of the calling range.

                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                            Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                            firstRowNumber

                                                                                                                                                                                                                                                                                                                                                                                                                            Required. The starting row

                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            lastRowNumber

                                                                                                                                                                                                                                                                                                                                                                                                                            Required. The ending row

                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                            Returns a duplicate of the calling range.

                                                                                                                                                                                                                                                                                                                                                                                                                               

                                                                                                                                                                                                                                                                                                                                                                                                                            Returns a duplicate of the calling range.

                                                                                                                                                                                                                                                                                                                                                                                                                              • Range.collapseRows()

                                                                                                                                                                                                                                                                                                                                                                                                                              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.

                                                                                                                                                                                                                                                                                                                                                                                                                              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.

                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                              rowNumberRequired. A row point to compare with
                                                                                                                                                                                                                                                                                                                                                                                                                              columnNumberRequired. A column point to compare with

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

                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                              rowNumber

                                                                                                                                                                                                                                                                                                                                                                                                                              Required. A row point to compare with

                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              columnNumber

                                                                                                                                                                                                                                                                                                                                                                                                                              Required. A column point to compare with

                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                              Returns

                                                                                                                                                                                                                                                                                                                                                                                                                              NumberThis method returns one of the following numbers:
                                                                                                                                                                                                                                                                                                                                                                                                                              0 if the two points are exactly equal
                                                                                                                                                                                                                                                                                                                                                                                                                              -1 if p.row is less then the calling range
                                                                                                                                                                                                                                                                                                                                                                                                                              1 if p.row is greater than the calling range

                                                                                                                                                                                                                                                                                                                                                                                                                              If the starting row of the calling range is equal to p.row, and:
                                                                                                                                                                                                                                                                                                                                                                                                                              p.column is greater than or equal to the calling range's starting column, this returns 0
                                                                                                                                                                                                                                                                                                                                                                                                                              Otherwise, it returns -1

                                                                                                                                                                                                                                                                                                                                                                                                                              If the ending row of the calling range is equal to p.row, and:
                                                                                                                                                                                                                                                                                                                                                                                                                              p.column is less than or equal to the calling range's ending column, this returns 0
                                                                                                                                                                                                                                                                                                                                                                                                                              Otherwise, it returns 1

                                                                                                                                                                                                                                                                                                                                                                                                                              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.

                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                              rowNumberRequired. A row point to compare with
                                                                                                                                                                                                                                                                                                                                                                                                                              columnNumberRequired. A column point to compare with

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

                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                              rowNumber

                                                                                                                                                                                                                                                                                                                                                                                                                              Required. A row point to compare with

                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              columnNumber

                                                                                                                                                                                                                                                                                                                                                                                                                              Required. A column point to compare with

                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                              Returns

                                                                                                                                                                                                                                                                                                                                                                                                                              NumberThis method returns one of the following numbers:
                                                                                                                                                                                                                                                                                                                                                                                                                              0 if the two points are exactly equal
                                                                                                                                                                                                                                                                                                                                                                                                                              -1 if p.row is less then the calling range
                                                                                                                                                                                                                                                                                                                                                                                                                              1 if p.row is greater than the calling range, or if isEnd is true.<br/> <br/> If the starting row of the calling range is equal to p.row, and:<br/> p.column is greater than or equal to the calling range's starting column, this returns 0<br/> Otherwise, it returns -1<br/> <br/> If the ending row of the calling range is equal to p.row, and:<br/> p.column is less than or equal to the calling range's ending column, this returns 0`
                                                                                                                                                                                                                                                                                                                                                                                                                              Otherwise, it returns 1

                                                                                                                                                                                                                                                                                                                                                                                                                              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.

                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                              rowNumberRequired. A row point to compare with
                                                                                                                                                                                                                                                                                                                                                                                                                              columnNumberRequired. A column point to compare with

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

                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                              rowNumber

                                                                                                                                                                                                                                                                                                                                                                                                                              Required. A row point to compare with

                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              columnNumber

                                                                                                                                                                                                                                                                                                                                                                                                                              Required. A column point to compare with

                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                              Returns

                                                                                                                                                                                                                                                                                                                                                                                                                              NumberThis method returns one of the following numbers:
                                                                                                                                                                                                                                                                                                                                                                                                                              1 if the ending row of the calling range is equal to row, and the ending column of the calling range is equal to column
                                                                                                                                                                                                                                                                                                                                                                                                                              -1 if the starting row of the calling range is equal to row, and the starting column of the calling range is equal to column

                                                                                                                                                                                                                                                                                                                                                                                                                              Otherwise, it returns the value after calling compare().

                                                                                                                                                                                                                                                                                                                                                                                                                              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.

                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                              pRangeRequired. A point to compare with

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

                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                              pRange

                                                                                                                                                                                                                                                                                                                                                                                                                              Required. A point to compare with

                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                              Returns

                                                                                                                                                                                                                                                                                                                                                                                                                              NumberThis method returns one of the following numbers:
                                                                                                                                                                                                                                                                                                                                                                                                                              0 if the two points are exactly equal
                                                                                                                                                                                                                                                                                                                                                                                                                              -1 if p.row is less then the calling range
                                                                                                                                                                                                                                                                                                                                                                                                                              1 if p.row is greater than the calling range

                                                                                                                                                                                                                                                                                                                                                                                                                              If the starting row of the calling range is equal to p.row, and:
                                                                                                                                                                                                                                                                                                                                                                                                                              p.column is greater than or equal to the calling range's starting column, this returns 0
                                                                                                                                                                                                                                                                                                                                                                                                                              Otherwise, it returns -1

                                                                                                                                                                                                                                                                                                                                                                                                                              If the ending row of the calling range is equal to p.row, and:
                                                                                                                                                                                                                                                                                                                                                                                                                              p.column is less than or equal to the calling range's ending column, this returns 0
                                                                                                                                                                                                                                                                                                                                                                                                                              Otherwise, it returns 1

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

                                                                                                                                                                                                                                                                                                                                                                                                                                 

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

                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                              rangeRangeRequired. A range to compare with

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

                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                              rangeRange

                                                                                                                                                                                                                                                                                                                                                                                                                              Required. A range to compare with

                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                              Returns

                                                                                                                                                                                                                                                                                                                                                                                                                              NumberThis method returns one of the following numbers:

                                                                                                                                                                                                                                                                                                                                                                                                                              -2: (B) is in front of (A), and doesn't intersect with (A)
                                                                                                                                                                                                                                                                                                                                                                                                                              -1: (B) begins before (A) but ends inside of (A)
                                                                                                                                                                                                                                                                                                                                                                                                                              0: (B) is completely inside of (A) OR (A) is completely inside of (B)
                                                                                                                                                                                                                                                                                                                                                                                                                              +1: (B) begins inside of (A) but ends outside of (A)
                                                                                                                                                                                                                                                                                                                                                                                                                              +2: (B) is after (A) and doesn't intersect with (A)
                                                                                                                                                                                                                                                                                                                                                                                                                              42: FTW state: (B) ends in (A) but starts outside of (A)

                                                                                                                                                                                                                                                                                                                                                                                                                              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.

                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                              rowNumberRequired. A row point to compare with
                                                                                                                                                                                                                                                                                                                                                                                                                              columnNumberRequired. A column point to compare with

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

                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                              rowNumber

                                                                                                                                                                                                                                                                                                                                                                                                                              Required. A row point to compare with

                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              columnNumber

                                                                                                                                                                                                                                                                                                                                                                                                                              Required. A column point to compare with

                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                              Returns

                                                                                                                                                                                                                                                                                                                                                                                                                              NumberThis method returns one of the following numbers:

                                                                                                                                                                                                                                                                                                                                                                                                                              0 if the two points are exactly equal
                                                                                                                                                                                                                                                                                                                                                                                                                              -1 if p.row is less then the calling range
                                                                                                                                                                                                                                                                                                                                                                                                                              1 if p.row is greater than the calling range, or if isStart is true.

                                                                                                                                                                                                                                                                                                                                                                                                                              If the starting row of the calling range is equal to p.row, and:
                                                                                                                                                                                                                                                                                                                                                                                                                              p.column is greater than or equal to the calling range's starting column, this returns 0
                                                                                                                                                                                                                                                                                                                                                                                                                              Otherwise, it returns -1

                                                                                                                                                                                                                                                                                                                                                                                                                              If the ending row of the calling range is equal to p.row, and:
                                                                                                                                                                                                                                                                                                                                                                                                                              p.column is less than or equal to the calling range's ending column, this returns 0
                                                                                                                                                                                                                                                                                                                                                                                                                              Otherwise, it returns 1

                                                                                                                                                                                                                                                                                                                                                                                                                              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

                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                              rowNumberRequired. A row to check for
                                                                                                                                                                                                                                                                                                                                                                                                                              columnNumberRequired. A column to check for

                                                                                                                                                                                                                                                                                                                                                                                                                              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.

                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                              rowNumber

                                                                                                                                                                                                                                                                                                                                                                                                                              Required. A row to check for

                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              columnNumber

                                                                                                                                                                                                                                                                                                                                                                                                                              Required. A column to check for

                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                              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.

                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                              rangeRangeRequired. A range to compare with

                                                                                                                                                                                                                                                                                                                                                                                                                              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.

                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                              rangeRange

                                                                                                                                                                                                                                                                                                                                                                                                                              Required. A range to compare with

                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                              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.

                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                              rowNumberRequired. A new row to extend to
                                                                                                                                                                                                                                                                                                                                                                                                                              columnNumberRequired. A new column to extend to

                                                                                                                                                                                                                                                                                                                                                                                                                              Creates and returns a new Range based on the row and column of the given parameters.

                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                              rowNumber

                                                                                                                                                                                                                                                                                                                                                                                                                              Required. A new row to extend to

                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              columnNumber

                                                                                                                                                                                                                                                                                                                                                                                                                              Required. A new column to extend to

                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                              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.

                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                              startRangeRequired. A starting point to use
                                                                                                                                                                                                                                                                                                                                                                                                                              endRangeRequired. An ending point to use

                                                                                                                                                                                                                                                                                                                                                                                                                              Returns true if the row and column are within the given range.

                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                              startRange

                                                                                                                                                                                                                                                                                                                                                                                                                              Required. A starting point to use

                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              endRange

                                                                                                                                                                                                                                                                                                                                                                                                                              Required. An ending point to use

                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                              Returns true if the row and column are within the given range.

                                                                                                                                                                                                                                                                                                                                                                                                                                 

                                                                                                                                                                                                                                                                                                                                                                                                                              Returns true if the row and column are within the given range.

                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                              rowNumberRequired. A row point to compare with
                                                                                                                                                                                                                                                                                                                                                                                                                              columnNumberRequired. A column point to compare with

                                                                                                                                                                                                                                                                                                                                                                                                                              Returns true if the row and column are within the given range's ending points.

                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                              rowNumber

                                                                                                                                                                                                                                                                                                                                                                                                                              Required. A row point to compare with

                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              columnNumber

                                                                                                                                                                                                                                                                                                                                                                                                                              Required. A column point to compare with

                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                              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.

                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                              rowNumberRequired. A row point to compare with
                                                                                                                                                                                                                                                                                                                                                                                                                              columnNumberRequired. A column point to compare with

                                                                                                                                                                                                                                                                                                                                                                                                                              Returns true if the row and column are within the given range's starting points.

                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                              rowNumber

                                                                                                                                                                                                                                                                                                                                                                                                                              Required. A row point to compare with

                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              columnNumber

                                                                                                                                                                                                                                                                                                                                                                                                                              Required. A column point to compare with

                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                              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.

                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                              rowNumberRequired. A row point to compare with
                                                                                                                                                                                                                                                                                                                                                                                                                              columnNumberRequired. A column point to compare with

                                                                                                                                                                                                                                                                                                                                                                                                                              Returns true if passed in range intersects with the one calling this method.

                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                              rowNumber

                                                                                                                                                                                                                                                                                                                                                                                                                              Required. A row point to compare with

                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              columnNumber

                                                                                                                                                                                                                                                                                                                                                                                                                              Required. A column point to compare with

                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                              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.

                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                              rangeRangeRequired. A range to compare with

                                                                                                                                                                                                                                                                                                                                                                                                                              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.

                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                              rangeRange

                                                                                                                                                                                                                                                                                                                                                                                                                              Required. A range to compare with

                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                              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.

                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                              rowNumberRequired. A row point to compare with
                                                                                                                                                                                                                                                                                                                                                                                                                              columnNumberRequired. A column point to compare with

                                                                                                                                                                                                                                                                                                                                                                                                                              Returns true if and only if the starting row and column, and ending tow and column, are equivalent to those given by range.

                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                              rowNumber

                                                                                                                                                                                                                                                                                                                                                                                                                              Required. A row point to compare with

                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              columnNumber

                                                                                                                                                                                                                                                                                                                                                                                                                              Required. A column point to compare with

                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                              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.

                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                              rangeRangeRequired. A range to check against

                                                                                                                                                                                                                                                                                                                                                                                                                              Returns true if the range spans across multiple lines.

                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                              rangeRange

                                                                                                                                                                                                                                                                                                                                                                                                                              Required. A range to check against

                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                              Returns true if the range spans across multiple lines.

                                                                                                                                                                                                                                                                                                                                                                                                                                 

                                                                                                                                                                                                                                                                                                                                                                                                                              Returns true if the range spans across multiple lines.

                                                                                                                                                                                                                                                                                                                                                                                                                              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.

                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                              rowNumberRequired. A row point to compare with
                                                                                                                                                                                                                                                                                                                                                                                                                              columnNumberRequired. A column point to compare with

                                                                                                                                                                                                                                                                                                                                                                                                                              Sets the starting row and column for the range.

                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                              rowNumber

                                                                                                                                                                                                                                                                                                                                                                                                                              Required. A row point to compare with

                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              columnNumber

                                                                                                                                                                                                                                                                                                                                                                                                                              Required. A column point to compare with

                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                              Sets the starting row and column for the range.

                                                                                                                                                                                                                                                                                                                                                                                                                                 

                                                                                                                                                                                                                                                                                                                                                                                                                              Sets the starting row and column for the range.

                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                              rowNumberRequired. A row point to set
                                                                                                                                                                                                                                                                                                                                                                                                                              columnNumberRequired. A column point to set

                                                                                                                                                                                                                                                                                                                                                                                                                              Sets the starting row and column for the range.

                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                              rowNumber

                                                                                                                                                                                                                                                                                                                                                                                                                              Required. A row point to set

                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              columnNumber

                                                                                                                                                                                                                                                                                                                                                                                                                              Required. A column point to set

                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                              Sets the starting row and column for the range.

                                                                                                                                                                                                                                                                                                                                                                                                                                 

                                                                                                                                                                                                                                                                                                                                                                                                                              Sets the starting row and column for the range.

                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                              rowNumberRequired. A row point to set
                                                                                                                                                                                                                                                                                                                                                                                                                              columnNumberRequired. A column point to set

                                                                                                                                                                                                                                                                                                                                                                                                                              Given the current Range, this function converts those starting and ending points into screen positions, and then returns a new Range object.

                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                              rowNumber

                                                                                                                                                                                                                                                                                                                                                                                                                              Required. A row point to set

                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              columnNumber

                                                                                                                                                                                                                                                                                                                                                                                                                              Required. A column point to set

                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                              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.

                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                              sessionEditSessionRequired. The EditSession to retrieve coordinates from

                                                                                                                                                                                                                                                                                                                                                                                                                              Returns a string containing the range's row and column information, given like this:

                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                              sessionEditSession

                                                                                                                                                                                                                                                                                                                                                                                                                              Required. The EditSession to retrieve coordinates from

                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                              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/renderloop.html b/api/renderloop.html index bdc7cae3..dc6b5526 100644 --- a/api/renderloop.html +++ b/api/renderloop.html @@ -2,7 +2,8 @@ RenderLoop - Ace API

                                                                                                                                                                                                                                                                                                                                                                                                                              RenderLoop[edit]

                                                                                                                                                                                                                                                                                                                                                                                                                              Batches changes (that force something to be redrawn) in the background.

                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                              Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                • new RenderLoop(onRender, win)
                                                                                                                                                                                                                                                                                                                                                                                                                                • Internal

                                                                                                                                                                                                                                                                                                                                                                                                                                 

                                                                                                                                                                                                                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                • RenderLoop.schedule(Array change)
                                                                                                                                                                                                                                                                                                                                                                                                                                • Internal

                                                                                                                                                                                                                                                                                                                                                                                                                                 

                                                                                                                                                                                                                                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                              changeArrayRequired.
                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                              Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                • new RenderLoop(onRender, win)
                                                                                                                                                                                                                                                                                                                                                                                                                                • Internal

                                                                                                                                                                                                                                                                                                                                                                                                                                 

                                                                                                                                                                                                                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                • RenderLoop.schedule(Array change)
                                                                                                                                                                                                                                                                                                                                                                                                                                • Internal

                                                                                                                                                                                                                                                                                                                                                                                                                                 

                                                                                                                                                                                                                                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                              changeArray

                                                                                                                                                                                                                                                                                                                                                                                                                              Required.

                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/api/scrollbar.html b/api/scrollbar.html index 1ea2683c..23c6f022 100644 --- a/api/scrollbar.html +++ b/api/scrollbar.html @@ -1,20 +1,25 @@ - ScrollBar - Ace API

                                                                                                                                                                                                                                                                                                                                                                                                                              ScrollBar[edit]

                                                                                                                                                                                                                                                                                                                                                                                                                              A set of methods for setting and retrieving the editor's scrollbar.

                                                                                                                                                                                                                                                                                                                                                                                                                              + ScrollBar - Ace API

                                                                                                                                                                                                                                                                                                                                                                                                                              ScrollBar[edit]

                                                                                                                                                                                                                                                                                                                                                                                                                              A set of methods for setting and retrieving the editor's scrollbar.

                                                                                                                                                                                                                                                                                                                                                                                                                              Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                              Creates a new ScrollBar. parent is the owner of the scroll bar.

                                                                                                                                                                                                                                                                                                                                                                                                                                 

                                                                                                                                                                                                                                                                                                                                                                                                                              Creates a new ScrollBar. parent is the owner of the scroll bar.

                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                              parentDOMElementRequired. A DOM element

                                                                                                                                                                                                                                                                                                                                                                                                                              Events

                                                                                                                                                                                                                                                                                                                                                                                                                                • ScrollBar.on("onScroll", function())

                                                                                                                                                                                                                                                                                                                                                                                                                                Emitted when the scroll bar, well, scrolls.

                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                   

                                                                                                                                                                                                                                                                                                                                                                                                                                Emitted when the scroll bar, well, scrolls.

                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                Returns the width of the scroll bar.

                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                parentDOMElement

                                                                                                                                                                                                                                                                                                                                                                                                                                Required. A DOM element

                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                Events

                                                                                                                                                                                                                                                                                                                                                                                                                                  • ScrollBar.on("scroll", function(Object e))

                                                                                                                                                                                                                                                                                                                                                                                                                                  Emitted when the scroll bar, well, scrolls.

                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                     

                                                                                                                                                                                                                                                                                                                                                                                                                                  Emitted when the scroll bar, well, scrolls.

                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                  Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                  eObject

                                                                                                                                                                                                                                                                                                                                                                                                                                  Required. Contains one property, "data", which indicates the current scroll top position

                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns the width of the scroll bar.

                                                                                                                                                                                                                                                                                                                                                                                                                                     

                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns the width of the scroll bar.

                                                                                                                                                                                                                                                                                                                                                                                                                                    • ScrollBar.setHeight(Number height)

                                                                                                                                                                                                                                                                                                                                                                                                                                    Sets the height of the scroll bar, in pixels.

                                                                                                                                                                                                                                                                                                                                                                                                                                       

                                                                                                                                                                                                                                                                                                                                                                                                                                    Sets the height of the scroll bar, in pixels.

                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                    Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                    heightNumberRequired. The new height
                                                                                                                                                                                                                                                                                                                                                                                                                                      • ScrollBar.setInnerHeight(Number height)

                                                                                                                                                                                                                                                                                                                                                                                                                                      Sets the inner height of the scroll bar, in pixels.

                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                      Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                      heightNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                      Required. The new height

                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                        • ScrollBar.setInnerHeight(Number height)

                                                                                                                                                                                                                                                                                                                                                                                                                                        Sets the inner height of the scroll bar, in pixels.

                                                                                                                                                                                                                                                                                                                                                                                                                                           

                                                                                                                                                                                                                                                                                                                                                                                                                                        Sets the inner height of the scroll bar, in pixels.

                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                        Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                        heightNumberRequired. The new inner height
                                                                                                                                                                                                                                                                                                                                                                                                                                          • ScrollBar.setScrollTop(Number scrollTop)

                                                                                                                                                                                                                                                                                                                                                                                                                                          Sets the scroll top of the scroll bar.

                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                          Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                          heightNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                          Required. The new inner height

                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                            • ScrollBar.setScrollTop(Number scrollTop)

                                                                                                                                                                                                                                                                                                                                                                                                                                            Sets the scroll top of the scroll bar.

                                                                                                                                                                                                                                                                                                                                                                                                                                               

                                                                                                                                                                                                                                                                                                                                                                                                                                            Sets the scroll top of the scroll bar.

                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                            Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                            scrollTopNumberRequired. The new scroll top
                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                            Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                            scrollTopNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                            Required. The new scroll top

                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/api/search.html b/api/search.html index 58022ef1..723f8536 100644 --- a/api/search.html +++ b/api/search.html @@ -1,7 +1,7 @@ - Search - Ace API

                                                                                                                                                                                                                                                                                                                                                                                                                                            Search[edit]

                                                                                                                                                                                                                                                                                                                                                                                                                                            A class designed to handle all sorts of text searches within a Document.

                                                                                                                                                                                                                                                                                                                                                                                                                                            + Search - Ace API

                                                                                                                                                                                                                                                                                                                                                                                                                                            Search[edit]

                                                                                                                                                                                                                                                                                                                                                                                                                                            A class designed to handle all sorts of text searches within a Document.

                                                                                                                                                                                                                                                                                                                                                                                                                                            Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                              • new Search()

                                                                                                                                                                                                                                                                                                                                                                                                                                              Creates a new Search object. The following search options are avaliable:

                                                                                                                                                                                                                                                                                                                                                                                                                                                 

                                                                                                                                                                                                                                                                                                                                                                                                                                              Creates a new Search object. The following search options are avaliable:

                                                                                                                                                                                                                                                                                                                                                                                                                                                @@ -10,22 +10,28 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                              • wrap: Whether to wrap the search back to the beginning when it hits the end. Defaults to false.
                                                                                                                                                                                                                                                                                                                                                                                                                                              • caseSensitive: Whether the search ought to be case-sensitive. Defaults to false.
                                                                                                                                                                                                                                                                                                                                                                                                                                              • wholeWord: Whether the search matches only on whole words. Defaults to false.
                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                              • range: The Range to search within. Set this to null for the whole document
                                                                                                                                                                                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                                                                                                                                                                              • range: The Range to search within. Set this to null for the whole document
                                                                                                                                                                                                                                                                                                                                                                                                                                              • regExp: Whether the search is a regular expression or not. Defaults to false.
                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                              • start: The starting Range or cursor position to begin the search
                                                                                                                                                                                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                                                                                                                                                                              • start: The starting Range or cursor position to begin the search
                                                                                                                                                                                                                                                                                                                                                                                                                                              • skipCurrent: Whether or not to include the current line in the search. Default to false.
                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                              Searches for options.needle. If found, this method returns the Range where the text first occurs. If options.backwards is true, the search goes backwards in the session.

                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                 

                                                                                                                                                                                                                                                                                                                                                                                                                                              Searches for options.needle. If found, this method returns the Range where the text first occurs. If options.backwards is true, the search goes backwards in the session.

                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                              sessionEditSessionRequired. The session to search with

                                                                                                                                                                                                                                                                                                                                                                                                                                              Searches for all occurances options.needle. If found, this method returns an array of Range where the text first occurs. If options.backwards is true, the search goes backwards in the session.

                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                 

                                                                                                                                                                                                                                                                                                                                                                                                                                              Searches for all occurances options.needle. If found, this method returns an array of Range where the text first occurs. If options.backwards is true, the search goes backwards in the session.

                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                              sessionEditSessionRequired. The session to search with

                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns an object containing all the search options.

                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                              Searches for options.needle. If found, this method returns the Range where the text first occurs. If options.backwards is true, the search goes backwards in the session.

                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                 

                                                                                                                                                                                                                                                                                                                                                                                                                                              Searches for options.needle. If found, this method returns the Range where the text first occurs. If options.backwards is true, the search goes backwards in the session.

                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                              sessionEditSession

                                                                                                                                                                                                                                                                                                                                                                                                                                              Required. The session to search with

                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                              Searches for all occurances options.needle. If found, this method returns an array of Ranges where the text first occurs. If options.backwards is true, the search goes backwards in the session.

                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                 

                                                                                                                                                                                                                                                                                                                                                                                                                                              Searches for all occurances options.needle. If found, this method returns an array of Ranges where the text first occurs. If options.backwards is true, the search goes backwards in the session.

                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                              sessionEditSession

                                                                                                                                                                                                                                                                                                                                                                                                                                              Required. The session to search with

                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns an object containing all the search options.

                                                                                                                                                                                                                                                                                                                                                                                                                                                 

                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns an object containing all the search options.

                                                                                                                                                                                                                                                                                                                                                                                                                                              Searches for options.needle in input, and, if found, replaces it with replacement.

                                                                                                                                                                                                                                                                                                                                                                                                                                                 

                                                                                                                                                                                                                                                                                                                                                                                                                                              Searches for options.needle in input, and, if found, replaces it with replacement.

                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                              inputStringRequired. The text to search in
                                                                                                                                                                                                                                                                                                                                                                                                                                              replacementStringRequired. The replacing text

                                                                                                                                                                                                                                                                                                                                                                                                                                              Sets the search options via the options parameter.

                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                              inputString

                                                                                                                                                                                                                                                                                                                                                                                                                                              Required. The text to search in

                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                              replacementString

                                                                                                                                                                                                                                                                                                                                                                                                                                              Required. The replacing text

                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns

                                                                                                                                                                                                                                                                                                                                                                                                                                              StringIf options.regExp is true, this function returns input with the replacement already made. Otherwise, this function just returns replacement.
                                                                                                                                                                                                                                                                                                                                                                                                                                              If options.needle was not found, this function returns null.

                                                                                                                                                                                                                                                                                                                                                                                                                                              Sets the search options via the options parameter.

                                                                                                                                                                                                                                                                                                                                                                                                                                                 

                                                                                                                                                                                                                                                                                                                                                                                                                                              Sets the search options via the options parameter.

                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                              optionsObjectRequired. An object containing all the new search properties
                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                              optionsObject

                                                                                                                                                                                                                                                                                                                                                                                                                                              Required. An object containing all the new search properties

                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/api/selection.html b/api/selection.html index 788bfd65..2f826b3b 100644 --- a/api/selection.html +++ b/api/selection.html @@ -1,18 +1,25 @@ - Selection - Ace API

                                                                                                                                                                                                                                                                                                                                                                                                                                              Selection[edit]

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

                                                                                                                                                                                                                                                                                                                                                                                                                                              + Selection - Ace API

                                                                                                                                                                                                                                                                                                                                                                                                                                              Selection[edit]

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

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

                                                                                                                                                                                                                                                                                                                                                                                                                                              Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                              Creates a new Selection object.

                                                                                                                                                                                                                                                                                                                                                                                                                                                 

                                                                                                                                                                                                                                                                                                                                                                                                                                              Creates a new Selection object.

                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                              sessionEditSessionRequired. The session to use

                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods

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

                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                              sessionEditSession

                                                                                                                                                                                                                                                                                                                                                                                                                                              Required. The session to use

                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                              Events

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                Emitted when the cursor position changes.

                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                   

                                                                                                                                                                                                                                                                                                                                                                                                                                                Emitted when the cursor position changes.

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Emitted when the cursor selection changes.

                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                     

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Emitted when the cursor selection changes.

                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                     

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                  rangeRangeRequired. The new range to add
                                                                                                                                                                                                                                                                                                                                                                                                                                                  $blockChangeEventsBooleanRequired. Whether or not to block changing events
                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Selection.clearSelection()

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                    Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                    rangeRange

                                                                                                                                                                                                                                                                                                                                                                                                                                                    Required. The new range to add

                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    $blockChangeEventsBoolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                    Required. Whether or not to block changing events

                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Selection.clearSelection()

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                         

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                      Gets the current position of the cursor.

                                                                                                                                                                                                                                                                                                                                                                                                                                                         

                                                                                                                                                                                                                                                                                                                                                                                                                                                      Gets the current position of the cursor.

                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Selection.getRange()

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns the Range for the selected text.

                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                           

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns the Range for the selected text.

                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Selection.getRange()

                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns the Range for the selected text.

                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                             

                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns the Range for the selected text.

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                             

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Selection.getSelectionLead()

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                            @@ -27,7 +34,9 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                               

                                                                                                                                                                                                                                                                                                                                                                                                                                                            Merges overlapping ranges ensuring consistency after changes

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                               

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                            Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                            rowsNumberRequired. The number of rows to move by
                                                                                                                                                                                                                                                                                                                                                                                                                                                            charsNumberRequired. The number of characters to move by
                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Selection.moveCursorDown()

                                                                                                                                                                                                                                                                                                                                                                                                                                                              Moves the cursor down one row.

                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                              rowsNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                              Required. The number of rows to move by

                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              charsNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                              Required. The number of characters to move by

                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Selection.moveCursorDown()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                Moves the cursor down one row.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                   

                                                                                                                                                                                                                                                                                                                                                                                                                                                                Moves the cursor down one row.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Selection.moveCursorFileEnd()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Moves the cursor to the end of the file.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                     

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Moves the cursor to the end of the file.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @@ -47,15 +56,25 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                     

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Moves the cursor right one column.

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                     

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  rowNumberRequired. The row to move to
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  columnNumberRequired. The column to move to
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  keepDesiredColumnBooleanRequired. If true, the cursor move does not respect the previous column
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Selection.moveCursorToPosition(Object position)

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    rowNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Required. The row to move to

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    columnNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Required. The column to move to

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    keepDesiredColumnBoolean

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Selection.moveCursorToPosition(Object position)

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                         

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      positionObjectRequired. The position to move to

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      positionObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Required. The position to move to

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                         

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      rowNumberRequired. The row to move to
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      columnNumberRequired. The column to move to
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      keepDesiredColumnBooleanRequired. If true, the cursor move does not respect the previous column
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Selection.moveCursorUp()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Moves the cursor up one row.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        rowNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required. The row to move to

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        columnNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required. The column to move to

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        keepDesiredColumnBoolean

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Selection.moveCursorUp()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Moves the cursor up one row.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                             

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Moves the cursor up one row.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Gets list of ranges composing rectangular block on the screen

                                                                                                                                                                                                                                                                                                                                                                                                                                                                             

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Gets list of ranges composing rectangular block on the screen

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          screenCursorCursorRequired. The cursor to use
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          screenAnchorAnchorRequired. The anchor to use
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          includeEmptyLinesBooleanRequired. If true, this includes ranges inside the block which are empty due to clipping
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Selection.selectAll()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Selects all the text in the document.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            screenCursorCursor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Required. The cursor to use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            screenAnchorAnchor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Required. The anchor to use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            includeEmptyLinesBoolean

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Selection.selectAll()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Selects all the text in the document.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Selects all the text in the document.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Selects a word, including its right whitespace.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Selects a word, including its right whitespace.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              @@ -77,9 +96,12 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Moves the selection right one column.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Moves the selection cursor to the indicated row and column.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Moves the selection cursor to the indicated row and column.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              rowNumberRequired. The row to select to
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              columnNumberRequired. The column to select to
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Selection.selectToPosition(Object pos)

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                rowNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Required. The row to select to

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                columnNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Required. The column to select to

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Selection.selectToPosition(Object pos)

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  posObjectRequired. An object containing the row and column
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Selection.selectUp()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Moves the selection up one row.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    posObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Required. An object containing the row and column

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Selection.selectUp()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Moves the selection up one row.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Moves the selection up one row.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Moves the selection to highlight the entire word.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Moves the selection to highlight the entire word.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      @@ -89,13 +111,19 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Moves the selection to the first word on the right.

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      rowNumberRequired. The new row
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      columnNumberRequired. The new column

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Sets the selection to the provided range.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      rowNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Required. The new row

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      columnNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Required. The new column

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Sets the selection to the provided range.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Sets the selection to the provided range.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      rangeRangeRequired. The range of text to select
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      reverseBooleanRequired. Indicates if the range should go backwards (true) or not
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Selection.shiftSelection(Number columns)

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        columnsNumberRequired. The number of columns to shift by

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Removes a Range containing pos (if it exists).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        rangeRange

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required. The range of text to select

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        reverseBoolean

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Selection.shiftSelection(Number columns)

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          columnsNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Required. The number of columns to shift by

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Removes a Range containing pos (if it exists).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Removes a Range containing pos (if it exists).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Arguments

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          posRange

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/api/split.html b/api/split.html index cdad4071..c9dde6a2 100644 --- a/api/split.html +++ b/api/split.html @@ -1,29 +1,42 @@ - Split - Ace API

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Split[edit]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          containerDocumentRequired. The document to associate with the split
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          themeStringRequired. The name of the initial theme
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          splitsNumberRequired. The number of initial splits

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Blurs the current editor.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + Split - Ace API

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Split[edit]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          containerDocument

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Required. The document to associate with the split

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          themeString

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Required. The name of the initial theme

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          splitsNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Required. The number of initial splits

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Blurs the current editor.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Blurs the current editor.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Focuses the current editor.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Focuses the current editor.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Executes callback on all of the available editors.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Executes callback on all of the available editors.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          callbackFunctionRequired. A callback function to execute
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          scopeStringRequired.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Split.getCurrentEditor()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns the current editor.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            callbackFunction

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Required. A callback function to execute

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            scopeString

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Required.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Split.getCurrentEditor()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns the current editor.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns the current editor.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns the editor identified by the index idx.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns the editor identified by the index idx.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              idxNumberRequired. The index of the editor you want
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Internal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns the orientation.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              idxNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Required. The index of the editor you want

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Internal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns the orientation.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns the orientation.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns the number of splits.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns the number of splits.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Split.resize()
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Internal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Sets the font size, in pixels, for all the available editors.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Sets the font size, in pixels, for all the available editors.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              sizeNumberRequired. The new font size
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Split.setKeyboardHandler(String keybinding)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Internal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              keybindingStringRequired.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Split.setOrientation(Number oriantation)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Internal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Sets the orientation.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              sizeNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Required. The new font size

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Split.setKeyboardHandler(String keybinding)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Internal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              keybindingString

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Required.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Split.setOrientation(Number oriantation)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Internal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Sets the orientation.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Sets the orientation.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              oriantationNumberRequired.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Split.setSplits(Number splits)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Internal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              splitsNumberRequired. The new number of splits

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Sets a theme for each of the available editors.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              oriantationNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Required.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Split.setSplits(Number splits)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Internal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              splitsNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Required. The new number of splits

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Sets a theme for each of the available editors.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Sets a theme for each of the available editors.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              themeStringRequired. The name of the theme to set
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Split.UndoManagerProxy()
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Internal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              themeString

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Required. The name of the theme to set

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Split.UndoManagerProxy()
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Internal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/api/token_iterator.html b/api/token_iterator.html index ef9d2a2a..2591976d 100644 --- a/api/token_iterator.html +++ b/api/token_iterator.html @@ -4,7 +4,10 @@ TokenIterator - Ace API

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              TokenIterator[edit]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              This class provides an essay way to treat the document as a stream of tokens, and provides methods to iterate over these tokens.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Creates a new token iterator object. The inital token index is set to the provided row and column coordinates.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Creates a new token iterator object. The inital token index is set to the provided row and column coordinates.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              sessionEditSessionRequired. The session to associate with
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              initialRowNumberRequired. The row to start the tokenizing at
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              initialColumnNumberRequired. The column to start the tokenizing at

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • TokenIterator.getCurrentToken()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns the current tokenized string.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                sessionEditSession

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Required. The session to associate with

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                initialRowNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Required. The row to start the tokenizing at

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                initialColumnNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Required. The column to start the tokenizing at

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • TokenIterator.getCurrentToken()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns the current tokenized string.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns the current tokenized string.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • TokenIterator.getCurrentTokenColumn()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns the current column.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns the current column.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    @@ -12,7 +15,7 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns the current row.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • TokenIterator.stepBackward()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Tokenizes all the items from the current point to the row prior in the document.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Tokenizes all the items from the current point to the row prior in the document.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • TokenIterator.stepForward()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Tokenizes all the items from the current point until the next row in the document. If the current point is at the end of the file, this function returns null. Otherwise, it returns the tokenized string.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        StringIf the current point is not at the top of the file, this function returns null. Otherwise, it returns an array of the tokenized strings.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • TokenIterator.stepForward()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Tokenizes all the items from the current point until the next row in the document. If the current point is at the end of the file, this function returns null. Otherwise, it returns the tokenized string.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Tokenizes all the items from the current point until the next row in the document. If the current point is at the end of the file, this function returns null. Otherwise, it returns the tokenized string.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/api/tokenizer.html b/api/tokenizer.html index de974f6b..5dfeae94 100644 --- a/api/tokenizer.html +++ b/api/tokenizer.html @@ -4,7 +4,9 @@ Tokenizer - Ace API

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Tokenizer[edit]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Constructs a new tokenizer based on the given rules and flags.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Constructs a new tokenizer based on the given rules and flags.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          rulesObjectRequired. The highlighting rules
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          flagStringRequired. Any additional regular expression flags to pass (like "i" for case insensitive)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Tokenizer.getLineTokens()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns an object containing two properties: tokens, which contains all the tokens; and state, the current state.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            rulesObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Required. The highlighting rules

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            flagString

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Required. Any additional regular expression flags to pass (like "i" for case insensitive)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Tokenizer.getLineTokens()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns an object containing two properties: tokens, which contains all the tokens; and state, the current state.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns an object containing two properties: tokens, which contains all the tokens; and state, the current state.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/api/undomanager.html b/api/undomanager.html index a7d02245..37273d66 100644 --- a/api/undomanager.html +++ b/api/undomanager.html @@ -1,7 +1,7 @@ - UndoManager - Ace API

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              UndoManager[edit]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              This object maintains the undo stack for an EditSession.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              + UndoManager - Ace API

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              UndoManager[edit]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              This object maintains the undo stack for an EditSession.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • new UndoManager()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Resets the current undo state and creates a new UndoManager.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Resets the current undo state and creates a new UndoManager.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • UndoManager.execute(Object options)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Provides a means for implementing your own undo manager. options has one property, args, an Array, with two elements:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @@ -10,17 +10,20 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • args[0] is an array of deltas
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • args[1] is the document to associate with
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  optionsObjectRequired. Contains additional properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns true if there are redo operations left to perform.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  optionsObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Required. Contains additional properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns true if there are redo operations left to perform.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns true if there are redo operations left to perform.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns true if there are undo operations left to perform.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns true if there are undo operations left to perform.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • UndoManager.redo(Boolean dontSelect)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Void

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    dontSelectBooleanRequired. If true, doesn't select the range of where the change occured
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • UndoManager.reset()
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Destroys the stack of undo and redo redo operations.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      dontSelectBoolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Required. If true, doesn't select the range of where the change occured

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • UndoManager.reset()
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Destroys the stack of undo and redo redo operations.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Destroys the stack of undo and redo redo operations.

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        dontSelectBooleanRequired. If true, doesn't select the range of where the change occured
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        dontSelectBoolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required. If true, doesn't select the range of where the change occured

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/api/virtual_renderer.html b/api/virtual_renderer.html index f8d4220e..ff108356 100644 --- a/api/virtual_renderer.html +++ b/api/virtual_renderer.html @@ -4,9 +4,11 @@ VirtualRenderer - Ace API

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        VirtualRenderer[edit]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The class that is responsible for drawing everything you see on the screen!

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Constructs a new VirtualRenderer within the container specified, applying the given theme.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Constructs a new VirtualRenderer within the container specified, applying the given theme.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        containerDOMElementRequired. The root element of the editor
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        themeStringRequired. The starting theme

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • VirtualRenderer.addGutterDecoration(row, className)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Deprecated (moved to EditSession)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Deprecated (moved to EditSession)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • VirtualRenderer.adjustWrapLimit()
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Adjusts the wrap limit, which is the number of characters that can fit within the width of the edit area on screen.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            containerDOMElement

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Required. The root element of the editor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            themeString

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Required. The starting theme

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • VirtualRenderer.addGutterDecoration(row, className)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Deprecated

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Deprecated; (moved to EditSession)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Deprecated; (moved to EditSession)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • VirtualRenderer.adjustWrapLimit()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Adjusts the wrap limit, which is the number of characters that can fit within the width of the edit area on screen.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Adjusts the wrap limit, which is the number of characters that can fit within the width of the edit area on screen.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • VirtualRenderer.destroy()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Destroys the text and cursor layers for this renderer.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Destroys the text and cursor layers for this renderer.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                @@ -46,77 +48,106 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns the element to which the hidden text area is added.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • VirtualRenderer.getTheme()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns the path of the current theme.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns the path of the current theme.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • VirtualRenderer.hideComposition()
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Hides the current composition.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • VirtualRenderer.hideComposition()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Hides the current composition.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Hides the current composition.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • VirtualRenderer.hideCursor()
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Hides the cursor icon.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • VirtualRenderer.hideCursor()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Hides the cursor icon.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Hides the cursor icon.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns true if you can still scroll by either parameter; in other words, you haven't reached the end of the file or line.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns true if you can still scroll by either parameter; in other words, you haven't reached the end of the file or line.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          deltaXNumberRequired. The x value to scroll by
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          deltaYNumberRequired. The y value to scroll by
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • VirtualRenderer.onResize(Boolean force)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Triggers a resize of the editor.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            deltaXNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Required. The x value to scroll by

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            deltaYNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Required. The y value to scroll by

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • VirtualRenderer.onResize(Boolean force)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Triggers a resize of the editor.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Triggers a resize of the editor.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              forceBooleanRequired. If true, recomputes the size, even if the height and width haven't changed
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • VirtualRenderer.removeGutterDecoration(row, className)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Deprecated (moved to EditSession)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Deprecated (moved to EditSession)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Scrolls the editor across both x- and y-axes.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                forceBoolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Required. If true, recomputes the size, even if the height and width haven't changed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • VirtualRenderer.removeGutterDecoration(row, className)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Deprecated

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Deprecated; (moved to EditSession)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Deprecated; (moved to EditSession)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Scrolls the editor across both x- and y-axes.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Scrolls the editor across both x- and y-axes.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                deltaXNumberRequired. The x value to scroll by
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                deltaYNumberRequired. The y value to scroll by
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • VirtualRenderer.scrollCursorIntoView(cursor, offset)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Scrolls the cursor into the first visibile area of the editor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  deltaXNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Required. The x value to scroll by

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  deltaYNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Required. The y value to scroll by

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • VirtualRenderer.scrollCursorIntoView(cursor, offset)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Scrolls the cursor into the first visibile area of the editor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Scrolls the cursor into the first visibile area of the editor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Gracefully scrolls the editor to the row indicated.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Gracefully scrolls the editor to the row indicated.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Gracefully scrolls the editor to the row indicated.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    lineNumberRequired. A line number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    centerBooleanRequired. If true, centers the editor the to indicated line
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    animateBooleanRequired. If true animates scrolling
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    callbackFunctionRequired. Function to be called after the animation has finished

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Gracefully scrolls the top of the editor to the row indicated.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    lineNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Required. A line number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    centerBoolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Required. If true, centers the editor the to indicated line

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    animateBoolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Required. If true animates scrolling

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    callbackFunction

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Required. Function to be called after the animation has finished

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Gracefully scrolls the top of the editor to the row indicated.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Gracefully scrolls the top of the editor to the row indicated.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    rowNumberRequired. A row id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Scrolls the editor to the x pixel indicated.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    rowNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Required. A row id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Scrolls the editor to the x pixel indicated.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Scrolls the editor to the x pixel indicated.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    scrollLeftNumberRequired. The position to scroll to

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Scrolls the editor to the y pixel indicated.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    scrollLeftNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Required. The position to scroll to

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Scrolls the editor to the y pixel indicated.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Scrolls the editor to the y pixel indicated.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    scrollTopNumberRequired. The position to scroll to
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • VirtualRenderer.setAnimatedScroll(Boolean shouldAnimate)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Identifies whether you want to have an animated scroll or not.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      scrollTopNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Required. The position to scroll to

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • VirtualRenderer.setAnimatedScroll(Boolean shouldAnimate)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Identifies whether you want to have an animated scroll or not.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Identifies whether you want to have an animated scroll or not.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        shouldAnimateBooleanRequired. Set to true to show animated scrolls
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • VirtualRenderer.setAnnotations(Array annotations)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Sets annotations for the gutter.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          shouldAnimateBoolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Required. Set to true to show animated scrolls

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • VirtualRenderer.setAnnotations(Array annotations)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Sets annotations for the gutter.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Sets annotations for the gutter.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            annotationsArrayRequired. An array containing annotations
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • VirtualRenderer.setCompositionText(String text)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Sets the inner text of the current composition to text.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              annotationsArray

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Required. An array containing annotations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • VirtualRenderer.setCompositionText(String text)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Sets the inner text of the current composition to text.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Sets the inner text of the current composition to text.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                textStringRequired. A string of text to use
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • VirtualRenderer.setHScrollBarAlwaysVisible(Boolean alwaysVisible)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Identifies whether you want to show the horizontal scrollbar or not.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  textString

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Required. A string of text to use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • VirtualRenderer.setHScrollBarAlwaysVisible(Boolean alwaysVisible)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Identifies whether you want to show the horizontal scrollbar or not.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Identifies whether you want to show the horizontal scrollbar or not.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    alwaysVisibleBooleanRequired. Set to true to make the horizontal scroll bar visible
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • VirtualRenderer.setPadding(Number padding)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Sets the padding for all the layers.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      alwaysVisibleBoolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Required. Set to true to make the horizontal scroll bar visible

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • VirtualRenderer.setPadding(Number padding)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Sets the padding for all the layers.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Sets the padding for all the layers.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        paddingNumberRequired. A new padding value (in pixels)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • VirtualRenderer.setPrintMarginColumn(Boolean showPrintMargin)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Identifies whether you want to show the print margin column or not.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          paddingNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Required. A new padding value (in pixels)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • VirtualRenderer.setPrintMarginColumn(Boolean showPrintMargin)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Identifies whether you want to show the print margin column or not.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Identifies whether you want to show the print margin column or not.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            showPrintMarginBooleanRequired. Set to true to show the print margin column
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • VirtualRenderer.setShowGutter(Boolean show)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Identifies whether you want to show the gutter or not.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              showPrintMarginBoolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Required. Set to true to show the print margin column

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • VirtualRenderer.setShowGutter(Boolean show)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Identifies whether you want to show the gutter or not.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Identifies whether you want to show the gutter or not.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                showBooleanRequired. Set to true to show the gutter
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • VirtualRenderer.setShowInvisibles(Boolean showInvisibles)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Identifies whether you want to show invisible characters or not.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  showBoolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Required. Set to true to show the gutter

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • VirtualRenderer.setShowInvisibles(Boolean showInvisibles)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Identifies whether you want to show invisible characters or not.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Identifies whether you want to show invisible characters or not.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    showInvisiblesBooleanRequired. Set to true to show invisibles
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • VirtualRenderer.setShowPrintMargin(Boolean showPrintMargin)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Identifies whether you want to show the print margin or not.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      showInvisiblesBoolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Required. Set to true to show invisibles

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • VirtualRenderer.setShowPrintMargin(Boolean showPrintMargin)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Identifies whether you want to show the print margin or not.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Identifies whether you want to show the print margin or not.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        showPrintMarginBooleanRequired. Set to true to show the print margin
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • VirtualRenderer.setStyle(String style)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Adds a new class, style, to the editor.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          showPrintMarginBoolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Required. Set to true to show the print margin

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • VirtualRenderer.setStyle(String style)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Adds a new class, style, to the editor.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Adds a new class, style, to the editor.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            styleStringRequired. A class name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • VirtualRenderer.setTheme(String theme)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Void

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              styleString

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Required. A class name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • VirtualRenderer.setTheme(String theme)

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                themeStringRequired. The path to a theme
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • VirtualRenderer.showComposition(Number position)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Internal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                positionNumberRequired.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • VirtualRenderer.showCursor()
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Shows the cursor icon.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  themeString

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Required. The path to a theme

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • VirtualRenderer.showComposition(Number position)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Internal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  positionNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Required.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • VirtualRenderer.showCursor()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Shows the cursor icon.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Shows the cursor icon.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns an object containing the pageX and pageY coordinates of the document position.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns an object containing the pageX and pageY coordinates of the document position.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    rowNumberRequired. The document row position
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    columnNumberRequired. The document column position
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • VirtualRenderer.unsetStyle(String style)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Removes the class style from the editor.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      rowNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Required. The document row position

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      columnNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Required. The document column position

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • VirtualRenderer.unsetStyle(String style)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Removes the class style from the editor.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Removes the class style from the editor.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        styleStringRequired. A class name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • VirtualRenderer.updateBackMarkers()
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Schedules an update to all the back markers in the document.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          styleString

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Required. A class name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • VirtualRenderer.updateBackMarkers()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Schedules an update to all the back markers in the document.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Schedules an update to all the back markers in the document.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • VirtualRenderer.updateBreakpoints()
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Redraw breakpoints.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • VirtualRenderer.updateBreakpoints()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Redraw breakpoints.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Redraw breakpoints.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • VirtualRenderer.updateCursor()
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Updates the cursor icon.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • VirtualRenderer.updateCursor()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Updates the cursor icon.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Updates the cursor icon.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • VirtualRenderer.updateFontSize()
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Updates the font size.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • VirtualRenderer.updateFontSize()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Updates the font size.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Updates the font size.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • VirtualRenderer.updateFrontMarkers()
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Schedules an update to all the front markers in the document.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • VirtualRenderer.updateFrontMarkers()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Schedules an update to all the front markers in the document.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Schedules an update to all the front markers in the document.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • VirtualRenderer.updateFull()
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Triggers a full update of all the layers, for all the rows.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • VirtualRenderer.updateFull()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Triggers a full update of all the layers, for all the rows.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Triggers a full update of all the layers, for all the rows.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • VirtualRenderer.updateLines(Number firstRow, Number lastRow)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Triggers a partial update of the text, from the range given by the two parameters.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • VirtualRenderer.updateLines(Number firstRow, Number lastRow)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Triggers a partial update of the text, from the range given by the two parameters.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Triggers a partial update of the text, from the range given by the two parameters.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    firstRowNumberRequired. The first row to update
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    lastRowNumberRequired. The last row to update
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • VirtualRenderer.updateText()
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Triggers a full update of the text, for all the rows.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      firstRowNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Required. The first row to update

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      lastRowNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Required. The last row to update

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • VirtualRenderer.updateText()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Triggers a full update of the text, for all the rows.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Triggers a full update of the text, for all the rows.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • VirtualRenderer.visualizeBlur()
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Blurs the current container.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • VirtualRenderer.visualizeBlur()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Blurs the current container.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Blurs the current container.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • VirtualRenderer.visualizeFocus()
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Focuses the current container.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • VirtualRenderer.visualizeFocus()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Focuses the current container.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Focuses the current container.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/doc/package.json b/doc/package.json index 6f9e675e..294fe73f 100644 --- a/doc/package.json +++ b/doc/package.json @@ -2,7 +2,7 @@ "name": "ace-api", "version": "0.1.0", "dependencies": { - "panino" : ">=2.0.1", + "panino" : ">=2.0.8", "asset-smasher": "0.2.0" } } \ No newline at end of file diff --git a/doc/resources/ace/templates/lib.jade b/doc/resources/ace/templates/lib.jade index d8437979..f3a75e1c 100644 --- a/doc/resources/ace/templates/lib.jade +++ b/doc/resources/ace/templates/lib.jade @@ -152,9 +152,9 @@ mixin article(obj, parents) h4 Arguments != argumentTable(obj.arguments, ["argument-list", "table", "table-striped", "table-bordered"]) - if obj.retDesc + if obj.returns h4 Returns - != returnTable(obj.retDesc, ["return-list", "table", "table-striped", "table-bordered"]) + != returnTable(obj.returns, ["return-list", "table", "table-striped", "table-bordered"]) //- children for child in obj.children.filter(function(x){return x.type === 'section'}) diff --git a/lib/ace/anchor.js b/lib/ace/anchor.js index 11809bc0..7ff69351 100644 --- a/lib/ace/anchor.js +++ b/lib/ace/anchor.js @@ -98,9 +98,14 @@ var Anchor = exports.Anchor = function(doc, row, column) { /** * Anchor@change(e) - * - e (Event): Contains data about the event + * - e (Object): An object containing information about the anchor position. It has two properties: + * `old`: An object describing the old Anchor position + * `value`: An object describing the new Anchor position + Both of these objects have a `row` and `column` property corresponding to the position. * - * 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 [[Anchor.setPosition `setPosition()`]]. * **/ diff --git a/lib/ace/background_tokenizer.js b/lib/ace/background_tokenizer.js index 7422d36d..bae507f5 100644 --- a/lib/ace/background_tokenizer.js +++ b/lib/ace/background_tokenizer.js @@ -142,6 +142,13 @@ var BackgroundTokenizer = function(tokenizer, editor) { * Emits the `'update'` event. `firstRow` and `lastRow` are used to define the boundaries of the region to be updated. * **/ + /** + * BackgroundTokenizer@update(e) + * - e (Object): An object containing two properties, `first` and `last`, which indicate the rows of the region being updated. + * + * Fires whenever the background tokeniziers between a range of rows are going to be updated. + * + **/ this.fireUpdateEvent = function(firstRow, lastRow) { var data = { first: firstRow, diff --git a/lib/ace/document.js b/lib/ace/document.js index ed83c18c..f35c1d51 100644 --- a/lib/ace/document.js +++ b/lib/ace/document.js @@ -58,6 +58,7 @@ var Anchor = require("./anchor").Anchor; * Creates a new `Document`. If `text` is included, the `Document` contains those strings; otherwise, it's empty. * **/ + var Document = function(text) { this.$lines = []; @@ -322,6 +323,29 @@ var Document = function(text) { * * **/ + /** + * Document@change(e) + * - e (Object): Contains at least one property called `"action"`. `"action"` indicates the action that triggered the change. Each action also has a set of additional properties. + * + * Fires whenever the document changes. + * + * Several methods trigger different `"change"` events. Below is a list of each action type, followed by each property that's also available: + * + * * `"insertLines"` (emitted by [[Document.insertLines]]) + * * `range`: the [[Range]] of the change within the document + * * `lines`: the lines in the document that are changing + * * `"insertText"` (emitted by [[Document.insertNewLine]]) + * * `range`: the [[Range]] of the change within the document + * * `text`: the text that's being added + * * `"removeLines"` (emitted by [[Document.insertLines]]) + * * `range`: the [[Range]] of the change within the document + * * `lines`: the lines in the document that were removed + * * `nl`: the new line character (as defined by [[Document.getNewLineCharacter]]) + * * `"removeText"` (emitted by [[Document.removeInLine]] and [[Document.removeNewLine]]) + * * `range`: the [[Range]] of the change within the document + * * `text`: the text that's being removed + * + **/ this.insertLines = function(row, lines) { if (lines.length == 0) return {row: row, column: 0}; diff --git a/lib/ace/edit_session.js b/lib/ace/edit_session.js index 21d908b5..26159dff 100644 --- a/lib/ace/edit_session.js +++ b/lib/ace/edit_session.js @@ -63,29 +63,87 @@ var SearchHighlight = require("./search_highlight").SearchHighlight; // events /** * EditSession@change(e) + * - e (Object): An object containing a `delta` of information about the change. * * Emitted when the document changes. **/ /** - * EditSession@tokenizerUpdate(e) + * EditSession@changeTabSize() * - * Emitted when a background tokenizer asynchronousely processes new rows. + * Emitted when the tab size changes, via [[EditSession.setTabSize]]. + **/ +/** + * EditSession@changeOverwrite() + * + * Emitted when the ability to overwrite text changes, via [[EditSession.setOverwrite]]. + **/ +/** + * EditSession@changeBreakpoint() + * + * Emitted when the gutter changes, either by setting or removing breakpoints, or when the gutter decorations change. + **/ +/** + * EditSession@changeFrontMarker() + * + * Emitted when a front marker changes. + **/ +/** + * EditSession@changeBackMarker() + * + * Emitted when a back marker changes. + **/ +/** + * EditSession@changeAnnotation() + * + * Emitted when an annotation changes, like through [[EditSession.setAnnotations]]. + **/ +/** + * EditSession@tokenizerUpdate(e) + * - e (Object): An object containing one property, `"data"`, that contains information about the changing rows + * + * Emitted when a background tokenizer asynchronously processes new rows. + * + **/ +/** hide + * EditSession@loadMode(e) + * + * + * + **/ +/** + * EditSession@changeMode() + * + * Emitted when the current mode changes. + * + **/ +/** + * EditSession@changeWrapMode() + * + * Emitted when the wrap mode changes. + * + **/ +/** + * EditSession@changeWrapLimit() + * + * Emitted when the wrapping limit changes. * **/ /** * EditSession@changeFold(e) * - * Emitted when a code fold added or removed. + * Emitted when a code fold is added or removed. * **/ /** - * EditSession@changeScrollTop() - * + * EditSession@changeScrollTop(scrollTop) + * - scrollTop (Number): The new scroll top value + * * Emitted when the scroll top changes. **/ /** - * EditSession@changeScrollLeft() - * + * EditSession@changeScrollLeft(scrollLeft) + * - scrollLeft (Number): The new scroll left value + * * Emitted when the scroll left changes. **/ @@ -482,7 +540,9 @@ var EditSession = function(text, mode) { * EditSession.setOverwrite(overwrite) * - overwrite (Boolean): Defines wheter or not to set overwrites * - * 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. * **/ this.setOverwrite = function(overwrite) { diff --git a/lib/ace/editor.js b/lib/ace/editor.js index be072a57..917a8a5c 100644 --- a/lib/ace/editor.js +++ b/lib/ace/editor.js @@ -127,6 +127,12 @@ var Editor = function(renderer, session) { * * Sets a new editsession to use. This method also emits the `'changeSession'` event. **/ + /** + * Editor@changeSession(e) + * - e (Object): An object with two properties, `oldSession` and `session`, that represent the old and new [[EditSession]]s. + * + * Emitted whenever the [[EditSession]] changes. + **/ this.setSession = function(session) { if (this.session == session) return; @@ -462,9 +468,10 @@ var Editor = function(renderer, session) { }; /** - * Editor@cursorChange() + * Editor@changeSelection() + * + * Emitted when the selection changes. * - * Emitted when the cursor changes. **/ this.onCursorChange = function() { this.$cursorChange(); @@ -508,12 +515,6 @@ var Editor = function(renderer, session) { }; - /** - * Editor@selectionChange(e) - * - e (Object): Contains a single property, `data`, which has the delta of changes - * - * Emitted when a selection has changed. - **/ this.onSelectionChange = function(e) { var session = this.session; @@ -568,74 +569,39 @@ var Editor = function(renderer, session) { return re; }; - /** - * Editor@changeFrontMarker() - * - * Emitted when a front marker changes. - **/ + this.onChangeFrontMarker = function() { this.renderer.updateFrontMarkers(); }; - /** - * Editor@changeBackMarker() - * - * Emitted when a back marker changes. - **/ this.onChangeBackMarker = function() { this.renderer.updateBackMarkers(); }; - /** - * Editor@changeBreakpoint() - * - * Emitted when a breakpoint changes. - **/ + this.onChangeBreakpoint = function() { this.renderer.updateBreakpoints(); }; - /** - * Editor@changeAnnotation() - * - * Emitted when an annotation changes. - **/ this.onChangeAnnotation = function() { this.renderer.setAnnotations(this.session.getAnnotations()); }; - /** - * Editor@changeMode() - * - * Emitted when the mode changes. - **/ + this.onChangeMode = function() { this.renderer.updateText(); }; - /** - * Editor@changeWrapLimit() - * - * Emitted when the wrap limit changes. - **/ + this.onChangeWrapLimit = function() { this.renderer.updateFull(); }; - /** - * Editor@changeWrapMode() - * - * Emitted when the wrap mode changes. - **/ this.onChangeWrapMode = function() { this.renderer.onResize(true); }; - /** - * Editor@changeFold() - * - * Emitted when the code folds change. - **/ + this.onChangeFold = function() { // Update the active line marker as due to folding changes the current // line range on the screen might have changed. @@ -649,6 +615,12 @@ var Editor = function(renderer, session) { * * Returns the string of text currently highlighted. **/ + /** + * Editor@copy(text) + * - text (String): The copied text + * + * Emitted when text is copied. + **/ this.getCopyText = function() { var text = ""; if (!this.selection.isEmpty()) @@ -677,9 +649,16 @@ var Editor = function(renderer, session) { }; /** - * Editor.onPaste() - * - * called whenever a text "paste" happens. + * Editor.onPaste(text) + * - text (String): The pasted text + * + * Called whenever a text "paste" happens. + **/ + /** + * Editor@paste(text) + * - text (String): The pasted text + * + * Emitted when text is pasted. **/ this.onPaste = function(text) { // todo this should change when paste becomes a command @@ -872,6 +851,13 @@ var Editor = function(renderer, session) { * Indicates how selections should occur. By default, selections are set to "line". This function also emits the `'changeSelectionStyle'` event. * **/ + /** + * Editor@changeSelectionStyle(data) + * - data (Object): Contains one property, `data`, which indicates the new selection style + * + * Emitted when the selection style changes, via [[Editor.setSelectionStyle]]. + * + **/ this.setSelectionStyle = function(style) { if (this.$selectionStyle == style) return; diff --git a/lib/ace/scrollbar.js b/lib/ace/scrollbar.js index 02afb232..64438740 100644 --- a/lib/ace/scrollbar.js +++ b/lib/ace/scrollbar.js @@ -82,7 +82,8 @@ var ScrollBar = function(parent) { oop.implement(this, EventEmitter); /** - * ScrollBar@onScroll() + * ScrollBar@scroll(e) + * - e (Object): Contains one property, `"data"`, which indicates the current scroll top position * * Emitted when the scroll bar, well, scrolls. * diff --git a/lib/ace/selection.js b/lib/ace/selection.js index 8ae66093..b976cb2d 100644 --- a/lib/ace/selection.js +++ b/lib/ace/selection.js @@ -59,6 +59,18 @@ var Range = require("./range").Range; * Creates a new `Selection` object. * **/ +/** + * Selection@changeCursor() + * + * Emitted when the cursor position changes. + * +**/ +/** + * Selection@changeSelection() + * + * Emitted when the cursor selection changes. + * +**/ var Selection = function(session) { this.session = session; this.doc = session.getDocument(); diff --git a/lib/ace/virtual_renderer.js b/lib/ace/virtual_renderer.js index 69a04240..85794989 100644 --- a/lib/ace/virtual_renderer.js +++ b/lib/ace/virtual_renderer.js @@ -203,7 +203,7 @@ var VirtualRenderer = function(container, theme) { oop.implement(this, EventEmitter); /** - * VirtualRenderer.setSession(session) -> Void + * VirtualRenderer.setSession(session) * * Associates an [[EditSession `EditSession`]]. **/ @@ -222,7 +222,7 @@ var VirtualRenderer = function(container, theme) { }; /** - * VirtualRenderer.updateLines(firstRow, lastRow) -> Void + * VirtualRenderer.updateLines(firstRow, lastRow) * - firstRow (Number): The first row to update * - lastRow (Number): The last row to update * @@ -255,7 +255,7 @@ var VirtualRenderer = function(container, theme) { }; /** - * VirtualRenderer.updateText() -> Void + * VirtualRenderer.updateText() * * Triggers a full update of the text, for all the rows. **/ @@ -264,7 +264,7 @@ var VirtualRenderer = function(container, theme) { }; /** - * VirtualRenderer.updateFull() -> Void + * VirtualRenderer.updateFull() * * Triggers a full update of all the layers, for all the rows. **/ @@ -278,7 +278,7 @@ var VirtualRenderer = function(container, theme) { }; /** - * VirtualRenderer.updateFontSize() -> Void + * VirtualRenderer.updateFontSize() * * Updates the font size. **/ @@ -287,7 +287,7 @@ var VirtualRenderer = function(container, theme) { }; /** - * VirtualRenderer.onResize(force) -> Void + * VirtualRenderer.onResize(force) * - force (Boolean): If `true`, recomputes the size, even if the height and width haven't changed * * [Triggers a resize of the editor.]{: #VirtualRenderer.onResize} @@ -342,7 +342,7 @@ var VirtualRenderer = function(container, theme) { }; /** - * VirtualRenderer.adjustWrapLimit() -> Void + * VirtualRenderer.adjustWrapLimit() * * Adjusts the wrap limit, which is the number of characters that can fit within the width of the edit area on screen. **/ @@ -353,7 +353,7 @@ var VirtualRenderer = function(container, theme) { }; /** - * VirtualRenderer.setAnimatedScroll(shouldAnimate) -> Void + * VirtualRenderer.setAnimatedScroll(shouldAnimate) * - shouldAnimate (Boolean): Set to `true` to show animated scrolls * * Identifies whether you want to have an animated scroll or not. @@ -373,7 +373,7 @@ var VirtualRenderer = function(container, theme) { }; /** - * VirtualRenderer.setShowInvisibles(showInvisibles) -> Void + * VirtualRenderer.setShowInvisibles(showInvisibles) * - showInvisibles (Boolean): Set to `true` to show invisibles * * Identifies whether you want to show invisible characters or not. @@ -458,7 +458,7 @@ var VirtualRenderer = function(container, theme) { }; /** - * VirtualRenderer.setShowGutter(show) -> Void + * VirtualRenderer.setShowGutter(show) * - show (Boolean): Set to `true` to show the gutter * * Identifies whether you want to show the gutter or not. @@ -626,7 +626,7 @@ var VirtualRenderer = function(container, theme) { this.$padding = null; /** - * VirtualRenderer.setPadding(padding) -> Void + * VirtualRenderer.setPadding(padding) * - padding (Number): A new padding value (in pixels) * * Sets the padding for all the layers. @@ -652,7 +652,7 @@ var VirtualRenderer = function(container, theme) { }; /** - * VirtualRenderer.setHScrollBarAlwaysVisible(alwaysVisible) -> Void + * VirtualRenderer.setHScrollBarAlwaysVisible(alwaysVisible) * - alwaysVisible (Boolean): Set to `true` to make the horizontal scroll bar visible * * Identifies whether you want to show the horizontal scrollbar or not. @@ -867,7 +867,7 @@ var VirtualRenderer = function(container, theme) { }; /** - * VirtualRenderer.updateFrontMarkers() -> Void + * VirtualRenderer.updateFrontMarkers() * * Schedules an update to all the front markers in the document. **/ @@ -877,7 +877,7 @@ var VirtualRenderer = function(container, theme) { }; /** - * VirtualRenderer.updateBackMarkers() -> Void + * VirtualRenderer.updateBackMarkers() * * Schedules an update to all the back markers in the document. **/ @@ -886,26 +886,26 @@ var VirtualRenderer = function(container, theme) { this.$loop.schedule(this.CHANGE_MARKER_BACK); }; - /** - * VirtualRenderer.addGutterDecoration(row, className) -> Void + /** deprecated + * VirtualRenderer.addGutterDecoration(row, className) * - * Deprecated (moved to EditSession) + * Deprecated; (moved to [[EditSession]]) **/ this.addGutterDecoration = function(row, className){ this.$gutterLayer.addGutterDecoration(row, className); }; - /** + /** deprecated * VirtualRenderer.removeGutterDecoration(row, className)-> Void * - * Deprecated (moved to EditSession) + * Deprecated; (moved to [[EditSession]]) **/ this.removeGutterDecoration = function(row, className){ this.$gutterLayer.removeGutterDecoration(row, className); }; /** - * VirtualRenderer.updateBreakpoints() -> Void + * VirtualRenderer.updateBreakpoints() * * Redraw breakpoints. **/ @@ -914,7 +914,7 @@ var VirtualRenderer = function(container, theme) { }; /** - * VirtualRenderer.setAnnotations(annotations) -> Void + * VirtualRenderer.setAnnotations(annotations) * - annotations (Array): An array containing annotations * * Sets annotations for the gutter. @@ -925,7 +925,7 @@ var VirtualRenderer = function(container, theme) { }; /** - * VirtualRenderer.updateCursor() -> Void + * VirtualRenderer.updateCursor() * * Updates the cursor icon. **/ @@ -934,7 +934,7 @@ var VirtualRenderer = function(container, theme) { }; /** - * VirtualRenderer.hideCursor() -> Void + * VirtualRenderer.hideCursor() * * Hides the cursor icon. **/ @@ -943,7 +943,7 @@ var VirtualRenderer = function(container, theme) { }; /** - * VirtualRenderer.showCursor() -> Void + * VirtualRenderer.showCursor() * * Shows the cursor icon. **/ @@ -958,7 +958,7 @@ var VirtualRenderer = function(container, theme) { }; /** - * VirtualRenderer.scrollCursorIntoView(cursor, offset) -> Void + * VirtualRenderer.scrollCursorIntoView(cursor, offset) * * Scrolls the cursor into the first visibile area of the editor **/ @@ -1030,7 +1030,7 @@ var VirtualRenderer = function(container, theme) { }; /** related to: EditSession.setScrollTop - * VirtualRenderer.scrollToRow(row) -> Void + * VirtualRenderer.scrollToRow(row) * - row (Number): A row id * * Gracefully scrolls the top of the editor to the row indicated. @@ -1066,7 +1066,7 @@ var VirtualRenderer = function(container, theme) { }; /** - * VirtualRenderer.scrollToLine(line, center, animate, callback) -> Void + * VirtualRenderer.scrollToLine(line, center, animate, callback) * - line (Number): A line number * - center (Boolean): If `true`, centers the editor the to indicated line * - animate (Boolean): If `true` animates scrolling @@ -1148,7 +1148,7 @@ var VirtualRenderer = function(container, theme) { }; /** - * VirtualRenderer.scrollBy(deltaX, deltaY) -> Void + * VirtualRenderer.scrollBy(deltaX, deltaY) * - deltaX (Number): The x value to scroll by * - deltaY (Number): The y value to scroll by * @@ -1220,7 +1220,7 @@ var VirtualRenderer = function(container, theme) { }; /** - * VirtualRenderer.visualizeFocus() -> Void + * VirtualRenderer.visualizeFocus() * * Focuses the current container. **/ @@ -1229,7 +1229,7 @@ var VirtualRenderer = function(container, theme) { }; /** - * VirtualRenderer.visualizeBlur() -> Void + * VirtualRenderer.visualizeBlur() * * Blurs the current container. **/ @@ -1238,7 +1238,7 @@ var VirtualRenderer = function(container, theme) { }; /** internal, hide - * VirtualRenderer.showComposition(position) -> Void + * VirtualRenderer.showComposition(position) * - position (Number): * **/ @@ -1256,7 +1256,7 @@ var VirtualRenderer = function(container, theme) { }; /** - * VirtualRenderer.setCompositionText(text) -> Void + * VirtualRenderer.setCompositionText(text) * - text (String): A string of text to use * * Sets the inner text of the current composition to `text`. @@ -1266,7 +1266,7 @@ var VirtualRenderer = function(container, theme) { }; /** - * VirtualRenderer.hideComposition() -> Void + * VirtualRenderer.hideComposition() * * Hides the current composition. **/ @@ -1288,7 +1288,7 @@ var VirtualRenderer = function(container, theme) { }; /** - * VirtualRenderer.setTheme(theme) -> Void + * VirtualRenderer.setTheme(theme) * - theme (String): The path to a theme * * [Sets a new theme for the editor. `theme` should exist, and be a directory path, like `ace/theme/textmate`.]{: #VirtualRenderer.setTheme} @@ -1361,7 +1361,7 @@ var VirtualRenderer = function(container, theme) { // a certain mode that editor is in. /** - * VirtualRenderer.setStyle(style) -> Void + * VirtualRenderer.setStyle(style) * - style (String): A class name * * [Adds a new class, `style`, to the editor.]{: #VirtualRenderer.setStyle} @@ -1371,7 +1371,7 @@ var VirtualRenderer = function(container, theme) { }; /** - * VirtualRenderer.unsetStyle(style) -> Void + * VirtualRenderer.unsetStyle(style) * - style (String): A class name * * [Removes the class `style` from the editor.]{: #VirtualRenderer.unsetStyle}