From 1846f3c9ba075ebf3c943606396e551355438ff6 Mon Sep 17 00:00:00 2001 From: Garen Torikian Date: Fri, 24 Aug 2012 11:14:23 -0700 Subject: [PATCH] Update to new panino, fix doc bugs --- api/ace.html | 204 +- api/anchor.html | 379 +- api/background_tokenizer.html | 442 +-- api/document.html | 1073 +----- api/edit_session.html | 3059 +-------------- api/editor.html | 4650 ++--------------------- api/index.html | 132 +- api/multi_select.html | 127 - api/placeholder.html | 429 +-- api/range.html | 1155 +----- api/scrollbar.html | 373 +- api/search.html | 393 +- api/selection.html | 1847 +-------- api/split.html | 731 +--- api/token_iterator.html | 388 +- api/tokenizer.html | 239 +- api/undefined.html | 127 - api/undomanager.html | 426 +-- api/virtual_renderer.html | 2322 +---------- doc/build.js | 38 +- doc/package.json | 4 +- doc/resources/ace/templates/layout.jade | 2 +- doc/resources/ace/templates/lib.jade | 2 +- lib/ace/background_tokenizer.js | 2 +- lib/ace/edit_session.js | 1 - lib/ace/edit_session/bracket_match.js | 25 - lib/ace/editor.js | 4 +- lib/ace/multi_select.js | 4 +- lib/ace/selection.js | 6 +- 29 files changed, 1055 insertions(+), 17529 deletions(-) delete mode 100644 api/multi_select.html delete mode 100644 api/undefined.html diff --git a/api/ace.html b/api/ace.html index 68aead6f..81894630 100644 --- a/api/ace.html +++ b/api/ace.html @@ -1,198 +1,14 @@ - - - - - - Ace API - ace - - - - - - - - - - - - - - - - - -
-
-
- - -
-
-
-
-
-
-
-
- -
-
-
-
-
-
-
-

Ace[edit] -

- -
-
-
-
-

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

+ Ace API - /Users/gjtorikian/Developer/ace/lib/ace/ace.js

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
+ + + + + - - - - - - - - \ No newline at end of file + \ No newline at end of file diff --git a/api/anchor.html b/api/anchor.html index 851ccc56..04534c58 100644 --- a/api/anchor.html +++ b/api/anchor.html @@ -1,361 +1,26 @@ - - - - - - Ace API - anchor - - - - - - - - - - - - - - - - - -
-
-
- - -
-
-
-
-
-
-
-
- -
-
-
-
-
-
-
-

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

