etherpad-lite/doc/api/editorInfo.md

# editorInfo

## editorInfo.ace_replaceRange(start, end, text)
This function replaces a range (from `start` to `end`) with `text`.

## editorInfo.ace_getRep()
Returns the `rep` object.

## editorInfo.ace_getAuthor()
## editorInfo.ace_inCallStack()
## editorInfo.ace_inCallStackIfNecessary(?)
## editorInfo.ace_focus(?)
## editorInfo.ace_importText(?)
## editorInfo.ace_importAText(?)
## editorInfo.ace_exportText(?)
## editorInfo.ace_editorChangedSize(?)
## editorInfo.ace_setOnKeyPress(?)
## editorInfo.ace_setOnKeyDown(?)
## editorInfo.ace_setNotifyDirty(?)
## editorInfo.ace_dispose(?)
## editorInfo.ace_getFormattedCode(?)
## editorInfo.ace_setEditable(bool)
## editorInfo.ace_execCommand(?)
## editorInfo.ace_callWithAce(fn, callStack, normalize)
## editorInfo.ace_setProperty(key, value)
## editorInfo.ace_setBaseText(txt)
## editorInfo.ace_setBaseAttributedText(atxt, apoolJsonObj)
## editorInfo.ace_applyChangesToBase(c, optAuthor, apoolJsonObj)
## editorInfo.ace_prepareUserChangeset()
## editorInfo.ace_applyPreparedChangesetToBase()
## editorInfo.ace_setUserChangeNotificationCallback(f)
## editorInfo.ace_setAuthorInfo(author, info)
## editorInfo.ace_setAuthorSelectionRange(author, start, end)
## editorInfo.ace_getUnhandledErrors()
## editorInfo.ace_getDebugProperty(prop)
## editorInfo.ace_fastIncorp(?)
## editorInfo.ace_isCaret(?)
## editorInfo.ace_getLineAndCharForPoint(?)
## editorInfo.ace_performDocumentApplyAttributesToCharRange(?)
## editorInfo.ace_setAttributeOnSelection(?)
## editorInfo.ace_toggleAttributeOnSelection(?)
## editorInfo.ace_performSelectionChange(?)
## editorInfo.ace_doIndentOutdent(?)
## editorInfo.ace_doUndoRedo(?)
## editorInfo.ace_doInsertUnorderedList(?)
## editorInfo.ace_doInsertOrderedList(?)
## editorInfo.ace_performDocumentApplyAttributesToRange()

## editorInfo.ace_getAuthorInfos()
Returns an info object about the author. Object key = author_id and info includes author's bg color value.
Use to define your own authorship.
## editorInfo.ace_performDocumentReplaceRange(start, end, newText)
This function replaces a range (from [x1,y1] to [x2,y2]) with `newText`.
## editorInfo.ace_performDocumentReplaceCharRange(startChar, endChar, newText)
This function replaces a range (from y1 to y2) with `newText`.
## editorInfo.ace_renumberList(lineNum)
If you delete a line, calling this method will fix the line numbering.
## editorInfo.ace_doReturnKey()
Forces a return key at the current carret position.
## editorInfo.ace_isBlockElement(element)
Returns true if your passed elment is registered as a block element
## editorInfo.ace_getLineListType(lineNum)
Returns the line's html list type.
## editorInfo.ace_caretLine()
Returns X position of the caret.
## editorInfo.ace_caretColumn()
Returns Y position of the caret.
## editorInfo.ace_caretDocChar()
Returns the Y offset starting from [x=0,y=0]
## editorInfo.ace_isWordChar(?)
Fix doc format, add in makefile for docs OK, first up, SOMEBODY coughanalphabetcough screwed up the docs by making them all use the wrong heading level. Not cool, guy. I had to change them so they would compile right. But anyway, now the docs will build into sexy-looking HTML and will shortly be hosted on marktraceur.info. Fixed the makefile to work properly. Run: * `make clean` for removing old doc-build(s) * `make docs` for running new doc-build(s) 2012-08-14 04:03:06 +02:00			`# editorInfo`
Add docs. 2012-08-03 22:04:06 +02:00
Fix doc format, add in makefile for docs OK, first up, SOMEBODY coughanalphabetcough screwed up the docs by making them all use the wrong heading level. Not cool, guy. I had to change them so they would compile right. But anyway, now the docs will build into sexy-looking HTML and will shortly be hosted on marktraceur.info. Fixed the makefile to work properly. Run: * `make clean` for removing old doc-build(s) * `make docs` for running new doc-build(s) 2012-08-14 04:03:06 +02:00			`## editorInfo.ace_replaceRange(start, end, text)`
Add docs. 2012-08-03 22:04:06 +02:00			This function replaces a range (from `start` to `end`) with `text`.

Fix doc format, add in makefile for docs OK, first up, SOMEBODY coughanalphabetcough screwed up the docs by making them all use the wrong heading level. Not cool, guy. I had to change them so they would compile right. But anyway, now the docs will build into sexy-looking HTML and will shortly be hosted on marktraceur.info. Fixed the makefile to work properly. Run: * `make clean` for removing old doc-build(s) * `make docs` for running new doc-build(s) 2012-08-14 04:03:06 +02:00			`## editorInfo.ace_getRep()`
Add docs. 2012-08-03 22:04:06 +02:00			Returns the `rep` object.

