DOMite.st 6.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330
  1. Smalltalk createPackage: 'DOMite'!
  2. ProtoStream subclass: #Domite
  3. instanceVariableNames: 'element reference'
  4. package: 'DOMite'!
  5. !Domite commentStamp!
  6. I am (hopefully thin) wrapper around the notion of "cursor in a page".
  7. I represent a DOM node _and_ a point where
  8. to insert new content into it.
  9. So I play both the role of a container that inserts
  10. as well as the role of an element being inserted.
  11. I inherit from `ProtoStream`.
  12. Creation API:
  13. - `Domite new` creates an insertion point at the bottom of `<body>`.
  14. - `Domite newStream` is unique way to create pieces of content. It creates an instance "floating in thin air" (wrapper around DOM DocumentFragment) that can be filled with any contents and then inserted in a page.
  15. - `Domite fromElement: aDomElement` wraps an element and set the cursor to its end.
  16. CSS selector API:
  17. - `Domite at: aSelector` wraps an element found by `document.querySelector(aSelector)`.
  18. - `aDomite at: aSelector` wraps an element found by `element.querySelector(aSelector)`.
  19. - `Domite allAt: aSelector` return collection of wrapped results of `document.querySelectorAll(aSelector)`.
  20. - `aDomite allAt: aSelector` return collection of wrapped results of `element.querySelectorAll(aSelector)`.
  21. Manipulation API:
  22. - `aDomite << obj` inserts obj at the insertion point.
  23. - `aDomite resetContents` deletes contents of the wrapped element.
  24. - `aDomite cutUpTo: anotherDomite` removes contents between the two cursors (or up to the end of the receiver) and returns it collected in a wrapped DocumentFragment (IOW, you can `anotherPlace << theResult` to move the contents in the specified range).
  25. Cursor moving API:
  26. Take this sample HTML, where `[n]` are just markers, not real content:
  27. ```
  28. <body>
  29. <h1>header</h1>
  30. [4]<p>[2]Hello[1]world[3]</p>[5]
  31. <small>footer</small>
  32. </body>
  33. ```
  34. If `d` is a `Domite` representing `[1]`, then:
  35. - `d setToStart` would move `d` to be at `[2]`,
  36. - `d setToEnd` would move `d` to be at `[3]`,
  37. - `d setToBefore` would move `d` to be at `[4]`, and
  38. - `d setToAfter` would move `d` to be at `[5]`.
  39. It is not presumed one would use `setToXxx`
  40. to actually move around in a single instance.
  41. It is envisioned this API will be used mostly
  42. in combination with `copy`, like
  43. `afterMe := self copy setToAfter`.!
  44. !Domite methodsFor: 'accessing'!
  45. allAt: aString
  46. ^ self class wrap: (self class domListAsArray: (self element querySelectorAll: aString))
  47. !
  48. at: aString
  49. ^ self class fromElement: (self element querySelector: aString)
  50. !
  51. attrAt: aString
  52. (element hasAttribute: aString)
  53. ifTrue: [ ^ element getAttribute: aString ]
  54. ifFalse: [ ^ nil ]
  55. !
  56. attrAt: aString put: anotherString
  57. element setAttribute: aString to: anotherString
  58. !
  59. element
  60. ^ element
  61. !
  62. element: anObject
  63. element := anObject
  64. !
  65. propAt: aString
  66. ^ element at: aString
  67. !
  68. propAt: aString put: anObject
  69. ^ element at: aString put: anObject
  70. !
  71. reference
  72. ^ reference
  73. !
  74. reference: anObject
  75. reference := anObject
  76. ! !
  77. !Domite methodsFor: 'comparing'!
  78. = aDomite
  79. ^ self class = aDomite class and: [
  80. self element = aDomite element and: [
  81. self reference = aDomite reference ]]
  82. ! !
  83. !Domite methodsFor: 'converting'!
  84. asJQuery
  85. ^ self element asJQuery
  86. ! !
  87. !Domite methodsFor: 'deletion'!
  88. cutUpTo: aDomite
  89. <
  90. var result = document.createDocumentFragment(),
  91. start = self['@reference'],
  92. end = aDomite['@reference'],
  93. tmp;
  94. while (start && start !!= end) {
  95. tmp = start;
  96. start = start.nextSibling;
  97. result.appendChild(tmp);
  98. }
  99. self['@reference'] = start;
  100. return self._class()._fromElement_(result);
  101. >
  102. !
  103. resetContents
  104. <
  105. var element = self['@element'], child;
  106. while (child = element.firstChild) element.removeChild(child);
  107. self['@reference'] = null;
  108. >
  109. ! !
  110. !Domite methodsFor: 'events'!
  111. off: aString unbind: aBlock
  112. self element removeEventListener: aString block: aBlock useCapture: false
  113. !
  114. on: aString bind: aBlock
  115. self element addEventListener: aString block: aBlock useCapture: false
  116. ! !
  117. !Domite methodsFor: 'initialization'!
  118. initialize
  119. super initialize.
  120. element := document body.
  121. reference := nil asJSON
  122. ! !
  123. !Domite methodsFor: 'insertion'!
  124. nextPut: anObject
  125. self nextPutString: anObject printString
  126. !
  127. nextPutDomNode: aDomElement
  128. self element
  129. insertBefore: aDomElement
  130. reference: self reference
  131. !
  132. nextPutJSObject: aJSObject
  133. (Domite isDomNode: aJSObject)
  134. ifTrue: [ self nextPutDomNode: aJSObject ]
  135. ifFalse: [ self nextPut: aJSObject ]
  136. !
  137. nextPutString: aString
  138. self nextPutDomNode: (
  139. document createTextNode: aString asString )
  140. ! !
  141. !Domite methodsFor: 'positioning'!
  142. reset
  143. self reference: self element firstChild
  144. !
  145. setToAfter
  146. self
  147. reference: self element nextSibling;
  148. element: self element parentNode
  149. !
  150. setToBefore
  151. self
  152. reference: self element;
  153. element: self element parentNode
  154. !
  155. setToEnd
  156. self reference: nil asJSON "null"
  157. !
  158. setToNext
  159. self atEnd ifFalse: [
  160. self reference: self reference nextSibling ]
  161. !
  162. setToPrev
  163. self atStart ifFalse: [
  164. self reference: (self reference
  165. ifNil: [ self element lastChild ]
  166. ifNotNil: [ :ref | ref previousSibling ])]
  167. ! !
  168. !Domite methodsFor: 'reading'!
  169. next
  170. self atEnd
  171. ifTrue: [ ^ nil ]
  172. ifFalse: [ | result |
  173. result := self peek.
  174. self setToNext.
  175. ^ result ]
  176. !
  177. peek
  178. ^ self reference
  179. ifNotNil: [ :ref | self class fromElement: ref ]
  180. !
  181. prev
  182. self atStart
  183. ifTrue: [ ^ nil ]
  184. ifFalse: [ self setToPrev. ^ self peek ]
  185. ! !
  186. !Domite methodsFor: 'streaming'!
  187. putOn: aStream
  188. aStream nextPutDomNode: self element
  189. ! !
  190. !Domite methodsFor: 'testing'!
  191. atEnd
  192. ^ self reference isNil
  193. !
  194. atStart
  195. ^ self reference = self element firstChild
  196. !
  197. canSetToUpperLevel
  198. ^ self element parentNode notNil
  199. !
  200. isInvalid
  201. ^ self element isNil
  202. ! !
  203. !Domite class methodsFor: 'converting'!
  204. domListAsArray: aDomList
  205. <return Array.prototype.slice.call(aDomList)>
  206. !
  207. wrap: aCollection
  208. ^ aCollection collect: [ :each | self fromElement: each ]
  209. ! !
  210. !Domite class methodsFor: 'instance creation'!
  211. allAt: aString
  212. ^ self wrap: (self domListAsArray: (document querySelectorAll: aString))
  213. !
  214. at: aString
  215. ^ self fromElement: (document querySelector: aString)
  216. !
  217. fromElement: aDomElement
  218. aDomElement ifNotNil: [
  219. (self isDomNode: aDomElement) ifFalse: [
  220. self error: self name, ': Need a DOM node' ]].
  221. ^ self new
  222. element: aDomElement;
  223. yourself
  224. !
  225. fromElement: aDomElement cursorBefore: anotherDomElement
  226. aDomElement ifNotNil: [
  227. (self isDomNode: aDomElement) ifFalse: [
  228. self error: self name, ': Need a DOM node' ]].
  229. ^ self new
  230. element: aDomElement;
  231. referenceElement: anotherDomElement;
  232. yourself
  233. !
  234. newElement: aString
  235. ^ self fromElement: (document createElement: aString)
  236. !
  237. newElement: aString xmlns: anotherString
  238. ^ self fromElement: (document createElementNS: anotherString tagName: aString)
  239. !
  240. newStream
  241. ^ self fromElement: document createDocumentFragment
  242. ! !
  243. !Domite class methodsFor: 'testing'!
  244. isDomNode: anObject
  245. <
  246. return anObject.nodeType >> 0 &&
  247. Object.prototype.toString.call(anObject) !!== "[object Object]"
  248. >
  249. ! !
  250. !ProtoStream methodsFor: '*DOMite'!
  251. nextPutDomNode: aNode
  252. self nextPut: aNode
  253. ! !