scrollbar.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261
  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">ScrollBar</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_ScrollBar.event.scroll" data-id="ScrollBar.event.scroll" class="memberLink"><a href="#ScrollBar.event.scroll" class="" title="ScrollBar.event.scroll (event)" data-id="ScrollBar.event.scroll">scroll</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_ScrollBar.new" data-id="ScrollBar.new" class="memberLink"><a href="#ScrollBar.new" class="" title="ScrollBar.new (constructor)" data-id="ScrollBar.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 (5)</span><b class="caret"></b></a>
  22. <ul class="dropdown-menu">
  23. <li id="dropdown_ScrollBar.getWidth" data-id="ScrollBar.getWidth" class="memberLink"><a href="#ScrollBar.getWidth" class="" title="ScrollBar.getWidth (class method)" data-id="ScrollBar.getWidth">getWidth</a>
  24. </li>
  25. <li id="dropdown_ScrollBar.onScroll" data-id="ScrollBar.onScroll" class="memberLink"><a href="#ScrollBar.onScroll" class="" title="ScrollBar.onScroll (class method)" data-id="ScrollBar.onScroll">onScroll</a>
  26. </li>
  27. <li id="dropdown_ScrollBar.setHeight" data-id="ScrollBar.setHeight" class="memberLink"><a href="#ScrollBar.setHeight" class="" title="ScrollBar.setHeight (class method)" data-id="ScrollBar.setHeight">setHeight</a>
  28. </li>
  29. <li id="dropdown_ScrollBar.setInnerHeight" data-id="ScrollBar.setInnerHeight" class="memberLink"><a href="#ScrollBar.setInnerHeight" class="" title="ScrollBar.setInnerHeight (class method)" data-id="ScrollBar.setInnerHeight">setInnerHeight</a>
  30. </li>
  31. <li id="dropdown_ScrollBar.setScrollTop" data-id="ScrollBar.setScrollTop" class="memberLink"><a href="#ScrollBar.setScrollTop" class="" title="ScrollBar.setScrollTop (class method)" data-id="ScrollBar.setScrollTop">setScrollTop</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="ScrollBar" data-title="ScrollBar (class)" class="article">
  55. <div class="section description">
  56. <div class="memberContent"><p>A set of methods for setting and retrieving the editor&#39;s scrollbar.</p>
  57. </div>
  58. </div>
  59. </article>
  60. <h3 class="sectionHeader">Constructors</h3>
  61. <article id="ScrollBar.new" data-title="ScrollBar.new (constructor)" class="article">
  62. <div class="section method">
  63. <div class="memberContent">
  64. <div class="title"><i id="ScrollBar.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="ScrollBar.new" class="member-name methodClicker">ScrollBar</span>(<span class="sigArgList"><a href="https://developer.mozilla.org/en/DOM/element" class="argument methodClicker" title="DOMElement" data-id="DOMElement">DOMElement</a> parent</span>)</li>
  69. </ul>
  70. <ul class="metaInfo">
  71. </ul>
  72. </li>
  73. </ul>
  74. </div>
  75. <div class="sideToggler">
  76. <div id="ellipsis_ScrollBar.new" class="ellipsis_description"><p>Creates a new <code>ScrollBar</code>. <code>parent</code> is the owner of the scroll bar.</p>
  77. </div>
  78. <div class="description"><p>Creates a new <code>ScrollBar</code>. <code>parent</code> is the owner of the scroll bar.</p>
  79. <h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"><tr class="argumentRow "><td class="argName ">parent</td><td class="argType" "><a href="https://developer.mozilla.org/en/DOM/element" class="" title="DOMElement" data-id="DOMElement">DOMElement</a></td><td class="argDescription "><p>Required. A DOM element</p>
  80. </td></tr></table>
  81. </div>
  82. </div>
  83. </div>
  84. </div>
  85. </article>
  86. <h3 class="sectionHeader">Events</h3>
  87. <article id="ScrollBar.event.scroll" data-title="ScrollBar.event.scroll (event)" class="article">
  88. <div class="section method">
  89. <div class="memberContent">
  90. <div class="title"><i id="ScrollBar.event.scroll" class="methodToggle methodClicker inactive icon-caret-right"></i>
  91. <ul class="signatures">
  92. <li class="signature">
  93. <ul>
  94. <li class="signature-call"><span class="eventObjName">ScrollBar</span><span class="eventListenerStart">.on("</span><span id="ScrollBar.event.scroll" class="member-name eventMember methodClicker">scroll</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>
  95. </ul>
  96. <ul class="metaInfo">
  97. </ul>
  98. </li>
  99. </ul>
  100. </div>
  101. <div class="sideToggler">
  102. <div id="ellipsis_ScrollBar.event.scroll" class="ellipsis_description"><p>Emitted when the scroll bar, well, scrolls.</p>
  103. </div>
  104. <div class="description"><p>Emitted when the scroll bar, well, scrolls.</p>
  105. <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. Contains one property, <code>&quot;data&quot;</code>, which indicates the current scroll top position</p>
  106. </td></tr></table>
  107. </div>
  108. </div>
  109. </div>
  110. </div>
  111. </article>
  112. <h3 class="sectionHeader">Methods</h3>
  113. <article id="ScrollBar.getWidth" data-title="ScrollBar.getWidth (class method)" class="article">
  114. <div class="section method">
  115. <div class="memberContent">
  116. <div class="title"><i id="ScrollBar.getWidth" class="methodToggle methodClicker inactive icon-caret-right"></i>
  117. <ul class="signatures">
  118. <li class="signature">
  119. <ul>
  120. <li class="signature-call"><span id="ScrollBar.getWidth" class="member-name methodClicker"><span class="sigClassName">ScrollBar.</span><span class="sigMemberName">getWidth</span></span><span class="emptyArgumentList">()</span>
  121. <li class="signature-returns">
  122. <ul class="argument-types">
  123. <li class="argument-type"><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="returnType " title="Number" data-id="Number">Number</a></li>
  124. </ul>
  125. </li></li>
  126. </ul>
  127. <ul class="metaInfo">
  128. </ul>
  129. </li>
  130. </ul>
  131. </div>
  132. <div class="sideToggler">
  133. <div id="ellipsis_ScrollBar.getWidth" class="ellipsis_description"><p>Returns the width of the scroll bar.</p>
  134. </div>
  135. <div class="description"><p>Returns the width of the scroll bar.</p>
  136. </div>
  137. </div>
  138. </div>
  139. </div>
  140. </article>
  141. <article id="ScrollBar.onScroll" data-title="ScrollBar.onScroll (class method)" class="article">
  142. <div class="section method">
  143. <div class="memberContent">
  144. <div class="title"><i id="ScrollBar.onScroll" class="methodToggle methodClicker inactive icon-caret-right"></i>
  145. <ul class="signatures">
  146. <li class="signature">
  147. <ul>
  148. <li class="signature-call"><span id="ScrollBar.onScroll" class="member-name methodClicker"><span class="sigClassName">ScrollBar.</span><span class="sigMemberName">onScroll</span></span><span class="emptyArgumentList">()</span></li>
  149. </ul>
  150. <ul class="metaInfo">
  151. <li><span class="label undocumented">Undocumented</span></li>
  152. </ul>
  153. </li>
  154. </ul>
  155. </div>
  156. <div class="sideToggler">
  157. <div id="ellipsis_ScrollBar.onScroll" class="ellipsis_description">
  158. </div>
  159. <div class="description">
  160. </div>
  161. </div>
  162. </div>
  163. </div>
  164. </article>
  165. <article id="ScrollBar.setHeight" data-title="ScrollBar.setHeight (class method)" class="article">
  166. <div class="section method">
  167. <div class="memberContent">
  168. <div class="title"><i id="ScrollBar.setHeight" class="methodToggle methodClicker inactive icon-caret-right"></i>
  169. <ul class="signatures">
  170. <li class="signature">
  171. <ul>
  172. <li class="signature-call"><span id="ScrollBar.setHeight" class="member-name methodClicker"><span class="sigClassName">ScrollBar.</span><span class="sigMemberName">setHeight</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> height</span>)</li>
  173. </ul>
  174. <ul class="metaInfo">
  175. </ul>
  176. </li>
  177. </ul>
  178. </div>
  179. <div class="sideToggler">
  180. <div id="ellipsis_ScrollBar.setHeight" class="ellipsis_description"><p>Sets the height of the scroll bar, in pixels.</p>
  181. </div>
  182. <div class="description"><p>Sets the height of the scroll bar, in pixels.</p>
  183. <h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"><tr class="argumentRow "><td class="argName ">height</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 new height</p>
  184. </td></tr></table>
  185. </div>
  186. </div>
  187. </div>
  188. </div>
  189. </article>
  190. <article id="ScrollBar.setInnerHeight" data-title="ScrollBar.setInnerHeight (class method)" class="article">
  191. <div class="section method">
  192. <div class="memberContent">
  193. <div class="title"><i id="ScrollBar.setInnerHeight" class="methodToggle methodClicker inactive icon-caret-right"></i>
  194. <ul class="signatures">
  195. <li class="signature">
  196. <ul>
  197. <li class="signature-call"><span id="ScrollBar.setInnerHeight" class="member-name methodClicker"><span class="sigClassName">ScrollBar.</span><span class="sigMemberName">setInnerHeight</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> height</span>)</li>
  198. </ul>
  199. <ul class="metaInfo">
  200. </ul>
  201. </li>
  202. </ul>
  203. </div>
  204. <div class="sideToggler">
  205. <div id="ellipsis_ScrollBar.setInnerHeight" class="ellipsis_description"><p>Sets the inner height of the scroll bar, in pixels.</p>
  206. </div>
  207. <div class="description"><p>Sets the inner height of the scroll bar, in pixels.</p>
  208. <h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"><tr class="argumentRow "><td class="argName ">height</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 new inner height</p>
  209. </td></tr></table>
  210. </div>
  211. </div>
  212. </div>
  213. </div>
  214. </article>
  215. <article id="ScrollBar.setScrollTop" data-title="ScrollBar.setScrollTop (class method)" class="article">
  216. <div class="section method">
  217. <div class="memberContent">
  218. <div class="title"><i id="ScrollBar.setScrollTop" class="methodToggle methodClicker inactive icon-caret-right"></i>
  219. <ul class="signatures">
  220. <li class="signature">
  221. <ul>
  222. <li class="signature-call"><span id="ScrollBar.setScrollTop" class="member-name methodClicker"><span class="sigClassName">ScrollBar.</span><span class="sigMemberName">setScrollTop</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> scrollTop</span>)</li>
  223. </ul>
  224. <ul class="metaInfo">
  225. </ul>
  226. </li>
  227. </ul>
  228. </div>
  229. <div class="sideToggler">
  230. <div id="ellipsis_ScrollBar.setScrollTop" class="ellipsis_description"><p>Sets the scroll top of the scroll bar.</p>
  231. </div>
  232. <div class="description"><p>Sets the scroll top of the scroll bar.</p>
  233. <h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"><tr class="argumentRow "><td class="argName ">scrollTop</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 new scroll top</p>
  234. </td></tr></table>
  235. </div>
  236. </div>
  237. </div>
  238. </div>
  239. </article>
  240. </div>
  241. <script defer src="./resources/javascripts/ux.js"></script>
  242. <script src="./resources/javascripts/clicker.js"></script>
  243. <script src="./resources/javascripts/jquery-scrollspy.js"></script>
  244. <script defer src="./resources/javascripts/disqus-ext.js"></script>
  245. <script defer src="./resources/javascripts/ga.js"></script>
  246. <div id="disqus_thread"></div>
  247. </div>