Fix doc format, add in makefile for docs OK, first up, SOMEBODY coughanalphabetcough screwed up the docs by making them all use the wrong heading level. Not cool, guy. I had to change them so they would compile right. But anyway, now the docs will build into sexy-looking HTML and will shortly be hosted on marktraceur.info. Fixed the makefile to work properly. Run: * `make clean` for removing old doc-build(s) * `make docs` for running new doc-build(s) 2012-08-14 04:03:06 +02:00			`## editorInfo.ace_getAuthor()`
			`## editorInfo.ace_inCallStack()`
			`## editorInfo.ace_inCallStackIfNecessary(?)`
			`## editorInfo.ace_focus(?)`
			`## editorInfo.ace_importText(?)`
			`## editorInfo.ace_importAText(?)`
			`## editorInfo.ace_exportText(?)`
			`## editorInfo.ace_editorChangedSize(?)`
			`## editorInfo.ace_setOnKeyPress(?)`
			`## editorInfo.ace_setOnKeyDown(?)`
			`## editorInfo.ace_setNotifyDirty(?)`
			`## editorInfo.ace_dispose(?)`
			`## editorInfo.ace_getFormattedCode(?)`
			`## editorInfo.ace_setEditable(bool)`
			`## editorInfo.ace_execCommand(?)`
			`## editorInfo.ace_callWithAce(fn, callStack, normalize)`
			`## editorInfo.ace_setProperty(key, value)`
			`## editorInfo.ace_setBaseText(txt)`
			`## editorInfo.ace_setBaseAttributedText(atxt, apoolJsonObj)`
			`## editorInfo.ace_applyChangesToBase(c, optAuthor, apoolJsonObj)`
			`## editorInfo.ace_prepareUserChangeset()`
			`## editorInfo.ace_applyPreparedChangesetToBase()`
			`## editorInfo.ace_setUserChangeNotificationCallback(f)`
			`## editorInfo.ace_setAuthorInfo(author, info)`
			`## editorInfo.ace_setAuthorSelectionRange(author, start, end)`
			`## editorInfo.ace_getUnhandledErrors()`
			`## editorInfo.ace_getDebugProperty(prop)`
			`## editorInfo.ace_fastIncorp(?)`
			`## editorInfo.ace_isCaret(?)`
			`## editorInfo.ace_getLineAndCharForPoint(?)`
			`## editorInfo.ace_performDocumentApplyAttributesToCharRange(?)`
			`## editorInfo.ace_setAttributeOnSelection(?)`
			`## editorInfo.ace_toggleAttributeOnSelection(?)`
			`## editorInfo.ace_performSelectionChange(?)`
			`## editorInfo.ace_doIndentOutdent(?)`
			`## editorInfo.ace_doUndoRedo(?)`
			`## editorInfo.ace_doInsertUnorderedList(?)`
			`## editorInfo.ace_doInsertOrderedList(?)`
			`## editorInfo.ace_performDocumentApplyAttributesToRange()`
added comments to ace exposed methods 2012-10-02 02:14:27 +02:00
update docs for new hooks and ace exposures 2012-10-01 00:13:14 +02:00			`## editorInfo.ace_getAuthorInfos()`
added comments to ace exposed methods 2012-10-02 02:18:19 +02:00			`Returns an info object about the author. Object key = author_id and info includes author's bg color value.`
added comments to ace exposed methods 2012-10-02 02:14:27 +02:00			`Use to define your own authorship.`
			`## editorInfo.ace_performDocumentReplaceRange(start, end, newText)`
			This function replaces a range (from [x1,y1] to [x2,y2]) with `newText`.
			`## editorInfo.ace_performDocumentReplaceCharRange(startChar, endChar, newText)`
			This function replaces a range (from y1 to y2) with `newText`.
			`## editorInfo.ace_renumberList(lineNum)`
			`If you delete a line, calling this method will fix the line numbering.`
update docs for new hooks and ace exposures 2012-10-01 00:13:14 +02:00			`## editorInfo.ace_doReturnKey()`
added comments to ace exposed methods 2012-10-02 02:14:27 +02:00			`Forces a return key at the current carret position.`
			`## editorInfo.ace_isBlockElement(element)`
			`Returns true if your passed elment is registered as a block element`
			`## editorInfo.ace_getLineListType(lineNum)`
			`Returns the line's html list type.`
update docs for new hooks and ace exposures 2012-10-01 00:13:14 +02:00			`## editorInfo.ace_caretLine()`
added comments to ace exposed methods 2012-10-02 02:14:27 +02:00			`Returns X position of the caret.`
update docs for new hooks and ace exposures 2012-10-01 00:13:14 +02:00			`## editorInfo.ace_caretColumn()`
added comments to ace exposed methods 2012-10-02 02:14:27 +02:00			`Returns Y position of the caret.`
update docs for new hooks and ace exposures 2012-10-01 00:13:14 +02:00			`## editorInfo.ace_caretDocChar()`
added comments to ace exposed methods 2012-10-02 02:14:27 +02:00			`Returns the Y offset starting from [x=0,y=0]`
update docs for new hooks and ace exposures 2012-10-01 00:13:14 +02:00			`## editorInfo.ace_isWordChar(?)`