anchor.html 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272
  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">Anchor</span>
  7. </h1>
  8. <ul data-tabs="tabs" class="nav tabs pos0">
  9. <li data-dropdown="dropdown" class="dropdown"><a href="#" data-toggle="dropdown" class="dropdown-toggle"><span>Events (1)</span><b class="caret"></b></a>
  10. <ul class="dropdown-menu">
  11. <li id="dropdown_Anchor.event.change" data-id="Anchor.event.change" class="memberLink"><a href="#Anchor.event.change" class="" title="Anchor.event.change (event)" data-id="Anchor.event.change">change</a>
  12. </li>
  13. </ul>
  14. </li>
  15. <li data-dropdown="dropdown" class="dropdown"><a href="#" data-toggle="dropdown" class="dropdown-toggle"><span>Constructors (1)</span><b class="caret"></b></a>
  16. <ul class="dropdown-menu">
  17. <li id="dropdown_Anchor.new" data-id="Anchor.new" class="memberLink"><a href="#Anchor.new" class="" title="Anchor.new (constructor)" data-id="Anchor.new">new</a>
  18. </li>
  19. </ul>
  20. </li>
  21. <li data-dropdown="dropdown" class="dropdown"><a href="#" data-toggle="dropdown" class="dropdown-toggle"><span>Functions (6)</span><b class="caret"></b></a>
  22. <ul class="dropdown-menu">
  23. <li id="dropdown_Anchor.detach" data-id="Anchor.detach" class="memberLink"><a href="#Anchor.detach" class="" title="Anchor.detach (class method)" data-id="Anchor.detach">detach</a>
  24. </li>
  25. <li id="dropdown_Anchor.getDocument" data-id="Anchor.getDocument" class="memberLink"><a href="#Anchor.getDocument" class="" title="Anchor.getDocument (class method)" data-id="Anchor.getDocument">getDocument</a>
  26. </li>
  27. <li id="dropdown_Anchor.getPosition" data-id="Anchor.getPosition" class="memberLink"><a href="#Anchor.getPosition" class="" title="Anchor.getPosition (class method)" data-id="Anchor.getPosition">getPosition</a>
  28. </li>
  29. <li id="dropdown_Anchor.onChange" data-id="Anchor.onChange" class="memberLink"><a href="#Anchor.onChange" class="" title="Anchor.onChange (class method)" data-id="Anchor.onChange">onChange</a>
  30. </li>
  31. <li id="dropdown_Anchor.setPosition" data-id="Anchor.setPosition" class="memberLink"><a href="#Anchor.setPosition" class="" title="Anchor.setPosition (class method)" data-id="Anchor.setPosition">setPosition</a>
  32. </li>
  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. <li data-dropdown="dropdown" class="dropdown">
  44. <ul class="dropdown-menu">
  45. </ul>
  46. </li>
  47. <li data-dropdown="dropdown" class="dropdown">
  48. <ul class="dropdown-menu">
  49. </ul>
  50. </li>
  51. </ul>
  52. </div>
  53. </div>
  54. <article id="Anchor" data-title="Anchor (class)" class="article">
  55. <div class="section description">
  56. <div class="memberContent"><p>Defines the floating pointer in the document. Whenever text is inserted or deleted before the cursor, the position of the cursor is updated.</p>
  57. </div>
  58. </div>
  59. </article>
  60. <h3 class="sectionHeader">Constructors</h3>
  61. <article id="Anchor.new" data-title="Anchor.new (constructor)" class="article">
  62. <div class="section method">
  63. <div class="memberContent">
  64. <div class="title"><i id="Anchor.new" class="methodToggle methodClicker inactive icon-caret-right"></i>
  65. <ul class="signatures">
  66. <li class="signature">
  67. <ul>
  68. <li class="signature-call"><span class="constructorIdentifier">new </span><span id="Anchor.new" class="member-name methodClicker">Anchor</span>(<span class="sigArgList"><a href="document.html" class="argument methodClicker" title="Document (class)" data-id="Document">Document</a> doc, <a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="argument methodClicker" title="Number" data-id="Number">Number</a> row, <a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="argument methodClicker" title="Number" data-id="Number">Number</a> column</span>)</li>
  69. </ul>
  70. <ul class="metaInfo">
  71. </ul>
  72. </li>
  73. </ul>
  74. </div>
  75. <div class="sideToggler">
  76. <div id="ellipsis_Anchor.new" class="ellipsis_description"><p>Creates a new <code>Anchor</code> and associates it with a document.</p>
  77. </div>
  78. <div class="description"><p>Creates a new <code>Anchor</code> and associates it with a document.</p>
  79. <h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"><tr class="argumentRow "><td class="argName ">doc</td><td class="argType" "><a href="document.html" class="" title="Document (class)" data-id="Document">Document</a></td><td class="argDescription "><p>Required. The document to associate with the anchor</p>
  80. </td></tr><tr class="argumentRow "><td class="argName ">row</td><td class="argType" "><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="" title="Number" data-id="Number">Number</a></td><td class="argDescription "><p>Required. The starting row position</p>
  81. </td></tr><tr class="argumentRow "><td class="argName ">column</td><td class="argType" "><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="" title="Number" data-id="Number">Number</a></td><td class="argDescription "><p>Required. The starting column position</p>
  82. </td></tr></table>
  83. </div>
  84. </div>
  85. </div>
  86. </div>
  87. </article>
  88. <h3 class="sectionHeader">Events</h3>
  89. <article id="Anchor.event.change" data-title="Anchor.event.change (event)" class="article">
  90. <div class="section method">
  91. <div class="memberContent">
  92. <div class="title"><i id="Anchor.event.change" class="methodToggle methodClicker inactive icon-caret-right"></i>
  93. <ul class="signatures">
  94. <li class="signature">
  95. <ul>
  96. <li class="signature-call"><span class="eventObjName">Anchor</span><span class="eventListenerStart">.on("</span><span id="Anchor.event.change" class="member-name eventMember methodClicker">change</span><span class="eventListenerClose">", </span><span class="eventFunctionOpen">function(</span><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Object" class="argument methodClicker" title="Object" data-id="Object">Object</a> e<span class="eventFunctionClose">))</span></li>
  97. </ul>
  98. <ul class="metaInfo">
  99. </ul>
  100. </li>
  101. </ul>
  102. </div>
  103. <div class="sideToggler">
  104. <div id="ellipsis_Anchor.event.change" class="ellipsis_description"><p>Fires whenever the anchor position changes.</p>
  105. </div>
  106. <div class="description"><p>Fires whenever the anchor position changes.</p>
  107. <p>Both of these objects have a <code>row</code> and <code>column</code> property corresponding to the position.</p>
  108. <p>Events that can trigger this function include <a href="#Anchor.setPosition" class="link-short" title="Anchor.setPosition (class method)" data-id="Anchor.setPosition"><code>setPosition()</code></a>.</p>
  109. <h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"><tr class="argumentRow "><td class="argName ">e</td><td class="argType" "><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Object" class="" title="Object" data-id="Object">Object</a></td><td class="argDescription "><p>Required. An object containing information about the anchor position. It has two properties: </p>
  110. <ul>
  111. <li><code>old</code>: An object describing the old Anchor position</li>
  112. <li><code>value</code>: An object describing the new Anchor position</li>
  113. </ul>
  114. </td></tr></table>
  115. </div>
  116. </div>
  117. </div>
  118. </div>
  119. </article>
  120. <h3 class="sectionHeader">Methods</h3>
  121. <article id="Anchor.detach" data-title="Anchor.detach (class method)" class="article">
  122. <div class="section method">
  123. <div class="memberContent">
  124. <div class="title"><i id="Anchor.detach" class="methodToggle methodClicker inactive icon-caret-right"></i>
  125. <ul class="signatures">
  126. <li class="signature">
  127. <ul>
  128. <li class="signature-call"><span id="Anchor.detach" class="member-name methodClicker"><span class="sigClassName">Anchor.</span><span class="sigMemberName">detach</span></span><span class="emptyArgumentList">()</span></li>
  129. </ul>
  130. <ul class="metaInfo">
  131. </ul>
  132. </li>
  133. </ul>
  134. </div>
  135. <div class="sideToggler">
  136. <div id="ellipsis_Anchor.detach" class="ellipsis_description"><p>When called, the <code>&#39;change&#39;</code> event listener is removed.</p>
  137. </div>
  138. <div class="description"><p>When called, the <code>&#39;change&#39;</code> event listener is removed.</p>
  139. </div>
  140. </div>
  141. </div>
  142. </div>
  143. </article>
  144. <article id="Anchor.getDocument" data-title="Anchor.getDocument (class method)" class="article">
  145. <div class="section method">
  146. <div class="memberContent">
  147. <div class="title"><i id="Anchor.getDocument" class="methodToggle methodClicker inactive icon-caret-right"></i>
  148. <ul class="signatures">
  149. <li class="signature">
  150. <ul>
  151. <li class="signature-call"><span id="Anchor.getDocument" class="member-name methodClicker"><span class="sigClassName">Anchor.</span><span class="sigMemberName">getDocument</span></span><span class="emptyArgumentList">()</span>
  152. <li class="signature-returns">
  153. <ul class="argument-types">
  154. <li class="argument-type"><a href="document.html" class="returnType " title="Document (class)" data-id="Document">Document</a></li>
  155. </ul>
  156. </li></li>
  157. </ul>
  158. <ul class="metaInfo">
  159. </ul>
  160. </li>
  161. </ul>
  162. </div>
  163. <div class="sideToggler">
  164. <div id="ellipsis_Anchor.getDocument" class="ellipsis_description"><p>Returns the current document.</p>
  165. </div>
  166. <div class="description"><p>Returns the current document.</p>
  167. </div>
  168. </div>
  169. </div>
  170. </div>
  171. </article>
  172. <article id="Anchor.getPosition" data-title="Anchor.getPosition (class method)" class="article">
  173. <div class="section method">
  174. <div class="memberContent">
  175. <div class="title"><i id="Anchor.getPosition" class="methodToggle methodClicker inactive icon-caret-right"></i>
  176. <ul class="signatures">
  177. <li class="signature">
  178. <ul>
  179. <li class="signature-call"><span id="Anchor.getPosition" class="member-name methodClicker"><span class="sigClassName">Anchor.</span><span class="sigMemberName">getPosition</span></span><span class="emptyArgumentList">()</span>
  180. <li class="signature-returns">
  181. <ul class="argument-types">
  182. <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>
  183. </ul>
  184. </li></li>
  185. </ul>
  186. <ul class="metaInfo">
  187. </ul>
  188. </li>
  189. </ul>
  190. </div>
  191. <div class="sideToggler">
  192. <div id="ellipsis_Anchor.getPosition" class="ellipsis_description"><p>Returns an object identifying the <code>row</code> and <code>column</code> position of the current anchor.</p>
  193. </div>
  194. <div class="description"><p>Returns an object identifying the <code>row</code> and <code>column</code> position of the current anchor.</p>
  195. </div>
  196. </div>
  197. </div>
  198. </div>
  199. </article>
  200. <article id="Anchor.onChange" data-title="Anchor.onChange (class method)" class="article">
  201. <div class="section method">
  202. <div class="memberContent">
  203. <div class="title"><i id="Anchor.onChange" class="methodToggle methodClicker inactive icon-caret-right"></i>
  204. <ul class="signatures">
  205. <li class="signature">
  206. <ul>
  207. <li class="signature-call"><span id="Anchor.onChange" class="member-name methodClicker"><span class="sigClassName">Anchor.</span><span class="sigMemberName">onChange</span></span><span class="emptyArgumentList">()</span></li>
  208. </ul>
  209. <ul class="metaInfo">
  210. <li><span class="label undocumented">Undocumented</span></li>
  211. </ul>
  212. </li>
  213. </ul>
  214. </div>
  215. <div class="sideToggler">
  216. <div id="ellipsis_Anchor.onChange" class="ellipsis_description">
  217. </div>
  218. <div class="description">
  219. </div>
  220. </div>
  221. </div>
  222. </div>
  223. </article>
  224. <article id="Anchor.setPosition" data-title="Anchor.setPosition (class method)" class="article">
  225. <div class="section method">
  226. <div class="memberContent">
  227. <div class="title"><i id="Anchor.setPosition" class="methodToggle methodClicker inactive icon-caret-right"></i>
  228. <ul class="signatures">
  229. <li class="signature">
  230. <ul>
  231. <li class="signature-call"><span id="Anchor.setPosition" class="member-name methodClicker"><span class="sigClassName">Anchor.</span><span class="sigMemberName">setPosition</span></span>(<span class="sigArgList"><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="argument methodClicker" title="Number" data-id="Number">Number</a> row, <a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="argument methodClicker" title="Number" data-id="Number">Number</a> column, <a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Boolean" class="argument methodClicker" title="Boolean" data-id="Boolean">Boolean</a> noClip</span>)</li>
  232. </ul>
  233. <ul class="metaInfo">
  234. </ul>
  235. </li>
  236. </ul>
  237. </div>
  238. <div class="sideToggler">
  239. <div id="ellipsis_Anchor.setPosition" class="ellipsis_description"><p>Sets the anchor position to the specified row and column. If <code>noClip</code> is <code>true</code>, the position is not clipped.</p>
  240. </div>
  241. <div class="description"><p>Sets the anchor position to the specified row and column. If <code>noClip</code> is <code>true</code>, the position is not clipped.</p>
  242. <h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"><tr class="argumentRow "><td class="argName ">row</td><td class="argType" "><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="" title="Number" data-id="Number">Number</a></td><td class="argDescription "><p>Required. The row index to move the anchor to</p>
  243. </td></tr><tr class="argumentRow "><td class="argName ">column</td><td class="argType" "><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="" title="Number" data-id="Number">Number</a></td><td class="argDescription "><p>Required. The column index to move the anchor to</p>
  244. </td></tr><tr class="argumentRow "><td class="argName ">noClip</td><td class="argType" "><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Boolean" class="" title="Boolean" data-id="Boolean">Boolean</a></td><td class="argDescription "><p>Required. Identifies if you want the position to be clipped</p>
  245. </td></tr></table>
  246. </div>
  247. </div>
  248. </div>
  249. </div>
  250. </article>
  251. </div>
  252. <script defer src="./resources/javascripts/ux.js"></script>
  253. <script src="./resources/javascripts/clicker.js"></script>
  254. <script src="./resources/javascripts/jquery-scrollspy.js"></script>
  255. <script defer src="./resources/javascripts/disqus-ext.js"></script>
  256. <script defer src="./resources/javascripts/ga.js"></script>
  257. <div id="disqus_thread"></div>
  258. </div>