ace.html 9.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149
  1. <div id="documentation" class="span9">
  2. <div class="classContent">
  3. <div class="membersBackground"></div>
  4. <div class=" members pos0">
  5. <div class=" membersContent pos0">
  6. <h1 class="memberHeader"><span class="name">Ace</span>
  7. </h1>
  8. <ul data-tabs="tabs" class="nav tabs pos0">
  9. <li data-dropdown="dropdown" class="dropdown">
  10. <ul class="dropdown-menu">
  11. </ul>
  12. </li>
  13. <li data-dropdown="dropdown" class="dropdown">
  14. <ul class="dropdown-menu">
  15. </ul>
  16. </li>
  17. <li data-dropdown="dropdown" class="dropdown"><a href="#" data-toggle="dropdown" class="dropdown-toggle"><span>Functions (3)</span><b class="caret"></b></a>
  18. <ul class="dropdown-menu">
  19. <li id="dropdown_Ace.createEditSession" data-id="Ace.createEditSession" class="memberLink"><a href="#Ace.createEditSession" class="" title="Ace.createEditSession (class method)" data-id="Ace.createEditSession">createEditSession</a>
  20. </li>
  21. <li id="dropdown_Ace.edit" data-id="Ace.edit" class="memberLink"><a href="#Ace.edit" class="" title="Ace.edit (class method)" data-id="Ace.edit">edit</a>
  22. </li>
  23. <li id="dropdown_Ace.require" data-id="Ace.require" class="memberLink"><a href="#Ace.require" class="" title="Ace.require (class method)" data-id="Ace.require">require</a>
  24. </li>
  25. </ul>
  26. </li>
  27. <li data-dropdown="dropdown" class="dropdown">
  28. <ul class="dropdown-menu">
  29. </ul>
  30. </li>
  31. <li data-dropdown="dropdown" class="dropdown">
  32. <ul class="dropdown-menu">
  33. </ul>
  34. </li>
  35. <li data-dropdown="dropdown" class="dropdown">
  36. <ul class="dropdown-menu">
  37. </ul>
  38. </li>
  39. <li data-dropdown="dropdown" class="dropdown">
  40. <ul class="dropdown-menu">
  41. </ul>
  42. </li>
  43. </ul>
  44. </div>
  45. </div>
  46. <article id="Ace" data-title="Ace (class)" class="article">
  47. <div class="section description">
  48. <div class="memberContent"><p>The main class required to set up an Ace instance in the browser.</p>
  49. </div>
  50. </div>
  51. </article>
  52. <h3 class="sectionHeader">Methods</h3>
  53. <article id="Ace.createEditSession" data-title="Ace.createEditSession (class method)" class="article">
  54. <div class="section method">
  55. <div class="memberContent">
  56. <div class="title"><i id="Ace.createEditSession" class="methodToggle methodClicker inactive icon-caret-right"></i>
  57. <ul class="signatures">
  58. <li class="signature">
  59. <ul>
  60. <li class="signature-call"><span id="Ace.createEditSession" class="member-name methodClicker"><span class="sigClassName">Ace.</span><span class="sigMemberName">createEditSession</span></span>(<span class="sigArgList"><a href="document.html" class="argument methodClicker" title="Document (class)" data-id="Document">Document</a> | <a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/String" class="argument methodClicker" title="String" data-id="String">String</a> text, <a href="https://github.com/ajaxorg/ace/blob/master/lib/ace/mode/text.js" class="argument methodClicker" title="TextMode" data-id="TextMode">TextMode</a> mode</span>)</li>
  61. </ul>
  62. <ul class="metaInfo">
  63. </ul>
  64. </li>
  65. </ul>
  66. </div>
  67. <div class="sideToggler">
  68. <div id="ellipsis_Ace.createEditSession" class="ellipsis_description"><p>Creates a new <a href="edit_session.html" class="link-short" title="EditSession (class)" data-id="EditSession"><code>EditSession</code></a>, and returns the associated <a href="document.html" class="link-short" title="Document (class)" data-id="Document"><code>Document</code></a>.</p>
  69. </div>
  70. <div class="description"><p>Creates a new <a href="edit_session.html" class="link-short" title="EditSession (class)" data-id="EditSession"><code>EditSession</code></a>, and returns the associated <a href="document.html" class="link-short" title="Document (class)" data-id="Document"><code>Document</code></a>.</p>
  71. <h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"><tr class="argumentRow "><td class="argName ">text</td><td class="argType" "><a href="document.html" class="" title="Document (class)" data-id="Document">Document</a> | <a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/String" class="" title="String" data-id="String">String</a></td><td class="argDescription "><p>Required. If <code>text</code> is a <code>Document</code>, it associates the <code>EditSession</code> with it. Otherwise, a new <code>Document</code> is created, with the initial text</p>
  72. </td></tr><tr class="argumentRow "><td class="argName ">mode</td><td class="argType" "><a href="https://github.com/ajaxorg/ace/blob/master/lib/ace/mode/text.js" class="" title="TextMode" data-id="TextMode">TextMode</a></td><td class="argDescription "><p>Required. The inital language mode to use for the document</p>
  73. </td></tr></table>
  74. </div>
  75. </div>
  76. </div>
  77. </div>
  78. </article>
  79. <article id="Ace.edit" data-title="Ace.edit (class method)" class="article">
  80. <div class="section method">
  81. <div class="memberContent">
  82. <div class="title"><i id="Ace.edit" class="methodToggle methodClicker inactive icon-caret-right"></i>
  83. <ul class="signatures">
  84. <li class="signature">
  85. <ul>
  86. <li class="signature-call"><span id="Ace.edit" class="member-name methodClicker"><span class="sigClassName">Ace.</span><span class="sigMemberName">edit</span></span>(<span class="sigArgList"><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/String" class="argument methodClicker" title="String" data-id="String">String</a> | <a href="https://developer.mozilla.org/en/DOM/element" class="argument methodClicker" title="DOMElement" data-id="DOMElement">DOMElement</a> el</span>)</li>
  87. </ul>
  88. <ul class="metaInfo">
  89. </ul>
  90. </li>
  91. </ul>
  92. </div>
  93. <div class="sideToggler">
  94. <div id="ellipsis_Ace.edit" class="ellipsis_description"><p>Embeds the Ace editor into the DOM, at the element provided by <code>el</code>.</p>
  95. </div>
  96. <div class="description"><p>Embeds the Ace editor into the DOM, at the element provided by <code>el</code>.</p>
  97. <h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"><tr class="argumentRow "><td class="argName ">el</td><td class="argType" "><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/String" class="" title="String" data-id="String">String</a> | <a href="https://developer.mozilla.org/en/DOM/element" class="" title="DOMElement" data-id="DOMElement">DOMElement</a></td><td class="argDescription "><p>Required. Either the id of an element, or the element itself</p>
  98. </td></tr></table>
  99. </div>
  100. </div>
  101. </div>
  102. </div>
  103. </article>
  104. <article id="Ace.require" data-title="Ace.require (class method)" class="article">
  105. <div class="section method">
  106. <div class="memberContent">
  107. <div class="title"><i id="Ace.require" class="methodToggle methodClicker inactive icon-caret-right"></i>
  108. <ul class="signatures">
  109. <li class="signature">
  110. <ul>
  111. <li class="signature-call"><span id="Ace.require" class="member-name methodClicker"><span class="sigClassName">Ace.</span><span class="sigMemberName">require</span></span>(<span class="sigArgList"><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/String" class="argument methodClicker" title="String" data-id="String">String</a> moduleName</span>)
  112. <li class="signature-returns">
  113. <ul class="argument-types">
  114. <li class="argument-type"><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Object" class="returnType " title="Object" data-id="Object">Object</a></li>
  115. </ul>
  116. </li></li>
  117. </ul>
  118. <ul class="metaInfo">
  119. </ul>
  120. </li>
  121. </ul>
  122. </div>
  123. <div class="sideToggler">
  124. <div id="ellipsis_Ace.require" class="ellipsis_description"><p>Provides access to require in packed noconflict mode</p>
  125. </div>
  126. <div class="description"><p>Provides access to require in packed noconflict mode</p>
  127. <h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"><tr class="argumentRow "><td class="argName ">moduleName</td><td class="argType" "><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/String" class="" title="String" data-id="String">String</a></td><td class="argDescription "><p>Required. </p>
  128. </td></tr></table>
  129. </div>
  130. </div>
  131. </div>
  132. </div>
  133. </article>
  134. </div>
  135. <script defer src="./resources/javascripts/ux.js"></script>
  136. <script src="./resources/javascripts/clicker.js"></script>
  137. <script src="./resources/javascripts/jquery-scrollspy.js"></script>
  138. <script defer src="./resources/javascripts/disqus-ext.js"></script>
  139. <script defer src="./resources/javascripts/ga.js"></script>
  140. <div id="disqus_thread"></div>
  141. </div>