+ Ace API - /Users/gjtorikian/Developer/ace/lib/ace/anchor.js

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.

    +

    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.

      +

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

      +

         

      Returns the current document.

      +

      Returns the current document.

      +

         

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

      +

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

      +

         

      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
      + + + + + - - - - - - - - \ No newline at end of file + \ No newline at end of file diff --git a/api/background_tokenizer.html b/api/background_tokenizer.html index af85f5a6..c2854c97 100644 --- a/api/background_tokenizer.html +++ b/api/background_tokenizer.html @@ -1,422 +1,28 @@ - - - - - - Ace API - background_tokenizer - - - - - - - - - - - - - - - - - -
      -
      -
      - - -
      -
      -
      -
      -
      -
      -
      -
      - -
      -
      -
      -
      -
      -
      -
      -

      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.

      + Ace API - /Users/gjtorikian/Developer/ace/lib/ace/background_tokenizer.js

      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.

        +

        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.

        +

        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)

        +

        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.

          +

          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.

            +

            Sets a new tokenizer for this object.

            +

               

            Arguments

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

                +

                Stops tokenizing.

                +

                   

                + + + + + - - - - - - - - \ No newline at end of file + \ No newline at end of file diff --git a/api/document.html b/api/document.html index a302b8ec..45b9e615 100644 --- a/api/document.html +++ b/api/document.html @@ -1,1021 +1,60 @@ - - - - - - Ace API - document - - - - - - - - - - - - - - - - - -
                -
                -
                - - -
                -
                -
                -
                -
                -
                -
                -
                - -
                -
                -
                -
                -
                -
                -
                -

                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.

                + Ace API - /Users/gjtorikian/Developer/ace/lib/ace/document.js

                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.

                +

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

                  +

                  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!

                    +

                    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.

                    +

                    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.

                      +

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

                        +

                        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.

                        +

                        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.

                        +

                        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.

                        +

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

                        +

                        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.

                        +

                        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.

                        +

                        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.

                        +

                        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.

                          +

                          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.

                          +

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

                            +

                            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.

                                +

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

                                +

                                   

                                Arguments

                                textStringRequired. The text to use
                                + + + + + - - - - - - - - \ No newline at end of file + \ No newline at end of file diff --git a/api/edit_session.html b/api/edit_session.html index ca33eb83..9ab62051 100644 --- a/api/edit_session.html +++ b/api/edit_session.html @@ -1,2885 +1,184 @@ - - - - - - Ace API - edit_session - - - - - - - - - - - - - - - - - -
                                -
                                -
                                - - -
                                -
                                -
                                -
                                -
                                -
                                -
                                -
                                - -
                                -
                                -
                                -
                                -
                                -
                                -
                                -

                                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.

                                - -
                                -

                                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.

                                - -
                                -

                                Emitted when the scroll left changes.

                                - -
                                -

                                   

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

                                Emitted when the scroll top changes.

                                - -
                                -

                                Emitted when the scroll top changes.

                                - -
                                -

                                   

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

                                Emitted when a background tokenizer asynchronousely processes new rows.

                                - -
                                -

                                Emitted when a background tokenizer asynchronousely processes new rows.

                                - -
                                -

                                   

                                -
                                -
                                -
                                -
                                -
                                -
                                -

                                Methods

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

                                Adds a dynamic marker to the session.

                                - -
                                -

                                Adds a dynamic marker to the session.

                                - -
                                -

                                   

                                -
                                -

                                Arguments

                                markerObjectRequired. object with update method
                                inFrontBooleanRequired. Set to true to establish a front marker
                                -
                                -
                                -
                                -
                                -
                                -
                                -
                                -
                                -
                                -
                                  -
                                • -
                                    -
                                  • 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.

                                - -
                                -

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

                                - -
                                -

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

                                - -
                                -

                                   

                                -
                                -
                                -
                                -
                                -
                                -
                                -
                                -
                                -
                                -
                                - -
                                -
                                -

                                Converts document coordinates to screen coordinates. {:conversionConsiderations}

                                - -
                                -

                                Converts document coordinates to screen coordinates. {:conversionConsiderations}

                                - -
                                -

                                   

                                -
                                -

                                Arguments

                                docRowNumberRequired. The document row to check
                                docColumnNumberRequired. The document column to check
                                -

                                Returns

                                ObjectThe object returned by this method has two properties: row and column.
                                -
                                -
                                -
                                -
                                -
                                -
                                -
                                -
                                -
                                -
                                  -
                                • - -
                                    -
                                  -
                                  • -
                                -
                                -
                                -

                                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
                                -

                                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.

                                - -
                                -

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

                                - -
                                -

                                   

                                -
                                -
                                -
                                -
                                -
                                -
                                -
                                -
                                -
                                -
                                -
                                  -
                                • -
                                    -
                                  • EditSession.getDocument() -
                                  • - -
                                    • -
                                  -
                                    -
                                  -
                                  • -
                                -
                                -
                                -

                                Returns the Document associated with this session.

                                - -
                                -

                                Returns the Document associated with this session.

                                - -
                                -

                                   

                                -
                                -
                                -
                                -
                                -
                                -
                                -
                                -
                                -
                                -
                                - -
                                -
                                -

                                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.

                                - -
                                -

                                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
                                -
                                -
                                -
                                -
                                -
                                -
                                -
                                -
                                -
                                -
                                  -
                                • -
                                    -
                                  • EditSession.getMarkers(Boolean inFront) -
                                  • - -
                                    • -
                                  -
                                    -
                                  -
                                  • -
                                -
                                -
                                -

                                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
                                -
                                -
                                -
                                -
                                -
                                -
                                -
                                -
                                -
                                -
                                  -
                                • -
                                    -
                                  • EditSession.getMode() -
                                  • - -
                                    • -
                                  -
                                    -
                                  -
                                  • -
                                -
                                -
                                -

                                Returns the current text mode.

                                - -
                                -

                                Returns the current text mode.

                                - -
                                -

                                   

                                -
                                -
                                -
                                -
                                -
                                -
                                -
                                -
                                -
                                -
                                - -
                                -
                                -

                                Returns the current new line mode.

                                - -
                                -

                                Returns the current new line mode.

                                - -
                                -

                                   

                                -
                                -
                                -
                                -
                                -
                                -
                                -
                                -
                                -
                                -
                                -
                                  -
                                • -
                                    -
                                  • EditSession.getOverwrite() -
                                  • - -
                                    • -
                                  -
                                    -
                                  -
                                  • -
                                -
                                -
                                -

                                Returns true if overwrites are enabled; false otherwise.

                                - -
                                -

                                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.getScreenLength() -
                                  • - -
                                    • -
                                  -
                                    -
                                  -
                                  • -
                                -
                                -
                                -

                                Returns the length of the screen.

                                - -
                                -

                                Returns the length of the screen.

                                - -
                                -

                                   

                                -
                                -
                                -
                                -
                                -
                                -
                                -
                                -
                                -
                                -
                                -
                                  -
                                • -
                                    -
                                  • EditSession.getScreenTabSize(Number screenColumn) -
                                  • - -
                                    • -
                                  -
                                    -
                                  -
                                  • -
                                -
                                -
                                -

                                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.

                                - -
                                -

                                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.]{: #EditSession.getScrollLeft}

                                - -
                                -

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

                                - -
                                -

                                   

                                -
                                -
                                -
                                -
                                -
                                -
                                -
                                -
                                -
                                -
                                -
                                  -
                                • -
                                    -
                                  • EditSession.getScrollTop() -
                                  • - -
                                    • -
                                  -
                                    -
                                  -
                                  • -
                                -
                                -
                                -

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

                                - -
                                -

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

                                - -
                                -

                                   

                                -
                                -
                                -
                                -
                                -
                                -
                                -
                                -
                                -
                                -
                                -
                                  -
                                • -
                                    -
                                  • EditSession.getSelection() -
                                  • - -
                                    • -
                                  -
                                    -
                                  -
                                  • -
                                -
                                -
                                -

                                Returns the string of the current selection.

                                - -
                                -

                                Returns the string of the current selection.

                                - -
                                -

                                   

                                -
                                -
                                -
                                -
                                -
                                -
                                -
                                -
                                -
                                -
                                - -
                                -
                                -

                                {:BackgroundTokenizer.getState}

                                - -
                                -

                                {:BackgroundTokenizer.getState}

                                - -
                                -

                                   

                                -
                                -

                                Arguments

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

                                - -
                                -

                                   

                                -
                                -
                                -
                                -
                                -
                                -
                                -
                                -
                                -
                                -
                                - -
                                -
                                -

                                {:Document.getTextRange.desc}

                                - -
                                -

                                {:Document.getTextRange.desc}

                                - -
                                -

                                   

                                -
                                -

                                Arguments

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

                                - -
                                -

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

                                - -
                                -

                                   

                                -
                                -

                                Arguments

                                rowNumberRequired. The row to start at
                                -
                                -
                                -
                                -
                                -
                                -
                                -
                                -
                                -
                                -
                                  -
                                • -
                                    -
                                  • EditSession.getUndoManager() -
                                  • - -
                                    • -
                                  -
                                    -
                                  -
                                  • -
                                -
                                -
                                -

                                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.

                                - -
                                -

                                   

                                -
                                -
                                -
                                -
                                -
                                -
                                -
                                -
                                -
                                -
                                -
                                  -
                                • -
                                    -
                                  • EditSession.getUseWorker() -
                                  • - -
                                    • -
                                  -
                                    -
                                  -
                                  • -
                                -
                                -
                                -

                                Returns true if workers are being used.

                                - -
                                -

                                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.

                                - -
                                -

                                   

                                -
                                -
                                -
                                -
                                -
                                -
                                -
                                -
                                -
                                -
                                - -
                                -
                                -

                                Returns the current Document as a string.

                                - -
                                -

                                Returns the current Document as a string.

                                - -
                                -

                                   

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

                                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.

                                - -
                                -

                                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:

                                + Ace API - /Users/gjtorikian/Developer/ace/lib/ace/edit_session.js

                                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.

                                  +

                                  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.

                                      +

                                      Emitted when the scroll left changes.

                                      +

                                         

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

                                        Emitted when the scroll top changes.

                                        +

                                        Emitted when the scroll top changes.

                                        +

                                           

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

                                          Emitted when a background tokenizer asynchronousely processes new rows.

                                          +

                                          Emitted when a background tokenizer asynchronousely processes new rows.

                                          +

                                             

                                          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.

                                          +

                                          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.

                                          +

                                          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.

                                          +

                                          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.

                                            +

                                            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.

                                            +

                                            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.

                                            +

                                            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.

                                              +

                                              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.

                                                  +

                                                  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.

                                                  +

                                                  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.

                                                    +

                                                    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.

                                                      +

                                                      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

                                                         

                                                      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.

                                                      +

                                                      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.

                                                      +

                                                      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.

                                                      +

                                                      Returns the current text mode.

                                                      +

                                                         

                                                      Returns the current new line mode.

                                                      +

                                                      Returns the current new line mode.

                                                      +

                                                         

                                                      Returns true if overwrites are enabled; false otherwise.

                                                      +

                                                      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

                                                         

                                                      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.

                                                        +

                                                        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.

                                                          +

                                                          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.

                                                            +

                                                               

                                                              • EditSession.getScrollTop()

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

                                                              +

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

                                                              +

                                                                 

                                                                • EditSession.getSelection()

                                                                Returns the string of the current selection.

                                                                +

                                                                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.

                                                                  +

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

                                                                    +

                                                                       

                                                                    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.

                                                                    +

                                                                    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.

                                                                    +

                                                                    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.

                                                                    +

                                                                    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.

                                                                      +

                                                                         

                                                                      Returns true if workers are being used.

                                                                      +

                                                                      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.

                                                                          +

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

                                                                               

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

                                                                            +

                                                                               

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

                                                                            - -
                                                                            -

                                                                               

                                                                            -

                                                                            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.

                                                                            - -
                                                                            -

                                                                            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

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

                                                                               

                                                                            -
                                                                            -

                                                                            Arguments

                                                                            firstRowNumberRequired. The starting row to move down
                                                                            lastRowNumberRequired. 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
                                                                            -

                                                                            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
                                                                            -

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

                                                                            - -
                                                                            -

                                                                               

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

                                                                            - -
                                                                            -

                                                                            Re-implements a previously undone change to your document.

                                                                            - -
                                                                            -

                                                                               

                                                                            -
                                                                            -

                                                                            Arguments

                                                                            deltasArrayRequired. An array of previous changes
                                                                            dontSelectBooleanRequired. {:dontSelect}
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                            - -
                                                                            -
                                                                            -

                                                                            Removes the range from the document.

                                                                            - -
                                                                            -

                                                                            Removes the range from the document.

                                                                            - -
                                                                            -

                                                                               

                                                                            -
                                                                            -

                                                                            Arguments

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

                                                                            - -
                                                                            -

                                                                            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.

                                                                            - -
                                                                            -

                                                                            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
                                                                            -

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

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

                                                                            - -
                                                                            -

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

                                                                            - -
                                                                            -

                                                                               

                                                                            -
                                                                            -

                                                                            Arguments

                                                                            screenRowNumberRequired. The screen row to check
                                                                            screenColumnNumberRequired. The screen column to check
                                                                            -

                                                                            Returns

                                                                            ObjectThe object returned has two properties: row and column.
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                              -
                                                                            • -
                                                                                -
                                                                              • 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
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                              -
                                                                            • -
                                                                                -
                                                                              • EditSession.setBreakpoint(Number row, String className)
                                                                                • -
                                                                              -
                                                                                -
                                                                              -
                                                                              • -
                                                                            -
                                                                            -
                                                                            -

                                                                            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.

                                                                            - -
                                                                            -

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

                                                                            - -
                                                                            -

                                                                               

                                                                            -
                                                                            -

                                                                            Arguments

                                                                            rowsArrayRequired. An array of row indicies
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                              -
                                                                            • -
                                                                                -
                                                                              • EditSession.setDocument(Document doc)
                                                                                • -
                                                                              -
                                                                                -
                                                                              -
                                                                              • -
                                                                            -
                                                                            -
                                                                            -

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

                                                                            - -
                                                                            -

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

                                                                            - -
                                                                            -

                                                                               

                                                                            -
                                                                            -

                                                                            Arguments

                                                                            docDocumentRequired. The new Document to use
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                              -
                                                                            • -
                                                                                -
                                                                              • EditSession.setMode(TextMode 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

                                                                            modeTextModeRequired. Set a new text mode
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                            - -
                                                                            -
                                                                            -

                                                                            {:Document.setNewLineMode.desc}

                                                                            - -
                                                                            -

                                                                            {:Document.setNewLineMode.desc}

                                                                            - -
                                                                            -

                                                                               

                                                                            -
                                                                            -

                                                                            Arguments

                                                                            newLineModeStringRequired. {:Document.setNewLineMode.param}
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                              -
                                                                            • -
                                                                                -
                                                                              • 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.]{: #EditSession.setScrollLeft}

                                                                            - -
                                                                            -

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

                                                                            - -
                                                                            -

                                                                               

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

                                                                            - -
                                                                            -

                                                                            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
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                              -
                                                                            • -
                                                                                -
                                                                              • EditSession.setUndoManager(UndoManager undoManager)
                                                                                • -
                                                                              -
                                                                                -
                                                                              -
                                                                              • -
                                                                            -
                                                                            -
                                                                            -

                                                                            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.

                                                                            - -
                                                                            -

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

                                                                            - -
                                                                            -

                                                                            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.

                                                                            - -
                                                                            -

                                                                            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.

                                                                            - -
                                                                            -

                                                                            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.

                                                                            - -
                                                                            -

                                                                            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.

                                                                            - -
                                                                            -

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

                                                                            - -
                                                                            -

                                                                               

                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                            - -
                                                                            -
                                                                            -

                                                                            Returns the current Document as a string.

                                                                            - -
                                                                            -

                                                                            Returns the current Document as a string.

                                                                            - -
                                                                            -

                                                                               

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

                                                                            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]{: #dontSelect}
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                            - - - - - - - - - - \ No newline at end of file +

                                                                               

                                                                            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.

                                                                            +

                                                                            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.

                                                                            +

                                                                            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.

                                                                            +

                                                                            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 }

                                                                            +

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

                                                                              +

                                                                                 

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

                                                                                +

                                                                                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.

                                                                                +

                                                                                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.

                                                                                  +

                                                                                  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.

                                                                                    +

                                                                                    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.

                                                                                    +

                                                                                    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.

                                                                                    +

                                                                                    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.

                                                                                      +

                                                                                      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.

                                                                                      +

                                                                                      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.

                                                                                        +

                                                                                        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.

                                                                                        +

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

                                                                                            +

                                                                                            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.

                                                                                                +

                                                                                                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.

                                                                                                +

                                                                                                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.

                                                                                                  +

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

                                                                                                    +

                                                                                                    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.

                                                                                                      +

                                                                                                      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.

                                                                                                        +

                                                                                                        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.

                                                                                                          +

                                                                                                          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.

                                                                                                          +

                                                                                                          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.

                                                                                                            +

                                                                                                            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
                                                                                                            + + + + + \ No newline at end of file diff --git a/api/editor.html b/api/editor.html index 80c82407..e739b794 100644 --- a/api/editor.html +++ b/api/editor.html @@ -1,4380 +1,280 @@ - - - - - - Ace API - editor - - - - - - - - - - - - - - - - - -
                                                                                                            -
                                                                                                            -
                                                                                                            - - -
                                                                                                            -
                                                                                                            -
                                                                                                            -
                                                                                                            -
                                                                                                            -
                                                                                                            -
                                                                                                            -
                                                                                                            - -
                                                                                                            -
                                                                                                            -
                                                                                                            -
                                                                                                            -
                                                                                                            -
                                                                                                            -
                                                                                                            -

                                                                                                            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.

                                                                                                            - -
                                                                                                            -

                                                                                                            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.

                                                                                                            - -
                                                                                                            -

                                                                                                            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:

                                                                                                            - -
                                                                                                            -

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

                                                                                                            + Ace API - /Users/gjtorikian/Developer/ace/lib/ace/editor.js

                                                                                                            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.

                                                                                                              +

                                                                                                              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.

                                                                                                                                    +

                                                                                                                                    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:

                                                                                                                                        +

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

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

                                                                                                                                        - -
                                                                                                                                        -

                                                                                                                                           

                                                                                                                                        -

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

                                                                                                                                        - -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                          -
                                                                                                                                        • -
                                                                                                                                            -
                                                                                                                                          • Editor.$getVisibleRowCount() -
                                                                                                                                          • - -
                                                                                                                                            • -
                                                                                                                                          -
                                                                                                                                            -
                                                                                                                                          -
                                                                                                                                          • -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -

                                                                                                                                        Returns the number of currently visibile rows.

                                                                                                                                        - -
                                                                                                                                        -

                                                                                                                                        Returns the number of currently visibile rows.

                                                                                                                                        - -
                                                                                                                                        -

                                                                                                                                           

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

                                                                                                                                        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.addSelectionMarker(Range orientedRange) -
                                                                                                                                          • - -
                                                                                                                                            • -
                                                                                                                                          -
                                                                                                                                            -
                                                                                                                                          -
                                                                                                                                          • -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -

                                                                                                                                        Adds the selection and cursor.

                                                                                                                                        - -
                                                                                                                                        -

                                                                                                                                        Adds the selection and cursor.

                                                                                                                                        - -
                                                                                                                                        -

                                                                                                                                           

                                                                                                                                        -
                                                                                                                                        -

                                                                                                                                        Arguments

                                                                                                                                        orientedRangeRangeRequired. A range containing a cursor
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        - -
                                                                                                                                        -
                                                                                                                                        -

                                                                                                                                        Outdents the current line.

                                                                                                                                        - -
                                                                                                                                        -

                                                                                                                                        Outdents the current line.

                                                                                                                                        - -
                                                                                                                                        -

                                                                                                                                           

                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                          -
                                                                                                                                        • -
                                                                                                                                            -
                                                                                                                                          • Editor.blur()
                                                                                                                                            • -
                                                                                                                                          -
                                                                                                                                            -
                                                                                                                                          -
                                                                                                                                          • -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -

                                                                                                                                        Blurs the current textInput.

                                                                                                                                        - -
                                                                                                                                        -

                                                                                                                                        Blurs the current textInput.

                                                                                                                                        - -
                                                                                                                                        -

                                                                                                                                           

                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                          -
                                                                                                                                        • -
                                                                                                                                            -
                                                                                                                                          • Editor.centerSelection()
                                                                                                                                            • -
                                                                                                                                          -
                                                                                                                                            -
                                                                                                                                          -
                                                                                                                                          • -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -

                                                                                                                                        Attempts to center the current selection on the screen.

                                                                                                                                        - -
                                                                                                                                        -

                                                                                                                                        Attempts to center the current selection on the screen.

                                                                                                                                        - -
                                                                                                                                        -

                                                                                                                                           

                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        - -
                                                                                                                                        -
                                                                                                                                        -

                                                                                                                                        {:Selection.clearSelection}

                                                                                                                                        - -
                                                                                                                                        -

                                                                                                                                        {:Selection.clearSelection}

                                                                                                                                        - -
                                                                                                                                        -

                                                                                                                                           

                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        - -
                                                                                                                                        -
                                                                                                                                        -

                                                                                                                                        Copies all the selected lines down one row.

                                                                                                                                        - -
                                                                                                                                        -

                                                                                                                                        Copies all the selected lines down one row.

                                                                                                                                        - -
                                                                                                                                        -

                                                                                                                                           

                                                                                                                                        -
                                                                                                                                        -

                                                                                                                                        Returns

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

                                                                                                                                        Copies all the selected lines up one row.

                                                                                                                                        - -
                                                                                                                                        -

                                                                                                                                        Copies all the selected lines up one row.

                                                                                                                                        - -
                                                                                                                                        -

                                                                                                                                           

                                                                                                                                        -
                                                                                                                                        -

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

                                                                                                                                        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.

                                                                                                                                        - -
                                                                                                                                        -

                                                                                                                                        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. {:BehaviorsDef}

                                                                                                                                        - -
                                                                                                                                        -

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

                                                                                                                                        - -
                                                                                                                                        -

                                                                                                                                           

                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                          -
                                                                                                                                        • -
                                                                                                                                            -
                                                                                                                                          • Editor.getCopyText() -
                                                                                                                                          • - -
                                                                                                                                            • -
                                                                                                                                          -
                                                                                                                                            -
                                                                                                                                          -
                                                                                                                                          • -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -

                                                                                                                                        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

                                                                                                                                        ObjectThis returns an object that looks something like this:
                                                                                                                                        { row: currRow, column: currCol }
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        - -
                                                                                                                                        -
                                                                                                                                        -

                                                                                                                                        Returns the screen position of the cursor.

                                                                                                                                        - -
                                                                                                                                        -

                                                                                                                                        Returns the screen position of the cursor.

                                                                                                                                        - -
                                                                                                                                        -

                                                                                                                                           

                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                          -
                                                                                                                                        • -
                                                                                                                                            -
                                                                                                                                          • Editor.getDragDelay() -
                                                                                                                                          • - -
                                                                                                                                            • -
                                                                                                                                          -
                                                                                                                                            -
                                                                                                                                          -
                                                                                                                                          • -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -

                                                                                                                                        Returns the current mouse drag delay.

                                                                                                                                        - -
                                                                                                                                        -

                                                                                                                                        Returns the current mouse drag delay.

                                                                                                                                        - -
                                                                                                                                        -

                                                                                                                                           

                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        - -
                                                                                                                                        -
                                                                                                                                        -

                                                                                                                                        {:VirtualRenderer.getFirstVisibleRow}

                                                                                                                                        - -
                                                                                                                                        -

                                                                                                                                        {:VirtualRenderer.getFirstVisibleRow}

                                                                                                                                        - -
                                                                                                                                        -

                                                                                                                                           

                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                          -
                                                                                                                                        • -
                                                                                                                                            -
                                                                                                                                          • Editor.getHighlightActiveLine() -
                                                                                                                                          • - -
                                                                                                                                            • -
                                                                                                                                          -
                                                                                                                                            -
                                                                                                                                          -
                                                                                                                                          • -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -

                                                                                                                                        Returns true if current lines are always highlighted.

                                                                                                                                        - -
                                                                                                                                        -

                                                                                                                                        Returns true if current lines are always highlighted.

                                                                                                                                        - -
                                                                                                                                        -

                                                                                                                                           

                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                          -
                                                                                                                                        • -
                                                                                                                                            -
                                                                                                                                          • Editor.getHighlightSelectedWord() -
                                                                                                                                          • - -
                                                                                                                                            • -
                                                                                                                                          -
                                                                                                                                            -
                                                                                                                                          -
                                                                                                                                          • -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -

                                                                                                                                        Returns true if currently highlighted words are to be highlighted.

                                                                                                                                        - -
                                                                                                                                        -

                                                                                                                                        Returns true if currently highlighted words are to be highlighted.

                                                                                                                                        - -
                                                                                                                                        -

                                                                                                                                           

                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                          -
                                                                                                                                        • -
                                                                                                                                            -
                                                                                                                                          • Editor.getKeyboardHandler() -
                                                                                                                                          • - -
                                                                                                                                            • -
                                                                                                                                          - -
                                                                                                                                          • -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -

                                                                                                                                        Returns the keyboard handler.

                                                                                                                                        - -
                                                                                                                                        -

                                                                                                                                        Returns the keyboard handler.

                                                                                                                                        - -
                                                                                                                                        -

                                                                                                                                           

                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        - -
                                                                                                                                        -
                                                                                                                                        -

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

                                                                                                                                        - -
                                                                                                                                        -

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

                                                                                                                                        - -
                                                                                                                                        -

                                                                                                                                           

                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        - -
                                                                                                                                        -
                                                                                                                                        -

                                                                                                                                        {:VirtualRenderer.getLastVisibleRow}

                                                                                                                                        - -
                                                                                                                                        -

                                                                                                                                        {:VirtualRenderer.getLastVisibleRow}

                                                                                                                                        - -
                                                                                                                                        -

                                                                                                                                           

                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        - -
                                                                                                                                        -
                                                                                                                                        -

                                                                                                                                        Returns true if overwrites are enabled; false otherwise.

                                                                                                                                        - -
                                                                                                                                        -

                                                                                                                                        Returns true if overwrites are enabled; false otherwise.

                                                                                                                                        - -
                                                                                                                                        -

                                                                                                                                           

                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                          -
                                                                                                                                        • -
                                                                                                                                            -
                                                                                                                                          • Editor.getPrintMarginColumn() -
                                                                                                                                          • - -
                                                                                                                                            • -
                                                                                                                                          -
                                                                                                                                            -
                                                                                                                                          -
                                                                                                                                          • -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -

                                                                                                                                        Returns the column number of where the print margin is.

                                                                                                                                        - -
                                                                                                                                        -

                                                                                                                                        Returns the column number of where the print margin is.

                                                                                                                                        - -
                                                                                                                                        -

                                                                                                                                           

                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                          -
                                                                                                                                        • -
                                                                                                                                            -
                                                                                                                                          • Editor.getReadOnly() -
                                                                                                                                          • - -
                                                                                                                                            • -
                                                                                                                                          -
                                                                                                                                            -
                                                                                                                                          -
                                                                                                                                          • -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -

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

                                                                                                                                        - -
                                                                                                                                        -

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

                                                                                                                                        - -
                                                                                                                                        -

                                                                                                                                           

                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                          -
                                                                                                                                        • -
                                                                                                                                            -
                                                                                                                                          • Editor.getScrollSpeed() -
                                                                                                                                          • - -
                                                                                                                                            • -
                                                                                                                                          -
                                                                                                                                            -
                                                                                                                                          -
                                                                                                                                          • -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -

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

                                                                                                                                        - -
                                                                                                                                        -

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

                                                                                                                                        - -
                                                                                                                                        -

                                                                                                                                           

                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                          -
                                                                                                                                        • -
                                                                                                                                            -
                                                                                                                                          • Editor.getSelection() -
                                                                                                                                          • - -
                                                                                                                                            • -
                                                                                                                                          -
                                                                                                                                            -
                                                                                                                                          -
                                                                                                                                          • -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -

                                                                                                                                        Returns the currently highlighted selection.

                                                                                                                                        - -
                                                                                                                                        -

                                                                                                                                        Returns the currently highlighted selection.

                                                                                                                                        - -
                                                                                                                                        -

                                                                                                                                           

                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        - -
                                                                                                                                        -
                                                                                                                                        -

                                                                                                                                        {:Selection.getRange}

                                                                                                                                        - -
                                                                                                                                        -

                                                                                                                                        {:Selection.getRange}

                                                                                                                                        - -
                                                                                                                                        -

                                                                                                                                           

                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                          -
                                                                                                                                        • -
                                                                                                                                            -
                                                                                                                                          • Editor.getSelectionStyle() -
                                                                                                                                          • - -
                                                                                                                                            • -
                                                                                                                                          -
                                                                                                                                            -
                                                                                                                                          -
                                                                                                                                          • -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -

                                                                                                                                        Returns the current selection style.

                                                                                                                                        - -
                                                                                                                                        -

                                                                                                                                        Returns the current selection style.

                                                                                                                                        - -
                                                                                                                                        -

                                                                                                                                           

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

                                                                                                                                        Returns the current session being used.

                                                                                                                                        - -
                                                                                                                                        -

                                                                                                                                        Returns the current session being used.

                                                                                                                                        - -
                                                                                                                                        -

                                                                                                                                           

                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                          -
                                                                                                                                        • -
                                                                                                                                            -
                                                                                                                                          • Editor.getShowFoldWidgets() -
                                                                                                                                          • - -
                                                                                                                                            • -
                                                                                                                                          -
                                                                                                                                            -
                                                                                                                                          -
                                                                                                                                          • -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -

                                                                                                                                        Returns true if the fold widgets are shown.

                                                                                                                                        - -
                                                                                                                                        -

                                                                                                                                        Returns true if the fold widgets are shown.

                                                                                                                                        - -
                                                                                                                                        -

                                                                                                                                           

                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                          -
                                                                                                                                        • -
                                                                                                                                            -
                                                                                                                                          • Editor.getShowInvisibles() -
                                                                                                                                          • - -
                                                                                                                                            • -
                                                                                                                                          -
                                                                                                                                            -
                                                                                                                                          -
                                                                                                                                          • -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -

                                                                                                                                        Returns true if invisible characters are being shown.

                                                                                                                                        - -
                                                                                                                                        -

                                                                                                                                        Returns true if invisible characters are being shown.

                                                                                                                                        - -
                                                                                                                                        -

                                                                                                                                           

                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                          -
                                                                                                                                        • -
                                                                                                                                            -
                                                                                                                                          • Editor.getShowPrintMargin() -
                                                                                                                                          • - -
                                                                                                                                            • -
                                                                                                                                          -
                                                                                                                                            -
                                                                                                                                          -
                                                                                                                                          • -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -

                                                                                                                                        Returns true if the print margin is being shown.

                                                                                                                                        - -
                                                                                                                                        -

                                                                                                                                        Returns true if the print margin is being shown.

                                                                                                                                        - -
                                                                                                                                        -

                                                                                                                                           

                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        - -
                                                                                                                                        -
                                                                                                                                        -

                                                                                                                                        {:VirtualRenderer.getTheme}

                                                                                                                                        - -
                                                                                                                                        -

                                                                                                                                        {:VirtualRenderer.getTheme}

                                                                                                                                        - -
                                                                                                                                        -

                                                                                                                                           

                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        - -
                                                                                                                                        -
                                                                                                                                        -

                                                                                                                                        Returns the current session's content.

                                                                                                                                        - -
                                                                                                                                        -

                                                                                                                                        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.

                                                                                                                                        - -
                                                                                                                                        -

                                                                                                                                        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.

                                                                                                                                        - -
                                                                                                                                        -

                                                                                                                                           

                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        - -
                                                                                                                                        -
                                                                                                                                        -

                                                                                                                                        Indents the current line.

                                                                                                                                        - -
                                                                                                                                        -

                                                                                                                                        Indents the current line.

                                                                                                                                        - -
                                                                                                                                        -

                                                                                                                                           

                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                          -
                                                                                                                                        • -
                                                                                                                                            -
                                                                                                                                          • Editor.insert(String text)
                                                                                                                                            • -
                                                                                                                                          -
                                                                                                                                            -
                                                                                                                                          -
                                                                                                                                          • -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -

                                                                                                                                        Inserts text into wherever the cursor is pointing.

                                                                                                                                        - -
                                                                                                                                        -

                                                                                                                                        Inserts text into wherever the cursor is pointing.

                                                                                                                                        - -
                                                                                                                                        -

                                                                                                                                           

                                                                                                                                        -
                                                                                                                                        -

                                                                                                                                        Arguments

                                                                                                                                        textStringRequired. The new text to add
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                          -
                                                                                                                                        • -
                                                                                                                                            -
                                                                                                                                          • Editor.isFocused() -
                                                                                                                                          • - -
                                                                                                                                            • -
                                                                                                                                          -
                                                                                                                                            -
                                                                                                                                          -
                                                                                                                                          • -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -

                                                                                                                                        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.

                                                                                                                                        - -
                                                                                                                                        -

                                                                                                                                        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.

                                                                                                                                        - -
                                                                                                                                        -

                                                                                                                                        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.

                                                                                                                                        - -
                                                                                                                                        -

                                                                                                                                        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.

                                                                                                                                        - -
                                                                                                                                        -

                                                                                                                                        Shifts all the selected lines down one row.

                                                                                                                                        - -
                                                                                                                                        -

                                                                                                                                           

                                                                                                                                        -
                                                                                                                                        -

                                                                                                                                        Returns

                                                                                                                                        NumberOn success, it returns -1.
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        - -
                                                                                                                                        -
                                                                                                                                        -

                                                                                                                                        Shifts all the selected lines up one row.

                                                                                                                                        - -
                                                                                                                                        -

                                                                                                                                        Shifts all the selected lines up one row.

                                                                                                                                        - -
                                                                                                                                        -

                                                                                                                                           

                                                                                                                                        -
                                                                                                                                        -

                                                                                                                                        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:

                                                                                                                                        +

                                                                                                                                           

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

                                                                                                                                            +

                                                                                                                                            Adds the selection and cursor.

                                                                                                                                            +

                                                                                                                                               

                                                                                                                                            Arguments

                                                                                                                                            orientedRangeRangeRequired. A range containing a cursor

                                                                                                                                            Outdents the current line.

                                                                                                                                            +

                                                                                                                                            Outdents the current line.

                                                                                                                                            +

                                                                                                                                               

                                                                                                                                              • Editor.blur()

                                                                                                                                              Blurs the current textInput.

                                                                                                                                              +

                                                                                                                                              Blurs the current textInput.

                                                                                                                                              +

                                                                                                                                                 

                                                                                                                                                • Editor.centerSelection()

                                                                                                                                                Attempts to center the current selection on the screen.

                                                                                                                                                +

                                                                                                                                                Attempts to center the current selection on the screen.

                                                                                                                                                +

                                                                                                                                                   

                                                                                                                                                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.

                                                                                                                                                +

                                                                                                                                                   

                                                                                                                                                Copies all the selected lines down one row.

                                                                                                                                                +

                                                                                                                                                Copies all the selected lines down one row.

                                                                                                                                                +

                                                                                                                                                   

                                                                                                                                                  • 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

                                                                                                                                                    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.

                                                                                                                                                      +

                                                                                                                                                      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.

                                                                                                                                                        +

                                                                                                                                                        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.

                                                                                                                                                        +

                                                                                                                                                           

                                                                                                                                                          • Editor.getHighlightActiveLine()

                                                                                                                                                          Returns true if current lines are always highlighted.

                                                                                                                                                          +

                                                                                                                                                          Returns true if current lines are always highlighted.

                                                                                                                                                          +

                                                                                                                                                             

                                                                                                                                                            • Editor.getHighlightSelectedWord()

                                                                                                                                                            Returns true if currently highlighted words are to be highlighted.

                                                                                                                                                            +

                                                                                                                                                            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 true if overwrites are enabled; false otherwise.

                                                                                                                                                            +

                                                                                                                                                            Returns true if overwrites are enabled; false otherwise.

                                                                                                                                                            +

                                                                                                                                                               

                                                                                                                                                              • Editor.getPrintMarginColumn()

                                                                                                                                                              Returns the column number of where the print margin is.

                                                                                                                                                              +

                                                                                                                                                              Returns the column number of where the print margin is.

                                                                                                                                                              +

                                                                                                                                                                 

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

                                                                                                                                                              +

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

                                                                                                                                                              +

                                                                                                                                                                 

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

                                                                                                                                                              +

                                                                                                                                                              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.

                                                                                                                                                                +

                                                                                                                                                                Returns the current session being used.

                                                                                                                                                                +

                                                                                                                                                                   

                                                                                                                                                                Returns true if the fold widgets are shown.

                                                                                                                                                                +

                                                                                                                                                                Returns true if the fold widgets are shown.

                                                                                                                                                                +

                                                                                                                                                                   

                                                                                                                                                                Returns true if invisible characters are being shown.

                                                                                                                                                                +

                                                                                                                                                                Returns true if invisible characters are being shown.

                                                                                                                                                                +

                                                                                                                                                                   

                                                                                                                                                                Returns true if the print margin is being shown.

                                                                                                                                                                +

                                                                                                                                                                Returns true if the print margin is being shown.

                                                                                                                                                                +

                                                                                                                                                                   

                                                                                                                                                                Returns the current session's content.

                                                                                                                                                                +

                                                                                                                                                                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.

                                                                                                                                                                  +

                                                                                                                                                                  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.

                                                                                                                                                                    +

                                                                                                                                                                       

                                                                                                                                                                    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.

                                                                                                                                                                    +

                                                                                                                                                                    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.

                                                                                                                                                                    +

                                                                                                                                                                    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.

                                                                                                                                                                      +

                                                                                                                                                                      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.

                                                                                                                                                                      +

                                                                                                                                                                      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.

                                                                                                                                                                      +

                                                                                                                                                                      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:

                                                                                                                                                                      +

                                                                                                                                                                      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 }

                                                                                                                                                                      - -
                                                                                                                                                                      -

                                                                                                                                                                         

                                                                                                                                                                      -

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

                                                                                                                                                                      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.

                                                                                                                                                                      - -
                                                                                                                                                                      -

                                                                                                                                                                      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.

                                                                                                                                                                      - -
                                                                                                                                                                      -

                                                                                                                                                                      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.

                                                                                                                                                                      - -
                                                                                                                                                                      -

                                                                                                                                                                      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.

                                                                                                                                                                      - -
                                                                                                                                                                      -

                                                                                                                                                                      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.

                                                                                                                                                                      - -
                                                                                                                                                                      -

                                                                                                                                                                      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.

                                                                                                                                                                      - -
                                                                                                                                                                      -

                                                                                                                                                                         

                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                        -
                                                                                                                                                                      • -
                                                                                                                                                                          -
                                                                                                                                                                        • Editor.removeSelectionMarker(Range range)
                                                                                                                                                                          • -
                                                                                                                                                                        -
                                                                                                                                                                          -
                                                                                                                                                                        -
                                                                                                                                                                        • -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -

                                                                                                                                                                      Removes the selection marker.

                                                                                                                                                                      - -
                                                                                                                                                                      -

                                                                                                                                                                      Removes the selection marker.

                                                                                                                                                                      - -
                                                                                                                                                                      -

                                                                                                                                                                         

                                                                                                                                                                      -
                                                                                                                                                                      -

                                                                                                                                                                      Arguments

                                                                                                                                                                      rangeRangeRequired. The selection range added with addSelectionMarker.
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      - -
                                                                                                                                                                      -
                                                                                                                                                                      -

                                                                                                                                                                      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.

                                                                                                                                                                      - -
                                                                                                                                                                      -

                                                                                                                                                                      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.transposeSelections(Number dir)
                                                                                                                                                                          • -
                                                                                                                                                                        -
                                                                                                                                                                          -
                                                                                                                                                                        -
                                                                                                                                                                        • -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -

                                                                                                                                                                      Transposes the selected ranges.

                                                                                                                                                                      - -
                                                                                                                                                                      -

                                                                                                                                                                      Transposes the selected ranges.

                                                                                                                                                                      - -
                                                                                                                                                                      -

                                                                                                                                                                         

                                                                                                                                                                      -
                                                                                                                                                                      -

                                                                                                                                                                      Arguments

                                                                                                                                                                      dirNumberRequired. The direction to rotate selections
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                        -
                                                                                                                                                                      • -
                                                                                                                                                                          -
                                                                                                                                                                        • Editor.onCopy()
                                                                                                                                                                          • -
                                                                                                                                                                        -
                                                                                                                                                                          -
                                                                                                                                                                        -
                                                                                                                                                                        • -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -

                                                                                                                                                                      Called whenever a text "copy" happens.

                                                                                                                                                                      - -
                                                                                                                                                                      -

                                                                                                                                                                      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.

                                                                                                                                                                      - -
                                                                                                                                                                      -

                                                                                                                                                                         

                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      - -
                                                                                                                                                                      -
                                                                                                                                                                      -

                                                                                                                                                                      {:UndoManager.redo}

                                                                                                                                                                      - -
                                                                                                                                                                      -

                                                                                                                                                                      {:UndoManager.redo}

                                                                                                                                                                      - -
                                                                                                                                                                      -

                                                                                                                                                                         

                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                        -
                                                                                                                                                                      • -
                                                                                                                                                                          -
                                                                                                                                                                        • Editor.remove(String dir)
                                                                                                                                                                          • -
                                                                                                                                                                        -
                                                                                                                                                                          -
                                                                                                                                                                        -
                                                                                                                                                                        • -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -

                                                                                                                                                                      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

                                                                                                                                                                      - -
                                                                                                                                                                      -

                                                                                                                                                                      Removes all the lines in the current selection

                                                                                                                                                                      - -
                                                                                                                                                                      -

                                                                                                                                                                         

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

                                                                                                                                                                      - -
                                                                                                                                                                      -

                                                                                                                                                                         

                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                        -
                                                                                                                                                                      • -
                                                                                                                                                                          -
                                                                                                                                                                        • Editor.removeWordLeft()
                                                                                                                                                                          • -
                                                                                                                                                                        -
                                                                                                                                                                          -
                                                                                                                                                                        -
                                                                                                                                                                        • -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -

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

                                                                                                                                                                      - -
                                                                                                                                                                      -

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

                                                                                                                                                                      - -
                                                                                                                                                                      -

                                                                                                                                                                         

                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                        -
                                                                                                                                                                      • -
                                                                                                                                                                          -
                                                                                                                                                                        • Editor.removeWordRight()
                                                                                                                                                                          • -
                                                                                                                                                                        -
                                                                                                                                                                          -
                                                                                                                                                                        -
                                                                                                                                                                        • -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -

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

                                                                                                                                                                      - -
                                                                                                                                                                      -

                                                                                                                                                                      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.

                                                                                                                                                                      - -
                                                                                                                                                                      -

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

                                                                                                                                                                      - -
                                                                                                                                                                      -

                                                                                                                                                                         

                                                                                                                                                                      -
                                                                                                                                                                      -

                                                                                                                                                                      Arguments

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

                                                                                                                                                                      {:VirtualRenderer.onResize}

                                                                                                                                                                      - -
                                                                                                                                                                      -

                                                                                                                                                                      {:VirtualRenderer.onResize}

                                                                                                                                                                      - -
                                                                                                                                                                      -

                                                                                                                                                                         

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

                                                                                                                                                                      - -
                                                                                                                                                                      -

                                                                                                                                                                         

                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                        -
                                                                                                                                                                      • -
                                                                                                                                                                          -
                                                                                                                                                                        • Editor.scrollPageUp()
                                                                                                                                                                          • -
                                                                                                                                                                        -
                                                                                                                                                                          -
                                                                                                                                                                        -
                                                                                                                                                                        • -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -

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

                                                                                                                                                                      - -
                                                                                                                                                                      -

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

                                                                                                                                                                      - -
                                                                                                                                                                      -

                                                                                                                                                                         

                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      - -
                                                                                                                                                                      -
                                                                                                                                                                      -

                                                                                                                                                                      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.

                                                                                                                                                                      - -
                                                                                                                                                                      -

                                                                                                                                                                      Moves the editor to the specified row.

                                                                                                                                                                      - -
                                                                                                                                                                      -

                                                                                                                                                                         

                                                                                                                                                                      -
                                                                                                                                                                      -

                                                                                                                                                                      Arguments

                                                                                                                                                                      rowNumberRequired. The row to move to
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      - -
                                                                                                                                                                      -
                                                                                                                                                                      -

                                                                                                                                                                      Selects all the text in editor.

                                                                                                                                                                      - -
                                                                                                                                                                      -

                                                                                                                                                                      Selects all the text in editor.

                                                                                                                                                                      - -
                                                                                                                                                                      -

                                                                                                                                                                         

                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                        -
                                                                                                                                                                      • -
                                                                                                                                                                          -
                                                                                                                                                                        • 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.]{: #BehaviorsDef}

                                                                                                                                                                      - -
                                                                                                                                                                      -

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

                                                                                                                                                                      - -
                                                                                                                                                                      -

                                                                                                                                                                         

                                                                                                                                                                      -
                                                                                                                                                                      -

                                                                                                                                                                      Arguments

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

                                                                                                                                                                      - -
                                                                                                                                                                      -

                                                                                                                                                                      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.

                                                                                                                                                                      - -
                                                                                                                                                                      -

                                                                                                                                                                      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.

                                                                                                                                                                      - -
                                                                                                                                                                      -

                                                                                                                                                                      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.

                                                                                                                                                                      - -
                                                                                                                                                                      -

                                                                                                                                                                      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.

                                                                                                                                                                      - -
                                                                                                                                                                      -

                                                                                                                                                                      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.

                                                                                                                                                                      - -
                                                                                                                                                                      -

                                                                                                                                                                      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.

                                                                                                                                                                      - -
                                                                                                                                                                      -

                                                                                                                                                                      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.

                                                                                                                                                                      - -
                                                                                                                                                                      -

                                                                                                                                                                      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.

                                                                                                                                                                      - -
                                                                                                                                                                      -

                                                                                                                                                                      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.

                                                                                                                                                                      - -
                                                                                                                                                                      -

                                                                                                                                                                      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.

                                                                                                                                                                      - -
                                                                                                                                                                      -

                                                                                                                                                                      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.

                                                                                                                                                                      - -
                                                                                                                                                                      -

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

                                                                                                                                                                      {:VirtualRenderer.setStyle}

                                                                                                                                                                      - -
                                                                                                                                                                      -

                                                                                                                                                                      {:VirtualRenderer.setStyle}

                                                                                                                                                                      - -
                                                                                                                                                                      -

                                                                                                                                                                         

                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                        -
                                                                                                                                                                      • -
                                                                                                                                                                          -
                                                                                                                                                                        • Editor.setTheme(theme)
                                                                                                                                                                          • -
                                                                                                                                                                        -
                                                                                                                                                                          -
                                                                                                                                                                        -
                                                                                                                                                                        • -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -

                                                                                                                                                                      {:VirtualRenderer.setTheme}

                                                                                                                                                                      - -
                                                                                                                                                                      -

                                                                                                                                                                      {:VirtualRenderer.setTheme}

                                                                                                                                                                      - -
                                                                                                                                                                      -

                                                                                                                                                                         

                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      - -
                                                                                                                                                                      -
                                                                                                                                                                      -

                                                                                                                                                                      Sets the current document to val.

                                                                                                                                                                      - -
                                                                                                                                                                      -

                                                                                                                                                                      Sets the current document to val.

                                                                                                                                                                      - -
                                                                                                                                                                      -

                                                                                                                                                                         

                                                                                                                                                                      -
                                                                                                                                                                      -

                                                                                                                                                                      Arguments

                                                                                                                                                                      valStringRequired. The new value to set for the document
                                                                                                                                                                      cursorPosNumberRequired. 0: selectAll, -1 document start, 1 end
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                        -
                                                                                                                                                                      • -
                                                                                                                                                                          -
                                                                                                                                                                        • 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).

                                                                                                                                                                      - -
                                                                                                                                                                      -

                                                                                                                                                                         

                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      - -
                                                                                                                                                                      -
                                                                                                                                                                      -

                                                                                                                                                                      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.

                                                                                                                                                                      - -
                                                                                                                                                                      -

                                                                                                                                                                         

                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                        -
                                                                                                                                                                      • -
                                                                                                                                                                          -
                                                                                                                                                                        • Editor.toLowerCase()
                                                                                                                                                                          • -
                                                                                                                                                                        -
                                                                                                                                                                          -
                                                                                                                                                                        -
                                                                                                                                                                        • -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -

                                                                                                                                                                      Converts the current selection entirely into lowercase.

                                                                                                                                                                      - -
                                                                                                                                                                      -

                                                                                                                                                                      Converts the current selection entirely into lowercase.

                                                                                                                                                                      - -
                                                                                                                                                                      -

                                                                                                                                                                         

                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                        -
                                                                                                                                                                      • -
                                                                                                                                                                          -
                                                                                                                                                                        • Editor.toUpperCase()
                                                                                                                                                                          • -
                                                                                                                                                                        -
                                                                                                                                                                          -
                                                                                                                                                                        -
                                                                                                                                                                        • -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -

                                                                                                                                                                      Converts the current selection entirely into uppercase.

                                                                                                                                                                      - -
                                                                                                                                                                      -

                                                                                                                                                                      Converts the current selection entirely into uppercase.

                                                                                                                                                                      - -
                                                                                                                                                                      -

                                                                                                                                                                         

                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                        -
                                                                                                                                                                      • -
                                                                                                                                                                          -
                                                                                                                                                                        • Editor.transposeLetters()
                                                                                                                                                                          • -
                                                                                                                                                                        -
                                                                                                                                                                          -
                                                                                                                                                                        -
                                                                                                                                                                        • -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -

                                                                                                                                                                      Transposes current line.

                                                                                                                                                                      - -
                                                                                                                                                                      -

                                                                                                                                                                      Transposes current line.

                                                                                                                                                                      - -
                                                                                                                                                                      -

                                                                                                                                                                         

                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      - -
                                                                                                                                                                      -
                                                                                                                                                                      -

                                                                                                                                                                      {:UndoManager.undo}

                                                                                                                                                                      - -
                                                                                                                                                                      -

                                                                                                                                                                      {:UndoManager.undo}

                                                                                                                                                                      - -
                                                                                                                                                                      -

                                                                                                                                                                         

                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      - -
                                                                                                                                                                      -
                                                                                                                                                                      -

                                                                                                                                                                      {:VirtualRenderer.unsetStyle}

                                                                                                                                                                      - -
                                                                                                                                                                      -

                                                                                                                                                                      {:VirtualRenderer.unsetStyle}

                                                                                                                                                                      - -
                                                                                                                                                                      -

                                                                                                                                                                         

                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      - - - - - - - - - - \ No newline at end of file +

                                                                                                                                                                         

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

                                                                                                                                                                        +

                                                                                                                                                                        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.

                                                                                                                                                                          +

                                                                                                                                                                          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.

                                                                                                                                                                                +

                                                                                                                                                                                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.

                                                                                                                                                                                    +

                                                                                                                                                                                    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.

                                                                                                                                                                                      +

                                                                                                                                                                                      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.

                                                                                                                                                                                        +

                                                                                                                                                                                        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.

                                                                                                                                                                                          +

                                                                                                                                                                                             

                                                                                                                                                                                            • Editor.onCopy()

                                                                                                                                                                                            Called whenever a text "copy" happens.

                                                                                                                                                                                            +

                                                                                                                                                                                            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.

                                                                                                                                                                                                +

                                                                                                                                                                                                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

                                                                                                                                                                                                +

                                                                                                                                                                                                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.

                                                                                                                                                                                                    +

                                                                                                                                                                                                    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.

                                                                                                                                                                                                      +

                                                                                                                                                                                                         

                                                                                                                                                                                                        • Editor.removeWordLeft()

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

                                                                                                                                                                                                        +

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

                                                                                                                                                                                                        +

                                                                                                                                                                                                           

                                                                                                                                                                                                          • Editor.removeWordRight()

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

                                                                                                                                                                                                          +

                                                                                                                                                                                                          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.

                                                                                                                                                                                                          +

                                                                                                                                                                                                          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.

                                                                                                                                                                                                            +

                                                                                                                                                                                                               

                                                                                                                                                                                                              • Editor.scrollPageUp()

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

                                                                                                                                                                                                              +

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

                                                                                                                                                                                                              +

                                                                                                                                                                                                                 

                                                                                                                                                                                                              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.

                                                                                                                                                                                                              +

                                                                                                                                                                                                              Moves the editor to the specified row.

                                                                                                                                                                                                              +

                                                                                                                                                                                                                 

                                                                                                                                                                                                              Arguments

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

                                                                                                                                                                                                              +

                                                                                                                                                                                                              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.

                                                                                                                                                                                                                +

                                                                                                                                                                                                                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.

                                                                                                                                                                                                                      +

                                                                                                                                                                                                                      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.

                                                                                                                                                                                                                        +

                                                                                                                                                                                                                        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.

                                                                                                                                                                                                                          +

                                                                                                                                                                                                                          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.

                                                                                                                                                                                                                            +

                                                                                                                                                                                                                            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.

                                                                                                                                                                                                                              +

                                                                                                                                                                                                                              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.

                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                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.

                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                  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.

                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    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.

                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                      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.

                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                      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.

                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                        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.

                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                          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.

                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                            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.

                                                                                                                                                                                                                                            +

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

                                                                                                                                                                                                                                                +

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

                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                     

                                                                                                                                                                                                                                                  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.

                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                     

                                                                                                                                                                                                                                                    • Editor.toLowerCase()

                                                                                                                                                                                                                                                    Converts the current selection entirely into lowercase.

                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                    Converts the current selection entirely into lowercase.

                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                       

                                                                                                                                                                                                                                                      • Editor.toUpperCase()

                                                                                                                                                                                                                                                      Converts the current selection entirely into uppercase.

                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                      Converts the current selection entirely into uppercase.

                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                         

                                                                                                                                                                                                                                                        • Editor.transposeLetters()

                                                                                                                                                                                                                                                        Transposes current line.

                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                        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.

                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                          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.

                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                             

                                                                                                                                                                                                                                                            • Editor.updateSelectionMarkers()

                                                                                                                                                                                                                                                            Updates the cursor and marker layers.

                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                            Updates the cursor and marker layers.

                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                               

                                                                                                                                                                                                                                                            + + + + + \ No newline at end of file diff --git a/api/index.html b/api/index.html index 75cbe2a4..a4e4af82 100644 --- a/api/index.html +++ b/api/index.html @@ -1,130 +1,14 @@ - - - - - - Ace API - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            - - -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                            Ace API Reference

                                                                                                                                                                                                                                                            + Ace API

                                                                                                                                                                                                                                                            Ace API Reference

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

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

                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            + + + + + - - - - - - - - \ No newline at end of file + \ No newline at end of file diff --git a/api/multi_select.html b/api/multi_select.html deleted file mode 100644 index 49be8126..00000000 --- a/api/multi_select.html +++ /dev/null @@ -1,127 +0,0 @@ - - - - - - - - - Ace API - multi_select - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            - - -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            - - - - - - - - - - \ No newline at end of file diff --git a/api/placeholder.html b/api/placeholder.html index 6a4ad2dc..6d0ce9ab 100644 --- a/api/placeholder.html +++ b/api/placeholder.html @@ -1,409 +1,28 @@ - - - - - - Ace API - placeholder - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            - - -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                            PlaceHolder[edit] -

                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                            TODO

                                                                                                                                                                                                                                                            + Ace API - /Users/gjtorikian/Developer/ace/lib/ace/placeholder.js

                                                                                                                                                                                                                                                            PlaceHolder[edit]

                                                                                                                                                                                                                                                            TODO

                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                            Constructors

                                                                                                                                                                                                                                                            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.

                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                   

                                                                                                                                                                                                                                                                Methods

                                                                                                                                                                                                                                                                  • PlaceHolder.cancel()

                                                                                                                                                                                                                                                                  TODO

                                                                                                                                                                                                                                                                  +

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

                                                                                                                                                                                                                                                                        TODO

                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                        TODO

                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                           

                                                                                                                                                                                                                                                                          • PlaceHolder.showOtherMarkers()

                                                                                                                                                                                                                                                                          TODO

                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                          TODO

                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                             

                                                                                                                                                                                                                                                                          + + + + + - - - - - - - - \ No newline at end of file + \ No newline at end of file diff --git a/api/range.html b/api/range.html index 34c38018..9e864f43 100644 --- a/api/range.html +++ b/api/range.html @@ -1,1101 +1,70 @@ - - - - - - Ace API - range - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                          - - -
                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                          - -
                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                          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.

                                                                                                                                                                                                                                                                          - -
                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                          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
                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                            • Range.clone() -
                                                                                                                                                                                                                                                                            • - -
                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                          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
                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                          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
                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                          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
                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                          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
                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                          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
                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                          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

                                                                                                                                                                                                                                                                          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:

                                                                                                                                                                                                                                                                          + Ace API - /Users/gjtorikian/Developer/ace/lib/ace/range.js

                                                                                                                                                                                                                                                                          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.

                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                          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.

                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                          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.

                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                            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.

                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                            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.

                                                                                                                                                                                                                                                                            +

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

                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                            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.

                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                            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:

                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                            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

                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                               

                                                                                                                                                                                                                                                                            -

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

                                                                                                                                                                                                                                                                               

                                                                                                                                                                                                                                                                            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.

                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                            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.

                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                            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.

                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                            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.

                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                            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.

                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                            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.

                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                            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.

                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                            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.

                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                            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.

                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                            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
                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                              • Range.isMultiLine() -
                                                                                                                                                                                                                                                                              • - -
                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                            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.

                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                            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.

                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                            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.

                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                            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
                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                              • Range.toString() -
                                                                                                                                                                                                                                                                              • - -
                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                            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:

                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                            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.

                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                            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.

                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                            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.

                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                            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.

                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                            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.

                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                            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.

                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                            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.

                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                            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.

                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                            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.

                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                            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.

                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                            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.

                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                            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.

                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                            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.

                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                            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:

                                                                                                                                                                                                                                                                            +

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

                                                                                                                                                                                                                                                                            [start.row/start.column] -> [end.row/end.column]

                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                               

                                                                                                                                                                                                                                                                            [start.row/start.column] -> [end.row/end.column]

                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            + + + + + - - - - - - - - \ No newline at end of file + \ No newline at end of file diff --git a/api/scrollbar.html b/api/scrollbar.html index c2b18a4e..932aed6d 100644 --- a/api/scrollbar.html +++ b/api/scrollbar.html @@ -1,357 +1,24 @@ - - - - - - Ace API - scrollbar - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            - - -
                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                            ScrollBar[edit] -

                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            -

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

                                                                                                                                                                                                                                                                            + Ace API - /Users/gjtorikian/Developer/ace/lib/ace/scrollbar.js

                                                                                                                                                                                                                                                                            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.

                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                              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.

                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                  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.

                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                    Sets the scroll top of the scroll bar.

                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                       

                                                                                                                                                                                                                                                                                    Arguments

                                                                                                                                                                                                                                                                                    scrollTopNumberRequired. The new scroll top
                                                                                                                                                                                                                                                                                    + + + + + - - - - - - - - \ No newline at end of file + \ No newline at end of file diff --git a/api/search.html b/api/search.html index fc38db24..9e72f5e9 100644 --- a/api/search.html +++ b/api/search.html @@ -1,167 +1,9 @@ - - - - - - Ace API - search - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    - - -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                    Search[edit] -

                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    -

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

                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                    Constructors

                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                      • new Search()
                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    - -