mirror of
https://github.com/ether/etherpad-lite.git
synced 2025-04-23 00:46:16 -04:00
161 lines
17 KiB
HTML
161 lines
17 KiB
HTML
<!doctype html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>editorInfo - Etherpad Lite v1.2.81 Manual & Documentation</title>
|
|
<link rel="stylesheet" href="assets/style.css">
|
|
</head>
|
|
<body class="apidoc" id="api-section-editorInfo">
|
|
<header id="header">
|
|
<h1>Etherpad-Lite v1.2.81 Manual & Documentation</h1>
|
|
</header>
|
|
|
|
<div id="toc">
|
|
<h2>Table of Contents</h2>
|
|
<ul>
|
|
<li><a href="#editorinfo_editorinfo">editorInfo</a><ul>
|
|
<li><a href="#editorinfo_editorinfo_ace_replacerange_start_end_text">editorInfo.ace_replaceRange(start, end, text)</a></li>
|
|
<li><a href="#editorinfo_editorinfo_ace_getrep">editorInfo.ace_getRep()</a></li>
|
|
<li><a href="#editorinfo_editorinfo_ace_getauthor">editorInfo.ace_getAuthor()</a></li>
|
|
<li><a href="#editorinfo_editorinfo_ace_incallstack">editorInfo.ace_inCallStack()</a></li>
|
|
<li><a href="#editorinfo_editorinfo_ace_incallstackifnecessary">editorInfo.ace_inCallStackIfNecessary(?)</a></li>
|
|
<li><a href="#editorinfo_editorinfo_ace_focus">editorInfo.ace_focus(?)</a></li>
|
|
<li><a href="#editorinfo_editorinfo_ace_importtext">editorInfo.ace_importText(?)</a></li>
|
|
<li><a href="#editorinfo_editorinfo_ace_importatext">editorInfo.ace_importAText(?)</a></li>
|
|
<li><a href="#editorinfo_editorinfo_ace_exporttext">editorInfo.ace_exportText(?)</a></li>
|
|
<li><a href="#editorinfo_editorinfo_ace_editorchangedsize">editorInfo.ace_editorChangedSize(?)</a></li>
|
|
<li><a href="#editorinfo_editorinfo_ace_setonkeypress">editorInfo.ace_setOnKeyPress(?)</a></li>
|
|
<li><a href="#editorinfo_editorinfo_ace_setonkeydown">editorInfo.ace_setOnKeyDown(?)</a></li>
|
|
<li><a href="#editorinfo_editorinfo_ace_setnotifydirty">editorInfo.ace_setNotifyDirty(?)</a></li>
|
|
<li><a href="#editorinfo_editorinfo_ace_dispose">editorInfo.ace_dispose(?)</a></li>
|
|
<li><a href="#editorinfo_editorinfo_ace_getformattedcode">editorInfo.ace_getFormattedCode(?)</a></li>
|
|
<li><a href="#editorinfo_editorinfo_ace_seteditable_bool">editorInfo.ace_setEditable(bool)</a></li>
|
|
<li><a href="#editorinfo_editorinfo_ace_execcommand">editorInfo.ace_execCommand(?)</a></li>
|
|
<li><a href="#editorinfo_editorinfo_ace_callwithace_fn_callstack_normalize">editorInfo.ace_callWithAce(fn, callStack, normalize)</a></li>
|
|
<li><a href="#editorinfo_editorinfo_ace_setproperty_key_value">editorInfo.ace_setProperty(key, value)</a></li>
|
|
<li><a href="#editorinfo_editorinfo_ace_setbasetext_txt">editorInfo.ace_setBaseText(txt)</a></li>
|
|
<li><a href="#editorinfo_editorinfo_ace_setbaseattributedtext_atxt_apooljsonobj">editorInfo.ace_setBaseAttributedText(atxt, apoolJsonObj)</a></li>
|
|
<li><a href="#editorinfo_editorinfo_ace_applychangestobase_c_optauthor_apooljsonobj">editorInfo.ace_applyChangesToBase(c, optAuthor, apoolJsonObj)</a></li>
|
|
<li><a href="#editorinfo_editorinfo_ace_prepareuserchangeset">editorInfo.ace_prepareUserChangeset()</a></li>
|
|
<li><a href="#editorinfo_editorinfo_ace_applypreparedchangesettobase">editorInfo.ace_applyPreparedChangesetToBase()</a></li>
|
|
<li><a href="#editorinfo_editorinfo_ace_setuserchangenotificationcallback_f">editorInfo.ace_setUserChangeNotificationCallback(f)</a></li>
|
|
<li><a href="#editorinfo_editorinfo_ace_setauthorinfo_author_info">editorInfo.ace_setAuthorInfo(author, info)</a></li>
|
|
<li><a href="#editorinfo_editorinfo_ace_setauthorselectionrange_author_start_end">editorInfo.ace_setAuthorSelectionRange(author, start, end)</a></li>
|
|
<li><a href="#editorinfo_editorinfo_ace_getunhandlederrors">editorInfo.ace_getUnhandledErrors()</a></li>
|
|
<li><a href="#editorinfo_editorinfo_ace_getdebugproperty_prop">editorInfo.ace_getDebugProperty(prop)</a></li>
|
|
<li><a href="#editorinfo_editorinfo_ace_fastincorp">editorInfo.ace_fastIncorp(?)</a></li>
|
|
<li><a href="#editorinfo_editorinfo_ace_iscaret">editorInfo.ace_isCaret(?)</a></li>
|
|
<li><a href="#editorinfo_editorinfo_ace_getlineandcharforpoint">editorInfo.ace_getLineAndCharForPoint(?)</a></li>
|
|
<li><a href="#editorinfo_editorinfo_ace_performdocumentapplyattributestocharrange">editorInfo.ace_performDocumentApplyAttributesToCharRange(?)</a></li>
|
|
<li><a href="#editorinfo_editorinfo_ace_setattributeonselection">editorInfo.ace_setAttributeOnSelection(?)</a></li>
|
|
<li><a href="#editorinfo_editorinfo_ace_toggleattributeonselection">editorInfo.ace_toggleAttributeOnSelection(?)</a></li>
|
|
<li><a href="#editorinfo_editorinfo_ace_performselectionchange">editorInfo.ace_performSelectionChange(?)</a></li>
|
|
<li><a href="#editorinfo_editorinfo_ace_doindentoutdent">editorInfo.ace_doIndentOutdent(?)</a></li>
|
|
<li><a href="#editorinfo_editorinfo_ace_doundoredo">editorInfo.ace_doUndoRedo(?)</a></li>
|
|
<li><a href="#editorinfo_editorinfo_ace_doinsertunorderedlist">editorInfo.ace_doInsertUnorderedList(?)</a></li>
|
|
<li><a href="#editorinfo_editorinfo_ace_doinsertorderedlist">editorInfo.ace_doInsertOrderedList(?)</a></li>
|
|
<li><a href="#editorinfo_editorinfo_ace_performdocumentapplyattributestorange">editorInfo.ace_performDocumentApplyAttributesToRange()</a></li>
|
|
<li><a href="#editorinfo_editorinfo_ace_getauthorinfos">editorInfo.ace_getAuthorInfos()</a></li>
|
|
<li><a href="#editorinfo_editorinfo_ace_performdocumentreplacerange_start_end_newtext">editorInfo.ace_performDocumentReplaceRange(start, end, newText)</a></li>
|
|
<li><a href="#editorinfo_editorinfo_ace_performdocumentreplacecharrange_startchar_endchar_newtext">editorInfo.ace_performDocumentReplaceCharRange(startChar, endChar, newText)</a></li>
|
|
<li><a href="#editorinfo_editorinfo_ace_renumberlist_linenum">editorInfo.ace_renumberList(lineNum)</a></li>
|
|
<li><a href="#editorinfo_editorinfo_ace_doreturnkey">editorInfo.ace_doReturnKey()</a></li>
|
|
<li><a href="#editorinfo_editorinfo_ace_isblockelement_element">editorInfo.ace_isBlockElement(element)</a></li>
|
|
<li><a href="#editorinfo_editorinfo_ace_getlinelisttype_linenum">editorInfo.ace_getLineListType(lineNum)</a></li>
|
|
<li><a href="#editorinfo_editorinfo_ace_caretline">editorInfo.ace_caretLine()</a></li>
|
|
<li><a href="#editorinfo_editorinfo_ace_caretcolumn">editorInfo.ace_caretColumn()</a></li>
|
|
<li><a href="#editorinfo_editorinfo_ace_caretdocchar">editorInfo.ace_caretDocChar()</a></li>
|
|
<li><a href="#editorinfo_editorinfo_ace_iswordchar">editorInfo.ace_isWordChar(?)</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
|
|
</div>
|
|
|
|
<div id="apicontent">
|
|
<h1>editorInfo<span><a class="mark" href="#editorinfo_editorinfo" id="editorinfo_editorinfo">#</a></span></h1>
|
|
<h2>editorInfo.ace_replaceRange(start, end, text)<span><a class="mark" href="#editorinfo_editorinfo_ace_replacerange_start_end_text" id="editorinfo_editorinfo_ace_replacerange_start_end_text">#</a></span></h2>
|
|
<p>This function replaces a range (from <code>start</code> to <code>end</code>) with <code>text</code>.
|
|
|
|
</p>
|
|
<h2>editorInfo.ace_getRep()<span><a class="mark" href="#editorinfo_editorinfo_ace_getrep" id="editorinfo_editorinfo_ace_getrep">#</a></span></h2>
|
|
<p>Returns the <code>rep</code> object.
|
|
|
|
</p>
|
|
<h2>editorInfo.ace_getAuthor()<span><a class="mark" href="#editorinfo_editorinfo_ace_getauthor" id="editorinfo_editorinfo_ace_getauthor">#</a></span></h2>
|
|
<h2>editorInfo.ace_inCallStack()<span><a class="mark" href="#editorinfo_editorinfo_ace_incallstack" id="editorinfo_editorinfo_ace_incallstack">#</a></span></h2>
|
|
<h2>editorInfo.ace_inCallStackIfNecessary(?)<span><a class="mark" href="#editorinfo_editorinfo_ace_incallstackifnecessary" id="editorinfo_editorinfo_ace_incallstackifnecessary">#</a></span></h2>
|
|
<h2>editorInfo.ace_focus(?)<span><a class="mark" href="#editorinfo_editorinfo_ace_focus" id="editorinfo_editorinfo_ace_focus">#</a></span></h2>
|
|
<h2>editorInfo.ace_importText(?)<span><a class="mark" href="#editorinfo_editorinfo_ace_importtext" id="editorinfo_editorinfo_ace_importtext">#</a></span></h2>
|
|
<h2>editorInfo.ace_importAText(?)<span><a class="mark" href="#editorinfo_editorinfo_ace_importatext" id="editorinfo_editorinfo_ace_importatext">#</a></span></h2>
|
|
<h2>editorInfo.ace_exportText(?)<span><a class="mark" href="#editorinfo_editorinfo_ace_exporttext" id="editorinfo_editorinfo_ace_exporttext">#</a></span></h2>
|
|
<h2>editorInfo.ace_editorChangedSize(?)<span><a class="mark" href="#editorinfo_editorinfo_ace_editorchangedsize" id="editorinfo_editorinfo_ace_editorchangedsize">#</a></span></h2>
|
|
<h2>editorInfo.ace_setOnKeyPress(?)<span><a class="mark" href="#editorinfo_editorinfo_ace_setonkeypress" id="editorinfo_editorinfo_ace_setonkeypress">#</a></span></h2>
|
|
<h2>editorInfo.ace_setOnKeyDown(?)<span><a class="mark" href="#editorinfo_editorinfo_ace_setonkeydown" id="editorinfo_editorinfo_ace_setonkeydown">#</a></span></h2>
|
|
<h2>editorInfo.ace_setNotifyDirty(?)<span><a class="mark" href="#editorinfo_editorinfo_ace_setnotifydirty" id="editorinfo_editorinfo_ace_setnotifydirty">#</a></span></h2>
|
|
<h2>editorInfo.ace_dispose(?)<span><a class="mark" href="#editorinfo_editorinfo_ace_dispose" id="editorinfo_editorinfo_ace_dispose">#</a></span></h2>
|
|
<h2>editorInfo.ace_getFormattedCode(?)<span><a class="mark" href="#editorinfo_editorinfo_ace_getformattedcode" id="editorinfo_editorinfo_ace_getformattedcode">#</a></span></h2>
|
|
<h2>editorInfo.ace_setEditable(bool)<span><a class="mark" href="#editorinfo_editorinfo_ace_seteditable_bool" id="editorinfo_editorinfo_ace_seteditable_bool">#</a></span></h2>
|
|
<h2>editorInfo.ace_execCommand(?)<span><a class="mark" href="#editorinfo_editorinfo_ace_execcommand" id="editorinfo_editorinfo_ace_execcommand">#</a></span></h2>
|
|
<h2>editorInfo.ace_callWithAce(fn, callStack, normalize)<span><a class="mark" href="#editorinfo_editorinfo_ace_callwithace_fn_callstack_normalize" id="editorinfo_editorinfo_ace_callwithace_fn_callstack_normalize">#</a></span></h2>
|
|
<h2>editorInfo.ace_setProperty(key, value)<span><a class="mark" href="#editorinfo_editorinfo_ace_setproperty_key_value" id="editorinfo_editorinfo_ace_setproperty_key_value">#</a></span></h2>
|
|
<h2>editorInfo.ace_setBaseText(txt)<span><a class="mark" href="#editorinfo_editorinfo_ace_setbasetext_txt" id="editorinfo_editorinfo_ace_setbasetext_txt">#</a></span></h2>
|
|
<h2>editorInfo.ace_setBaseAttributedText(atxt, apoolJsonObj)<span><a class="mark" href="#editorinfo_editorinfo_ace_setbaseattributedtext_atxt_apooljsonobj" id="editorinfo_editorinfo_ace_setbaseattributedtext_atxt_apooljsonobj">#</a></span></h2>
|
|
<h2>editorInfo.ace_applyChangesToBase(c, optAuthor, apoolJsonObj)<span><a class="mark" href="#editorinfo_editorinfo_ace_applychangestobase_c_optauthor_apooljsonobj" id="editorinfo_editorinfo_ace_applychangestobase_c_optauthor_apooljsonobj">#</a></span></h2>
|
|
<h2>editorInfo.ace_prepareUserChangeset()<span><a class="mark" href="#editorinfo_editorinfo_ace_prepareuserchangeset" id="editorinfo_editorinfo_ace_prepareuserchangeset">#</a></span></h2>
|
|
<h2>editorInfo.ace_applyPreparedChangesetToBase()<span><a class="mark" href="#editorinfo_editorinfo_ace_applypreparedchangesettobase" id="editorinfo_editorinfo_ace_applypreparedchangesettobase">#</a></span></h2>
|
|
<h2>editorInfo.ace_setUserChangeNotificationCallback(f)<span><a class="mark" href="#editorinfo_editorinfo_ace_setuserchangenotificationcallback_f" id="editorinfo_editorinfo_ace_setuserchangenotificationcallback_f">#</a></span></h2>
|
|
<h2>editorInfo.ace_setAuthorInfo(author, info)<span><a class="mark" href="#editorinfo_editorinfo_ace_setauthorinfo_author_info" id="editorinfo_editorinfo_ace_setauthorinfo_author_info">#</a></span></h2>
|
|
<h2>editorInfo.ace_setAuthorSelectionRange(author, start, end)<span><a class="mark" href="#editorinfo_editorinfo_ace_setauthorselectionrange_author_start_end" id="editorinfo_editorinfo_ace_setauthorselectionrange_author_start_end">#</a></span></h2>
|
|
<h2>editorInfo.ace_getUnhandledErrors()<span><a class="mark" href="#editorinfo_editorinfo_ace_getunhandlederrors" id="editorinfo_editorinfo_ace_getunhandlederrors">#</a></span></h2>
|
|
<h2>editorInfo.ace_getDebugProperty(prop)<span><a class="mark" href="#editorinfo_editorinfo_ace_getdebugproperty_prop" id="editorinfo_editorinfo_ace_getdebugproperty_prop">#</a></span></h2>
|
|
<h2>editorInfo.ace_fastIncorp(?)<span><a class="mark" href="#editorinfo_editorinfo_ace_fastincorp" id="editorinfo_editorinfo_ace_fastincorp">#</a></span></h2>
|
|
<h2>editorInfo.ace_isCaret(?)<span><a class="mark" href="#editorinfo_editorinfo_ace_iscaret" id="editorinfo_editorinfo_ace_iscaret">#</a></span></h2>
|
|
<h2>editorInfo.ace_getLineAndCharForPoint(?)<span><a class="mark" href="#editorinfo_editorinfo_ace_getlineandcharforpoint" id="editorinfo_editorinfo_ace_getlineandcharforpoint">#</a></span></h2>
|
|
<h2>editorInfo.ace_performDocumentApplyAttributesToCharRange(?)<span><a class="mark" href="#editorinfo_editorinfo_ace_performdocumentapplyattributestocharrange" id="editorinfo_editorinfo_ace_performdocumentapplyattributestocharrange">#</a></span></h2>
|
|
<h2>editorInfo.ace_setAttributeOnSelection(?)<span><a class="mark" href="#editorinfo_editorinfo_ace_setattributeonselection" id="editorinfo_editorinfo_ace_setattributeonselection">#</a></span></h2>
|
|
<h2>editorInfo.ace_toggleAttributeOnSelection(?)<span><a class="mark" href="#editorinfo_editorinfo_ace_toggleattributeonselection" id="editorinfo_editorinfo_ace_toggleattributeonselection">#</a></span></h2>
|
|
<h2>editorInfo.ace_performSelectionChange(?)<span><a class="mark" href="#editorinfo_editorinfo_ace_performselectionchange" id="editorinfo_editorinfo_ace_performselectionchange">#</a></span></h2>
|
|
<h2>editorInfo.ace_doIndentOutdent(?)<span><a class="mark" href="#editorinfo_editorinfo_ace_doindentoutdent" id="editorinfo_editorinfo_ace_doindentoutdent">#</a></span></h2>
|
|
<h2>editorInfo.ace_doUndoRedo(?)<span><a class="mark" href="#editorinfo_editorinfo_ace_doundoredo" id="editorinfo_editorinfo_ace_doundoredo">#</a></span></h2>
|
|
<h2>editorInfo.ace_doInsertUnorderedList(?)<span><a class="mark" href="#editorinfo_editorinfo_ace_doinsertunorderedlist" id="editorinfo_editorinfo_ace_doinsertunorderedlist">#</a></span></h2>
|
|
<h2>editorInfo.ace_doInsertOrderedList(?)<span><a class="mark" href="#editorinfo_editorinfo_ace_doinsertorderedlist" id="editorinfo_editorinfo_ace_doinsertorderedlist">#</a></span></h2>
|
|
<h2>editorInfo.ace_performDocumentApplyAttributesToRange()<span><a class="mark" href="#editorinfo_editorinfo_ace_performdocumentapplyattributestorange" id="editorinfo_editorinfo_ace_performdocumentapplyattributestorange">#</a></span></h2>
|
|
<h2>editorInfo.ace_getAuthorInfos()<span><a class="mark" href="#editorinfo_editorinfo_ace_getauthorinfos" id="editorinfo_editorinfo_ace_getauthorinfos">#</a></span></h2>
|
|
<p>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.
|
|
</p>
|
|
<h2>editorInfo.ace_performDocumentReplaceRange(start, end, newText)<span><a class="mark" href="#editorinfo_editorinfo_ace_performdocumentreplacerange_start_end_newtext" id="editorinfo_editorinfo_ace_performdocumentreplacerange_start_end_newtext">#</a></span></h2>
|
|
<p>This function replaces a range (from [x1,y1] to [x2,y2]) with <code>newText</code>.
|
|
</p>
|
|
<h2>editorInfo.ace_performDocumentReplaceCharRange(startChar, endChar, newText)<span><a class="mark" href="#editorinfo_editorinfo_ace_performdocumentreplacecharrange_startchar_endchar_newtext" id="editorinfo_editorinfo_ace_performdocumentreplacecharrange_startchar_endchar_newtext">#</a></span></h2>
|
|
<p>This function replaces a range (from y1 to y2) with <code>newText</code>.
|
|
</p>
|
|
<h2>editorInfo.ace_renumberList(lineNum)<span><a class="mark" href="#editorinfo_editorinfo_ace_renumberlist_linenum" id="editorinfo_editorinfo_ace_renumberlist_linenum">#</a></span></h2>
|
|
<p>If you delete a line, calling this method will fix the line numbering.
|
|
</p>
|
|
<h2>editorInfo.ace_doReturnKey()<span><a class="mark" href="#editorinfo_editorinfo_ace_doreturnkey" id="editorinfo_editorinfo_ace_doreturnkey">#</a></span></h2>
|
|
<p>Forces a return key at the current carret position.
|
|
</p>
|
|
<h2>editorInfo.ace_isBlockElement(element)<span><a class="mark" href="#editorinfo_editorinfo_ace_isblockelement_element" id="editorinfo_editorinfo_ace_isblockelement_element">#</a></span></h2>
|
|
<p>Returns true if your passed elment is registered as a block element
|
|
</p>
|
|
<h2>editorInfo.ace_getLineListType(lineNum)<span><a class="mark" href="#editorinfo_editorinfo_ace_getlinelisttype_linenum" id="editorinfo_editorinfo_ace_getlinelisttype_linenum">#</a></span></h2>
|
|
<p>Returns the line's html list type.
|
|
</p>
|
|
<h2>editorInfo.ace_caretLine()<span><a class="mark" href="#editorinfo_editorinfo_ace_caretline" id="editorinfo_editorinfo_ace_caretline">#</a></span></h2>
|
|
<p>Returns X position of the caret.
|
|
</p>
|
|
<h2>editorInfo.ace_caretColumn()<span><a class="mark" href="#editorinfo_editorinfo_ace_caretcolumn" id="editorinfo_editorinfo_ace_caretcolumn">#</a></span></h2>
|
|
<p>Returns Y position of the caret.
|
|
</p>
|
|
<h2>editorInfo.ace_caretDocChar()<span><a class="mark" href="#editorinfo_editorinfo_ace_caretdocchar" id="editorinfo_editorinfo_ace_caretdocchar">#</a></span></h2>
|
|
<p>Returns the Y offset starting from [x=0,y=0]
|
|
</p>
|
|
<h2>editorInfo.ace_isWordChar(?)<span><a class="mark" href="#editorinfo_editorinfo_ace_iswordchar" id="editorinfo_editorinfo_ace_iswordchar">#</a></span></h2>
|
|
|
|
</div>
|
|
|
|
</body>
|
|
</html>
|
|
|