DOMite.st 4.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247
  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. Manipulation API:
  19. - `aDomite << obj` inserts obj at the insertion point.
  20. - `aDomite resetContents` deletes contents of the wrapped element.
  21. Cursor moving API:
  22. Take this sample HTML, where `[n]` are just markers, not real content:
  23. ```
  24. <body>
  25. <h1>header</h1>
  26. [4]<p>[2]Hello[1]world[3]</p>[5]
  27. <small>footer</small>
  28. </body>
  29. ```
  30. If `d` is a `Domite` representing `[1]`, then:
  31. - `d setToStart` would move `d` to be at `[2]`,
  32. - `d setToEnd` would move `d` to be at `[3]`,
  33. - `d setToBefore` would move `d` to be at `[4]`, and
  34. - `d setToAfter` would move `d` to be at `[5]`.
  35. It is not presumed one would use `setToXxx`
  36. to actually move around in a single instance.
  37. It is envisioned this API will be used mostly
  38. in combination with `copy`, like
  39. `afterMe := self copy setToAfter`.!
  40. !Domite methodsFor: 'accessing'!
  41. at: aString
  42. ^ self class fromElement: (self element querySelector: aString)
  43. !
  44. attrAt: aString
  45. (element hasAttribute: aString)
  46. ifTrue: [ ^ element getAttribute: aString ]
  47. ifFalse: [ ^ nil ]
  48. !
  49. attrAt: aString put: anotherString
  50. element setAttribute: aString to: anotherString
  51. !
  52. element
  53. ^ element
  54. !
  55. element: anObject
  56. element := anObject
  57. !
  58. propAt: aString
  59. ^ element at: aString
  60. !
  61. propAt: aString put: anObject
  62. ^ element at: aString put: anObject
  63. !
  64. reference
  65. ^ reference
  66. !
  67. reference: anObject
  68. reference := anObject
  69. ! !
  70. !Domite methodsFor: 'comparing'!
  71. = aDomite
  72. ^ self class = aDomite class and: [
  73. self element = aDomite element and: [
  74. self reference = aDomite reference ]]
  75. ! !
  76. !Domite methodsFor: 'deletion'!
  77. resetContents
  78. <
  79. var element = self['@element'], child;
  80. while (child = element.firstChild) element.removeChild(child);
  81. self['@reference'] = null;
  82. >
  83. ! !
  84. !Domite methodsFor: 'events'!
  85. off: aString unbind: aBlock
  86. self removeEventListener: aString block: aBlock useCapture: false
  87. !
  88. on: aString bind: aBlock
  89. self addEventListener: aString block: aBlock useCapture: false
  90. ! !
  91. !Domite methodsFor: 'initialization'!
  92. initialize
  93. super initialize.
  94. element := document body.
  95. reference := nil asJSON
  96. ! !
  97. !Domite methodsFor: 'insertion'!
  98. nextPut: anObject
  99. self nextPutString: anObject printString
  100. !
  101. nextPutDomNode: aDomElement
  102. self element
  103. insertBefore: aDomElement
  104. reference: self reference
  105. !
  106. nextPutJSObject: aJSObject
  107. (Domite isDomNode: aJSObject)
  108. ifTrue: [ self nextPutDomNode: aJSObject ]
  109. ifFalse: [ self nextPut: aJSObject ]
  110. !
  111. nextPutString: aString
  112. self nextPutDomNode: (
  113. document createTextNode: aString asString )
  114. ! !
  115. !Domite methodsFor: 'positioning'!
  116. reset
  117. self reference: self element firstChild
  118. !
  119. setToAfter
  120. self
  121. reference: self element nextSibling;
  122. element: self element parentNode
  123. !
  124. setToBefore
  125. self
  126. reference: self element;
  127. element: self element parentNode
  128. !
  129. setToEnd
  130. self reference: nil asJSON "null"
  131. ! !
  132. !Domite methodsFor: 'streaming'!
  133. putOn: aStream
  134. aStream nextPutDomNode: self element
  135. ! !
  136. !Domite methodsFor: 'testing'!
  137. atEnd
  138. ^ self reference isNil
  139. !
  140. atStart
  141. ^ self reference = self element firstChild
  142. !
  143. canSetToUpperLevel
  144. ^ self element parentNode notNil
  145. !
  146. isInvalid
  147. ^ self element isNil
  148. ! !
  149. !Domite class methodsFor: 'instance creation'!
  150. at: aString
  151. ^ self fromElement: (document querySelector: aString)
  152. !
  153. fromElement: aDomElement
  154. aDomElement ifNotNil: [
  155. (self isDomNode: aDomElement) ifFalse: [
  156. self error: self name, ': Need a DOM node' ]].
  157. ^ self new
  158. element: aDomElement;
  159. yourself
  160. !
  161. fromElement: aDomElement cursorBefore: anotherDomElement
  162. aDomElement ifNotNil: [
  163. (self isDomNode: aDomElement) ifFalse: [
  164. self error: self name, ': Need a DOM node' ]].
  165. ^ self new
  166. element: aDomElement;
  167. referenceElement: anotherDomElement;
  168. yourself
  169. !
  170. newElement: aString
  171. ^ self fromElement: (document createElement: aString)
  172. !
  173. newStream
  174. ^ self fromElement: document createDocumentFragment
  175. ! !
  176. !Domite class methodsFor: 'testing'!
  177. isDomNode: anObject
  178. <
  179. return anObject.nodeType >> 0 &&
  180. Object.prototype.toString.call(anObject) !!== "[object Object]"
  181. >
  182. ! !
  183. !ProtoStream methodsFor: '*DOMite'!
  184. nextPutDomNode: aNode
  185. self nextPut: aNode
  186. ! !