diff --git a/api/ace.html b/api/ace.html index 7b46b2c1..64a0cc2f 100644 --- a/api/ace.html +++ b/api/ace.html @@ -1,15 +1,8 @@ - Ace - Ace API

Ace [edit]

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

-

Methods

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

-

   

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

+ Ace - Ace API

The high performance code editor for the web.

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

Required. 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 60b23109..2a57d4d0 100644 --- a/api/anchor.html +++ b/api/anchor.html @@ -1,14 +1,14 @@ - Anchor - Ace API

Anchor [edit]

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

-

Constructors

Creates a new Anchor and associates it with a document.

-

   

Creates a new Anchor and associates it with a document.

+ Anchor - Ace API

The high performance code editor for the web.

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

docDocument

Required. The document to associate with the anchor

rowNumber

Required. The starting row position

columnNumber

Required. The starting column position

-

Events

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

    Fires whenever the anchor position changes.

    -

       

    Fires whenever the anchor position changes.

    +

    Events

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

      Fires whenever the anchor position changes.

      +

      Fires whenever the anchor position changes.

      Events that can trigger this function include setPosition().

      Arguments

      eObject

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

        @@ -18,26 +18,19 @@

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

      -

      Methods

        • Internal

      Clips the anchor position to the specified row and column.

      -

         

      Clips the anchor position to the specified row and column.

      +

      Methods

        • Internal

      Clips the anchor position to the specified row and column.

      +

      Clips the anchor position to the specified row and column.

      Arguments

      rowNumber

      Required. The row index to clip the anchor to

      columnNumber

      Required. The column index to clip the anchor to

      -
        • Anchor.detach()

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

        -

           

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

        -

        Returns the current document.

        -

           

        Returns the current document.

        -

        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.

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

          rowNumber

          Required. The row index to move the anchor to

          columnNumber

          Required. The column index to move the anchor to

          noClipBoolean

          Required. Identifies if you want the position to be clipped

          -
          - - - - - \ 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 56587186..4f5936e0 100644 --- a/api/background_tokenizer.html +++ b/api/background_tokenizer.html @@ -1,40 +1,33 @@ - BackgroundTokenizer - Ace API

          BackgroundTokenizer [edit]

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

          -

          Constructors

          Creates a new BackgroundTokenizer object.

          -

             

          Creates a new BackgroundTokenizer object.

          + BackgroundTokenizer - Ace API

          The high performance code editor for the web.

          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

          tokenizerTokenizer

          Required. The tokenizer to use

          editorEditor

          Required. The editor to associate with

          -

          Events

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

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

            -

               

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

            +

            Events

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

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

              +

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

              Arguments

              eObject

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

              -

              Methods

                • BackgroundTokenizer.fireUpdateEvent(Number firstRow, Number lastRow)

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

                -

                   

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

                +

                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

                  firstRowNumber

                  Required. The starting row region

                  lastRowNumber

                  Required. The final row region

                  -

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

                  -

                     

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

                  +

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

                  +

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

                  Arguments

                  rowNumber

                  Required. The row to get state at

                  -

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

                  -

                     

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

                  +

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

                  +

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

                  Arguments

                  rowNumber

                  Required. The row to get tokens at

                  -
                    • BackgroundTokenizer.setDocument(Document doc)

                    Sets a new document to associate with this object.

                    -

                       

                    Sets a new document to associate with this object.

                    +
                      • BackgroundTokenizer.setDocument(Document doc)

                      Sets a new document to associate with this object.

                      +

                      Sets a new document to associate with this object.

                      Arguments

                      docDocument

                      Required. The new document to associate with

                      -
                        • BackgroundTokenizer.setTokenizer(Tokenizer tokenizer)

                        Sets a new tokenizer for this object.

                        -

                           

                        Sets a new tokenizer for this object.

                        +
                          • BackgroundTokenizer.setTokenizer(Tokenizer tokenizer)

                          Sets a new tokenizer for this object.

                          +

                          Sets a new tokenizer for this object.

                          Arguments

                          tokenizerTokenizer

                          Required. The new tokenizer to use

                          -
                            • BackgroundTokenizer.start(Number startRow)

                            Starts tokenizing at the row indicated.

                            -

                               

                            Starts tokenizing at the row indicated.

                            +
                              • BackgroundTokenizer.start(Number startRow)

                              Starts tokenizing at the row indicated.

                              +

                              Starts tokenizing at the row indicated.

                              Arguments

                              startRowNumber

                              Required. The row to start at

                              -
                                • BackgroundTokenizer.stop()

                                Stops tokenizing.

                                -

                                   

                                Stops tokenizing.

                                -
                                - - - - - \ No newline at end of file +
                                  • BackgroundTokenizer.stop()

                                  Stops tokenizing.

                                  +

                                  Stops tokenizing.

                                  +
                                  \ No newline at end of file diff --git a/api/command_manager.html b/api/command_manager.html index 660d81d9..5f54b975 100644 --- a/api/command_manager.html +++ b/api/command_manager.html @@ -1,15 +1,8 @@ - CommandManager - Ace API

                                  CommandManager [edit]

                                  Constructors

                                  TODO

                                  -

                                     

                                  TODO

                                  + CommandManager - Ace API

                                  The high performance code editor for the web.

                                  CommandManager [edit]

                                  Constructors

                                  TODO

                                  +

                                  TODO

                                  Arguments

                                  platformString

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

                                  commandsArray

                                  Required. A list of commands

                                  -
                                  - - - - - \ No newline at end of file +
                                  \ No newline at end of file diff --git a/api/document.html b/api/document.html index 696bb268..192f41dc 100644 --- a/api/document.html +++ b/api/document.html @@ -1,12 +1,12 @@ - Document - Ace API

                                  Document [edit]

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

                                  -

                                  Constructors

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

                                  -

                                     

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

                                  + Document - Ace API

                                  The high performance code editor for the web.

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

                                  Required. The starting text

                                  -

                                  Events

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

                                    Fires whenever the document changes.

                                    -

                                       

                                    Fires whenever the document changes.

                                    +

                                    Events

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

                                      Fires whenever the document changes.

                                      +

                                      Fires whenever the document changes.

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

                                      • "insertLines" (emitted by Document.insertLines())
                                          @@ -32,83 +32,118 @@

                                        Arguments

                                        eObject

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

                                        -

                                      Methods

                                        • Document.$clipPosition(position)
                                        • Internal

                                         

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

                                         

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

                                      -

                                         

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

                                      +

                                      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

                                      textString

                                      Required. The text to work with

                                      -

                                      Returns

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

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

                                        -

                                           

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

                                        -

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

                                        -

                                           

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

                                        +

                                        Returns

                                        Array of Strings

                                        A String array, with each index containing a piece of the original text string.

                                        +
                                          • Document.applyDeltas(deltas)
                                            • Void

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

                                          +

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

                                          +

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

                                          +

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

                                          Arguments

                                          rowNumber

                                          Required. The row number to use

                                          columnNumber

                                          Required. The column number to use

                                          -
                                            • Document.getAllLines()

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

                                            -

                                               

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

                                            -

                                            Returns the number of rows in the document.

                                            -

                                               

                                            Returns the number of rows in the document.

                                            -

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

                                            -

                                               

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

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

                                              rowNumber

                                              Required. The row index to retrieve

                                              -

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

                                              -

                                                 

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

                                              +

                                              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

                                              firstRowNumber

                                              Required. The first row index to retrieve

                                              lastRowNumber

                                              Required. The final row index to retrieve

                                              -
                                                • Document.getNewLineCharacter()

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

                                                -

                                                   

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

                                                -

                                                Returns

                                                StringIf newLineMode == windows, \r\n is returned.
                                                If newLineMode == unix, \n is returned.
                                                If newLineMode == auto, the value of autoNewLine is returned.
                                                  • Document.getNewLineMode()

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

                                                  -

                                                     

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

                                                  -

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

                                                  -

                                                     

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

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

                                                    +

                                                    Returns

                                                    String

                                                    If newLineMode == windows, \r\n is returned.

                                                    +
                                                      +

                                                    • If newLineMode == unix, \n is returned.

                                                      +
                                                      • +

                                                    • If newLineMode == auto, the value of autoNewLine is returned.

                                                      +
                                                      • +
                                                    +
                                                      • Document.getNewLineMode()

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

                                                      +

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

                                                      +

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

                                                      +

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

                                                      Arguments

                                                      rangeRange

                                                      Required. The range to work with

                                                      -

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

                                                      -

                                                         

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

                                                      -

                                                         

                                                      Arguments

                                                      positionNumber

                                                      Required. The position to start inserting at

                                                      +

                                                      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

                                                      positionNumber

                                                      Required. The position to start inserting at

                                                      textString

                                                      Required. A chunk of text to insert

                                                      -

                                                      Returns

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

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

                                                      -

                                                         

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

                                                      +

                                                      Returns

                                                      Number

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

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

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

                                                      +

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

                                                      Arguments

                                                      positionNumber

                                                      Required. The position to insert at

                                                      textString

                                                      Required. A chunk of text

                                                      -

                                                      Returns

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

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

                                                      -

                                                         

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

                                                      +

                                                      Returns

                                                      Object

                                                      Returns an object containing the final row and column, like this:

                                                      +
                                                        +
                                                      • {row: endRow, column: 0}
                                                        • +
                                                      +
                                                      Number

                                                      If text is empty, this function returns the value of position

                                                      +

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

                                                      +

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

                                                      Arguments

                                                      rowNumber

                                                      Required. The index of the row to insert at

                                                      linesArray

                                                      Required. An array of strings

                                                      -

                                                      Returns

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

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

                                                      -

                                                         

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

                                                      +

                                                      Returns

                                                      Object

                                                      Returns an object containing the final row and column, like this:

                                                      +
                                                        +

                                                      • {row: endRow, column: 0}

                                                        +
                                                        • +

                                                      • If lines is empty, this function returns an object containing the current row, and column, like this:

                                                        +
                                                        • +

                                                      • {row: row, column: 0}

                                                        +
                                                        • +
                                                      +

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

                                                      +

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

                                                      Arguments

                                                      positionString

                                                      Required. The position to insert at

                                                      -

                                                      Returns

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

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

                                                      -

                                                         

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

                                                      +

                                                      Returns

                                                      Object

                                                      Returns an object containing the final row and column, like this:

                                                      +
                                                        +
                                                      • {row: endRow, column: 0}
                                                        • +
                                                      +

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

                                                      +

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

                                                      Arguments

                                                      textString

                                                      Required. The text to check

                                                      -

                                                      Removes the range from the document.

                                                      -

                                                         

                                                      Removes the range from the document.

                                                      +

                                                      Removes the range from the document.

                                                      +

                                                      Removes the range from the document.

                                                      Arguments

                                                      rangeRange

                                                      Required. A specified Range to remove

                                                      -

                                                      Returns

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

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

                                                      -

                                                         

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

                                                      +

                                                      Returns

                                                      Object

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

                                                      +

                                                      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

                                                      rowNumber

                                                      Required. The row to remove from

                                                      startColumnNumber

                                                      Required. The column to start removing at

                                                      endColumnNumber

                                                      Required. The column to stop removing at

                                                      -

                                                      Returns

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

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

                                                      -

                                                         

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

                                                      +

                                                      Returns

                                                      Object

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

                                                      +

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

                                                      +

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

                                                      Arguments

                                                      firstRowNumber

                                                      Required. The first row to be removed

                                                      lastRowNumber

                                                      Required. The last row to be removed

                                                      -

                                                      Returns

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

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

                                                        -

                                                           

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

                                                        +

                                                        Returns

                                                        Array of Strings

                                                        Returns all the removed lines.

                                                        +
                                                          • Document.removeNewLine(Number row)
                                                            • Void

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

                                                          +

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

                                                          Arguments

                                                          rowNumber

                                                          Required. The row to check

                                                          -

                                                          Replaces a range in the document with the new text.

                                                          -

                                                             

                                                          Replaces a range in the document with the new text.

                                                          +

                                                          Replaces a range in the document with the new text.

                                                          +

                                                          Replaces a range in the document with the new text.

                                                          Arguments

                                                          rangeRange

                                                          Required. A specified Range to replace

                                                          textString

                                                          Required. The new text to use as a replacement

                                                          -

                                                          Returns

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

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

                                                            -

                                                               

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

                                                            -
                                                              • Document.setNewLineMode(String newLineMode)
                                                                • Void

                                                              Sets the new line mode.

                                                              -

                                                                 

                                                              Sets the new line mode.

                                                              +

                                                              Returns

                                                              Object

                                                              Returns an object containing the final row and column, like this:

                                                              +
                                                                +

                                                              • {row: endRow, column: 0}

                                                                +
                                                                • +

                                                              • If the text and range are empty, this function returns an object containing the current range.start value.

                                                                +
                                                                • +

                                                              • If the text is the exact same as what currently exists, this function returns an object containing the current range.end value.

                                                                +
                                                                • +
                                                              +
                                                                • Document.revertDeltas(deltas)
                                                                  • Void

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

                                                                +

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

                                                                +
                                                                  • Document.setNewLineMode(String newLineMode)
                                                                    • Void

                                                                  Sets the new line mode.

                                                                  +

                                                                  Sets the new line mode.

                                                                  Arguments

                                                                  newLineModeString

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

                                                                  -
                                                                    • Document.setValue(String text)
                                                                      • Void

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

                                                                    -

                                                                       

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

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

                                                                      textString

                                                                      Required. 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 ef427e89..529d0360 100644 --- a/api/edit_session.html +++ b/api/edit_session.html @@ -1,289 +1,309 @@ - EditSession - Ace API

                                                                      EditSession [edit]

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

                                                                      -

                                                                      Constructors

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

                                                                      -

                                                                         

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

                                                                      + EditSession - Ace API

                                                                      The high performance code editor for the web.

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

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

                                                                      modeTextMode

                                                                      Required. The inital language mode to use for the document

                                                                      -

                                                                      Events

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

                                                                        Emitted when the document changes.

                                                                        -

                                                                           

                                                                        Emitted when the document changes.

                                                                        +

                                                                        Events

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

                                                                          Emitted when the document changes.

                                                                          +

                                                                          Emitted when the document changes.

                                                                          Arguments

                                                                          eObject

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

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

                                                                            Emitted when a back marker changes.

                                                                            -

                                                                               

                                                                            Emitted when a back marker changes.

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

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

                                                                              -

                                                                                 

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

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

                                                                                Emitted when a code fold is added or removed.

                                                                                -

                                                                                   

                                                                                Emitted when a code fold is added or removed.

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

                                                                                  Emitted when a front marker changes.

                                                                                  -

                                                                                     

                                                                                  Emitted when a front marker changes.

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

                                                                                    Emitted when the current mode changes.

                                                                                    -

                                                                                       

                                                                                    Emitted when the current mode changes.

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

                                                                                      Emitted when the scroll left changes.

                                                                                      -

                                                                                         

                                                                                      Emitted when the scroll left changes.

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

                                                                                        Emitted when a back marker changes.

                                                                                        +

                                                                                        Emitted when a back marker changes.

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

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

                                                                                          +

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

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

                                                                                            Emitted when a code fold is added or removed.

                                                                                            +

                                                                                            Emitted when a code fold is added or removed.

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

                                                                                              Emitted when a front marker changes.

                                                                                              +

                                                                                              Emitted when a front marker changes.

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

                                                                                                Emitted when the current mode changes.

                                                                                                +

                                                                                                Emitted when the current mode changes.

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

                                                                                                  Emitted when the scroll left changes.

                                                                                                  +

                                                                                                  Emitted when the scroll left changes.

                                                                                                  Arguments

                                                                                                  scrollLeftNumber

                                                                                                  Required. The new scroll left value

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

                                                                                                    Emitted when the scroll top changes.

                                                                                                    -

                                                                                                       

                                                                                                    Emitted when the scroll top changes.

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

                                                                                                      Emitted when the scroll top changes.

                                                                                                      +

                                                                                                      Emitted when the scroll top changes.

                                                                                                      Arguments

                                                                                                      scrollTopNumber

                                                                                                      Required. The new scroll top value

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

                                                                                                        Emitted when the wrapping limit changes.

                                                                                                        -

                                                                                                           

                                                                                                        Emitted when the wrapping limit changes.

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

                                                                                                          Emitted when the wrap mode changes.

                                                                                                          -

                                                                                                             

                                                                                                          Emitted when the wrap mode changes.

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

                                                                                                               

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

                                                                                                              Emitted when a background tokenizer asynchronously processes new rows.

                                                                                                              -

                                                                                                                 

                                                                                                              Emitted when a background tokenizer asynchronously processes new rows.

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

                                                                                                                Emitted when the wrapping limit changes.

                                                                                                                +

                                                                                                                Emitted when the wrapping limit changes.

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

                                                                                                                  Emitted when the wrap mode changes.

                                                                                                                  +

                                                                                                                  Emitted when the wrap mode changes.

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

                                                                                                                      Emitted when a background tokenizer asynchronously processes new rows.

                                                                                                                      +

                                                                                                                      Emitted when a background tokenizer asynchronously processes new rows.

                                                                                                                      Arguments

                                                                                                                      eObject

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

                                                                                                                      -

                                                                                                                      Methods

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

                                                                                                                         

                                                                                                                        • EditSession.$constrainWrapLimit(wrapLimit)
                                                                                                                        • Internal

                                                                                                                         

                                                                                                                        • EditSession.$detectNewLine(String text)
                                                                                                                        • Internal

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

                                                                                                                      -

                                                                                                                         

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

                                                                                                                      +

                                                                                                                      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

                                                                                                                      textString

                                                                                                                      Required. A block of text

                                                                                                                      -

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

                                                                                                                      -

                                                                                                                         

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

                                                                                                                      +

                                                                                                                      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

                                                                                                                      strString

                                                                                                                      Required. The string to check

                                                                                                                      offsetNumber

                                                                                                                      Required. The value to start at

                                                                                                                      -

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

                                                                                                                      -

                                                                                                                         

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

                                                                                                                      +

                                                                                                                      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

                                                                                                                      strString

                                                                                                                      Required. The string to calculate the screen width of

                                                                                                                      maxScreenColumnNumber

                                                                                                                      Required.

                                                                                                                      screenColumnNumber

                                                                                                                      Required.

                                                                                                                      -

                                                                                                                      Returns

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

                                                                                                                         

                                                                                                                        • EditSession.$resetRowCache(Number row)
                                                                                                                        • Internal

                                                                                                                         

                                                                                                                      Arguments

                                                                                                                      rowNumber

                                                                                                                      Required. The row to work with

                                                                                                                      -
                                                                                                                        • EditSession.$startWorker()
                                                                                                                        • Internal

                                                                                                                         

                                                                                                                        • EditSession.$syncInformUndoManager()
                                                                                                                        • Internal

                                                                                                                         

                                                                                                                        • EditSession.$updateInternalDataOnChange()
                                                                                                                        • Internal

                                                                                                                         

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

                                                                                                                         

                                                                                                                      Adds a dynamic marker to the session.

                                                                                                                      -

                                                                                                                         

                                                                                                                      Adds a dynamic marker to the session.

                                                                                                                      +

                                                                                                                      Returns

                                                                                                                      Array of Numbers

                                                                                                                      Returns an int[] array with two elements:

                                                                                                                      +
                                                                                                                        +

                                                                                                                      • The first position indicates the number of columns for str on screen.

                                                                                                                        +
                                                                                                                        • +

                                                                                                                      • The second value contains the position of the document column that this function read until.

                                                                                                                        +
                                                                                                                        • +
                                                                                                                      +
                                                                                                                        • EditSession.$getUndoSelection(deltas, isUndo, lastUndoRange)
                                                                                                                        • Internal
                                                                                                                        • EditSession.$resetRowCache(Number row)
                                                                                                                        • Internal

                                                                                                                      Arguments

                                                                                                                      rowNumber

                                                                                                                      Required. The row to work with

                                                                                                                      +
                                                                                                                        • EditSession.$startWorker()
                                                                                                                        • Internal
                                                                                                                        • EditSession.$syncInformUndoManager()
                                                                                                                        • Internal
                                                                                                                        • EditSession.$updateInternalDataOnChange()
                                                                                                                        • Internal
                                                                                                                        • EditSession.$updateWrapData(firstRow, lastRow)
                                                                                                                        • Internal

                                                                                                                      Adds a dynamic marker to the session.

                                                                                                                      +

                                                                                                                      Adds a dynamic marker to the session.

                                                                                                                      Arguments

                                                                                                                      markerObject

                                                                                                                      Required. object with update method

                                                                                                                      inFrontBoolean

                                                                                                                      Required. Set to true to establish a front marker

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

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

                                                                                                                        -

                                                                                                                           

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

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

                                                                                                                          rowNumber

                                                                                                                          Required. The row number

                                                                                                                          classNameString

                                                                                                                          Required. The class to add

                                                                                                                          -

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

                                                                                                                          -

                                                                                                                             

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

                                                                                                                          +

                                                                                                                          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

                                                                                                                          rangeRange

                                                                                                                          Required. Define the range of the marker

                                                                                                                          clazzString

                                                                                                                          Required. Set the CSS class for the marker

                                                                                                                          typeFunction | String

                                                                                                                          Required. Identify the type of the marker

                                                                                                                          inFrontBoolean

                                                                                                                          Required. Set to true to establish a front marker

                                                                                                                          -

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

                                                                                                                          -

                                                                                                                             

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

                                                                                                                          +

                                                                                                                          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

                                                                                                                          desiredLimitNumber

                                                                                                                          Required. The new wrap limit

                                                                                                                          -
                                                                                                                            • EditSession.clearAnnotations()

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

                                                                                                                            -

                                                                                                                               

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

                                                                                                                            -
                                                                                                                              • EditSession.clearBreakpoint(Number row)

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

                                                                                                                              -

                                                                                                                                 

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

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

                                                                                                                                  rowNumber

                                                                                                                                  Required. A row index

                                                                                                                                  -
                                                                                                                                    • EditSession.clearBreakpoints()

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

                                                                                                                                    -

                                                                                                                                       

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

                                                                                                                                    -
                                                                                                                                      • EditSession.documentToScreenColumn(row, docColumn)
                                                                                                                                      • Internal

                                                                                                                                       

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

                                                                                                                                    -

                                                                                                                                       

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

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

                                                                                                                                      docRowNumber

                                                                                                                                      Required. The document row to check

                                                                                                                                      docColumnNumber

                                                                                                                                      Required. The document column to check

                                                                                                                                      -

                                                                                                                                      Returns

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

                                                                                                                                         

                                                                                                                                      Duplicates all the text between firstRow and lastRow.

                                                                                                                                      -

                                                                                                                                         

                                                                                                                                      Duplicates all the text between firstRow and lastRow.

                                                                                                                                      +

                                                                                                                                      Returns

                                                                                                                                      Object

                                                                                                                                      The object returned by this method has two properties: row and column.

                                                                                                                                      +
                                                                                                                                        • EditSession.documentToScreenRow(docRow, docColumn)
                                                                                                                                        • Internal

                                                                                                                                      Duplicates all the text between firstRow and lastRow.

                                                                                                                                      +

                                                                                                                                      Duplicates all the text between firstRow and lastRow.

                                                                                                                                      Arguments

                                                                                                                                      firstRowNumber

                                                                                                                                      Required. The starting row to duplicate

                                                                                                                                      lastRowNumber

                                                                                                                                      Required. The final row to duplicate

                                                                                                                                      -

                                                                                                                                      Returns

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

                                                                                                                                        Returns the annotations for the EditSession.

                                                                                                                                        -

                                                                                                                                           

                                                                                                                                        Returns the annotations for the EditSession.

                                                                                                                                        -

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

                                                                                                                                        -

                                                                                                                                           

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

                                                                                                                                        +

                                                                                                                                        Returns

                                                                                                                                        Number

                                                                                                                                        Returns 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

                                                                                                                                          rowNumber

                                                                                                                                          Required. The row number to start from

                                                                                                                                          columnNumber

                                                                                                                                          Required. The column number to start from

                                                                                                                                          -
                                                                                                                                            • EditSession.getBreakpoints()

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

                                                                                                                                            -

                                                                                                                                               

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

                                                                                                                                            -

                                                                                                                                            Returns the Document associated with this session.

                                                                                                                                            -

                                                                                                                                               

                                                                                                                                            Returns the Document associated with this session.

                                                                                                                                            -

                                                                                                                                               

                                                                                                                                            Arguments

                                                                                                                                            docRowNumber

                                                                                                                                            Required.

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

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

                                                                                                                                              rowNumber

                                                                                                                                              Required. The row to retrieve from

                                                                                                                                              -

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

                                                                                                                                              -

                                                                                                                                                 

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

                                                                                                                                              +

                                                                                                                                              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

                                                                                                                                              firstRowNumber

                                                                                                                                              Required. The first row index to retrieve

                                                                                                                                              lastRowNumber

                                                                                                                                              Required. The final row index to retrieve

                                                                                                                                              -

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

                                                                                                                                              -

                                                                                                                                                 

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

                                                                                                                                              +

                                                                                                                                              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

                                                                                                                                              inFrontBoolean

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

                                                                                                                                              -

                                                                                                                                              Returns the current text mode.

                                                                                                                                              -

                                                                                                                                                 

                                                                                                                                              Returns the current text mode.

                                                                                                                                              -

                                                                                                                                              Returns the current new line mode.

                                                                                                                                              -

                                                                                                                                                 

                                                                                                                                              Returns the current new line mode.

                                                                                                                                              -

                                                                                                                                              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.

                                                                                                                                              +

                                                                                                                                              Returns the current text mode.

                                                                                                                                              +

                                                                                                                                              Returns the current text 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

                                                                                                                                              rowNumber

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

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

                                                                                                                                              screenRowNumber

                                                                                                                                              Required. The screen row to check

                                                                                                                                              -
                                                                                                                                                • EditSession.getScreenLength()

                                                                                                                                                Returns the length of the screen.

                                                                                                                                                -

                                                                                                                                                   

                                                                                                                                                Returns the length of the screen.

                                                                                                                                                -

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

                                                                                                                                                -

                                                                                                                                                   

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

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

                                                                                                                                                  screenColumnNumber

                                                                                                                                                  Required. The screen column to check

                                                                                                                                                  -
                                                                                                                                                    • EditSession.getScreenWidth()

                                                                                                                                                    Returns the width of the screen.

                                                                                                                                                    -

                                                                                                                                                       

                                                                                                                                                    Returns the width of the screen.

                                                                                                                                                    -
                                                                                                                                                      • EditSession.getScrollLeft()

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

                                                                                                                                                      -

                                                                                                                                                         

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

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

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

                                                                                                                                                                  rowNumber

                                                                                                                                                                  Required. The row to start at

                                                                                                                                                                  -
                                                                                                                                                                    • EditSession.getTabSize()

                                                                                                                                                                    Returns the current tab size.

                                                                                                                                                                    -

                                                                                                                                                                       

                                                                                                                                                                    Returns the current tab size.

                                                                                                                                                                    -
                                                                                                                                                                      • EditSession.getTabString()

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

                                                                                                                                                                      -

                                                                                                                                                                         

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

                                                                                                                                                                      -

                                                                                                                                                                      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.

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

                                                                                                                                                                          rangeString

                                                                                                                                                                          Required. The range to work with

                                                                                                                                                                          -

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

                                                                                                                                                                          -

                                                                                                                                                                             

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

                                                                                                                                                                          +

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

                                                                                                                                                                          +

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

                                                                                                                                                                          Arguments

                                                                                                                                                                          rowNumber

                                                                                                                                                                          Required. The row number to retrieve from

                                                                                                                                                                          columnNumber

                                                                                                                                                                          Required. The column number to retrieve from

                                                                                                                                                                          -

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

                                                                                                                                                                          -

                                                                                                                                                                             

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

                                                                                                                                                                          +

                                                                                                                                                                          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

                                                                                                                                                                          rowNumber

                                                                                                                                                                          Required. The row to start at

                                                                                                                                                                          -

                                                                                                                                                                          Returns the current undo manager.

                                                                                                                                                                          -

                                                                                                                                                                             

                                                                                                                                                                          Returns the current undo manager.

                                                                                                                                                                          -
                                                                                                                                                                            • EditSession.getUseSoftTabs()

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

                                                                                                                                                                            -

                                                                                                                                                                               

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

                                                                                                                                                                            -

                                                                                                                                                                            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.

                                                                                                                                                                              +

                                                                                                                                                                              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

                                                                                                                                                                                  rowNumber

                                                                                                                                                                                  Required. The row to start at

                                                                                                                                                                                  columnNumber

                                                                                                                                                                                  Required. The column to start at

                                                                                                                                                                                  -
                                                                                                                                                                                    • EditSession.getWrapLimit()

                                                                                                                                                                                    Returns the value of wrap limit.

                                                                                                                                                                                    -

                                                                                                                                                                                       

                                                                                                                                                                                    Returns the value of wrap limit.

                                                                                                                                                                                    -
                                                                                                                                                                                      • EditSession.getWrapLimitRange()

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

                                                                                                                                                                                      -

                                                                                                                                                                                         

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

                                                                                                                                                                                      +
                                                                                                                                                                                        • EditSession.getWrapLimit()

                                                                                                                                                                                        Returns the value of wrap limit.

                                                                                                                                                                                        +

                                                                                                                                                                                        Returns the value of wrap limit.

                                                                                                                                                                                        +
                                                                                                                                                                                          • EditSession.getWrapLimitRange()

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

                                                                                                                                                                                          +

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

                                                                                                                                                                                          { min: wrapLimitRange_min, max: wrapLimitRange_max }
                                                                                                                                                                                          -

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

                                                                                                                                                                                          -

                                                                                                                                                                                             

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

                                                                                                                                                                                          +

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

                                                                                                                                                                                          +

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

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

                                                                                                                                                                                          Arguments

                                                                                                                                                                                          startRowNumber

                                                                                                                                                                                          Required. Starting row

                                                                                                                                                                                          endRowNumber

                                                                                                                                                                                          Required. Ending row

                                                                                                                                                                                          indentStringString

                                                                                                                                                                                          Required. The indent token

                                                                                                                                                                                          -

                                                                                                                                                                                          Inserts a block of text and the indicated position.

                                                                                                                                                                                          -

                                                                                                                                                                                             

                                                                                                                                                                                          Inserts a block of text and the indicated position.

                                                                                                                                                                                          +

                                                                                                                                                                                          Inserts a block of text and the indicated position.

                                                                                                                                                                                          +

                                                                                                                                                                                          Inserts a block of text and the indicated position.

                                                                                                                                                                                          Arguments

                                                                                                                                                                                          positionNumber

                                                                                                                                                                                          Required. The position to start inserting at

                                                                                                                                                                                          textString

                                                                                                                                                                                          Required. A chunk of text to insert

                                                                                                                                                                                          -

                                                                                                                                                                                          Returns

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

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

                                                                                                                                                                                          -

                                                                                                                                                                                             

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

                                                                                                                                                                                          +

                                                                                                                                                                                          Returns

                                                                                                                                                                                          Number

                                                                                                                                                                                          The 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

                                                                                                                                                                                          positionObject

                                                                                                                                                                                          Required. The position to check

                                                                                                                                                                                          -

                                                                                                                                                                                          Arguments

                                                                                                                                                                                          firstRowNumber

                                                                                                                                                                                          Required. The starting row to move down

                                                                                                                                                                                          lastRowNumber

                                                                                                                                                                                          Required. The final row to move down

                                                                                                                                                                                          -

                                                                                                                                                                                          Returns

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

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

                                                                                                                                                                                          -

                                                                                                                                                                                             

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

                                                                                                                                                                                          +

                                                                                                                                                                                          Returns

                                                                                                                                                                                          Number

                                                                                                                                                                                          If 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

                                                                                                                                                                                          firstRowNumber

                                                                                                                                                                                          Required. The starting row to move up

                                                                                                                                                                                          lastRowNumber

                                                                                                                                                                                          Required. The final row to move up

                                                                                                                                                                                          -

                                                                                                                                                                                          Returns

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

                                                                                                                                                                                          { row: newRowLocation, column: newColumnLocation }

                                                                                                                                                                                          -

                                                                                                                                                                                             

                                                                                                                                                                                          { row: newRowLocation, column: newColumnLocation }

                                                                                                                                                                                          +

                                                                                                                                                                                          Returns

                                                                                                                                                                                          Number

                                                                                                                                                                                          If 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

                                                                                                                                                                                          fromRangeRange

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

                                                                                                                                                                                          toPositionObject

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

                                                                                                                                                                                          -

                                                                                                                                                                                          Returns

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

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

                                                                                                                                                                                            -

                                                                                                                                                                                               

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

                                                                                                                                                                                            -
                                                                                                                                                                                              • EditSession.outdentRows(Range range)

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

                                                                                                                                                                                              -

                                                                                                                                                                                                 

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

                                                                                                                                                                                              +

                                                                                                                                                                                              Returns

                                                                                                                                                                                              Range

                                                                                                                                                                                              The new range where the text was moved to.

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

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

                                                                                                                                                                                                +

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

                                                                                                                                                                                                +
                                                                                                                                                                                                  • EditSession.outdentRows(Range range)

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

                                                                                                                                                                                                  +

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

                                                                                                                                                                                                  Arguments

                                                                                                                                                                                                  rangeRange

                                                                                                                                                                                                  Required. A range of rows

                                                                                                                                                                                                  -

                                                                                                                                                                                                  Re-implements a previously undone change to your document.

                                                                                                                                                                                                  -

                                                                                                                                                                                                     

                                                                                                                                                                                                  Re-implements a previously undone change to your document.

                                                                                                                                                                                                  +

                                                                                                                                                                                                  Re-implements a previously undone change to your document.

                                                                                                                                                                                                  +

                                                                                                                                                                                                  Re-implements a previously undone change to your document.

                                                                                                                                                                                                  Arguments

                                                                                                                                                                                                  deltasArray

                                                                                                                                                                                                  Required. An array of previous changes

                                                                                                                                                                                                  dontSelectBoolean

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

                                                                                                                                                                                                  -

                                                                                                                                                                                                  Removes the range from the document.

                                                                                                                                                                                                  -

                                                                                                                                                                                                     

                                                                                                                                                                                                  Removes the range from the document.

                                                                                                                                                                                                  +

                                                                                                                                                                                                  Removes the range from the document.

                                                                                                                                                                                                  +

                                                                                                                                                                                                  Removes the range from the document.

                                                                                                                                                                                                  Arguments

                                                                                                                                                                                                  rangeRange

                                                                                                                                                                                                  Required. A specified Range to remove

                                                                                                                                                                                                  -

                                                                                                                                                                                                  Returns

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

                                                                                                                                                                                                    Removes className from the row.

                                                                                                                                                                                                    -

                                                                                                                                                                                                       

                                                                                                                                                                                                    Removes className from the row.

                                                                                                                                                                                                    +

                                                                                                                                                                                                    Returns

                                                                                                                                                                                                    Object

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

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

                                                                                                                                                                                                      Removes className from the row.

                                                                                                                                                                                                      +

                                                                                                                                                                                                      Removes className from the row.

                                                                                                                                                                                                      Arguments

                                                                                                                                                                                                      rowNumber

                                                                                                                                                                                                      Required. The row number

                                                                                                                                                                                                      classNameString

                                                                                                                                                                                                      Required. The class to add

                                                                                                                                                                                                      -
                                                                                                                                                                                                        • EditSession.removeMarker(Number markerId)

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

                                                                                                                                                                                                        -

                                                                                                                                                                                                           

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

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

                                                                                                                                                                                                          markerIdNumber

                                                                                                                                                                                                          Required. A number representing a marker

                                                                                                                                                                                                          -

                                                                                                                                                                                                          Replaces a range in the document with the new text.

                                                                                                                                                                                                          -

                                                                                                                                                                                                             

                                                                                                                                                                                                          Replaces a range in the document with the new text.

                                                                                                                                                                                                          +

                                                                                                                                                                                                          Replaces a range in the document with the new text.

                                                                                                                                                                                                          +

                                                                                                                                                                                                          Replaces a range in the document with the new text.

                                                                                                                                                                                                          Arguments

                                                                                                                                                                                                          rangeRange

                                                                                                                                                                                                          Required. A specified Range to replace

                                                                                                                                                                                                          textString

                                                                                                                                                                                                          Required. The new text to use as a replacement

                                                                                                                                                                                                          -

                                                                                                                                                                                                          Returns

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

                                                                                                                                                                                                             

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

                                                                                                                                                                                                          -

                                                                                                                                                                                                             

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

                                                                                                                                                                                                          +

                                                                                                                                                                                                          Returns

                                                                                                                                                                                                          Object

                                                                                                                                                                                                          Returns an object containing the final row and column, like this:

                                                                                                                                                                                                          +
                                                                                                                                                                                                            +

                                                                                                                                                                                                          • {row: endRow, column: 0}

                                                                                                                                                                                                            +
                                                                                                                                                                                                            • +

                                                                                                                                                                                                          • If the text and range are empty, this function returns an object containing the current range.start value.

                                                                                                                                                                                                            +
                                                                                                                                                                                                            • +

                                                                                                                                                                                                          • If the text is the exact same as what currently exists, this function returns an object containing the current range.end value.

                                                                                                                                                                                                            +
                                                                                                                                                                                                            • +
                                                                                                                                                                                                          +
                                                                                                                                                                                                            • EditSession.screenToDocumentColumn(screenRow, screenColumn)
                                                                                                                                                                                                            • Internal

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

                                                                                                                                                                                                          +

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

                                                                                                                                                                                                          Arguments

                                                                                                                                                                                                          screenRowNumber

                                                                                                                                                                                                          Required. The screen row to check

                                                                                                                                                                                                          screenColumnNumber

                                                                                                                                                                                                          Required. The screen column to check

                                                                                                                                                                                                          -

                                                                                                                                                                                                          Returns

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

                                                                                                                                                                                                             

                                                                                                                                                                                                            • EditSession.setAnnotations(Array annotations)

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

                                                                                                                                                                                                            -

                                                                                                                                                                                                               

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

                                                                                                                                                                                                            +

                                                                                                                                                                                                            Returns

                                                                                                                                                                                                            Object

                                                                                                                                                                                                            The object returned has two properties: row and column.

                                                                                                                                                                                                            +
                                                                                                                                                                                                              • EditSession.screenToDocumentRow(screenRow, screenColumn)
                                                                                                                                                                                                              • Internal
                                                                                                                                                                                                              • EditSession.setAnnotations(Array annotations)

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

                                                                                                                                                                                                              +

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

                                                                                                                                                                                                              Arguments

                                                                                                                                                                                                              annotationsArray

                                                                                                                                                                                                              Required. A list of annotations

                                                                                                                                                                                                              -

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

                                                                                                                                                                                                              -

                                                                                                                                                                                                                 

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

                                                                                                                                                                                                              +

                                                                                                                                                                                                              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

                                                                                                                                                                                                              rowNumber

                                                                                                                                                                                                              Required. A row index

                                                                                                                                                                                                              classNameString

                                                                                                                                                                                                              Required. Class of the breakpoint

                                                                                                                                                                                                              -
                                                                                                                                                                                                                • EditSession.setBreakpoints(Array rows)

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

                                                                                                                                                                                                                -

                                                                                                                                                                                                                   

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

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

                                                                                                                                                                                                                  rowsArray

                                                                                                                                                                                                                  Required. An array of row indicies

                                                                                                                                                                                                                  -

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

                                                                                                                                                                                                                  -

                                                                                                                                                                                                                     

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

                                                                                                                                                                                                                  +

                                                                                                                                                                                                                  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

                                                                                                                                                                                                                  docDocument

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

                                                                                                                                                                                                                  +

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

                                                                                                                                                                                                                  +

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

                                                                                                                                                                                                                  Arguments

                                                                                                                                                                                                                  modeTextMode

                                                                                                                                                                                                                  Required. Set a new text mode

                                                                                                                                                                                                                  -

                                                                                                                                                                                                                  Sets the new line mode.

                                                                                                                                                                                                                  +

                                                                                                                                                                                                                  Sets the new line mode.

                                                                                                                                                                                                                  Arguments

                                                                                                                                                                                                                  newLineModeString

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

                                                                                                                                                                                                                  -
                                                                                                                                                                                                                    • EditSession.setOverwrite(Boolean overwrite)

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

                                                                                                                                                                                                                    -

                                                                                                                                                                                                                       

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

                                                                                                                                                                                                                    +
                                                                                                                                                                                                                      • EditSession.setOverwrite(Boolean overwrite)

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

                                                                                                                                                                                                                      +

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

                                                                                                                                                                                                                      If overwrites is enabled, any text you enter will type over any text after it. If the value of overwrite changes, this function also emites the changeOverwrite event.

                                                                                                                                                                                                                      Arguments

                                                                                                                                                                                                                      overwriteBoolean

                                                                                                                                                                                                                      Required. Defines wheter or not to set overwrites

                                                                                                                                                                                                                      -
                                                                                                                                                                                                                        • EditSession.setScrollLeft(scrollLeft)

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

                                                                                                                                                                                                                        -

                                                                                                                                                                                                                           

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

                                                                                                                                                                                                                        -
                                                                                                                                                                                                                          • EditSession.setScrollTop(Number scrollTop)

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

                                                                                                                                                                                                                          -

                                                                                                                                                                                                                             

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

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

                                                                                                                                                                                                                              scrollTopNumber

                                                                                                                                                                                                                              Required. The new scroll top value

                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                • EditSession.setTabSize(Number tabSize)

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

                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                   

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

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

                                                                                                                                                                                                                                  tabSizeNumber

                                                                                                                                                                                                                                  Required. The new tab size

                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                  Sets the undo manager.

                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                     

                                                                                                                                                                                                                                  Sets the undo manager.

                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                  Sets the undo manager.

                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                  Sets the undo manager.

                                                                                                                                                                                                                                  Arguments

                                                                                                                                                                                                                                  undoManagerUndoManager

                                                                                                                                                                                                                                  Required. The new undo manager

                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                    • EditSession.setUndoSelect(Boolean enable)

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

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                       

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

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

                                                                                                                                                                                                                                      enableBoolean

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

                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                        • EditSession.setUseSoftTabs(Boolean useSoftTabs)

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

                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                           

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

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

                                                                                                                                                                                                                                          useSoftTabsBoolean

                                                                                                                                                                                                                                          Required. Value indicating whether or not to use soft tabs

                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                            • EditSession.setUseWorker(Boolean useWorker)

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

                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                               

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

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

                                                                                                                                                                                                                                              useWorkerBoolean

                                                                                                                                                                                                                                              Required. Set to true to use a worker

                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                • EditSession.setUseWrapMode(Boolean useWrapMode)

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

                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                   

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

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

                                                                                                                                                                                                                                                  useWrapModeBoolean

                                                                                                                                                                                                                                                  Required. Enable (or disable) wrap mode

                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                    • EditSession.setValue(String text)

                                                                                                                                                                                                                                                    Sets the session text.

                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                       

                                                                                                                                                                                                                                                    Sets the session text.

                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                      • EditSession.setValue(String text)

                                                                                                                                                                                                                                                      Sets the session text.

                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                      Sets the session text.

                                                                                                                                                                                                                                                      Arguments

                                                                                                                                                                                                                                                      textString

                                                                                                                                                                                                                                                      Required. The new text to place

                                                                                                                                                                                                                                                      -

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

                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                         

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

                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                      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

                                                                                                                                                                                                                                                      minNumber

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

                                                                                                                                                                                                                                                      maxNumber

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

                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                        • EditSession.stopWorker()
                                                                                                                                                                                                                                                        • Internal

                                                                                                                                                                                                                                                         

                                                                                                                                                                                                                                                        • EditSession.toggleOverwrite()

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

                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                           

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

                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                        Reverts previous changes to your document.

                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                           

                                                                                                                                                                                                                                                        Reverts previous changes to your document.

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

                                                                                                                                                                                                                                                          deltasArray

                                                                                                                                                                                                                                                          Required. An array of previous changes

                                                                                                                                                                                                                                                          dontSelectBoolean

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

                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                          - - - - - \ No newline at end of file +
                                                                                                                                                                                                                                                          \ No newline at end of file diff --git a/api/editor.html b/api/editor.html index dd7bae66..362697c2 100644 --- a/api/editor.html +++ b/api/editor.html @@ -1,342 +1,344 @@ - Editor - Ace API

                                                                                                                                                                                                                                                          Editor [edit]

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

                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                          Constructors

                                                                                                                                                                                                                                                          Creates a new Editor object.

                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                             

                                                                                                                                                                                                                                                          Creates a new Editor object.

                                                                                                                                                                                                                                                          + Editor - Ace API

                                                                                                                                                                                                                                                          The high performance code editor for the web.

                                                                                                                                                                                                                                                          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

                                                                                                                                                                                                                                                          rendererVirtualRenderer

                                                                                                                                                                                                                                                          Required. Associated VirtualRenderer that draws everything

                                                                                                                                                                                                                                                          sessionEditSession

                                                                                                                                                                                                                                                          Required. The EditSession to refer to

                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                          Events

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

                                                                                                                                                                                                                                                            Emitted once the editor has been blurred.

                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                               

                                                                                                                                                                                                                                                            Emitted once the editor has been blurred.

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

                                                                                                                                                                                                                                                              Emitted whenever the document is changed.

                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                 

                                                                                                                                                                                                                                                              Emitted whenever the document is changed.

                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                              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

                                                                                                                                                                                                                                                                  eObject

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

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

                                                                                                                                                                                                                                                                    Emitted when the selection changes.

                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                       

                                                                                                                                                                                                                                                                    Emitted when the selection changes.

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

                                                                                                                                                                                                                                                                      Emitted when the selection changes.

                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                      Emitted when the selection changes.

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

                                                                                                                                                                                                                                                                        Emitted whenever the EditSession changes.

                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                        Emitted whenever the EditSession changes.

                                                                                                                                                                                                                                                                        Arguments

                                                                                                                                                                                                                                                                        eObject

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

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

                                                                                                                                                                                                                                                                          Emitted when text is copied.

                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                             

                                                                                                                                                                                                                                                                          Emitted when text is copied.

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

                                                                                                                                                                                                                                                                            Emitted when text is copied.

                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                            Emitted when text is copied.

                                                                                                                                                                                                                                                                            Arguments

                                                                                                                                                                                                                                                                            textString

                                                                                                                                                                                                                                                                            Required. The copied text

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

                                                                                                                                                                                                                                                                              Emitted once the editor comes into focus.

                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                 

                                                                                                                                                                                                                                                                              Emitted once the editor comes into focus.

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

                                                                                                                                                                                                                                                                                Emitted when text is pasted.

                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                   

                                                                                                                                                                                                                                                                                Emitted when text is pasted.

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

                                                                                                                                                                                                                                                                                  Emitted once the editor comes into focus.

                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                  Emitted once the editor comes into focus.

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

                                                                                                                                                                                                                                                                                    Emitted when text is pasted.

                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                    Emitted when text is pasted.

                                                                                                                                                                                                                                                                                    Arguments

                                                                                                                                                                                                                                                                                    textString

                                                                                                                                                                                                                                                                                    Required. The pasted text

                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                    Methods

                                                                                                                                                                                                                                                                                      • Editor.$getSelectedRows()

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

                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                         

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

                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                                                        • Editor.$getSelectedRows()

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

                                                                                                                                                                                                                                                                                        +

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

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

                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                          • Editor.$getVisibleRowCount()

                                                                                                                                                                                                                                                                                          Returns the number of currently visibile rows.

                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                             

                                                                                                                                                                                                                                                                                          Returns the number of currently visibile rows.

                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                            • Editor.$highlightBrackets()
                                                                                                                                                                                                                                                                                            • Internal

                                                                                                                                                                                                                                                                                             

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

                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                             

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

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

                                                                                                                                                                                                                                                                                            moverFunction

                                                                                                                                                                                                                                                                                            Required. A method to call on each selected row

                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                              • Editor.$updateHighlightActiveLine()
                                                                                                                                                                                                                                                                                              • Internal

                                                                                                                                                                                                                                                                                               

                                                                                                                                                                                                                                                                                              • Editor.addSelectionMarker(Range orientedRange)

                                                                                                                                                                                                                                                                                              Adds the selection and cursor.

                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                 

                                                                                                                                                                                                                                                                                              Adds the selection and cursor.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                • Editor.$updateHighlightActiveLine()
                                                                                                                                                                                                                                                                                                • Internal
                                                                                                                                                                                                                                                                                                • Editor.addSelectionMarker(Range orientedRange)

                                                                                                                                                                                                                                                                                                Adds the selection and cursor.

                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                Adds the selection and cursor.

                                                                                                                                                                                                                                                                                                Arguments

                                                                                                                                                                                                                                                                                                orientedRangeRange

                                                                                                                                                                                                                                                                                                Required. A range containing a cursor

                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                Outdents the current line.

                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                   

                                                                                                                                                                                                                                                                                                Outdents the current line.

                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                  • Editor.blur()

                                                                                                                                                                                                                                                                                                  Blurs the current textInput.

                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                     

                                                                                                                                                                                                                                                                                                  Blurs the current textInput.

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

                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                    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.

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

                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                            Returns

                                                                                                                                                                                                                                                                                                            Number

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

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

                                                                                                                                                                                                                                                                                                                needleString

                                                                                                                                                                                                                                                                                                                Required. The text to search for (optional)

                                                                                                                                                                                                                                                                                                                optionsObject

                                                                                                                                                                                                                                                                                                                Required. An object defining various search properties

                                                                                                                                                                                                                                                                                                                animateBoolean

                                                                                                                                                                                                                                                                                                                Required. If true animate scrolling

                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                Finds and selects all the occurences of needle.

                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                   

                                                                                                                                                                                                                                                                                                                Finds and selects all the occurences of needle.

                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                Finds and selects all the occurences of needle.

                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                Finds and selects all the occurences of needle.

                                                                                                                                                                                                                                                                                                                Arguments

                                                                                                                                                                                                                                                                                                                needleString

                                                                                                                                                                                                                                                                                                                Required. The text to find

                                                                                                                                                                                                                                                                                                                optionsObject

                                                                                                                                                                                                                                                                                                                Required. The search options

                                                                                                                                                                                                                                                                                                                additiveBoolean

                                                                                                                                                                                                                                                                                                                Required. keeps

                                                                                                                                                                                                                                                                                                                -

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

                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                   

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

                                                                                                                                                                                                                                                                                                                +

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

                                                                                                                                                                                                                                                                                                                +

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

                                                                                                                                                                                                                                                                                                                Arguments

                                                                                                                                                                                                                                                                                                                optionsObject

                                                                                                                                                                                                                                                                                                                Required. search options

                                                                                                                                                                                                                                                                                                                animateBoolean

                                                                                                                                                                                                                                                                                                                Required. If true animate scrolling

                                                                                                                                                                                                                                                                                                                -

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

                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                   

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

                                                                                                                                                                                                                                                                                                                +

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

                                                                                                                                                                                                                                                                                                                +

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

                                                                                                                                                                                                                                                                                                                Arguments

                                                                                                                                                                                                                                                                                                                optionsObject

                                                                                                                                                                                                                                                                                                                Required. search options

                                                                                                                                                                                                                                                                                                                animateBoolean

                                                                                                                                                                                                                                                                                                                Required. If true animate scrolling

                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                  • Editor.focus()

                                                                                                                                                                                                                                                                                                                  Brings the current textInput into focus.

                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                     

                                                                                                                                                                                                                                                                                                                  Brings the current textInput into focus.

                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                  Executes a command for each selection range.

                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                     

                                                                                                                                                                                                                                                                                                                  Executes a command for each selection range.

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

                                                                                                                                                                                                                                                                                                                    cmdString

                                                                                                                                                                                                                                                                                                                    Required. The command to execute

                                                                                                                                                                                                                                                                                                                    argsString

                                                                                                                                                                                                                                                                                                                    Required. Any arguments for the command

                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                      • Editor.getBehavioursEnabled()

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

                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                         

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

                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                      Returns the string of text currently highlighted.

                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                         

                                                                                                                                                                                                                                                                                                                      Returns the string of text currently highlighted.

                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                      Gets the current position of the cursor.

                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                         

                                                                                                                                                                                                                                                                                                                      Gets the current position of the cursor.

                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                      Returns

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

                                                                                                                                                                                                                                                                                                                      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.

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

                                                                                                                                                                                                                                                                                                                                Object

                                                                                                                                                                                                                                                                                                                                This returns an object that looks something like this:

                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                • { row: currRow, column: currCol }
                                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                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

                                                                                                                                                                                                                                                                                                                                        lineNumberNumber

                                                                                                                                                                                                                                                                                                                                        Required. The line number to go to

                                                                                                                                                                                                                                                                                                                                        columnNumber

                                                                                                                                                                                                                                                                                                                                        Required. A column number to go to

                                                                                                                                                                                                                                                                                                                                        animateBoolean

                                                                                                                                                                                                                                                                                                                                        Required. If true animates scolling

                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                          • Editor.gotoPageDown()

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

                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                             

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

                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                            • Editor.gotoPageUp()

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

                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                               

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

                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                            Inserts text into wherever the cursor is pointing.

                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                               

                                                                                                                                                                                                                                                                                                                                            Inserts text into wherever the cursor is pointing.

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

                                                                                                                                                                                                                                                                                                                                                textString

                                                                                                                                                                                                                                                                                                                                                Required. The new text to add

                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                Returns true if the current textInput is in focus.

                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                   

                                                                                                                                                                                                                                                                                                                                                Returns true if the current textInput is in focus.

                                                                                                                                                                                                                                                                                                                                                -

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

                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                   

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

                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                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

                                                                                                                                                                                                                                                                                                                                                rowNumber

                                                                                                                                                                                                                                                                                                                                                Required. The row to check

                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                Indicates if the row is currently visible on the screen.

                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                   

                                                                                                                                                                                                                                                                                                                                                Indicates if the row is currently visible on the screen.

                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                Indicates if the row is currently visible on the screen.

                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                Indicates if the row is currently visible on the screen.

                                                                                                                                                                                                                                                                                                                                                Arguments

                                                                                                                                                                                                                                                                                                                                                rowNumber

                                                                                                                                                                                                                                                                                                                                                Required. The row to check

                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                  • Editor.jumpToMatching()

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

                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                     

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

                                                                                                                                                                                                                                                                                                                                                  -

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

                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                     

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

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

                                                                                                                                                                                                                                                                                                                                                    rowNumber

                                                                                                                                                                                                                                                                                                                                                    Required. The new row number

                                                                                                                                                                                                                                                                                                                                                    columnNumber

                                                                                                                                                                                                                                                                                                                                                    Required. The new column number

                                                                                                                                                                                                                                                                                                                                                    -

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

                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                       

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

                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    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

                                                                                                                                                                                                                                                                                                                                                    posObject

                                                                                                                                                                                                                                                                                                                                                    Required. An object with two properties, row and column

                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Shifts all the selected lines down one row.

                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                       

                                                                                                                                                                                                                                                                                                                                                    Shifts all the selected lines down one row.

                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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:

                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    Shifts all the selected lines down one row.

                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    Shifts all the selected lines down one row.

                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    Returns

                                                                                                                                                                                                                                                                                                                                                    Number

                                                                                                                                                                                                                                                                                                                                                    On success, it returns -1.

                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    Shifts all the selected lines up one row.

                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    Shifts all the selected lines up one row.

                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    Returns

                                                                                                                                                                                                                                                                                                                                                    Number

                                                                                                                                                                                                                                                                                                                                                    On success, it returns -1.

                                                                                                                                                                                                                                                                                                                                                    +

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

                                                                                                                                                                                                                                                                                                                                                    +

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

                                                                                                                                                                                                                                                                                                                                                    { row: newRowLocation, column: newColumnLocation }

                                                                                                                                                                                                                                                                                                                                                    Arguments

                                                                                                                                                                                                                                                                                                                                                    fromRangeRange

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

                                                                                                                                                                                                                                                                                                                                                    toPositionObject

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

                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Returns

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

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

                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                         

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

                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                      Returns

                                                                                                                                                                                                                                                                                                                                                      Range

                                                                                                                                                                                                                                                                                                                                                      The 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

                                                                                                                                                                                                                                                                                                                                                        timesNumber

                                                                                                                                                                                                                                                                                                                                                        Required. The number of times to change navigation

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                          • Editor.navigateFileEnd()

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

                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                             

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

                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                            • Editor.navigateFileStart()

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

                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                               

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

                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                              • Editor.navigateLeft(Number times)

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

                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                 

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

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

                                                                                                                                                                                                                                                                                                                                                                    timesNumber

                                                                                                                                                                                                                                                                                                                                                                    Required. The number of times to change navigation

                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                      • Editor.navigateLineEnd()

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

                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                         

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

                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                        • Editor.navigateLineStart()

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

                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                           

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

                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                          • Editor.navigateRight(Number times)

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

                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                             

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

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

                                                                                                                                                                                                                                                                                                                                                                                timesNumber

                                                                                                                                                                                                                                                                                                                                                                                Required. The number of times to change navigation

                                                                                                                                                                                                                                                                                                                                                                                -

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

                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                   

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

                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                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

                                                                                                                                                                                                                                                                                                                                                                                rowNumber

                                                                                                                                                                                                                                                                                                                                                                                Required. The new row number

                                                                                                                                                                                                                                                                                                                                                                                columnNumber

                                                                                                                                                                                                                                                                                                                                                                                Required. The new column number

                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                  • Editor.navigateUp(Number times)

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

                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                     

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

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

                                                                                                                                                                                                                                                                                                                                                                                    timesNumber

                                                                                                                                                                                                                                                                                                                                                                                    Required. The number of times to change navigation

                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                      • Editor.navigateWordLeft()

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

                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                         

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

                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                        • Editor.navigateWordRight()

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

                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                           

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

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

                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                            Called whenever a text "paste" happens.

                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                               

                                                                                                                                                                                                                                                                                                                                                                                            Called whenever a text "paste" happens.

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

                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                    Called whenever a text "paste" happens.

                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                    Called whenever a text "paste" happens.

                                                                                                                                                                                                                                                                                                                                                                                                    Arguments

                                                                                                                                                                                                                                                                                                                                                                                                    textString

                                                                                                                                                                                                                                                                                                                                                                                                    Required. The pasted text

                                                                                                                                                                                                                                                                                                                                                                                                    -

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

                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                       

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

                                                                                                                                                                                                                                                                                                                                                                                                    -

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

                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                       

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

                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                    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

                                                                                                                                                                                                                                                                                                                                                                                                    dirString

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

                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                    Removes all the lines in the current selection

                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                       

                                                                                                                                                                                                                                                                                                                                                                                                    Removes all the lines in the current selection

                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                      • Editor.removeSelectionMarker(Range range)

                                                                                                                                                                                                                                                                                                                                                                                                      Removes the selection marker.

                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                         

                                                                                                                                                                                                                                                                                                                                                                                                      Removes the selection marker.

                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                      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

                                                                                                                                                                                                                                                                                                                                                                                                        rangeRange

                                                                                                                                                                                                                                                                                                                                                                                                        Required. The selection range added with addSelectionMarker().

                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                          • Editor.removeToLineEnd()

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

                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                             

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

                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                            • Editor.removeToLineStart()

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

                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                               

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

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

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

                                                                                                                                                                                                                                                                                                                                                                                                                        replacementString

                                                                                                                                                                                                                                                                                                                                                                                                                        Required. The text to replace with

                                                                                                                                                                                                                                                                                                                                                                                                                        optionsObject

                                                                                                                                                                                                                                                                                                                                                                                                                        Required. The Search options to use

                                                                                                                                                                                                                                                                                                                                                                                                                        -

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

                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                           

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

                                                                                                                                                                                                                                                                                                                                                                                                                        +

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

                                                                                                                                                                                                                                                                                                                                                                                                                        +

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

                                                                                                                                                                                                                                                                                                                                                                                                                        Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                        replacementString

                                                                                                                                                                                                                                                                                                                                                                                                                        Required. The text to replace with

                                                                                                                                                                                                                                                                                                                                                                                                                        optionsObject

                                                                                                                                                                                                                                                                                                                                                                                                                        Required. The Search options to use

                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                        Triggers a resize of the editor.

                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                        Triggers a resize of the editor.

                                                                                                                                                                                                                                                                                                                                                                                                                        Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                        forceBoolean

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

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

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

                                                                                                                                                                                                                                                                                                                                                                                                                                lineNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                Required. The line to scroll to

                                                                                                                                                                                                                                                                                                                                                                                                                                centerBoolean

                                                                                                                                                                                                                                                                                                                                                                                                                                Required. If true

                                                                                                                                                                                                                                                                                                                                                                                                                                animateBoolean

                                                                                                                                                                                                                                                                                                                                                                                                                                Required. If true animates scrolling

                                                                                                                                                                                                                                                                                                                                                                                                                                callbackFunction

                                                                                                                                                                                                                                                                                                                                                                                                                                Required. Function to be called when the animation has finished

                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                Moves the editor to the specified row.

                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                Moves the editor to the specified row.

                                                                                                                                                                                                                                                                                                                                                                                                                                Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                rowNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                Required. The row to move to

                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                Selects all the text in editor.

                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                   

                                                                                                                                                                                                                                                                                                                                                                                                                                Selects all the text in editor.

                                                                                                                                                                                                                                                                                                                                                                                                                                -

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

                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                   

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

                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                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

                                                                                                                                                                                                                                                                                                                                                                                                                                dirNumber

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

                                                                                                                                                                                                                                                                                                                                                                                                                                skipBoolean

                                                                                                                                                                                                                                                                                                                                                                                                                                Required. If true, removes the active selection range

                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                Adds a cursor above or below the active cursor.

                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                   

                                                                                                                                                                                                                                                                                                                                                                                                                                Adds a cursor above or below the active cursor.

                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                Adds a cursor above or below the active cursor.

                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                Adds a cursor above or below the active cursor.

                                                                                                                                                                                                                                                                                                                                                                                                                                Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                dirNumber

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

                                                                                                                                                                                                                                                                                                                                                                                                                                skipBoolean

                                                                                                                                                                                                                                                                                                                                                                                                                                Required. If true, removes the active selection range

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

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

                                                                                                                                                                                                                                                                                                                                                                                                                                            enabledBoolean

                                                                                                                                                                                                                                                                                                                                                                                                                                            Required. Enables or disables behaviors

                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                              • Editor.setDragDelay(Number dragDelay)

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

                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                 

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

                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                • Editor.setDragDelay(Number dragDelay)

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                +

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                dragDelayNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                Required. A value indicating the new delay

                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Editor.setFontSize(Number size)

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                     

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

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                    sizeNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                    Required. A font size

                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Editor.setHighlightActiveLine(Boolean shouldHighlight)

                                                                                                                                                                                                                                                                                                                                                                                                                                                      Determines whether or not the current line should be highlighted.

                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                         

                                                                                                                                                                                                                                                                                                                                                                                                                                                      Determines whether or not the current line should be highlighted.

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                        shouldHighlightBoolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required. Set to true to highlight the current line

                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Editor.setHighlightSelectedWord(Boolean shouldHighlight)

                                                                                                                                                                                                                                                                                                                                                                                                                                                          Determines if the currently selected word should be highlighted.

                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                             

                                                                                                                                                                                                                                                                                                                                                                                                                                                          Determines if the currently selected word should be highlighted.

                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Editor.setHighlightSelectedWord(Boolean shouldHighlight)

                                                                                                                                                                                                                                                                                                                                                                                                                                                            Determines if the currently selected word should be highlighted.

                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                            Determines if the currently selected word should be highlighted.

                                                                                                                                                                                                                                                                                                                                                                                                                                                            Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                            shouldHighlightBoolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                            Required. Set to true to highlight the currently selected word

                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Editor.setKeyboardHandler(keyboardHandler)

                                                                                                                                                                                                                                                                                                                                                                                                                                                              Sets a new keyboard handler.

                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                 

                                                                                                                                                                                                                                                                                                                                                                                                                                                              Sets a new keyboard handler.

                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                 

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

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                overwriteBoolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                Required. Defines wheter or not to set overwrites

                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Editor.setPrintMarginColumn(Number showPrintMargin)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Sets the column defining where the print margin should be.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                     

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Sets the column defining where the print margin should be.

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    showPrintMarginNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Required. Specifies the new print margin

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Editor.setReadOnly(Boolean readOnly)

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                         

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

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        readOnlyBoolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required. Specifies whether the editor can be modified or not

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Editor.setScrollSpeed(Number speed)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Sets how fast the mouse scrolling should do.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                             

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Sets how fast the mouse scrolling should do.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Editor.setScrollSpeed(Number speed)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Sets how fast the mouse scrolling should do.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Sets how fast the mouse scrolling should do.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            speedNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Required. A value indicating the new speed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Editor.setSelectionStyle(String style)

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 

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

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                styleString

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Required. The new selection style

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                sessionEditSession

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Required. The new session to use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Editor.setShowFoldWidgets(Boolean show)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Indicates whether the fold widgets are shown or not.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Indicates whether the fold widgets are shown or not.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Editor.setShowFoldWidgets(Boolean show)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Indicates whether the fold widgets are shown or not.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Indicates whether the fold widgets are shown or not.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    showBoolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Required. Specifies whether the fold widgets are shown

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Editor.setShowInvisibles(Boolean showInvisibles)

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         

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

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        showInvisiblesBoolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required. Specifies whether or not to show invisible characters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Editor.setShowPrintMargin(Boolean showPrintMargin)

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             

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

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            showPrintMarginBoolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Required. Specifies whether or not to show the print margin

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Adds a new class, style, to the editor.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Adds a new class, style, to the editor.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Adds a new class, style, to the editor.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Adds a new class, style, to the editor.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            styleString

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Required. A class name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            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 a new theme for the editor. theme should exist, and be a directory path, like ace/theme/textmate.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            themeString

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Required. The path to a theme

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Sets the current document to val.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Sets the current document to val.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            valString

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Required. The new value to set for the document

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cursorPosNumber

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Editor.splitLine()

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Editor.toggleCommentLines()

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                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.

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    dirNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Required. The direction to rotate selections

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Removes the class style from the editor.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Removes the class style from the editor.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Editor.updateSelectionMarkers()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Updates the cursor and marker layers.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Updates the cursor and marker layers.

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      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 a4e4af82..32e65c8f 100644 --- a/api/index.html +++ b/api/index.html @@ -1,14 +1,7 @@ - Ace API

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Ace API Reference

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + Ace API

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The high performance code editor for the web.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        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/placeholder.html b/api/placeholder.html index 549bb2b6..45e7601e 100644 --- a/api/placeholder.html +++ b/api/placeholder.html @@ -1,34 +1,27 @@ - PlaceHolder - Ace API

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        PlaceHolder [edit]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        TODO

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        TODO

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        TODO

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + PlaceHolder - Ace API

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The high performance code editor for the web.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        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 +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      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 diff --git a/api/range.html b/api/range.html index af0dbdbe..9ed3122e 100644 --- a/api/range.html +++ b/api/range.html @@ -1,107 +1,300 @@ - Range - Ace API

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Range [edit]

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Constructors

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + Range - Ace API

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The high performance code editor for the web.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    startRowNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Required. The starting row

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    startColumnNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Required. The starting column

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    endRowNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Required. The ending row

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    endColumnNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Required. The ending column

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Methods

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    firstRowNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Required. The starting row

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    lastRowNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Required. The ending row

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns a duplicate of the calling range.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns a duplicate of the calling range.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Range.collapseRows()

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        rowNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required. A row point to compare with

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        columnNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required. A column point to compare with

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns

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

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

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

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        This 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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        rowNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required. A row point to compare with

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        columnNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required. A column point to compare with

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns

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

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Number

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


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • 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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        rowNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required. A row point to compare with

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        columnNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required. A column point to compare with

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns

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

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

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        This 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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        pRange

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required. A point to compare with

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns

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

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

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

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        This 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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        rangeRange

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required. A range to compare with

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        NumberThis method returns one of the following numbers:

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

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        This 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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        rowNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required. A row point to compare with

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        columnNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required. A column point to compare with

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        NumberThis method returns one of the following numbers:

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

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

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

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        This method returns one of the following numbers:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +


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


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • If the starting row of the calling range is equal to p.row, and:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • p.column is greater than or equal to the calling range's starting column, this returns 0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Otherwise, it returns -1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • +


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • If the ending row of the calling range is equal to p.row, and:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • p.column is less than or equal to the calling range's ending column, this returns 0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Otherwise, it returns 1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

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

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        rowNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required. A row to check for

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        columnNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required. A column to check for

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Checks the start and end points of range and compares them to the calling range. Returns true if the range is contained within the caller's range.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Checks the start and end points of range and compares them to the calling range. Returns true if the range is contained within the caller's range.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        rangeRange

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required. A range to compare with

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Changes the row and column points for the calling range for both the starting and ending points. This method returns that range with a new row.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Changes the row and column points for the calling range for both the starting and ending points. This method returns that range with a new row.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        rowNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required. A new row to extend to

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        columnNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required. A new column to extend to

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        startRange

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required. A starting point to use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        endRange

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required. An ending point to use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        rowNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required. A row point to compare with

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        columnNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required. A column point to compare with

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        rowNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required. A row point to compare with

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        columnNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required. A column point to compare with

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        rowNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required. A row point to compare with

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        columnNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required. A column point to compare with

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        rangeRange

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required. A range to compare with

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns true if the caller's ending row point is the same as row, and if the caller's ending column is the same as column.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns true if the caller's ending row point is the same as row, and if the caller's ending column is the same as column.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        rowNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required. A row point to compare with

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        columnNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required. A column point to compare with

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        rangeRange

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required. A range to check against

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns true if the range spans across multiple lines.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns true if the range spans across multiple lines.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns true if the caller's starting row point is the same as row, and if the caller's starting column is the same as column.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns true if the caller's starting row point is the same as row, and if the caller's starting column is the same as column.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        rowNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required. A row point to compare with

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        columnNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required. A column point to compare with

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Sets the starting row and column for the range.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Sets the starting row and column for the range.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Sets the starting row and column for the range.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Sets the starting row and column for the range.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        rowNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required. A row point to set

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        columnNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required. A column point to set

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Sets the starting row and column for the range.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Sets the starting row and column for the range.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Sets the starting row and column for the range.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Sets the starting row and column for the range.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        rowNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required. A row point to set

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        columnNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required. A column point to set

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        sessionEditSession

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required. The EditSession to retrieve coordinates from

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        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]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        - - - - - \ No newline at end of file +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/api/renderloop.html b/api/renderloop.html index 45f68085..19626ea2 100644 --- a/api/renderloop.html +++ b/api/renderloop.html @@ -1,13 +1,6 @@ - RenderLoop - Ace API

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        RenderLoop [edit]

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • new RenderLoop(onRender, win)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Internal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • RenderLoop.schedule(Array change)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Internal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        changeArray

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        - - - - - \ No newline at end of file + RenderLoop - Ace API

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The high performance code editor for the web.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        RenderLoop [edit]

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • new RenderLoop(onRender, win)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Internal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • RenderLoop.schedule(Array change)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Internal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        changeArray

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/api/resources/csses/ace_api.css b/api/resources/csses/ace_api.css index 16af81f2..83c8e8f7 100644 --- a/api/resources/csses/ace_api.css +++ b/api/resources/csses/ace_api.css @@ -146,6 +146,14 @@ blockquote p{ Menu venue */ +form.navbar-search { + float: none; +} + +h3.api_title { + padding-top: 10px; +} + ul.menu { margin-left: 16px; } @@ -227,7 +235,6 @@ ul.menu { box-shadow: 0 1px 4px 0 rgba(0, 0, 0, 0.35); */ padding-bottom: 15px; /* height: 31px;*/ - top: 40px; position: fixed; } .shadow.members{ @@ -275,7 +282,7 @@ ul.menu { .srolled .membersContent { /*top : 0;*/ width : 695px; - padding-left : 305px; + padding-left : 407px; margin : 0 auto 0 auto; } .membersBackground { @@ -532,7 +539,6 @@ header.filler { } #documentation article.article { -/* border-bottom: 1px solid #e9e9e9;*/ border-top: 1px solid #e9e9e9; padding: 16px 10px 2px; } @@ -773,9 +779,32 @@ li.signature { font-size: 24px; margin-top: 5px; } -#documentation h3.methodToggle { - margin: 0; +#documentation i.methodToggle { + cursor: pointer; + color: #9f9f9f; + padding-top: 5px; + float: left; } +#documentation i.methodToggle.methodToggleHover { + text-shadow: 0 0 10px #4699d5; + color: #4699d5; +} +#documentation i.methodToggle.active { + text-shadow: 0 0 10px #4699d5; + color: #4699d5; + /* Safari */ + -webkit-transform: rotate(45deg); + + /* Firefox */ + -moz-transform: rotate(45deg); + + /* IE */ + -ms-transform: rotate(45deg); + + /* Opera */ + -o-transform: rotate(45deg); +} + #documentation h3.sectionHeader { margin: 10px 0 17px 0; line-height : 24px; diff --git a/api/resources/csses/prettify.css b/api/resources/csses/prettify.css deleted file mode 100644 index 2cd13649..00000000 --- a/api/resources/csses/prettify.css +++ /dev/null @@ -1,52 +0,0 @@ -/* Pretty printing styles. Used with prettify.js. */ - -/* SPAN elements with the classes below are added by prettyprint. */ -.pln { color: #000 } /* plain text */ - -@media screen { - .str { color: #2e6a40 } /* string content */ - .kwd { color: #214afc } /* a keyword */ - .com { color: #4c886b } /* a comment */ - .typ { color: #1130ad } /* a type name */ - .lit { color: #1130ad } /* a literal value */ - /* punctuation, lisp open bracket, lisp close bracket */ - .pun, .opn, .clo { color: #2d0603 } - .tag { color: #008 } /* a markup tag name */ - .atn { color: #606 } /* a markup attribute name */ - .atv { color: #080 } /* a markup attribute value */ - .dec, .var { color: #606 } /* a declaration; a variable name */ - .fun { color: #1130ad } /* a function name */ -} - -/* Use higher contrast and text-weight for printable form. */ -@media print, projection { - .str { color: #060 } - .kwd { color: #006; font-weight: bold } - .com { color: #600; font-style: italic } - .typ { color: #404; font-weight: bold } - .lit { color: #044 } - .pun, .opn, .clo { color: #440 } - .tag { color: #006; font-weight: bold } - .atn { color: #404 } - .atv { color: #060 } -} - -/* Put a border around prettyprinted code snippets. */ -/*pre.prettyprint { padding: 2px; }*/ - -/* Specify class=linenums on a pre to get line numbering */ -ol.linenums { margin-top: 0; margin-bottom: 0 } /* IE indents via margin-left */` -li.L0, -li.L1, -li.L2, -li.L3, -li.L5, -li.L6, -li.L7, -li.L8 { list-style-type: none } -/* Alternate shading for lines */ -li.L1, -li.L3, -li.L5, -li.L7, -li.L9 { background: #eee } diff --git a/api/resources/javascripts/clicker.js b/api/resources/javascripts/clicker.js index 5fe3dca2..3ee3c64d 100644 --- a/api/resources/javascripts/clicker.js +++ b/api/resources/javascripts/clicker.js @@ -1,7 +1,7 @@ -$(function() { +$(document).ready(function () { // when hovering over arrow, add highlight (only if inactive) - $("h3.methodToggle").hover(function () { - if (!$("h3.methodToggle").hasClass('active')) + $("i.methodToggle").hover(function () { + if (!$("i.methodToggle").hasClass('active')) $(this).addClass("methodToggleHover"); }, function () { @@ -10,26 +10,45 @@ $(function() { ); // after expanding the hidden description, hide the ellipsis - $('.signature-call, .signature-returns', '.signature').click(function() { + $("i.methodToggle").click(function() { var $article = $(this).closest('.article'), - $arrow = $('h3.methodClicker', $article); + $arrow = $('i.methodClicker', $article); if (!$article.hasClass('methodToggleOpen') || this.force) { $article.addClass('methodToggleOpen'); $arrow.removeClass('inactive').addClass('active'); - var data = location.hash = $arrow[0].id.replace(/^js_/, ""); + var data = $arrow[0].id.replace(/^js_/, ""); + location.hash = data + "#nav=api"; scrollTo(null, data); } else { $article.removeClass('methodToggleOpen'); $arrow.removeClass('active').addClass('inactive'); } - - }); + }); + + $('.signature-call, .signature-returns', '.signature').click(function() { + var $article = $(this).closest('.article'), + $arrow = $('i.methodClicker', $article); + + if (!$article.hasClass('methodToggleOpen') || this.force) { + $article.addClass('methodToggleOpen'); + $arrow.removeClass('inactive').addClass('active'); + + var data = $arrow[0].id.replace(/^js_/, ""); + location.hash = data + "#nav=api"; + scrollTo(null, data); + } + else { + $article.removeClass('methodToggleOpen'); + $arrow.removeClass('active').addClass('inactive'); + } + }); $('.related-to', '.metaInfo').click(function(){ location.hash = $(this).find('a').attr('href').split('#')[1]; }); + }); diff --git a/api/resources/javascripts/disqus-ext.js b/api/resources/javascripts/disqus-ext.js index 6f966cc6..81a21f61 100644 --- a/api/resources/javascripts/disqus-ext.js +++ b/api/resources/javascripts/disqus-ext.js @@ -7,6 +7,6 @@ var disqus_identifier = fileName; (function() { var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true; - dsq.src = 'http://' + disqus_shortname + '.disqus.com/embed.js'; + dsq.src = 'https://' + disqus_shortname + '.disqus.com/embed.js'; (document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq); })(); \ No newline at end of file diff --git a/api/resources/javascripts/ux.js b/api/resources/javascripts/ux.js index 58b1d358..b1685551 100644 --- a/api/resources/javascripts/ux.js +++ b/api/resources/javascripts/ux.js @@ -11,15 +11,6 @@ $(function () { $selNavLink.addClass('currentItem'); } - // init prettyprint - $('pre > code').addClass('prettyprint'); - prettyPrint(); - - var baseTitle = document.title, - // base (general) part of title - pathName = window.location.pathname, - fileName = pathName.substring(window.location.pathname.lastIndexOf("/") + 1); - if (window.addEventListener) window.addEventListener('load', loadCallback, true); else window.attachEvent('load', loadCallback, true); @@ -31,7 +22,6 @@ $(function () { if (query) { input.value = ""; input.blur(); - var currentVersion = $('#currentVersion').text(); var url = "https://www.google.com/search?q=" + encodeURIComponent("site:ace.ajax.org/api" + " " + query); window.open(url); } @@ -79,11 +69,10 @@ $(document).ready(function () { else sx = 0; $('.members').each(function (i) { - var position = $(this).position(); var $classContent = $(this).closest('.classContent'); $(this).scrollspy({ - min: $classContent.position().top - 35, + min: $classContent.position().top + 5, max: $classContent.position().top + $classContent.height() - 35, onEnter: function (element, position) { var $pagination = $(element); @@ -94,8 +83,7 @@ $(document).ready(function () { $paginationContent.css('top', 0); $pagination.addClass('shadow').stop().css({ - height: 31, - 'top': 33 + height: 31 }).closest('.classContent').addClass('srolled'); $tabs.addClass('tabsSansBorder'); @@ -133,7 +121,7 @@ $(document).ready(function () { }); }); - $('span.methodClicker, article.article, h3.methodClicker').each(function () { + /*$('span.methodClicker, article.article, i.methodClicker').each(function () { var a = $(this); var constructorPos = a.attr("id").indexOf("new "); @@ -144,28 +132,21 @@ $(document).ready(function () { } a.attr("id", objName); - }); + });*/ - $('.brand').parent('.dropdown').hover( - function () { - $(this).addClass('open'); - }, function () { - clearMenus(); - }); - - $('.versions').hover( - - function () { - $(this).addClass('open'); - }, function () { - clearMenus(); - }); function showMethodContent() { if (!location.hash) return; - var $clickerEl = $('span#' + location.hash.replace(/^#/, '').replace(/\./g, '\\.')); + var locationHash = location.hash.replace(/^#/, '').replace(/\./g, '\\.'); + var equalsPos = location.hash.indexOf("="); + + if (equalsPos >=0) { + locationHash = locationHash.substring(0, location.hash.indexOf("=")); + } + + var $clickerEl = $('span#' + locationHash); if ($clickerEl.length > 0 && $clickerEl.hasClass('methodClicker')) { var p = $clickerEl.parent(); p[0].force = true; diff --git a/api/scrollbar.html b/api/scrollbar.html index 9753245e..5cf46366 100644 --- a/api/scrollbar.html +++ b/api/scrollbar.html @@ -1,29 +1,22 @@ - ScrollBar - Ace API

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ScrollBar [edit]

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Constructors

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + ScrollBar - Ace API

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The high performance code editor for the web.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        parentDOMElement

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required. A DOM element

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Events

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Emitted when the scroll bar, well, scrolls.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Emitted when the scroll bar, well, scrolls.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Events

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Emitted when the scroll bar, well, scrolls.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Emitted when the scroll bar, well, scrolls.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            eObject

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns the width of the scroll bar.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns the width of the scroll bar.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • ScrollBar.setHeight(Number height)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Sets the height of the scroll bar, in pixels.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Sets the height of the scroll bar, in pixels.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                heightNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Required. The new height

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • ScrollBar.setInnerHeight(Number height)

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     

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

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    heightNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Required. The new inner height

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • ScrollBar.setScrollTop(Number scrollTop)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Sets the scroll top of the scroll bar.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Sets the scroll top of the scroll bar.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • ScrollBar.setScrollTop(Number scrollTop)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Sets the scroll top of the scroll bar.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Sets the scroll top of the scroll bar.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        scrollTopNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required. 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 deace184..2e51d956 100644 --- a/api/search.html +++ b/api/search.html @@ -1,9 +1,9 @@ - Search - Ace API

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Search [edit]

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • new Search()

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + Search - Ace API

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The high performance code editor for the web.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Search [edit]

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • new Search()

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • needle: The string or regular expression you're looking for
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • backwards: Whether to search backwards from where cursor currently is. Defaults to false.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • @@ -15,27 +15,24 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • start: The starting Range or cursor position to begin the search
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • skipCurrent: Whether or not to include the current line in the search. Default to false.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            sessionEditSession

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Required. The session to search with

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            sessionEditSession

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Required. The session to search with

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns an object containing all the search options.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns an object containing all the search options.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns an object containing all the search options.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns an object containing all the search options.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            inputString

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Required. The text to search in

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            replacementString

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Required. The replacing text

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Sets the search options via the options parameter.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Sets the search options via the options parameter.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            String

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            If options.regExp is true, this function returns input with the replacement already made. Otherwise, this function just returns replacement.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • If options.needle was not found, this function returns null.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Sets the search options via the options parameter.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Sets the search options via the options parameter.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            optionsObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Required. An object containing all the new search properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            - - - - - \ No newline at end of file +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            \ No newline at end of file diff --git a/api/selection.html b/api/selection.html index 4b24dcac..d045e4e5 100644 --- a/api/selection.html +++ b/api/selection.html @@ -1,133 +1,126 @@ - Selection - Ace API

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Selection [edit]

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + Selection - Ace API

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The high performance code editor for the web.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Selection [edit]

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

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Creates a new Selection object.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Creates a new Selection object.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Creates a new Selection object.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Creates a new Selection object.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            sessionEditSession

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Required. The session to use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Events

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Emitted when the cursor position changes.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Emitted when the cursor position changes.

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Emitted when the cursor selection changes.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Emitted when the cursor selection changes.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Events

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Emitted when the cursor position changes.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Emitted when the cursor position changes.

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Emitted when the cursor selection changes.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Emitted when the cursor selection changes.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Methods

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    rangeRange

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Required. The new range to add

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    $blockChangeEventsBoolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Required. Whether or not to block changing events

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Selection.clearSelection()

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Gets the current position of the cursor.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Gets the current position of the cursor.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Selection.getRange()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns the Range for the selected text.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns the Range for the selected text.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Selection.getSelectionLead()

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns true if the selection is empty.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns true if the selection is empty.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns true if the selection is a multi-line.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns true if the selection is a multi-line.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Selection.mergeOverlappingRanges()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Merges overlapping ranges ensuring consistency after changes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Merges overlapping ranges ensuring consistency after changes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Selection.clearSelection()

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Gets the current position of the cursor.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Gets the current position of the cursor.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Selection.getRange()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns the Range for the selected text.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns the Range for the selected text.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Selection.getSelectionLead()

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns true if the selection is empty.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns true if the selection is empty.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns true if the selection is a multi-line.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns true if the selection is a multi-line.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Selection.mergeOverlappingRanges()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Merges overlapping ranges ensuring consistency after changes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Merges overlapping ranges ensuring consistency after changes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    rowsNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Required. The number of rows to move by

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    charsNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Required. The number of characters to move by

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Selection.moveCursorDown()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Moves the cursor down one row.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Moves the cursor down one row.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Selection.moveCursorFileEnd()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Moves the cursor to the end of the file.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Moves the cursor to the end of the file.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Selection.moveCursorFileStart()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Moves the cursor to the start of the file.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Moves the cursor to the start of the file.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Selection.moveCursorLeft()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Moves the cursor left one column.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Moves the cursor left one column.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Selection.moveCursorLineEnd()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Moves the cursor to the end of the line.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Moves the cursor to the end of the line.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Selection.moveCursorLineStart()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Moves the cursor to the start of the line.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Moves the cursor to the start of the line.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Selection.moveCursorLongWordLeft()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Moves the cursor to the word on the left.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Moves the cursor to the word on the left.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Selection.moveCursorLongWordRight()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Moves the cursor to the word on the right.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Moves the cursor to the word on the right.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Selection.moveCursorRight()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Moves the cursor right one column.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Moves the cursor right one column.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Selection.moveCursorDown()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Moves the cursor down one row.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Moves the cursor down one row.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Selection.moveCursorFileEnd()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Moves the cursor to the end of the file.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Moves the cursor to the end of the file.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Selection.moveCursorFileStart()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Moves the cursor to the start of the file.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Moves the cursor to the start of the file.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Selection.moveCursorLeft()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Moves the cursor left one column.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Moves the cursor left one column.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Selection.moveCursorLineEnd()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Moves the cursor to the end of the line.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Moves the cursor to the end of the line.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Selection.moveCursorLineStart()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Moves the cursor to the start of the line.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Moves the cursor to the start of the line.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Selection.moveCursorLongWordLeft()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Moves the cursor to the word on the left.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Moves the cursor to the word on the left.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Selection.moveCursorLongWordRight()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Moves the cursor to the word on the right.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Moves the cursor to the word on the right.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Selection.moveCursorRight()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Moves the cursor right one column.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Moves the cursor right one column.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        rowNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required. The row to move to

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        columnNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required. The column to move to

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        keepDesiredColumnBoolean

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Selection.moveCursorToPosition(Object position)

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Selection.moveCursorToPosition(Object position)

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            positionObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Required. The position to move to

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            rowNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Required. The row to move to

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            columnNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Required. The column to move to

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            keepDesiredColumnBoolean

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Selection.moveCursorUp()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Moves the cursor up one row.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Moves the cursor up one row.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Gets list of ranges composing rectangular block on the screen

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Gets list of ranges composing rectangular block on the screen

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Selection.moveCursorUp()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Moves the cursor up one row.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Moves the cursor up one row.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Gets list of ranges composing rectangular block on the screen

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Gets list of ranges composing rectangular block on the screen

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                screenCursorCursor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Required. The cursor to use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                screenAnchorAnchor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Required. The anchor to use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                includeEmptyLinesBoolean

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Selection.selectAll()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Selects all the text in the document.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Selects all the text in the document.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Selects a word, including its right whitespace.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Selects a word, including its right whitespace.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Selection.selectDown()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Moves the selection down one row.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Moves the selection down one row.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Selection.selectFileEnd()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Moves the selection to the end of the file.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Moves the selection to the end of the file.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Selection.selectFileStart()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Moves the selection to the start of the file.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Moves the selection to the start of the file.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Selection.selectLeft()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Moves the selection left one column.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Moves the selection left one column.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Selection.selectLine()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Selects the entire line.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Selects the entire line.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Selection.selectLineEnd()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Moves the selection to the end of the current line.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Moves the selection to the end of the current line.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Selection.selectLineStart()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Moves the selection to the beginning of the current line.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Moves the selection to the beginning of the current line.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Selection.selectRight()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Moves the selection right one column.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Moves the selection right one column.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Moves the selection cursor to the indicated row and column.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Moves the selection cursor to the indicated row and column.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Selection.selectAll()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Selects all the text in the document.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Selects all the text in the document.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Selects a word, including its right whitespace.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Selects a word, including its right whitespace.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Selection.selectDown()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Moves the selection down one row.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Moves the selection down one row.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Selection.selectFileEnd()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Moves the selection to the end of the file.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Moves the selection to the end of the file.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Selection.selectFileStart()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Moves the selection to the start of the file.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Moves the selection to the start of the file.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Selection.selectLeft()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Moves the selection left one column.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Moves the selection left one column.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Selection.selectLine()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Selects the entire line.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Selects the entire line.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Selection.selectLineEnd()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Moves the selection to the end of the current line.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Moves the selection to the end of the current line.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Selection.selectLineStart()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Moves the selection to the beginning of the current line.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Moves the selection to the beginning of the current line.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Selection.selectRight()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Moves the selection right one column.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Moves the selection right one column.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Moves the selection cursor to the indicated row and column.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Moves the selection cursor to the indicated row and column.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    rowNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Required. The row to select to

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    columnNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Required. The column to select to

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Selection.selectToPosition(Object pos)

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Selection.selectToPosition(Object pos)

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        posObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required. An object containing the row and column

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Selection.selectUp()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Moves the selection up one row.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Moves the selection up one row.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Moves the selection to highlight the entire word.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Moves the selection to highlight the entire word.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Selection.selectWordLeft()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Moves the selection to the first word on the left.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Moves the selection to the first word on the left.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Selection.selectWordRight()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Moves the selection to the first word on the right.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Moves the selection to the first word on the right.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Selection.selectUp()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Moves the selection up one row.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Moves the selection up one row.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Moves the selection to highlight the entire word.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Moves the selection to highlight the entire word.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Selection.selectWordLeft()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Moves the selection to the first word on the left.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Moves the selection to the first word on the left.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Selection.selectWordRight()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Moves the selection to the first word on the right.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Moves the selection to the first word on the right.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    rowNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Required. The new row

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    columnNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Required. The new column

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Sets the selection to the provided range.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Sets the selection to the provided range.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Sets the selection to the provided range.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Sets the selection to the provided range.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    rangeRange

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Required. The range of text to select

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    reverseBoolean

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Selection.shiftSelection(Number columns)

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Selection.shiftSelection(Number columns)

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        columnsNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required. The number of columns to shift by

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Removes a Range containing pos (if it exists).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Removes a Range containing pos (if it exists).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Removes a Range containing pos (if it exists).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Removes a Range containing pos (if it exists).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        posRange

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        - - - - - \ No newline at end of file +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/api/split.html b/api/split.html index d3d6d206..c9d0ec90 100644 --- a/api/split.html +++ b/api/split.html @@ -1,46 +1,39 @@ - Split - Ace API

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Split [edit]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        containerDocument

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required. The document to associate with the split

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + Split - Ace API

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The high performance code editor for the web.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Split [edit]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        containerDocument

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required. The document to associate with the split

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        themeString

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required. The name of the initial theme

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        splitsNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required. The number of initial splits

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Blurs the current editor.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Blurs the current editor.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Focuses the current editor.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Focuses the current editor.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Executes callback on all of the available editors.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Executes callback on all of the available editors.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Blurs the current editor.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Blurs the current editor.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Focuses the current editor.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Focuses the current editor.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Executes callback on all of the available editors.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Executes callback on all of the available editors.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        callbackFunction

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required. A callback function to execute

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        scopeString

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Split.getCurrentEditor()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns the current editor.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns the current editor.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns the editor identified by the index idx.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns the editor identified by the index idx.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Split.getCurrentEditor()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns the current editor.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns the current editor.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns the editor identified by the index idx.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns the editor identified by the index idx.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            idxNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Required. The index of the editor you want

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Internal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns the orientation.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns the orientation.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns the number of splits.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns the number of splits.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Split.resize()
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Internal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Internal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns the orientation.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns the orientation.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns the number of splits.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns the number of splits.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Split.resize()
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Internal

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            sizeNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Required. The new font size

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            keybindingString

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Required.

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Sets the orientation.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Sets the orientation.

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            keybindingString

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Required.

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Sets the orientation.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Sets the orientation.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            oriantationNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Required.

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            splitsNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Required. The new number of splits

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Sets a theme for each of the available editors.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Sets a theme for each of the available editors.

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            splitsNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Required. The new number of splits

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Sets a theme for each of the available editors.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Sets a theme for each of the available editors.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            themeString

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Required. The name of the theme to set

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Split.UndoManagerProxy()
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Internal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            - - - - - \ No newline at end of file +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Split.UndoManagerProxy()
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Void
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Internal
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            \ No newline at end of file diff --git a/api/token_iterator.html b/api/token_iterator.html index 99d71067..77f2e0f2 100644 --- a/api/token_iterator.html +++ b/api/token_iterator.html @@ -1,27 +1,21 @@ - TokenIterator - Ace API

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            TokenIterator [edit]

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Constructors

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + TokenIterator - Ace API

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The high performance code editor for the web.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            TokenIterator [edit]

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Constructors

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            sessionEditSession

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Required. The session to associate with

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            initialRowNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Required. The row to start the tokenizing at

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            initialColumnNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Required. The column to start the tokenizing at

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • TokenIterator.getCurrentToken()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns the current tokenized string.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns the current tokenized string.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • TokenIterator.getCurrentTokenColumn()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns the current column.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns the current column.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • TokenIterator.getCurrentTokenRow()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns the current row.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns the current row.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • TokenIterator.stepBackward()

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns

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

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         

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

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • TokenIterator.getCurrentToken()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns the current tokenized string.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns the current tokenized string.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • TokenIterator.getCurrentTokenColumn()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns the current column.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns the current column.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • TokenIterator.getCurrentTokenRow()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns the current row.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns the current row.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • TokenIterator.stepBackward()

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              String

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              If the current point is not at the top of the file, this function returns null. Otherwise, it returns an array of the tokenized strings.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • TokenIterator.stepForward()

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file diff --git a/api/tokenizer.html b/api/tokenizer.html index d7b979cb..7ba61563 100644 --- a/api/tokenizer.html +++ b/api/tokenizer.html @@ -1,18 +1,11 @@ - Tokenizer - Ace API

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Tokenizer [edit]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Constructors

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                + Tokenizer - Ace API

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The high performance code editor for the web.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Tokenizer [edit]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Constructors

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                rulesObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Required. The highlighting rules

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                flagString

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Tokenizer.getLineTokens()

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     

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

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Tokenizer.getLineTokens()

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/api/undomanager.html b/api/undomanager.html index aed3394c..340c9d8d 100644 --- a/api/undomanager.html +++ b/api/undomanager.html @@ -1,33 +1,26 @@ - UndoManager - Ace API

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    UndoManager [edit]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    This object maintains the undo stack for an EditSession.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • new UndoManager()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Resets the current undo state and creates a new UndoManager.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Resets the current undo state and creates a new UndoManager.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • UndoManager.execute(Object options)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Void

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + UndoManager - Ace API

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The high performance code editor for the web.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        UndoManager [edit]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        This object maintains the undo stack for an EditSession.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • new UndoManager()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Resets the current undo state and creates a new UndoManager.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Resets the current undo state and creates a new UndoManager.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • UndoManager.execute(Object options)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Void

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • args[0] is an array of deltas
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • args[1] is the document to associate with

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            optionsObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Required. Contains additional properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns true if there are redo operations left to perform.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns true if there are redo operations left to perform.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns true if there are undo operations left to perform.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns true if there are undo operations left to perform.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • UndoManager.redo(Boolean dontSelect)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Void

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns true if there are redo operations left to perform.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns true if there are redo operations left to perform.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns true if there are undo operations left to perform.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns true if there are undo operations left to perform.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • UndoManager.redo(Boolean dontSelect)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Void

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                dontSelectBoolean

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • UndoManager.reset()
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Destroys the stack of undo and redo redo operations.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Destroys the stack of undo and redo redo operations.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • UndoManager.reset()
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Destroys the stack of undo and redo redo operations.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Destroys the stack of undo and redo redo operations.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    dontSelectBoolean

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    - - - - - \ No newline at end of file +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/api/virtual_renderer.html b/api/virtual_renderer.html index e2f92bfc..d2418df0 100644 --- a/api/virtual_renderer.html +++ b/api/virtual_renderer.html @@ -1,163 +1,156 @@ - VirtualRenderer - Ace API

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    VirtualRenderer [edit]

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Constructors

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + VirtualRenderer - Ace API

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The high performance code editor for the web.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    VirtualRenderer [edit]

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Constructors

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    containerDOMElement

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Required. The root element of the editor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    themeString

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Required. The starting theme

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • VirtualRenderer.addGutterDecoration(row, className)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Deprecated

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Deprecated; (moved to EditSession)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Deprecated; (moved to EditSession)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • VirtualRenderer.adjustWrapLimit()

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • VirtualRenderer.destroy()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Destroys the text and cursor layers for this renderer.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Destroys the text and cursor layers for this renderer.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • VirtualRenderer.getAnimatedScroll()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns whether an animated scroll happens or not.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns whether an animated scroll happens or not.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns the root element containing this renderer.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns the root element containing this renderer.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • VirtualRenderer.getFirstFullyVisibleRow()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns the index of the first fully visible row. "Fully" here means that the characters in the row are not truncated; that the top and the bottom of the row are on the screen.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns the index of the first fully visible row. "Fully" here means that the characters in the row are not truncated; that the top and the bottom of the row are on the screen.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • VirtualRenderer.getFirstVisibleRow()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns the index of the first visible row.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns the index of the first visible row.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • VirtualRenderer.getHScrollBarAlwaysVisible()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns whether the horizontal scrollbar is set to be always visible.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns whether the horizontal scrollbar is set to be always visible.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • VirtualRenderer.getLastFullyVisibleRow()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns the index of the last fully visible row. "Fully" here means that the characters in the row are not truncated; that the top and the bottom of the row are on the screen.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns the index of the last fully visible row. "Fully" here means that the characters in the row are not truncated; that the top and the bottom of the row are on the screen.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • VirtualRenderer.getLastVisibleRow()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns the index of the last visible row.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns the index of the last visible row.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns the element that the mouse events are attached to

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns the element that the mouse events are attached to

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • VirtualRenderer.getPrintMarginColumn()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns whether the print margin column is being shown or not.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns whether the print margin column is being shown or not.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • VirtualRenderer.getScrollBottomRow()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns the last visible row, regardless of whether it's fully visible or not.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns the last visible row, regardless of whether it's fully visible or not.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        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.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        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.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • VirtualRenderer.getScrollTopRow()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns the first visible row, regardless of whether it's fully visible or not.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns the first visible row, regardless of whether it's fully visible or not.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • VirtualRenderer.getShowGutter()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns true if the gutter is being shown.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns true if the gutter is being shown.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • VirtualRenderer.getShowInvisibles()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns whether invisible characters are being shown or not.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns whether invisible characters are being shown or not.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • VirtualRenderer.getShowPrintMargin()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns whetherthe print margin is being shown or not.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns whetherthe print margin is being shown or not.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • VirtualRenderer.getTheme()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns the path of the current theme.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns the path of the current theme.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • VirtualRenderer.hideComposition()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Hides the current composition.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Hides the current composition.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • VirtualRenderer.hideCursor()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Hides the cursor icon.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Hides the cursor icon.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • VirtualRenderer.addGutterDecoration(row, className)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Deprecated

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Deprecated; (moved to EditSession)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Deprecated; (moved to EditSession)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • VirtualRenderer.adjustWrapLimit()

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • VirtualRenderer.destroy()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Destroys the text and cursor layers for this renderer.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Destroys the text and cursor layers for this renderer.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • VirtualRenderer.getAnimatedScroll()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns whether an animated scroll happens or not.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns whether an animated scroll happens or not.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns the root element containing this renderer.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns the root element containing this renderer.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • VirtualRenderer.getFirstFullyVisibleRow()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns the index of the first fully visible row. "Fully" here means that the characters in the row are not truncated; that the top and the bottom of the row are on the screen.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns the index of the first fully visible row. "Fully" here means that the characters in the row are not truncated; that the top and the bottom of the row are on the screen.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • VirtualRenderer.getFirstVisibleRow()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns the index of the first visible row.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns the index of the first visible row.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • VirtualRenderer.getHScrollBarAlwaysVisible()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns whether the horizontal scrollbar is set to be always visible.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns whether the horizontal scrollbar is set to be always visible.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • VirtualRenderer.getLastFullyVisibleRow()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns the index of the last fully visible row. "Fully" here means that the characters in the row are not truncated; that the top and the bottom of the row are on the screen.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns the index of the last fully visible row. "Fully" here means that the characters in the row are not truncated; that the top and the bottom of the row are on the screen.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • VirtualRenderer.getLastVisibleRow()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns the index of the last visible row.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns the index of the last visible row.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns the element that the mouse events are attached to

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns the element that the mouse events are attached to

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • VirtualRenderer.getPrintMarginColumn()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns whether the print margin column is being shown or not.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns whether the print margin column is being shown or not.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • VirtualRenderer.getScrollBottomRow()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns the last visible row, regardless of whether it's fully visible or not.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns the last visible row, regardless of whether it's fully visible or not.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          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.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          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.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • VirtualRenderer.getScrollTopRow()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns the first visible row, regardless of whether it's fully visible or not.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns the first visible row, regardless of whether it's fully visible or not.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • VirtualRenderer.getShowGutter()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns true if the gutter is being shown.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns true if the gutter is being shown.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • VirtualRenderer.getShowInvisibles()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns whether invisible characters are being shown or not.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns whether invisible characters are being shown or not.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • VirtualRenderer.getShowPrintMargin()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns whetherthe print margin is being shown or not.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns whetherthe print margin is being shown or not.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • VirtualRenderer.getTheme()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns the path of the current theme.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns the path of the current theme.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • VirtualRenderer.hideComposition()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Hides the current composition.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Hides the current composition.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • VirtualRenderer.hideCursor()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Hides the cursor icon.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Hides the cursor icon.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        deltaXNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required. The x value to scroll by

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        deltaYNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required. The y value to scroll by

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Triggers a resize of the editor.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Triggers a resize of the editor.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Triggers a resize of the editor.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Triggers a resize of the editor.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        forceBoolean

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        gutterWidthNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required. The width of the gutter in pixels

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        widthNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required. The width of the editor in pixels

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        heightNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required. The hiehgt of the editor, in pixels

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Deprecated; (moved to EditSession)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Deprecated; (moved to EditSession)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           

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

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Deprecated; (moved to EditSession)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Deprecated; (moved to EditSession)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        deltaXNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required. The x value to scroll by

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        deltaYNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required. The y value to scroll by

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • VirtualRenderer.scrollCursorIntoView(cursor, offset)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Scrolls the cursor into the first visibile area of the editor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Scrolls the cursor into the first visibile area of the editor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Gracefully scrolls the editor to the row indicated.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Gracefully scrolls the editor to the row indicated.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • VirtualRenderer.scrollCursorIntoView(cursor, offset)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Scrolls the cursor into the first visibile area of the editor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Scrolls the cursor into the first visibile area of the editor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Gracefully scrolls the editor to the row indicated.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Gracefully scrolls the editor to the row indicated.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            lineNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Required. A line number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            centerBoolean

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            animateBoolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Required. If true animates scrolling

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            callbackFunction

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Required. Function to be called after the animation has finished

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            rowNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Required. A row id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Scrolls the editor to the x pixel indicated.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Scrolls the editor to the x pixel indicated.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Scrolls the editor to the x pixel indicated.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Scrolls the editor to the x pixel indicated.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            scrollLeftNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Required. The position to scroll to

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Scrolls the editor to the y pixel indicated.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Scrolls the editor to the y pixel indicated.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Scrolls the editor to the y pixel indicated.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Scrolls the editor to the y pixel indicated.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            scrollTopNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Required. The position to scroll to

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • VirtualRenderer.setAnimatedScroll(Boolean shouldAnimate)

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • VirtualRenderer.setAnimatedScroll(Boolean shouldAnimate)

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                shouldAnimateBoolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Required. Set to true to show animated scrolls

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • VirtualRenderer.setAnnotations(Array annotations)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Sets annotations for the gutter.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Sets annotations for the gutter.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • VirtualRenderer.setAnnotations(Array annotations)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Sets annotations for the gutter.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Sets annotations for the gutter.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    annotationsArray

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Required. An array containing annotations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • VirtualRenderer.setCompositionText(String text)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Sets the inner text of the current composition to text.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Sets the inner text of the current composition to text.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • VirtualRenderer.setCompositionText(String text)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Sets the inner text of the current composition to text.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Sets the inner text of the current composition to text.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        textString

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required. A string of text to use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • VirtualRenderer.setHScrollBarAlwaysVisible(Boolean alwaysVisible)

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • VirtualRenderer.setHScrollBarAlwaysVisible(Boolean alwaysVisible)

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            alwaysVisibleBoolean

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • VirtualRenderer.setPadding(Number padding)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Sets the padding for all the layers.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Sets the padding for all the layers.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • VirtualRenderer.setPadding(Number padding)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Sets the padding for all the layers.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Sets the padding for all the layers.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                paddingNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Required. A new padding value (in pixels)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • VirtualRenderer.setPrintMarginColumn(Boolean showPrintMargin)

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • VirtualRenderer.setPrintMarginColumn(Boolean showPrintMargin)

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    showPrintMarginBoolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Required. Set to true to show the print margin column

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • VirtualRenderer.setShowGutter(Boolean show)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Identifies whether you want to show the gutter or not.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Identifies whether you want to show the gutter or not.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • VirtualRenderer.setShowGutter(Boolean show)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Identifies whether you want to show the gutter or not.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Identifies whether you want to show the gutter or not.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        showBoolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required. Set to true to show the gutter

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • VirtualRenderer.setShowInvisibles(Boolean showInvisibles)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Identifies whether you want to show invisible characters or not.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Identifies whether you want to show invisible characters or not.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • VirtualRenderer.setShowInvisibles(Boolean showInvisibles)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Identifies whether you want to show invisible characters or not.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Identifies whether you want to show invisible characters or not.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            showInvisiblesBoolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Required. Set to true to show invisibles

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • VirtualRenderer.setShowPrintMargin(Boolean showPrintMargin)

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • VirtualRenderer.setShowPrintMargin(Boolean showPrintMargin)

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                showPrintMarginBoolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Required. Set to true to show the print margin

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • VirtualRenderer.setStyle(String style)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Adds a new class, style, to the editor.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Adds a new class, style, to the editor.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • VirtualRenderer.setStyle(String style)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Adds a new class, style, to the editor.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Adds a new class, style, to the editor.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    styleString

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Required. A class name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • VirtualRenderer.setTheme(String theme)

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • VirtualRenderer.setTheme(String theme)

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        themeString

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required. The path to a theme

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • VirtualRenderer.showComposition(Number position)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Internal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        positionNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • VirtualRenderer.showCursor()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Shows the cursor icon.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Shows the cursor icon.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • VirtualRenderer.showComposition(Number position)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Internal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          positionNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Required.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • VirtualRenderer.showCursor()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Shows the cursor icon.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Shows the cursor icon.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            rowNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Required. The document row position

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            columnNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Required. The document column position

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • VirtualRenderer.unsetStyle(String style)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Removes the class style from the editor.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Removes the class style from the editor.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • VirtualRenderer.unsetStyle(String style)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Removes the class style from the editor.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Removes the class style from the editor.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                styleString

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Required. A class name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • VirtualRenderer.updateBackMarkers()

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • VirtualRenderer.updateBreakpoints()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Redraw breakpoints.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Redraw breakpoints.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • VirtualRenderer.updateCursor()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Updates the cursor icon.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Updates the cursor icon.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • VirtualRenderer.updateFontSize()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Updates the font size.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Updates the font size.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • VirtualRenderer.updateFrontMarkers()

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • VirtualRenderer.updateFull(Boolean force)

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • VirtualRenderer.updateBackMarkers()

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • VirtualRenderer.updateBreakpoints()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Redraw breakpoints.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Redraw breakpoints.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • VirtualRenderer.updateCursor()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Updates the cursor icon.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Updates the cursor icon.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • VirtualRenderer.updateFontSize()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Updates the font size.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Updates the font size.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • VirtualRenderer.updateFrontMarkers()

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • VirtualRenderer.updateFull(Boolean force)

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        forceBoolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required. If true, forces the changes through

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

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             

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

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

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Arguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            firstRowNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Required. The first row to update

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            lastRowNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Required. The last row to update

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • VirtualRenderer.updateText()

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • VirtualRenderer.visualizeBlur()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Blurs the current container.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Blurs the current container.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • VirtualRenderer.visualizeFocus()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Focuses the current container.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Focuses the current container.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  - - - - - \ No newline at end of file +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • VirtualRenderer.updateText()

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • VirtualRenderer.visualizeBlur()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Blurs the current container.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Blurs the current container.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • VirtualRenderer.visualizeFocus()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Focuses the current container.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Focuses the current container.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/doc/build.js b/doc/build.js index fcc6f599..c2b1db95 100644 --- a/doc/build.js +++ b/doc/build.js @@ -18,7 +18,8 @@ var options = { assets : "./resources/ace/skeleton", additionalObjs : "./additionalObjs.json", exclude : ["**/*_test.js", "**/mode/**", "**/test/**", "**/theme/**", "**/worker/**"], - index : "./index.md" + index : "./index.md", + disableTests: true }; files = [srcPath]; @@ -28,7 +29,7 @@ panino.parse(files, options, function (err, ast) { console.error(err); process.exit(1); } - + panino.render('html', ast, options, function (err) { if (err) { console.error(err); diff --git a/doc/resources/ace/skeleton/csses/ace_api.css b/doc/resources/ace/skeleton/csses/ace_api.css index 16af81f2..83c8e8f7 100644 --- a/doc/resources/ace/skeleton/csses/ace_api.css +++ b/doc/resources/ace/skeleton/csses/ace_api.css @@ -146,6 +146,14 @@ blockquote p{ Menu venue */ +form.navbar-search { + float: none; +} + +h3.api_title { + padding-top: 10px; +} + ul.menu { margin-left: 16px; } @@ -227,7 +235,6 @@ ul.menu { box-shadow: 0 1px 4px 0 rgba(0, 0, 0, 0.35); */ padding-bottom: 15px; /* height: 31px;*/ - top: 40px; position: fixed; } .shadow.members{ @@ -275,7 +282,7 @@ ul.menu { .srolled .membersContent { /*top : 0;*/ width : 695px; - padding-left : 305px; + padding-left : 407px; margin : 0 auto 0 auto; } .membersBackground { @@ -532,7 +539,6 @@ header.filler { } #documentation article.article { -/* border-bottom: 1px solid #e9e9e9;*/ border-top: 1px solid #e9e9e9; padding: 16px 10px 2px; } @@ -773,9 +779,32 @@ li.signature { font-size: 24px; margin-top: 5px; } -#documentation h3.methodToggle { - margin: 0; +#documentation i.methodToggle { + cursor: pointer; + color: #9f9f9f; + padding-top: 5px; + float: left; } +#documentation i.methodToggle.methodToggleHover { + text-shadow: 0 0 10px #4699d5; + color: #4699d5; +} +#documentation i.methodToggle.active { + text-shadow: 0 0 10px #4699d5; + color: #4699d5; + /* Safari */ + -webkit-transform: rotate(45deg); + + /* Firefox */ + -moz-transform: rotate(45deg); + + /* IE */ + -ms-transform: rotate(45deg); + + /* Opera */ + -o-transform: rotate(45deg); +} + #documentation h3.sectionHeader { margin: 10px 0 17px 0; line-height : 24px; diff --git a/doc/resources/ace/skeleton/csses/prettify.css b/doc/resources/ace/skeleton/csses/prettify.css deleted file mode 100644 index 2cd13649..00000000 --- a/doc/resources/ace/skeleton/csses/prettify.css +++ /dev/null @@ -1,52 +0,0 @@ -/* Pretty printing styles. Used with prettify.js. */ - -/* SPAN elements with the classes below are added by prettyprint. */ -.pln { color: #000 } /* plain text */ - -@media screen { - .str { color: #2e6a40 } /* string content */ - .kwd { color: #214afc } /* a keyword */ - .com { color: #4c886b } /* a comment */ - .typ { color: #1130ad } /* a type name */ - .lit { color: #1130ad } /* a literal value */ - /* punctuation, lisp open bracket, lisp close bracket */ - .pun, .opn, .clo { color: #2d0603 } - .tag { color: #008 } /* a markup tag name */ - .atn { color: #606 } /* a markup attribute name */ - .atv { color: #080 } /* a markup attribute value */ - .dec, .var { color: #606 } /* a declaration; a variable name */ - .fun { color: #1130ad } /* a function name */ -} - -/* Use higher contrast and text-weight for printable form. */ -@media print, projection { - .str { color: #060 } - .kwd { color: #006; font-weight: bold } - .com { color: #600; font-style: italic } - .typ { color: #404; font-weight: bold } - .lit { color: #044 } - .pun, .opn, .clo { color: #440 } - .tag { color: #006; font-weight: bold } - .atn { color: #404 } - .atv { color: #060 } -} - -/* Put a border around prettyprinted code snippets. */ -/*pre.prettyprint { padding: 2px; }*/ - -/* Specify class=linenums on a pre to get line numbering */ -ol.linenums { margin-top: 0; margin-bottom: 0 } /* IE indents via margin-left */` -li.L0, -li.L1, -li.L2, -li.L3, -li.L5, -li.L6, -li.L7, -li.L8 { list-style-type: none } -/* Alternate shading for lines */ -li.L1, -li.L3, -li.L5, -li.L7, -li.L9 { background: #eee } diff --git a/doc/resources/ace/skeleton/javascripts/clicker.js b/doc/resources/ace/skeleton/javascripts/clicker.js index 5fe3dca2..3ee3c64d 100644 --- a/doc/resources/ace/skeleton/javascripts/clicker.js +++ b/doc/resources/ace/skeleton/javascripts/clicker.js @@ -1,7 +1,7 @@ -$(function() { +$(document).ready(function () { // when hovering over arrow, add highlight (only if inactive) - $("h3.methodToggle").hover(function () { - if (!$("h3.methodToggle").hasClass('active')) + $("i.methodToggle").hover(function () { + if (!$("i.methodToggle").hasClass('active')) $(this).addClass("methodToggleHover"); }, function () { @@ -10,26 +10,45 @@ $(function() { ); // after expanding the hidden description, hide the ellipsis - $('.signature-call, .signature-returns', '.signature').click(function() { + $("i.methodToggle").click(function() { var $article = $(this).closest('.article'), - $arrow = $('h3.methodClicker', $article); + $arrow = $('i.methodClicker', $article); if (!$article.hasClass('methodToggleOpen') || this.force) { $article.addClass('methodToggleOpen'); $arrow.removeClass('inactive').addClass('active'); - var data = location.hash = $arrow[0].id.replace(/^js_/, ""); + var data = $arrow[0].id.replace(/^js_/, ""); + location.hash = data + "#nav=api"; scrollTo(null, data); } else { $article.removeClass('methodToggleOpen'); $arrow.removeClass('active').addClass('inactive'); } - - }); + }); + + $('.signature-call, .signature-returns', '.signature').click(function() { + var $article = $(this).closest('.article'), + $arrow = $('i.methodClicker', $article); + + if (!$article.hasClass('methodToggleOpen') || this.force) { + $article.addClass('methodToggleOpen'); + $arrow.removeClass('inactive').addClass('active'); + + var data = $arrow[0].id.replace(/^js_/, ""); + location.hash = data + "#nav=api"; + scrollTo(null, data); + } + else { + $article.removeClass('methodToggleOpen'); + $arrow.removeClass('active').addClass('inactive'); + } + }); $('.related-to', '.metaInfo').click(function(){ location.hash = $(this).find('a').attr('href').split('#')[1]; }); + }); diff --git a/doc/resources/ace/skeleton/javascripts/disqus-ext.js b/doc/resources/ace/skeleton/javascripts/disqus-ext.js index 6f966cc6..81a21f61 100644 --- a/doc/resources/ace/skeleton/javascripts/disqus-ext.js +++ b/doc/resources/ace/skeleton/javascripts/disqus-ext.js @@ -7,6 +7,6 @@ var disqus_identifier = fileName; (function() { var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true; - dsq.src = 'http://' + disqus_shortname + '.disqus.com/embed.js'; + dsq.src = 'https://' + disqus_shortname + '.disqus.com/embed.js'; (document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq); })(); \ No newline at end of file diff --git a/doc/resources/ace/skeleton/javascripts/ux.js b/doc/resources/ace/skeleton/javascripts/ux.js index 58b1d358..b1685551 100644 --- a/doc/resources/ace/skeleton/javascripts/ux.js +++ b/doc/resources/ace/skeleton/javascripts/ux.js @@ -11,15 +11,6 @@ $(function () { $selNavLink.addClass('currentItem'); } - // init prettyprint - $('pre > code').addClass('prettyprint'); - prettyPrint(); - - var baseTitle = document.title, - // base (general) part of title - pathName = window.location.pathname, - fileName = pathName.substring(window.location.pathname.lastIndexOf("/") + 1); - if (window.addEventListener) window.addEventListener('load', loadCallback, true); else window.attachEvent('load', loadCallback, true); @@ -31,7 +22,6 @@ $(function () { if (query) { input.value = ""; input.blur(); - var currentVersion = $('#currentVersion').text(); var url = "https://www.google.com/search?q=" + encodeURIComponent("site:ace.ajax.org/api" + " " + query); window.open(url); } @@ -79,11 +69,10 @@ $(document).ready(function () { else sx = 0; $('.members').each(function (i) { - var position = $(this).position(); var $classContent = $(this).closest('.classContent'); $(this).scrollspy({ - min: $classContent.position().top - 35, + min: $classContent.position().top + 5, max: $classContent.position().top + $classContent.height() - 35, onEnter: function (element, position) { var $pagination = $(element); @@ -94,8 +83,7 @@ $(document).ready(function () { $paginationContent.css('top', 0); $pagination.addClass('shadow').stop().css({ - height: 31, - 'top': 33 + height: 31 }).closest('.classContent').addClass('srolled'); $tabs.addClass('tabsSansBorder'); @@ -133,7 +121,7 @@ $(document).ready(function () { }); }); - $('span.methodClicker, article.article, h3.methodClicker').each(function () { + /*$('span.methodClicker, article.article, i.methodClicker').each(function () { var a = $(this); var constructorPos = a.attr("id").indexOf("new "); @@ -144,28 +132,21 @@ $(document).ready(function () { } a.attr("id", objName); - }); + });*/ - $('.brand').parent('.dropdown').hover( - function () { - $(this).addClass('open'); - }, function () { - clearMenus(); - }); - - $('.versions').hover( - - function () { - $(this).addClass('open'); - }, function () { - clearMenus(); - }); function showMethodContent() { if (!location.hash) return; - var $clickerEl = $('span#' + location.hash.replace(/^#/, '').replace(/\./g, '\\.')); + var locationHash = location.hash.replace(/^#/, '').replace(/\./g, '\\.'); + var equalsPos = location.hash.indexOf("="); + + if (equalsPos >=0) { + locationHash = locationHash.substring(0, location.hash.indexOf("=")); + } + + var $clickerEl = $('span#' + locationHash); if ($clickerEl.length > 0 && $clickerEl.hasClass('methodClicker')) { var p = $clickerEl.parent(); p[0].force = true; diff --git a/doc/resources/ace/templates/ace_menu.jade b/doc/resources/ace/templates/ace_menu.jade old mode 100755 new mode 100644 index d325887c..7bf9599a --- a/doc/resources/ace/templates/ace_menu.jade +++ b/doc/resources/ace/templates/ace_menu.jade @@ -1,61 +1,59 @@ div#well - - h3 Ace Reference - - div.swirl_divider + form(id='searchbox', action='', class='navbar-search') + input(class='search-query span3', name='query', type='text', placeholder="Search the API", title="Search across all the documentation") ul.menu li div.menu-item - a(class="menuLink namespace", href="ace.html") Ace + a(class="menuLink namespace", href="ace.html#nav=api") Ace li div.menu-item - a(class="menuLink namespace", href="anchor.html") Anchor + a(class="menuLink namespace", href="anchor.html#nav=api") Anchor li div.menu-item - a(class="menuLink namespace", href="background_tokenizer.html") BackgroundTokenizer + a(class="menuLink namespace", href="background_tokenizer.html#nav=api") BackgroundTokenizer li div.menu-item - a(class="menuLink namespace", href="document.html") Document + a(class="menuLink namespace", href="document.html#nav=api") Document li div.menu-item - a(class="menuLink namespace", href="edit_session.html") EditSession + a(class="menuLink namespace", href="edit_session.html#nav=api") EditSession li div.menu-item - a(class="menuLink namespace", href="editor.html") Editor + a(class="menuLink namespace", href="editor.html#nav=api") Editor - //- probably not needing doc a(class="menuLink namespace", href="multi_select.html") MultiSelect + //- probably not needing doc a(class="menuLink namespace", href="multi_select.html#nav=api") MultiSelect - //- not actually doc'ed yet a(class="menuLink namespace", href="placeholder.html") PlaceHolder + //- not actually doc'ed yet a(class="menuLink namespace", href="placeholder.html#nav=api") PlaceHolder li div.menu-item - a(class="menuLink namespace", href="range.html") Range + a(class="menuLink namespace", href="range.html#nav=api") Range - //- not actually doc'ed yet a(class="menuLink namespace", href="renderloop.html") RenderLoop + //- not actually doc'ed yet a(class="menuLink namespace", href="renderloop.html#nav=api") RenderLoop li div.menu-item - a(class="menuLink namespace", href="scrollbar.html") Scrollbar + a(class="menuLink namespace", href="scrollbar.html#nav=api") Scrollbar li div.menu-item - a(class="menuLink namespace", href="search.html") Search + a(class="menuLink namespace", href="search.html#nav=api") Search li div.menu-item - a(class="menuLink namespace", href="selection.html") Selection + a(class="menuLink namespace", href="selection.html#nav=api") Selection - //- not actually doc'ed yet a(class="menuLink namespace", href="split.html") Split + //- not actually doc'ed yet a(class="menuLink namespace", href="split.html#nav=api") Split li div.menu-item - a(class="menuLink namespace", href="token_iterator.html") TokenIterator + a(class="menuLink namespace", href="token_iterator.html#nav=api") TokenIterator li div.menu-item - a(class="menuLink namespace", href="tokenizer.html") Tokenizer + a(class="menuLink namespace", href="tokenizer.html#nav=api") Tokenizer li div.menu-item - a(class="menuLink namespace", href="undomanager.html") UndoManager + a(class="menuLink namespace", href="undomanager.html#nav=api") UndoManager li div.menu-item - a(class="menuLink namespace", href="virtual_renderer.html") VirtualRenderer \ No newline at end of file + a(class="menuLink namespace", href="virtual_renderer.html#nav=api") VirtualRenderer \ No newline at end of file diff --git a/doc/resources/ace/templates/layout.jade b/doc/resources/ace/templates/layout.jade index 88847947..705f686c 100644 --- a/doc/resources/ace/templates/layout.jade +++ b/doc/resources/ace/templates/layout.jade @@ -4,27 +4,46 @@ include lib mixin doctype html(xmlns="http://www.w3.org/1999/xhtml") - head - mixin head - - body - mixin navBar - #nonFooter - #wrapper - .content - .row.centerpiece - .span3#sidebarContainer - #sidebar - include ace_menu.jade - .span9#mainContent - #documentation - -if (isIndex) - != content - -else - mixin api() - - div(id="disqus_thread") - .push - mixin footer - - mixin endingScripts \ No newline at end of file + head + mixin head + + body + #wrapper + .content + .column2 + #top_container.collapse + h1 The high performance code editor for the web. + #page_logo + img(src='doc/site/images/logo.png') + div(style='clear: both;') + ul#tabnav.nav.nav-pills + li + a(href='/') + img(src='.//resources/images/ace_logo_menu.png') + li + a(href='../index.html#nav=about', data-toggle='tab') About + li + a(href='../index.html#nav=embedding', data-toggle='tab') Embedding Guide + li + a(href='../index.html#nav=howto', data-toggle='tab') How-To Guide + li.active + a(href='index.html') API Reference + li + a(href='../index.html#nav=production', data-toggle='tab') ACE in Production + li + a(href='../index.html#nav=support', data-toggle='tab') Support + .tab-content + .row.centerpiece + .span3#sidebarContainer + #sidebar + include ace_menu.jade + .span9#mainContent + #documentation + -if (isIndex) + != content + -else + mixin api() + + div(id="disqus_thread") + + mixin endingScripts \ No newline at end of file diff --git a/doc/resources/ace/templates/lib.jade b/doc/resources/ace/templates/lib.jade index 5c3e0ac5..ed5f9f6e 100644 --- a/doc/resources/ace/templates/lib.jade +++ b/doc/resources/ace/templates/lib.jade @@ -77,6 +77,7 @@ mixin article(obj, parents) .memberContent if obj.signatures div.title + i(id='#{obj.path}', class='methodToggle methodClicker inactive icon-caret-right') ul.signatures -var loops = 0; for sig in obj.signatures @@ -131,8 +132,7 @@ mixin article(obj, parents) div(id='ellipsis_#{obj.path}', class='ellipsis_description') mixin markdown(obj.short_description) - h3(id='#{obj.path}', class='methodToggle methodClicker inactive') -     + div.description mixin markdown(obj.description) @@ -174,7 +174,7 @@ mixin article(obj, parents) h3.sectionHeader Events mixin article(child, parents.concat(obj), 'event') - for child in obj.children.filter(function(x){return x.type === 'class method'}) + for child in obj.children.filter(function(x){return x.type === 'class method'}) - if (!methodSection) - methodSection = true h3.sectionHeader Methods diff --git a/doc/resources/common_layout.jade b/doc/resources/common_layout.jade index fb19e158..137bc570 100644 --- a/doc/resources/common_layout.jade +++ b/doc/resources/common_layout.jade @@ -1,86 +1,58 @@ -var dirPrefix = "./"; +-var sitePrefix = "../doc/site/"; -var landingPage = 'false' -var versions = [] mixin doctype - !!! 5 + !!! 5 - - - - + + + + mixin head - meta(charset="utf-8") - //- N.B. http://blog.yjl.im/2011/01/bad-value-x-ua-compatible-for-attribute.html - meta(http-equiv="X-UA-Compatible", content="IE=edge,chrome=1") + meta(http-equiv='Content-Type', content='text/html; charset=UTF-8') - -if (isIndex) - title #{title} - -else - title #{classId} - #{title} + -if (isIndex) + title #{title} + -else + title #{classId} - #{title} - meta(name="generator", content="c9-doc-build") - meta(name="description", content="Ace API documentation for the online code editor.") - meta(name="author", content="Garen J. Torikian") + meta(name="generator", content="panino-doc-build") + meta(name="description", content="Ace API documentation for the online code editor") + meta(name="author", content="Garen J. Torikian") - meta(name="viewport", content="width=device-width,initial-scale=1") + script(src="#{dirPrefix}resources/javascripts/jquery.js") + script(src='#{sitePrefix}/js/main.js') + link(rel='stylesheet', media='all and (max-device-width: 480px)', href='doc/site/iphone.css') + link(rel='stylesheet', media='all and (min-device-width: 481px) and (max-device-width: 1024px)', href='doc/site/iphone.css') + link(href='#{dirPrefix}resources/ace/skeleton/images/favicon.ico', rel='icon', type='image/x-icon') - link(rel="stylesheet", href="#{dirPrefix}resources/csses/bootstrap.min.css") - link(rel="stylesheet", href="#{dirPrefix}resources/csses/prettify.css") - link(rel="stylesheet", href="#{dirPrefix}resources/csses/ace_api.css") + link(rel="stylesheet", href="#{dirPrefix}resources/csses/bootstrap.min.css") + link(href='#{sitePrefix}/style.css', rel='stylesheet', type='text/css') + link(rel="stylesheet", href="#{dirPrefix}resources/csses/ace_api.css") + link(rel="stylesheet", href="#{dirPrefix}resources/csses/font-awesome.css") - link(href="#{dirPrefix}resources/images/favicon.ico", rel="icon", type="image/x-icon") + link(href="#{dirPrefix}resources/images/favicon.ico", rel="icon", type="image/x-icon") - script(src="#{dirPrefix}resources/javascripts/jquery.js") - script(src="#{dirPrefix}resources/javascripts/clicker.js") - script(src="#{dirPrefix}resources/javascripts/jquery.collapse.js") - script(src="#{dirPrefix}resources/javascripts/jquery.cookie.js") - script(src="#{dirPrefix}resources/javascripts/bootstrap-dropdown.js") - script(src="#{dirPrefix}resources/javascripts/jquery-scrollspy.js") - script(script src="#{dirPrefix}resources/javascripts/prettify-extension.js") + script(src='#{dirPrefix}resources/javascripts/bbq.js') + script(src="#{dirPrefix}resources/javascripts/jquery.collapse.js") + script(src="#{dirPrefix}resources/javascripts/jquery.cookie.js") + script(src="#{dirPrefix}resources/javascripts/bootstrap-dropdown.js") + script(src='#{dirPrefix}resources/javascripts/bootstrap-tab.js') -mixin navBar - div.navbar.navbar-fixed-top - div.navbar-inner - div#topSection.container - span.brand - - ul.nav.topLinks - li#ace_site - a(href='../index.html') Ace - li#ace_api.active - a(href='index.html') Ace API Reference - form(id='searchbox', action='', class='navbar-search pull-right') - input(class='search-query span3', name='query', type='text', placeholder="Search the API", title="Search across all the documentation") - -mixin footer - div#footer - .footerInner - .footer-text.pull-right - p - About Cloud9 | Ace & Cloud9 IDE are © Ajax.org 2012 mixin endingScripts - // scripts concatenated and minified via ant build script - - - - - - - //- - // end scripts - - //if lt IE 7 - script(src="//ajax.googleapis.com/ajax/libs/chrome-frame/1.0.3/CFInstall.min.js") - script - window.attachEvent('onload',function(){CFInstall.check({mode:'overlay'})}) - + script(defer, src="#{dirPrefix}resources/javascripts/ux.js") + script(src="#{dirPrefix}resources/javascripts/clicker.js") + script(src="#{dirPrefix}resources/javascripts/jquery-scrollspy.js") + script(defer, src="#{dirPrefix}resources/javascripts/disqus-ext.js") + script(defer, src="#{dirPrefix}resources/javascripts/ga.js") mixin identifyBuild(tree, type) - landingPage = 'true' - -dirPrefix = './' + landingPage = 'true' + -dirPrefix = './' mixin markdown(text, inline) - != markdown(text, inline) \ No newline at end of file + != markdown(text, inline) \ No newline at end of file diff --git a/doc/site/js/main.js b/doc/site/js/main.js index 2b664c29..268dc36d 100644 --- a/doc/site/js/main.js +++ b/doc/site/js/main.js @@ -1,17 +1,33 @@ - $(function() { - hljs.initHighlighting(); - +var editor; +$(function() { + this.isApi = location.href.indexOf("/api") >= 0; + if (!this.isApi) { + hljs.initHighlighting(); + editor = ace.edit("ace_editor_demo"); + var javascriptMode = require("ace/mode/javascript").Mode; + editor.getSession().setMode(new javascriptMode()); + } + $("ul.menu-list li").click(function(e) { if (e.target.tagName === "LI") { console.log($(this).find("a")); window.location = $(this).find("a").attr("href"); } + else if (e.target.tagName === "P") { + var anchor = $(e.target).siblings(); + window.location = anchor.attr("href"); + } }); var tabs = $("#tabnav"), tab_a_selector = "a"; - var firstLoad = true; + var firstLoad = true; + var _self = this; tabs.find(tab_a_selector).click(function(e) { + if (_self.isApi || $(this).attr("href").indexOf("/api/") >= 0) { + window.location = $(this).attr("href"); + } + e.preventDefault(); if ($(this).attr("href") === "/") return; @@ -39,7 +55,8 @@ }, 400); } } - + + $(this).tab("show"); var state = {}; @@ -47,10 +64,12 @@ $.bbq.pushState(state); }); - $(window).on("hashchange", function(e) { - tabs.each(function() { - var idx = $.bbq.getState("nav") || "about"; - $(this).find(tab_a_selector + "[href='#" + idx + "']").triggerHandler('click'); - }); - }).trigger("hashchange"); - }); \ No newline at end of file + if (!this.isApi) { + $(window).on("hashchange", function(e) { + tabs.each(function() { + var idx = $.bbq.getState("nav") || "about"; + $(this).find(tab_a_selector + "[href='#" + idx + "']").triggerHandler('click'); + }); + }).trigger("hashchange"); + } +}); \ No newline at end of file diff --git a/doc/site/style.css b/doc/site/style.css index 5cb69bee..30e389c7 100644 --- a/doc/site/style.css +++ b/doc/site/style.css @@ -5,6 +5,22 @@ body { font-family: Helvetica, Arial; } +#ace_editor_wrapper { + height: 275px; + position: relative; + border: 1px solid #DDD; + border-radius: 5px; + margin-top: 5px; +} + +#ace_editor_demo { + left: 0px; + top: 0px; + bottom: 1px; + right: 1px; + background: #fff; +} + h1, h2, h3, h4, h5, h6 { font-family: Helvetica; font-weight: 100; @@ -37,13 +53,12 @@ H4 { P { padding:13px 0; margin:0; - line-height:22px; - font-size: 16px; + line-height:21px; + font-size: 15px; } UL{ - line-height : 22px; - font-size: 16px; + font-size: 15px; } #header { @@ -188,6 +203,7 @@ UL.content-list { UL.content-list li { padding-left: 10px; + padding-bottom: 3px; } ul.menu-list { @@ -235,20 +251,62 @@ ul.menu-list li:hover { -moz-box-shadow: 0 0 4px rgba(0, 0, 0, 0.5); } -UL.menu-list LI a { +ul.menu-list li a { position: absolute; - bottom: 3px; - left: 8px; - color: #FFF; - text-align: left; + bottom: 0px; + left: 0px; + color: white; + text-align: center; font-weight: bold; text-shadow: 0px 0px 4px rgba(0, 0, 0, 0.8); + width: 100%; + display: block; + background: rgba(0, 0, 0, 0.6); + line-height: 12px; + padding: 4px 0; } UL.menu-list LI a:hover { text-decoration: none; } +li#add_your_site p { + font-size: 32px; + border: 3px solid rgb(52, 160, 52); + color: rgb(52, 160, 52); + border-radius: 34px; + padding: 4px 4px 4px 7px; + width: 22px; + height: 22px; + line-height: 18px; + position: relative; + left: 31px; + top: 20px; + background: rgba(255, 255, 255, 1); +} + +ul.menu-list li#add_your_site a { + color: #A3EEA3; +} + +/* This is the animation code. */ +@-webkit-keyframes example { + 0% { -webkit-transform: rotate(0deg); } + 25% { -webkit-transform: rotate(3deg); } + 50% { -webkit-transform: rotate(0deg); } + 75% { -webkit-transform: rotate(-3deg); } +} + +/* This is the element that we apply the animation to. */ +li#add_your_site { + -webkit-animation-name: example; + -webkit-animation-duration: 0.4s; + -webkit-animation-timing-function: ease; /* ease is the default */ + -webkit-animation-delay: 0s; /* 0 is the default */ + -webkit-animation-iteration-count: infinite; /* 1 is the default */ + -webkit-animation-direction: alternate; /* normal is the default */ +} + A { color:#2557b4; text-decoration:none; @@ -346,11 +404,11 @@ UL.menu-footer LI A:hover { } .tab-content { - margin-bottom: 100px; + margin-bottom: 50px; } .tab-content > .active, .pill-content > .active { - padding: 35px 30px; + padding: 25px 30px; } #top_container, .tab-content > .active, .pill-content > .active { @@ -362,4 +420,33 @@ UL.menu-footer LI A:hover { pre .xml .javascript, pre .xml .css { opacity: 1; +} + +#embed_link { + text-align: right; +} +#embed_link a { + color: #059C05; + font-weight: 100; + font-family: helvetica; + text-transform: uppercase; + font-size: 13px; + display: inline-block; + padding: 2px 10px; +} + +p.highlight_note { + padding: 8px 35px 8px 14px; + margin-top: 10px; + color: #A0762E; + text-shadow: 0 1px 0 rgba(255, 255, 255, 0.5); + background-color: #FCF8E3; + border: 1px solid #CA9C44; + -webkit-border-radius: 4px; + -moz-border-radius: 4px; + border-radius: 4px; +} + +p.highlight_note a { + color: #537CC7; } \ No newline at end of file diff --git a/index.html b/index.html index 0ea80571..954061e3 100644 --- a/index.html +++ b/index.html @@ -7,6 +7,7 @@ + @@ -45,7 +46,7 @@ How-To Guide
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • - API Reference + API Reference
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • ACE in Production @@ -57,16 +58,33 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Built for Code

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ACE is a embeddable code editor written in JavaScript. - It matches and extends the features, usability and performance of existing - native editors such as Sublime, Vim or TextMate. It can be easily embedded +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ACE is an embeddable code editor written in JavaScript. + It matches the features and performance of native + editors such as Sublime, Vim and TextMate. It can be easily embedded in any web page and JavaScript application. ACE is maintained as the primary editor for Cloud9 IDE and is the successor of the Mozilla Skywriter (Bespin) project.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Using ACE

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Want ACE on your own site or web app? Check out our embedding - guide to get started right away!

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Features

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        /** + * In fact, you're looking at ACE right now. + * + * We are currently showing off the JavaScript mode. ACE has support for 45 + * language modes and 24 color themes! + */ + +var resultString = "Hello, ACE! The result of your math is: "; +function add(x, y) { + var result = x + y; + return resultString + result; +} + +var addResult = add(3, 2); +console.log(addResult);
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Looking for a more full-featured demo? The kitchen sink + demonstrates all ACE features.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ACE Features

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Syntax highlighting
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Auto indentation and outdent
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • @@ -80,10 +98,6 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Displays hidden characters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Highlight selected word
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Take ACE for a spin!

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The kitchen sink demo - allows you to test all ACE features. You can check out the code for the - demo on GitHub.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Getting the code

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ACE is a community project. We actively encourage and support contributions! The ACE source code is hosted on GitHub @@ -127,8 +141,10 @@ <style type="text/css" media="screen"> #editor { position: absolute; - width: 500px; - height: 400px; + top: 0; + right: 0; + bottom: 0; + left: 0; } </style> </head> @@ -159,15 +175,14 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Nearly Everything you Want to do with ACE

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        This is a collection of common operations developers perform on ACE. - In all of these cases ACE has been invoked exactly +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        In all of these cases ACE has been invoked exactly as shown on the embedding guide.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Setting Themes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        To change the theme, configure the editor to use the theme using its module name. The theme file will be loaded on demand:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        editor.setTheme("ace/theme/twilight");
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Setting Other Language Modes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Setting the Programming Language Mode

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        By default, the editor supports plain text mode. All other language modes are available as separate modules. Modes are also loaded on demand like this:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        <script src="src/mode-javascript.js" type="text/javascript" charset="utf-8">
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        @@ -321,7 +336,7 @@ editor.replace('bar'); exec: function(editor) { //... } -});

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +});

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        API Reference

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        @@ -332,32 +347,97 @@ editor.replace('bar');

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ACE is used all over the web in all kinds of production applications. Here is just a small sampling: