old_sql 1.16.0 → 1.17.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (273) hide show
  1. data/README.md +24 -13
  2. data/app/controllers/old_sql/report_controller.rb +3 -17
  3. data/app/views/layouts/old_sql/chart.html.erb +11 -0
  4. data/app/views/old_sql/report/chart.html.erb +8 -25
  5. data/lib/generators/old_sql/templates/user_design_template.csv +2 -3
  6. data/lib/generators/old_sql/templates/user_old_sql_demo_chart_design.yml +18 -9
  7. data/lib/old_sql/report_design/chart.rb +2 -2
  8. data/lib/old_sql/report_design/chart_item.rb +4 -4
  9. data/lib/old_sql/report_design/chart_parser.rb +2 -2
  10. data/public/javascripts/old_sql/chart.js +33 -0
  11. metadata +5 -265
  12. data/public/javascripts/old_sql/MochiKit-1.4.2/Changes +0 -362
  13. data/public/javascripts/old_sql/MochiKit-1.4.2/LICENSE.txt +0 -69
  14. data/public/javascripts/old_sql/MochiKit-1.4.2/MANIFEST +0 -179
  15. data/public/javascripts/old_sql/MochiKit-1.4.2/META.json +0 -17
  16. data/public/javascripts/old_sql/MochiKit-1.4.2/doc/html/MochiKit/Async.html +0 -814
  17. data/public/javascripts/old_sql/MochiKit-1.4.2/doc/html/MochiKit/Base.html +0 -1703
  18. data/public/javascripts/old_sql/MochiKit-1.4.2/doc/html/MochiKit/Color.html +0 -755
  19. data/public/javascripts/old_sql/MochiKit-1.4.2/doc/html/MochiKit/DOM.html +0 -1197
  20. data/public/javascripts/old_sql/MochiKit-1.4.2/doc/html/MochiKit/DateTime.html +0 -168
  21. data/public/javascripts/old_sql/MochiKit-1.4.2/doc/html/MochiKit/DragAndDrop.html +0 -187
  22. data/public/javascripts/old_sql/MochiKit-1.4.2/doc/html/MochiKit/Format.html +0 -300
  23. data/public/javascripts/old_sql/MochiKit-1.4.2/doc/html/MochiKit/Iter.html +0 -524
  24. data/public/javascripts/old_sql/MochiKit-1.4.2/doc/html/MochiKit/Logging.html +0 -420
  25. data/public/javascripts/old_sql/MochiKit-1.4.2/doc/html/MochiKit/LoggingPane.html +0 -142
  26. data/public/javascripts/old_sql/MochiKit-1.4.2/doc/html/MochiKit/Position.html +0 -38
  27. data/public/javascripts/old_sql/MochiKit-1.4.2/doc/html/MochiKit/Selector.html +0 -240
  28. data/public/javascripts/old_sql/MochiKit-1.4.2/doc/html/MochiKit/Signal.html +0 -508
  29. data/public/javascripts/old_sql/MochiKit-1.4.2/doc/html/MochiKit/Sortable.html +0 -244
  30. data/public/javascripts/old_sql/MochiKit-1.4.2/doc/html/MochiKit/Style.html +0 -385
  31. data/public/javascripts/old_sql/MochiKit-1.4.2/doc/html/MochiKit/VersionHistory.html +0 -384
  32. data/public/javascripts/old_sql/MochiKit-1.4.2/doc/html/MochiKit/Visual.html +0 -1161
  33. data/public/javascripts/old_sql/MochiKit-1.4.2/doc/html/MochiKit/index.html +0 -447
  34. data/public/javascripts/old_sql/MochiKit-1.4.2/doc/js/toc.js +0 -113
  35. data/public/javascripts/old_sql/MochiKit-1.4.2/doc/rst/MochiKit/Async.rst +0 -767
  36. data/public/javascripts/old_sql/MochiKit-1.4.2/doc/rst/MochiKit/Base.rst +0 -1445
  37. data/public/javascripts/old_sql/MochiKit-1.4.2/doc/rst/MochiKit/Color.rst +0 -651
  38. data/public/javascripts/old_sql/MochiKit-1.4.2/doc/rst/MochiKit/DOM.rst +0 -1143
  39. data/public/javascripts/old_sql/MochiKit-1.4.2/doc/rst/MochiKit/DateTime.rst +0 -145
  40. data/public/javascripts/old_sql/MochiKit-1.4.2/doc/rst/MochiKit/DragAndDrop.rst +0 -197
  41. data/public/javascripts/old_sql/MochiKit-1.4.2/doc/rst/MochiKit/Format.rst +0 -258
  42. data/public/javascripts/old_sql/MochiKit-1.4.2/doc/rst/MochiKit/Iter.rst +0 -454
  43. data/public/javascripts/old_sql/MochiKit-1.4.2/doc/rst/MochiKit/Logging.rst +0 -348
  44. data/public/javascripts/old_sql/MochiKit-1.4.2/doc/rst/MochiKit/LoggingPane.rst +0 -128
  45. data/public/javascripts/old_sql/MochiKit-1.4.2/doc/rst/MochiKit/Position.rst +0 -26
  46. data/public/javascripts/old_sql/MochiKit-1.4.2/doc/rst/MochiKit/Selector.rst +0 -203
  47. data/public/javascripts/old_sql/MochiKit-1.4.2/doc/rst/MochiKit/Signal.rst +0 -498
  48. data/public/javascripts/old_sql/MochiKit-1.4.2/doc/rst/MochiKit/Sortable.rst +0 -186
  49. data/public/javascripts/old_sql/MochiKit-1.4.2/doc/rst/MochiKit/Style.rst +0 -353
  50. data/public/javascripts/old_sql/MochiKit-1.4.2/doc/rst/MochiKit/VersionHistory.rst +0 -362
  51. data/public/javascripts/old_sql/MochiKit-1.4.2/doc/rst/MochiKit/Visual.rst +0 -895
  52. data/public/javascripts/old_sql/MochiKit-1.4.2/doc/rst/MochiKit/index.rst +0 -83
  53. data/public/javascripts/old_sql/MochiKit-1.4.2/examples/ajax_tables/ajax_tables.css +0 -69
  54. data/public/javascripts/old_sql/MochiKit-1.4.2/examples/ajax_tables/ajax_tables.js +0 -401
  55. data/public/javascripts/old_sql/MochiKit-1.4.2/examples/ajax_tables/domains.json +0 -10
  56. data/public/javascripts/old_sql/MochiKit-1.4.2/examples/ajax_tables/domains.xml +0 -40
  57. data/public/javascripts/old_sql/MochiKit-1.4.2/examples/ajax_tables/index.html +0 -96
  58. data/public/javascripts/old_sql/MochiKit-1.4.2/examples/color_wheel/color_wheel.css +0 -4
  59. data/public/javascripts/old_sql/MochiKit-1.4.2/examples/color_wheel/color_wheel.js +0 -95
  60. data/public/javascripts/old_sql/MochiKit-1.4.2/examples/color_wheel/index.html +0 -31
  61. data/public/javascripts/old_sql/MochiKit-1.4.2/examples/dnd_sortable/dnd_sortable.css +0 -23
  62. data/public/javascripts/old_sql/MochiKit-1.4.2/examples/dnd_sortable/dropmarker.png +0 -0
  63. data/public/javascripts/old_sql/MochiKit-1.4.2/examples/dnd_sortable/icon.png +0 -0
  64. data/public/javascripts/old_sql/MochiKit-1.4.2/examples/dnd_sortable/index.html +0 -54
  65. data/public/javascripts/old_sql/MochiKit-1.4.2/examples/dnd_sortable/sortable2_test.html +0 -150
  66. data/public/javascripts/old_sql/MochiKit-1.4.2/examples/dnd_sortable/sortable3_test.html +0 -42
  67. data/public/javascripts/old_sql/MochiKit-1.4.2/examples/dnd_sortable/sortable4_test.html +0 -90
  68. data/public/javascripts/old_sql/MochiKit-1.4.2/examples/dnd_sortable/sortable5_test.html +0 -29
  69. data/public/javascripts/old_sql/MochiKit-1.4.2/examples/dnd_sortable/sortable_test.html +0 -38
  70. data/public/javascripts/old_sql/MochiKit-1.4.2/examples/dnd_sortable/sortable_tree_test.html +0 -189
  71. data/public/javascripts/old_sql/MochiKit-1.4.2/examples/draggable/draggable.css +0 -28
  72. data/public/javascripts/old_sql/MochiKit-1.4.2/examples/draggable/draggable.js +0 -73
  73. data/public/javascripts/old_sql/MochiKit-1.4.2/examples/draggable/index.html +0 -38
  74. data/public/javascripts/old_sql/MochiKit-1.4.2/examples/effects/effects_bigslide.html +0 -36
  75. data/public/javascripts/old_sql/MochiKit-1.4.2/examples/effects/effects_blind.html +0 -65
  76. data/public/javascripts/old_sql/MochiKit-1.4.2/examples/effects/effects_blindslide.html +0 -31
  77. data/public/javascripts/old_sql/MochiKit-1.4.2/examples/effects/effects_combi.css +0 -18
  78. data/public/javascripts/old_sql/MochiKit-1.4.2/examples/effects/effects_fadeappear.html +0 -61
  79. data/public/javascripts/old_sql/MochiKit-1.4.2/examples/effects/effects_grow_shrink.html +0 -38
  80. data/public/javascripts/old_sql/MochiKit-1.4.2/examples/effects/effects_onload.html +0 -67
  81. data/public/javascripts/old_sql/MochiKit-1.4.2/examples/effects/effects_queue.html +0 -67
  82. data/public/javascripts/old_sql/MochiKit-1.4.2/examples/effects/effects_queue_limit.html +0 -30
  83. data/public/javascripts/old_sql/MochiKit-1.4.2/examples/effects/effects_scroll.html +0 -483
  84. data/public/javascripts/old_sql/MochiKit-1.4.2/examples/effects/effects_slide.html +0 -62
  85. data/public/javascripts/old_sql/MochiKit-1.4.2/examples/effects/full.html +0 -71
  86. data/public/javascripts/old_sql/MochiKit-1.4.2/examples/effects/icon.png +0 -0
  87. data/public/javascripts/old_sql/MochiKit-1.4.2/examples/effects/index.html +0 -150
  88. data/public/javascripts/old_sql/MochiKit-1.4.2/examples/interpreter/index.html +0 -88
  89. data/public/javascripts/old_sql/MochiKit-1.4.2/examples/interpreter/interpreter.css +0 -54
  90. data/public/javascripts/old_sql/MochiKit-1.4.2/examples/interpreter/interpreter.js +0 -373
  91. data/public/javascripts/old_sql/MochiKit-1.4.2/examples/key_events/index.html +0 -78
  92. data/public/javascripts/old_sql/MochiKit-1.4.2/examples/key_events/key_events.css +0 -5
  93. data/public/javascripts/old_sql/MochiKit-1.4.2/examples/key_events/key_events.js +0 -85
  94. data/public/javascripts/old_sql/MochiKit-1.4.2/examples/logging_pane/index.html +0 -46
  95. data/public/javascripts/old_sql/MochiKit-1.4.2/examples/logging_pane/logging_pane.css +0 -78
  96. data/public/javascripts/old_sql/MochiKit-1.4.2/examples/logging_pane/logging_pane.js +0 -11
  97. data/public/javascripts/old_sql/MochiKit-1.4.2/examples/mochiregexp/index.html +0 -74
  98. data/public/javascripts/old_sql/MochiKit-1.4.2/examples/mochiregexp/mochiregexp.css +0 -73
  99. data/public/javascripts/old_sql/MochiKit-1.4.2/examples/mochiregexp/mochiregexp.js +0 -125
  100. data/public/javascripts/old_sql/MochiKit-1.4.2/examples/mouse_events/index.html +0 -88
  101. data/public/javascripts/old_sql/MochiKit-1.4.2/examples/mouse_events/mouse_events.css +0 -17
  102. data/public/javascripts/old_sql/MochiKit-1.4.2/examples/mouse_events/mouse_events.js +0 -59
  103. data/public/javascripts/old_sql/MochiKit-1.4.2/examples/rounded_corners/index.html +0 -28
  104. data/public/javascripts/old_sql/MochiKit-1.4.2/examples/rounded_corners/rounded_corners.css +0 -3
  105. data/public/javascripts/old_sql/MochiKit-1.4.2/examples/rounded_corners/rounded_corners.js +0 -19
  106. data/public/javascripts/old_sql/MochiKit-1.4.2/examples/simple_dnd/dnd_boxes.html +0 -45
  107. data/public/javascripts/old_sql/MochiKit-1.4.2/examples/simple_dnd/dnd_full.html +0 -119
  108. data/public/javascripts/old_sql/MochiKit-1.4.2/examples/simple_dnd/dnd_ghost.html +0 -40
  109. data/public/javascripts/old_sql/MochiKit-1.4.2/examples/simple_dnd/dnd_hoverclass.html +0 -43
  110. data/public/javascripts/old_sql/MochiKit-1.4.2/examples/simple_dnd/dnd_scroll.html +0 -91
  111. data/public/javascripts/old_sql/MochiKit-1.4.2/examples/simple_dnd/dnd_snap.html +0 -54
  112. data/public/javascripts/old_sql/MochiKit-1.4.2/examples/simple_dnd/index.html +0 -93
  113. data/public/javascripts/old_sql/MochiKit-1.4.2/examples/simple_dnd/simple_dnd.css +0 -64
  114. data/public/javascripts/old_sql/MochiKit-1.4.2/examples/sortable_tables/index.html +0 -71
  115. data/public/javascripts/old_sql/MochiKit-1.4.2/examples/sortable_tables/sortable_tables.css +0 -66
  116. data/public/javascripts/old_sql/MochiKit-1.4.2/examples/sortable_tables/sortable_tables.js +0 -203
  117. data/public/javascripts/old_sql/MochiKit-1.4.2/examples/view-source/lib/SyntaxHighlighter/SyntaxHighlighter.css +0 -177
  118. data/public/javascripts/old_sql/MochiKit-1.4.2/examples/view-source/lib/SyntaxHighlighter/Tests.html +0 -339
  119. data/public/javascripts/old_sql/MochiKit-1.4.2/examples/view-source/lib/SyntaxHighlighter/shBrushCSharp.js +0 -30
  120. data/public/javascripts/old_sql/MochiKit-1.4.2/examples/view-source/lib/SyntaxHighlighter/shBrushDelphi.js +0 -31
  121. data/public/javascripts/old_sql/MochiKit-1.4.2/examples/view-source/lib/SyntaxHighlighter/shBrushJScript.js +0 -22
  122. data/public/javascripts/old_sql/MochiKit-1.4.2/examples/view-source/lib/SyntaxHighlighter/shBrushPhp.js +0 -23
  123. data/public/javascripts/old_sql/MochiKit-1.4.2/examples/view-source/lib/SyntaxHighlighter/shBrushPython.js +0 -71
  124. data/public/javascripts/old_sql/MochiKit-1.4.2/examples/view-source/lib/SyntaxHighlighter/shBrushSql.js +0 -40
  125. data/public/javascripts/old_sql/MochiKit-1.4.2/examples/view-source/lib/SyntaxHighlighter/shBrushVb.js +0 -29
  126. data/public/javascripts/old_sql/MochiKit-1.4.2/examples/view-source/lib/SyntaxHighlighter/shBrushXml.js +0 -61
  127. data/public/javascripts/old_sql/MochiKit-1.4.2/examples/view-source/lib/SyntaxHighlighter/shCore.js +0 -622
  128. data/public/javascripts/old_sql/MochiKit-1.4.2/examples/view-source/view-source.css +0 -1
  129. data/public/javascripts/old_sql/MochiKit-1.4.2/examples/view-source/view-source.html +0 -19
  130. data/public/javascripts/old_sql/MochiKit-1.4.2/examples/view-source/view-source.js +0 -70
  131. data/public/javascripts/old_sql/MochiKit-1.4.2/include/_img/bg_docheader.gif +0 -0
  132. data/public/javascripts/old_sql/MochiKit-1.4.2/include/_img/g_bullet.gif +0 -0
  133. data/public/javascripts/old_sql/MochiKit-1.4.2/include/_img/g_logo_doc.gif +0 -0
  134. data/public/javascripts/old_sql/MochiKit-1.4.2/include/css/documentation.css +0 -130
  135. data/public/javascripts/old_sql/MochiKit-1.4.2/include/css/general.css +0 -48
  136. data/public/javascripts/old_sql/MochiKit-1.4.2/lib/MochiKit/Async.js +0 -682
  137. data/public/javascripts/old_sql/MochiKit-1.4.2/lib/MochiKit/Base.js +0 -1489
  138. data/public/javascripts/old_sql/MochiKit-1.4.2/lib/MochiKit/Color.js +0 -863
  139. data/public/javascripts/old_sql/MochiKit-1.4.2/lib/MochiKit/DOM.js +0 -1256
  140. data/public/javascripts/old_sql/MochiKit-1.4.2/lib/MochiKit/DateTime.js +0 -222
  141. data/public/javascripts/old_sql/MochiKit-1.4.2/lib/MochiKit/DragAndDrop.js +0 -793
  142. data/public/javascripts/old_sql/MochiKit-1.4.2/lib/MochiKit/Format.js +0 -304
  143. data/public/javascripts/old_sql/MochiKit-1.4.2/lib/MochiKit/Iter.js +0 -844
  144. data/public/javascripts/old_sql/MochiKit-1.4.2/lib/MochiKit/Logging.js +0 -315
  145. data/public/javascripts/old_sql/MochiKit-1.4.2/lib/MochiKit/LoggingPane.js +0 -353
  146. data/public/javascripts/old_sql/MochiKit-1.4.2/lib/MochiKit/MochiKit.js +0 -188
  147. data/public/javascripts/old_sql/MochiKit-1.4.2/lib/MochiKit/MockDOM.js +0 -115
  148. data/public/javascripts/old_sql/MochiKit-1.4.2/lib/MochiKit/Position.js +0 -236
  149. data/public/javascripts/old_sql/MochiKit-1.4.2/lib/MochiKit/Selector.js +0 -415
  150. data/public/javascripts/old_sql/MochiKit-1.4.2/lib/MochiKit/Signal.js +0 -897
  151. data/public/javascripts/old_sql/MochiKit-1.4.2/lib/MochiKit/Sortable.js +0 -589
  152. data/public/javascripts/old_sql/MochiKit-1.4.2/lib/MochiKit/Style.js +0 -594
  153. data/public/javascripts/old_sql/MochiKit-1.4.2/lib/MochiKit/Test.js +0 -162
  154. data/public/javascripts/old_sql/MochiKit-1.4.2/lib/MochiKit/Visual.js +0 -2026
  155. data/public/javascripts/old_sql/MochiKit-1.4.2/lib/MochiKit/__package__.js +0 -18
  156. data/public/javascripts/old_sql/MochiKit-1.4.2/packed/MochiKit/MochiKit.js +0 -7829
  157. data/public/javascripts/old_sql/MochiKit-1.4.2/packed/MochiKit/__package__.js +0 -6
  158. data/public/javascripts/old_sql/MochiKit-1.4.2/packed/MochiKit/customize.html +0 -251
  159. data/public/javascripts/old_sql/MochiKit-1.4.2/tests/FakeJSAN.js +0 -40
  160. data/public/javascripts/old_sql/MochiKit-1.4.2/tests/SimpleTest/SimpleTest.js +0 -381
  161. data/public/javascripts/old_sql/MochiKit-1.4.2/tests/SimpleTest/TestRunner.js +0 -159
  162. data/public/javascripts/old_sql/MochiKit-1.4.2/tests/SimpleTest/test.css +0 -28
  163. data/public/javascripts/old_sql/MochiKit-1.4.2/tests/cli.js +0 -6
  164. data/public/javascripts/old_sql/MochiKit-1.4.2/tests/index.html +0 -25
  165. data/public/javascripts/old_sql/MochiKit-1.4.2/tests/standalone.js +0 -16
  166. data/public/javascripts/old_sql/MochiKit-1.4.2/tests/test_Base.js +0 -577
  167. data/public/javascripts/old_sql/MochiKit-1.4.2/tests/test_Color.js +0 -137
  168. data/public/javascripts/old_sql/MochiKit-1.4.2/tests/test_DateTime.js +0 -52
  169. data/public/javascripts/old_sql/MochiKit-1.4.2/tests/test_DragAndDrop.js +0 -30
  170. data/public/javascripts/old_sql/MochiKit-1.4.2/tests/test_Format.js +0 -89
  171. data/public/javascripts/old_sql/MochiKit-1.4.2/tests/test_Iter.js +0 -186
  172. data/public/javascripts/old_sql/MochiKit-1.4.2/tests/test_Logging.js +0 -88
  173. data/public/javascripts/old_sql/MochiKit-1.4.2/tests/test_MochiKit-Async.html +0 -408
  174. data/public/javascripts/old_sql/MochiKit-1.4.2/tests/test_MochiKit-Async.json +0 -1
  175. data/public/javascripts/old_sql/MochiKit-1.4.2/tests/test_MochiKit-Base.html +0 -34
  176. data/public/javascripts/old_sql/MochiKit-1.4.2/tests/test_MochiKit-Color.html +0 -84
  177. data/public/javascripts/old_sql/MochiKit-1.4.2/tests/test_MochiKit-DOM-Safari.html +0 -48
  178. data/public/javascripts/old_sql/MochiKit-1.4.2/tests/test_MochiKit-DOM.html +0 -363
  179. data/public/javascripts/old_sql/MochiKit-1.4.2/tests/test_MochiKit-DateTime.html +0 -39
  180. data/public/javascripts/old_sql/MochiKit-1.4.2/tests/test_MochiKit-DragAndDrop.html +0 -54
  181. data/public/javascripts/old_sql/MochiKit-1.4.2/tests/test_MochiKit-Format.html +0 -39
  182. data/public/javascripts/old_sql/MochiKit-1.4.2/tests/test_MochiKit-Iter.html +0 -38
  183. data/public/javascripts/old_sql/MochiKit-1.4.2/tests/test_MochiKit-JSAN.html +0 -32
  184. data/public/javascripts/old_sql/MochiKit-1.4.2/tests/test_MochiKit-Logging.html +0 -40
  185. data/public/javascripts/old_sql/MochiKit-1.4.2/tests/test_MochiKit-MochiKit.html +0 -18
  186. data/public/javascripts/old_sql/MochiKit-1.4.2/tests/test_MochiKit-Selector.html +0 -295
  187. data/public/javascripts/old_sql/MochiKit-1.4.2/tests/test_MochiKit-Signal.html +0 -43
  188. data/public/javascripts/old_sql/MochiKit-1.4.2/tests/test_MochiKit-Style.html +0 -223
  189. data/public/javascripts/old_sql/MochiKit-1.4.2/tests/test_MochiKit-Visual.html +0 -197
  190. data/public/javascripts/old_sql/MochiKit-1.4.2/tests/test_Signal.js +0 -481
  191. data/public/javascripts/old_sql/plotkit-0.9.1/COPYING +0 -28
  192. data/public/javascripts/old_sql/plotkit-0.9.1/PlotKit/Base.js +0 -406
  193. data/public/javascripts/old_sql/plotkit-0.9.1/PlotKit/Canvas.js +0 -683
  194. data/public/javascripts/old_sql/plotkit-0.9.1/PlotKit/EasyPlot.js +0 -161
  195. data/public/javascripts/old_sql/plotkit-0.9.1/PlotKit/Layout.js +0 -756
  196. data/public/javascripts/old_sql/plotkit-0.9.1/PlotKit/PlotKit.js +0 -151
  197. data/public/javascripts/old_sql/plotkit-0.9.1/PlotKit/PlotKit_Packed.js +0 -2177
  198. data/public/javascripts/old_sql/plotkit-0.9.1/PlotKit/SVG.js +0 -705
  199. data/public/javascripts/old_sql/plotkit-0.9.1/PlotKit/SweetCanvas.js +0 -348
  200. data/public/javascripts/old_sql/plotkit-0.9.1/PlotKit/SweetSVG.js +0 -247
  201. data/public/javascripts/old_sql/plotkit-0.9.1/PlotKit/dummy.svg +0 -9
  202. data/public/javascripts/old_sql/plotkit-0.9.1/PlotKit/excanvas.js +0 -723
  203. data/public/javascripts/old_sql/plotkit-0.9.1/README +0 -1
  204. data/public/javascripts/old_sql/plotkit-0.9.1/doc/MochiKitAdditions.html +0 -2
  205. data/public/javascripts/old_sql/plotkit-0.9.1/doc/MochiKitAdditions.txt +0 -2
  206. data/public/javascripts/old_sql/plotkit-0.9.1/doc/PlotKit.Base.html +0 -302
  207. data/public/javascripts/old_sql/plotkit-0.9.1/doc/PlotKit.Base.txt +0 -139
  208. data/public/javascripts/old_sql/plotkit-0.9.1/doc/PlotKit.Canvas.html +0 -172
  209. data/public/javascripts/old_sql/plotkit-0.9.1/doc/PlotKit.Canvas.txt +0 -81
  210. data/public/javascripts/old_sql/plotkit-0.9.1/doc/PlotKit.EasyPlot.html +0 -155
  211. data/public/javascripts/old_sql/plotkit-0.9.1/doc/PlotKit.EasyPlot.txt +0 -50
  212. data/public/javascripts/old_sql/plotkit-0.9.1/doc/PlotKit.Layout.html +0 -428
  213. data/public/javascripts/old_sql/plotkit-0.9.1/doc/PlotKit.Layout.txt +0 -330
  214. data/public/javascripts/old_sql/plotkit-0.9.1/doc/PlotKit.QuickStart.html +0 -368
  215. data/public/javascripts/old_sql/plotkit-0.9.1/doc/PlotKit.QuickStart.txt +0 -256
  216. data/public/javascripts/old_sql/plotkit-0.9.1/doc/PlotKit.Renderer.html +0 -436
  217. data/public/javascripts/old_sql/plotkit-0.9.1/doc/PlotKit.Renderer.txt +0 -299
  218. data/public/javascripts/old_sql/plotkit-0.9.1/doc/PlotKit.SVG.html +0 -159
  219. data/public/javascripts/old_sql/plotkit-0.9.1/doc/PlotKit.SVG.txt +0 -64
  220. data/public/javascripts/old_sql/plotkit-0.9.1/doc/PlotKit.SweetCanvas.html +0 -131
  221. data/public/javascripts/old_sql/plotkit-0.9.1/doc/PlotKit.SweetCanvas.txt +0 -34
  222. data/public/javascripts/old_sql/plotkit-0.9.1/doc/PlotKit.SweetSVG.html +0 -131
  223. data/public/javascripts/old_sql/plotkit-0.9.1/doc/PlotKit.SweetSVG.txt +0 -34
  224. data/public/javascripts/old_sql/plotkit-0.9.1/doc/PlotKit.html +0 -334
  225. data/public/javascripts/old_sql/plotkit-0.9.1/doc/PlotKit.txt +0 -151
  226. data/public/javascripts/old_sql/plotkit-0.9.1/doc/SVGCanvasCompat.html +0 -304
  227. data/public/javascripts/old_sql/plotkit-0.9.1/doc/SVGCanvasCompat.txt +0 -144
  228. data/public/javascripts/old_sql/plotkit-0.9.1/doc/barsample.png +0 -0
  229. data/public/javascripts/old_sql/plotkit-0.9.1/doc/black.png +0 -0
  230. data/public/javascripts/old_sql/plotkit-0.9.1/doc/blue.png +0 -0
  231. data/public/javascripts/old_sql/plotkit-0.9.1/doc/cyan.png +0 -0
  232. data/public/javascripts/old_sql/plotkit-0.9.1/doc/doc.css +0 -62
  233. data/public/javascripts/old_sql/plotkit-0.9.1/doc/generate.py +0 -37
  234. data/public/javascripts/old_sql/plotkit-0.9.1/doc/green.png +0 -0
  235. data/public/javascripts/old_sql/plotkit-0.9.1/doc/orange.png +0 -0
  236. data/public/javascripts/old_sql/plotkit-0.9.1/doc/piesample.png +0 -0
  237. data/public/javascripts/old_sql/plotkit-0.9.1/doc/purple.png +0 -0
  238. data/public/javascripts/old_sql/plotkit-0.9.1/doc/red.png +0 -0
  239. data/public/javascripts/old_sql/plotkit-0.9.1/scripts/custom_rhino.jar +0 -0
  240. data/public/javascripts/old_sql/plotkit-0.9.1/scripts/pack.py +0 -58
  241. data/public/javascripts/old_sql/plotkit-0.9.1/tests/axis.html +0 -31
  242. data/public/javascripts/old_sql/plotkit-0.9.1/tests/basic.html +0 -25
  243. data/public/javascripts/old_sql/plotkit-0.9.1/tests/basic.js +0 -143
  244. data/public/javascripts/old_sql/plotkit-0.9.1/tests/debug.html +0 -56
  245. data/public/javascripts/old_sql/plotkit-0.9.1/tests/demo-svg.html +0 -58
  246. data/public/javascripts/old_sql/plotkit-0.9.1/tests/demo-svg.js +0 -133
  247. data/public/javascripts/old_sql/plotkit-0.9.1/tests/demo.html +0 -57
  248. data/public/javascripts/old_sql/plotkit-0.9.1/tests/demo.js +0 -136
  249. data/public/javascripts/old_sql/plotkit-0.9.1/tests/dynamic.html +0 -161
  250. data/public/javascripts/old_sql/plotkit-0.9.1/tests/img/firefox.png +0 -0
  251. data/public/javascripts/old_sql/plotkit-0.9.1/tests/img/konqueror.png +0 -0
  252. data/public/javascripts/old_sql/plotkit-0.9.1/tests/img/mozilla.ico +0 -0
  253. data/public/javascripts/old_sql/plotkit-0.9.1/tests/img/msie.gif +0 -0
  254. data/public/javascripts/old_sql/plotkit-0.9.1/tests/img/opera.ico +0 -0
  255. data/public/javascripts/old_sql/plotkit-0.9.1/tests/img/safari.gif +0 -0
  256. data/public/javascripts/old_sql/plotkit-0.9.1/tests/labels-img.html +0 -38
  257. data/public/javascripts/old_sql/plotkit-0.9.1/tests/labels.html +0 -43
  258. data/public/javascripts/old_sql/plotkit-0.9.1/tests/prototype_compat.html +0 -28
  259. data/public/javascripts/old_sql/plotkit-0.9.1/tests/quickstart-easy.html +0 -29
  260. data/public/javascripts/old_sql/plotkit-0.9.1/tests/quickstart-horiz.html +0 -53
  261. data/public/javascripts/old_sql/plotkit-0.9.1/tests/quickstart-neg.html +0 -29
  262. data/public/javascripts/old_sql/plotkit-0.9.1/tests/quickstart-svg.html +0 -61
  263. data/public/javascripts/old_sql/plotkit-0.9.1/tests/quickstart.html +0 -57
  264. data/public/javascripts/old_sql/plotkit-0.9.1/tests/sample.txt +0 -6
  265. data/public/javascripts/old_sql/plotkit-0.9.1/tests/svg-sweet.html +0 -29
  266. data/public/javascripts/old_sql/plotkit-0.9.1/tests/svg-sweet.js +0 -141
  267. data/public/javascripts/old_sql/plotkit-0.9.1/tests/svg.html +0 -26
  268. data/public/javascripts/old_sql/plotkit-0.9.1/tests/svg.js +0 -147
  269. data/public/javascripts/old_sql/plotkit-0.9.1/tests/sweet.html +0 -24
  270. data/public/javascripts/old_sql/plotkit-0.9.1/tests/sweet.js +0 -89
  271. data/public/javascripts/old_sql/plotkit-0.9.1/tests/tests.css +0 -66
  272. data/public/javascripts/old_sql/plotkit-0.9.1/tests/testsvg.html +0 -20
  273. data/public/javascripts/old_sql/plotkit-0.9.1/tests/testsvg.js +0 -31
@@ -1,1197 +0,0 @@
1
- <?xml version="1.0" encoding="utf-8" ?>
2
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
-
4
- <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5
- <head>
6
- <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
7
- <meta name="generator" content="Docutils 0.4: http://docutils.sourceforge.net/" />
8
- <title>MochiKit.DOM - painless DOM manipulation API</title>
9
-
10
- <link rel="stylesheet" href="../../../include/css/documentation.css" type="text/css" />
11
- <script type="text/javascript" src="../../../packed/lib/MochiKit/MochiKit.js"></script>
12
- <script type="text/javascript" src="../../js/toc.js"></script>
13
- </head>
14
- <body>
15
- <a href="http://mochikit.com"><img id="mainlink" src="../../../include/_img/g_logo_doc.gif" alt="MochiKit" /></a>
16
- <a class='indexlink' href='index.html'>Back to docs index</a>
17
- <div class="document">
18
- <div class="section">
19
- <h1><a id="name" name="name">Name</a></h1>
20
- <p>MochiKit.DOM - painless DOM manipulation API</p>
21
- </div>
22
- <div class="section">
23
- <h1><a id="synopsis" name="synopsis">Synopsis</a></h1>
24
- <pre class="literal-block">
25
- var rows = [
26
- [&quot;dataA1&quot;, &quot;dataA2&quot;, &quot;dataA3&quot;],
27
- [&quot;dataB1&quot;, &quot;dataB2&quot;, &quot;dataB3&quot;]
28
- ];
29
- row_display = function (row) {
30
- return TR(null, map(partial(TD, null), row));
31
- }
32
- var newTable = TABLE({'class': 'prettytable'},
33
- THEAD(null,
34
- row_display([&quot;head1&quot;, &quot;head2&quot;, &quot;head3&quot;])),
35
- TFOOT(null,
36
- row_display([&quot;foot1&quot;, &quot;foot2&quot;, &quot;foot3&quot;])),
37
- TBODY(null,
38
- map(row_display, rows)));
39
- // put that in your document.createElement and smoke it!
40
- swapDOM(oldTable, newTable);
41
- </pre>
42
- </div>
43
- <div class="section">
44
- <h1><a id="description" name="description">Description</a></h1>
45
- <p>As you probably know, the DOM APIs are some of the most painful
46
- Java-inspired APIs you'll run across from a highly dynamic
47
- language. Don't worry about that though, because they provide a
48
- reasonable basis to build something that sucks a lot less.</p>
49
- <p>MochiKit.DOM takes much of its inspiration from Nevow's <a class="footnote-reference" href="#id5" id="id1" name="id1">[1]</a> stan
50
- <a class="footnote-reference" href="#id6" id="id2" name="id2">[2]</a>. This means you choose a tag, give it some attributes, then
51
- stuff it full of <em>whatever objects you want</em>. MochiKit.DOM isn't
52
- stupid, it knows that a string should be a text node, and that you
53
- want functions to be called, and that <tt class="docutils literal"><span class="pre">Array</span></tt>-like objects should be
54
- expanded, and stupid <tt class="docutils literal"><span class="pre">null</span></tt> values should be skipped.</p>
55
- <p>Hell, it will let you return strings from functions, and use iterators
56
- from <a class="mochiref reference" href="Iter.html">MochiKit.Iter</a>. If that's not enough, just teach it
57
- new tricks with <a class="mochiref reference" href="#fn-registerdomconverter">registerDOMConverter</a>. If you have never
58
- used an API like this for creating DOM elements, you've been wasting
59
- your damn time. Get with it!</p>
60
- </div>
61
- <div class="section">
62
- <h1><a id="dependencies" name="dependencies">Dependencies</a></h1>
63
- <ul class="simple">
64
- <li><a class="mochiref reference" href="Base.html">MochiKit.Base</a></li>
65
- <li><a class="mochiref reference" href="Style.html">MochiKit.Style</a> (optional since MochiKit 1.4 for
66
- backwards-compatibility)</li>
67
- <li><a class="mochiref reference" href="Iter.html">MochiKit.Iter</a> (optional since MochiKit 1.4)</li>
68
- </ul>
69
- </div>
70
- <div class="section">
71
- <h1><a id="overview" name="overview">Overview</a></h1>
72
- <div class="section">
73
- <h2><a id="dom-coercion-rules" name="dom-coercion-rules">DOM Coercion Rules</a></h2>
74
- <p>In order of precedence, <a class="mochiref reference" href="#fn-createdom">createDOM</a> coerces given arguments
75
- to DOM nodes using the following rules:</p>
76
- <ol class="arabic simple">
77
- <li>Functions are called with a <tt class="docutils literal"><span class="pre">this</span></tt> and first argument of the
78
- parent node and their return value is subject to the following
79
- rules (even this one).</li>
80
- <li><tt class="docutils literal"><span class="pre">undefined</span></tt> and <tt class="docutils literal"><span class="pre">null</span></tt> are ignored.</li>
81
- <li>If <a class="mochiref reference" href="Iter.html">MochiKit.Iter</a> is loaded, iterables are flattened
82
- (as if they were passed in-line as nodes) and each return value is
83
- subject to these rules.</li>
84
- <li>Values that look like DOM nodes (objects with a <tt class="docutils literal"><span class="pre">.nodeType</span> <span class="pre">&gt;</span> <span class="pre">0</span></tt>)
85
- are <tt class="docutils literal"><span class="pre">.appendChild</span></tt>'ed to the created DOM fragment.</li>
86
- <li>Strings are wrapped up with <tt class="docutils literal"><span class="pre">document.createTextNode</span></tt></li>
87
- <li>Objects that have a <tt class="docutils literal"><span class="pre">.dom(node)</span></tt> or <tt class="docutils literal"><span class="pre">.__dom__(node)</span></tt> method
88
- are called with the parent node and their result is coerced using
89
- these rules. (MochiKit 1.4+).</li>
90
- <li>Objects that are not strings are run through the <tt class="docutils literal"><span class="pre">domConverters</span></tt>
91
- <a class="mochiref reference" href="Base.html#fn-adapterregistry">MochiKit.Base.AdapterRegistry</a> (see
92
- <a class="mochiref reference" href="#fn-registerdomconverter">registerDOMConverter</a>). The adapted value is subject
93
- to these same rules (e.g. if the adapter returns a string, it
94
- will be coerced to a text node).</li>
95
- <li>If no adapter is available, <tt class="docutils literal"><span class="pre">.toString()</span></tt> is used to create a
96
- text node.</li>
97
- </ol>
98
- </div>
99
- <div class="section">
100
- <h2><a id="creating-dom-element-trees" name="creating-dom-element-trees">Creating DOM Element Trees</a></h2>
101
- <p><a class="mochiref reference" href="#fn-createdom">createDOM</a> provides you with an excellent facility for
102
- creating DOM trees that is easy on the wrists. One of the best ways to
103
- understand how to use it is to take a look at an example:</p>
104
- <pre class="literal-block">
105
- var rows = [
106
- [&quot;dataA1&quot;, &quot;dataA2&quot;, &quot;dataA3&quot;],
107
- [&quot;dataB1&quot;, &quot;dataB2&quot;, &quot;dataB3&quot;]
108
- ];
109
- row_display = function (row) {
110
- return TR(null, map(partial(TD, null), row));
111
- }
112
- var newTable = TABLE({'class': 'prettytable'},
113
- THEAD(null,
114
- row_display([&quot;head1&quot;, &quot;head2&quot;, &quot;head3&quot;])),
115
- TFOOT(null,
116
- row_display([&quot;foot1&quot;, &quot;foot2&quot;, &quot;foot3&quot;])),
117
- TBODY(null,
118
- map(row_display, rows)));
119
- </pre>
120
- <p>This will create a table with the following visual layout (if it were
121
- inserted into the document DOM):</p>
122
- <blockquote>
123
- <table border="1" class="docutils">
124
- <colgroup>
125
- <col width="33%" />
126
- <col width="33%" />
127
- <col width="33%" />
128
- </colgroup>
129
- <thead valign="bottom">
130
- <tr><th class="head">head1</th>
131
- <th class="head">head2</th>
132
- <th class="head">head3</th>
133
- </tr>
134
- </thead>
135
- <tbody valign="top">
136
- <tr><td>dataA1</td>
137
- <td>dataA2</td>
138
- <td>dataA3</td>
139
- </tr>
140
- <tr><td>dataB1</td>
141
- <td>dataB2</td>
142
- <td>dataB3</td>
143
- </tr>
144
- <tr><td>foot1</td>
145
- <td>foot2</td>
146
- <td>foot3</td>
147
- </tr>
148
- </tbody>
149
- </table>
150
- </blockquote>
151
- <p>Corresponding to the following HTML:</p>
152
- <pre class="literal-block">
153
- &lt;table class=&quot;prettytable&quot;&gt;
154
- &lt;thead&gt;
155
- &lt;tr&gt;
156
- &lt;td&gt;head1&lt;/td&gt;
157
- &lt;td&gt;head2&lt;/td&gt;
158
- &lt;td&gt;head3&lt;/td&gt;
159
- &lt;/tr&gt;
160
- &lt;/thead&gt;
161
- &lt;tfoot&gt;
162
- &lt;tr&gt;
163
- &lt;td&gt;foot1&lt;/td&gt;
164
- &lt;td&gt;foot2&lt;/td&gt;
165
- &lt;td&gt;foot3&lt;/td&gt;
166
- &lt;/tr&gt;
167
- &lt;/tfoot&gt;
168
- &lt;tbody&gt;
169
- &lt;tr&gt;
170
- &lt;td&gt;dataA1&lt;/td&gt;
171
- &lt;td&gt;dataA2&lt;/td&gt;
172
- &lt;td&gt;dataA3&lt;/td&gt;
173
- &lt;/tr&gt;
174
- &lt;tr&gt;
175
- &lt;td&gt;dataB1&lt;/td&gt;
176
- &lt;td&gt;dataB2&lt;/td&gt;
177
- &lt;td&gt;dataB3&lt;/td&gt;
178
- &lt;/tr&gt;
179
- &lt;/tbody&gt;
180
- &lt;/table&gt;
181
- </pre>
182
- </div>
183
- <div class="section">
184
- <h2><a id="dom-context" name="dom-context">DOM Context</a></h2>
185
- <p>In order to prevent having to pass a <tt class="docutils literal"><span class="pre">window</span></tt> and/or <tt class="docutils literal"><span class="pre">document</span></tt>
186
- variable to every MochiKit.DOM function (e.g. when working with a
187
- child window), MochiKit.DOM maintains a context variable for each of
188
- them. They are managed with the <a class="mochiref reference" href="#fn-withwindow">withWindow</a> and
189
- <a class="mochiref reference" href="#fn-withdocument">withDocument</a> functions, and can be acquired with
190
- <a class="mochiref reference" href="#fn-currentwindow">currentWindow()</a> and <a class="mochiref reference" href="#fn-currentdocument">currentDocument()</a></p>
191
- <p>For example, if you are creating DOM nodes in a child window, you
192
- could do something like this:</p>
193
- <pre class="literal-block">
194
- withWindow(child, function () {
195
- var doc = currentDocument();
196
- appendChildNodes(doc.body, H1(null, &quot;This is in the child!&quot;));
197
- });
198
- </pre>
199
- <p>Note that <a class="mochiref reference" href="#fn-withwindow">withWindow(win, ...)</a> also implies
200
- <a class="mochiref reference" href="#fn-withdocument">withDocument(win.document, ...)</a>.</p>
201
- </div>
202
- <div class="section">
203
- <h2><a id="dom-gotchas" name="dom-gotchas">DOM Gotchas</a></h2>
204
- <dl class="docutils">
205
- <dt>Performance Tradeoff:</dt>
206
- <dd>DOM is much easier to get correct and more flexible than working
207
- directly with markup as strings. Modifying <tt class="docutils literal"><span class="pre">innerHTML</span></tt> is still
208
- the fastest way to make document changes.</dd>
209
- <dt>Internet Explorer:</dt>
210
- <dd>Internet Explorer's DOM implementation is quite poor in comparison
211
- to the other popular implementations. In order to avoid memory
212
- leaks due to circular references, you should use
213
- <a class="mochiref reference" href="Signal.html#fn-connect">MochiKit.Signal.connect</a> for all of your event handling
214
- needs. Additionally, when creating tables with DOM, it is required
215
- to use a <tt class="docutils literal"><span class="pre">TBODY</span></tt> tag (see <a class="reference" href="#creating-dom-element-trees">Creating DOM Element Trees</a> for an
216
- example of this).</dd>
217
- </dl>
218
- </div>
219
- </div>
220
- <div class="section">
221
- <h1><a id="api-reference" name="api-reference">API Reference</a></h1>
222
- <div class="section">
223
- <h2><a id="functions" name="functions">Functions</a></h2>
224
- <p>
225
- <a name="fn-$"></a>
226
- <a class="mochidef reference" href="#fn-$">$(id[, ...])</a>:</p>
227
- <blockquote>
228
- <p>An alias for <a class="mochiref reference" href="#fn-getelement">getElement(id[, ...])</a></p>
229
- <dl class="docutils">
230
- <dt><em>Availability</em>:</dt>
231
- <dd>Available in MochiKit 1.3.1+</dd>
232
- </dl>
233
- </blockquote>
234
- <p>
235
- <a name="fn-addelementclass"></a>
236
- <a class="mochidef reference" href="#fn-addelementclass">addElementClass(element, className)</a>:</p>
237
- <blockquote>
238
- <p>Ensure that the given <tt class="docutils literal"><span class="pre">element</span></tt> has <tt class="docutils literal"><span class="pre">className</span></tt> set as part of
239
- its class attribute. This will not disturb other class names.
240
- <tt class="docutils literal"><span class="pre">element</span></tt> is looked up with <a class="mochiref reference" href="#fn-getelement">getElement</a>, so string
241
- identifiers are also acceptable.</p>
242
- <dl class="docutils">
243
- <dt><em>Availability</em>:</dt>
244
- <dd>Available in MochiKit 1.3.1+</dd>
245
- </dl>
246
- </blockquote>
247
- <p>
248
- <a name="fn-addloadevent"></a>
249
- <a class="mochidef reference" href="#fn-addloadevent">addLoadEvent(func)</a>:</p>
250
- <blockquote>
251
- <p>Note that <a class="mochiref reference" href="#fn-addloadevent">addLoadEvent</a> can not be used in combination
252
- with <a class="mochiref reference" href="Signal.html">MochiKit.Signal</a> if the <tt class="docutils literal"><span class="pre">onload</span></tt> event is
253
- connected. Once an event is connected with
254
- <a class="mochiref reference" href="Signal.html">MochiKit.Signal</a>, no other APIs may be used for that
255
- same event.</p>
256
- <p>This will stack <tt class="docutils literal"><span class="pre">window.onload</span></tt> functions on top of each other.
257
- Each function added will be called after <tt class="docutils literal"><span class="pre">onload</span></tt> in the order
258
- that they were added.</p>
259
- <dl class="docutils">
260
- <dt><em>Availability</em>:</dt>
261
- <dd>Available in MochiKit 1.3.1+</dd>
262
- </dl>
263
- </blockquote>
264
- <p>
265
- <a name="fn-addtocallstack"></a>
266
- <a class="mochidef reference" href="#fn-addtocallstack">addToCallStack(target, path, func[, once])</a>:</p>
267
- <blockquote>
268
- <p>Note that <a class="mochiref reference" href="#fn-addtocallstack">addToCallStack</a> is not compatible with
269
- <a class="mochiref reference" href="Signal.html">MochiKit.Signal</a>. Once an event is connected with
270
- <a class="mochiref reference" href="Signal.html">MochiKit.Signal</a>, no other APIs may be used for that
271
- same event.</p>
272
- <p>Set the property <tt class="docutils literal"><span class="pre">path</span></tt> of <tt class="docutils literal"><span class="pre">target</span></tt> to a function that calls
273
- the existing function at that property (if any), then calls
274
- <tt class="docutils literal"><span class="pre">func</span></tt>.</p>
275
- <p>If <tt class="docutils literal"><span class="pre">target[path]()</span></tt> returns exactly <tt class="docutils literal"><span class="pre">false</span></tt>, then <tt class="docutils literal"><span class="pre">func</span></tt>
276
- will not be called.</p>
277
- <p>If <tt class="docutils literal"><span class="pre">once</span></tt> is <tt class="docutils literal"><span class="pre">true</span></tt>, then <tt class="docutils literal"><span class="pre">target[path]</span></tt> is set to <tt class="docutils literal"><span class="pre">null</span></tt>
278
- after the function call stack has completed.</p>
279
- <p>If called several times for the same <tt class="docutils literal"><span class="pre">target[path]</span></tt>, it will
280
- create a stack of functions (instead of just a pair).</p>
281
- <dl class="docutils">
282
- <dt><em>Availability</em>:</dt>
283
- <dd>Available in MochiKit 1.3.1+</dd>
284
- </dl>
285
- </blockquote>
286
- <p>
287
- <a name="fn-appendchildnodes"></a>
288
- <a class="mochidef reference" href="#fn-appendchildnodes">appendChildNodes(node[, childNode[, ...]])</a>:</p>
289
- <blockquote>
290
- <p>Append children to a DOM element using the <a class="reference" href="#dom-coercion-rules">DOM Coercion Rules</a>.</p>
291
- <dl class="docutils">
292
- <dt><tt class="docutils literal"><span class="pre">node</span></tt>:</dt>
293
- <dd>A reference to the DOM element to add children to (if a string
294
- is given, <a class="mochiref reference" href="#fn-getelement">getElement(node)</a> will be used to locate
295
- the node)</dd>
296
- <dt><tt class="docutils literal"><span class="pre">childNode</span></tt>...:</dt>
297
- <dd>All additional arguments, if any, will be coerced into DOM
298
- nodes that are appended as children using the <a class="reference" href="#dom-coercion-rules">DOM Coercion
299
- Rules</a>.</dd>
300
- <dt><em>returns</em>:</dt>
301
- <dd>The given DOM element</dd>
302
- <dt><em>Availability</em>:</dt>
303
- <dd>Available in MochiKit 1.3.1+</dd>
304
- </dl>
305
- </blockquote>
306
- <p>
307
- <a name="fn-insertsiblingnodesbefore"></a>
308
- <a class="mochidef reference" href="#fn-insertsiblingnodesbefore">insertSiblingNodesBefore(node[, siblingNode[, ...]])</a>:</p>
309
- <blockquote>
310
- <p>Insert children into the DOM structure using the <a class="reference" href="#dom-coercion-rules">DOM Coercion
311
- Rules</a>.</p>
312
- <dl class="docutils">
313
- <dt><tt class="docutils literal"><span class="pre">node</span></tt>:</dt>
314
- <dd>A reference to the DOM element you want to insert children
315
- before (if a string is given, <a class="mochiref reference" href="#fn-getelement">getElement(node)</a>
316
- will be used to locate the node)</dd>
317
- <dt><tt class="docutils literal"><span class="pre">siblingNode</span></tt>...:</dt>
318
- <dd>All additional arguments, if any, will be coerced into DOM
319
- nodes that are inserted as siblings using the <a class="reference" href="#dom-coercion-rules">DOM Coercion
320
- Rules</a>.</dd>
321
- <dt><em>returns</em>:</dt>
322
- <dd>The parent of the given DOM element</dd>
323
- <dt><em>Availability</em>:</dt>
324
- <dd>Available in MochiKit 1.4+</dd>
325
- </dl>
326
- </blockquote>
327
- <p>
328
- <a name="fn-insertsiblingnodesafter"></a>
329
- <a class="mochidef reference" href="#fn-insertsiblingnodesafter">insertSiblingNodesAfter(node[, siblingNode[, ...]])</a>:</p>
330
- <blockquote>
331
- <p>Insert children into the DOM structure using the <a class="reference" href="#dom-coercion-rules">DOM Coercion
332
- Rules</a>.</p>
333
- <dl class="docutils">
334
- <dt><tt class="docutils literal"><span class="pre">node</span></tt>:</dt>
335
- <dd>A reference to the DOM element you want to insert children
336
- after (if a string is given, <a class="mochiref reference" href="#fn-getelement">getElement(node)</a>
337
- will be used to locate the node)</dd>
338
- <dt><tt class="docutils literal"><span class="pre">siblingNode</span></tt>...:</dt>
339
- <dd>All additional arguments, if any, will be coerced into DOM
340
- nodes that are inserted as siblings using the <a class="reference" href="#dom-coercion-rules">DOM Coercion
341
- Rules</a>.</dd>
342
- <dt><em>returns</em>:</dt>
343
- <dd>The parent of the given DOM element</dd>
344
- <dt><em>Availability</em>:</dt>
345
- <dd>Available in MochiKit 1.4+</dd>
346
- </dl>
347
- </blockquote>
348
- <p>
349
- <a name="fn-createdom"></a>
350
- <a class="mochidef reference" href="#fn-createdom">createDOM(name[, attrs[, node[, ...]]])</a>:</p>
351
- <blockquote>
352
- <p>Create a DOM fragment in a really convenient manner, much like
353
- Nevow`s <a class="footnote-reference" href="#id5" id="id3" name="id3">[1]</a> stan <a class="footnote-reference" href="#id6" id="id4" name="id4">[2]</a>.</p>
354
- <p>Partially applied versions of this function for common tags are
355
- available as aliases:</p>
356
- <ul class="simple">
357
- <li><tt class="docutils literal"><span class="pre">A</span></tt></li>
358
- <li><tt class="docutils literal"><span class="pre">BUTTON</span></tt></li>
359
- <li><tt class="docutils literal"><span class="pre">BR</span></tt></li>
360
- <li><tt class="docutils literal"><span class="pre">CANVAS</span></tt></li>
361
- <li><tt class="docutils literal"><span class="pre">DD</span></tt></li>
362
- <li><tt class="docutils literal"><span class="pre">DIV</span></tt></li>
363
- <li><tt class="docutils literal"><span class="pre">DL</span></tt></li>
364
- <li><tt class="docutils literal"><span class="pre">DT</span></tt></li>
365
- <li><tt class="docutils literal"><span class="pre">FIELDSET</span></tt></li>
366
- <li><tt class="docutils literal"><span class="pre">FORM</span></tt></li>
367
- <li><tt class="docutils literal"><span class="pre">H1</span></tt></li>
368
- <li><tt class="docutils literal"><span class="pre">H2</span></tt></li>
369
- <li><tt class="docutils literal"><span class="pre">H3</span></tt></li>
370
- <li><tt class="docutils literal"><span class="pre">H4</span></tt></li>
371
- <li><tt class="docutils literal"><span class="pre">H5</span></tt></li>
372
- <li><tt class="docutils literal"><span class="pre">H6</span></tt></li>
373
- <li><tt class="docutils literal"><span class="pre">HR</span></tt></li>
374
- <li><tt class="docutils literal"><span class="pre">IMG</span></tt></li>
375
- <li><tt class="docutils literal"><span class="pre">INPUT</span></tt></li>
376
- <li><tt class="docutils literal"><span class="pre">LABEL</span></tt></li>
377
- <li><tt class="docutils literal"><span class="pre">LEGEND</span></tt></li>
378
- <li><tt class="docutils literal"><span class="pre">LI</span></tt></li>
379
- <li><tt class="docutils literal"><span class="pre">OL</span></tt></li>
380
- <li><tt class="docutils literal"><span class="pre">OPTGROUP</span></tt></li>
381
- <li><tt class="docutils literal"><span class="pre">OPTION</span></tt></li>
382
- <li><tt class="docutils literal"><span class="pre">P</span></tt></li>
383
- <li><tt class="docutils literal"><span class="pre">PRE</span></tt></li>
384
- <li><tt class="docutils literal"><span class="pre">SELECT</span></tt></li>
385
- <li><tt class="docutils literal"><span class="pre">SPAN</span></tt></li>
386
- <li><tt class="docutils literal"><span class="pre">STRONG</span></tt></li>
387
- <li><tt class="docutils literal"><span class="pre">TABLE</span></tt></li>
388
- <li><tt class="docutils literal"><span class="pre">TBODY</span></tt></li>
389
- <li><tt class="docutils literal"><span class="pre">TD</span></tt></li>
390
- <li><tt class="docutils literal"><span class="pre">TEXTAREA</span></tt></li>
391
- <li><tt class="docutils literal"><span class="pre">TFOOT</span></tt></li>
392
- <li><tt class="docutils literal"><span class="pre">TH</span></tt></li>
393
- <li><tt class="docutils literal"><span class="pre">THEAD</span></tt></li>
394
- <li><tt class="docutils literal"><span class="pre">TR</span></tt></li>
395
- <li><tt class="docutils literal"><span class="pre">TT</span></tt></li>
396
- <li><tt class="docutils literal"><span class="pre">UL</span></tt></li>
397
- </ul>
398
- <p>See <a class="reference" href="#creating-dom-element-trees">Creating DOM Element Trees</a> for a comprehensive example.</p>
399
- <dl class="docutils">
400
- <dt><tt class="docutils literal"><span class="pre">name</span></tt>:</dt>
401
- <dd>The kind of fragment to create (e.g. 'span'), such as you
402
- would pass to <tt class="docutils literal"><span class="pre">document.createElement</span></tt>.</dd>
403
- <dt><tt class="docutils literal"><span class="pre">attrs</span></tt>:</dt>
404
- <dd><p class="first">An object whose properties will be used as the attributes
405
- (e.g. <tt class="docutils literal"><span class="pre">{'style':</span> <span class="pre">'display:block'}</span></tt>), or <tt class="docutils literal"><span class="pre">null</span></tt> if no
406
- attributes need to be set.</p>
407
- <p>See <a class="mochiref reference" href="#fn-updatenodeattributes">updateNodeAttributes</a> for more information.</p>
408
- <p class="last">For convenience, if <tt class="docutils literal"><span class="pre">attrs</span></tt> is a string, <tt class="docutils literal"><span class="pre">null</span></tt> is used
409
- and the string will be considered the first <tt class="docutils literal"><span class="pre">node</span></tt>.</p>
410
- </dd>
411
- <dt><tt class="docutils literal"><span class="pre">node</span></tt>...:</dt>
412
- <dd>All additional arguments, if any, will be coerced into DOM
413
- nodes that are appended as children using the <a class="reference" href="#dom-coercion-rules">DOM Coercion
414
- Rules</a>.</dd>
415
- <dt><em>returns</em>:</dt>
416
- <dd>A DOM element</dd>
417
- <dt><em>Availability</em>:</dt>
418
- <dd>Available in MochiKit 1.3.1+</dd>
419
- </dl>
420
- </blockquote>
421
- <p>
422
- <a name="fn-createdomfunc"></a>
423
- <a class="mochidef reference" href="#fn-createdomfunc">createDOMFunc(tag[, attrs[, node[, ...]]])</a>:</p>
424
- <blockquote>
425
- <p>Convenience function to create a partially applied createDOM
426
- function. You'd want to use this if you add additional convenience
427
- functions for creating tags, or if you find yourself creating a
428
- lot of tags with a bunch of the same attributes or contents.</p>
429
- <p>See <a class="mochiref reference" href="#fn-createdom">createDOM</a> for more detailed descriptions of the
430
- arguments.</p>
431
- <dl class="docutils">
432
- <dt><tt class="docutils literal"><span class="pre">tag</span></tt>:</dt>
433
- <dd>The name of the tag</dd>
434
- <dt><tt class="docutils literal"><span class="pre">attrs</span></tt>:</dt>
435
- <dd>Optionally specify the attributes to apply</dd>
436
- <dt><tt class="docutils literal"><span class="pre">node</span></tt>...:</dt>
437
- <dd>Optionally specify any children nodes it should have</dd>
438
- <dt><em>returns</em>:</dt>
439
- <dd>function that takes additional arguments and calls
440
- <a class="mochiref reference" href="#fn-createdom">createDOM</a></dd>
441
- <dt><em>Availability</em>:</dt>
442
- <dd>Available in MochiKit 1.3.1+</dd>
443
- </dl>
444
- </blockquote>
445
- <p>
446
- <a name="fn-currentdocument"></a>
447
- <a class="mochidef reference" href="#fn-currentdocument">currentDocument()</a>:</p>
448
- <blockquote>
449
- <p>Return the current <tt class="docutils literal"><span class="pre">document</span></tt> <a class="reference" href="#dom-context">DOM Context</a>. This will always
450
- be the same as the global <tt class="docutils literal"><span class="pre">document</span></tt> unless
451
- <a class="mochiref reference" href="#fn-withdocument">withDocument</a> or <a class="mochiref reference" href="#fn-withwindow">withWindow</a> is currently
452
- executing.</p>
453
- <dl class="docutils">
454
- <dt><em>Availability</em>:</dt>
455
- <dd>Available in MochiKit 1.3.1+</dd>
456
- </dl>
457
- </blockquote>
458
- <p>
459
- <a name="fn-currentwindow"></a>
460
- <a class="mochidef reference" href="#fn-currentwindow">currentWindow()</a>:</p>
461
- <blockquote>
462
- <p>Return the current <tt class="docutils literal"><span class="pre">window</span></tt> <a class="reference" href="#dom-context">DOM Context</a>. This will always be
463
- the same as the global <tt class="docutils literal"><span class="pre">window</span></tt> unless <a class="mochiref reference" href="#fn-withwindow">withWindow</a> is
464
- currently executing.</p>
465
- <dl class="docutils">
466
- <dt><em>Availability</em>:</dt>
467
- <dd>Available in MochiKit 1.3.1+</dd>
468
- </dl>
469
- </blockquote>
470
- <p>
471
- <a name="fn-emithtml"></a>
472
- <a class="mochidef reference" href="#fn-emithtml">emitHTML(dom[, lst])</a>:</p>
473
- <blockquote>
474
- <p>Convert a DOM tree to an <tt class="docutils literal"><span class="pre">Array</span></tt> of HTML string fragments. This should
475
- be used for debugging/testing purposes only.</p>
476
- <p>The DOM property <tt class="docutils literal"><span class="pre">innerHTML</span></tt> or <tt class="docutils literal"><span class="pre">cloneNode(true)</span></tt> method should
477
- be used for most purposes.</p>
478
- <dl class="docutils">
479
- <dt><em>Availability</em>:</dt>
480
- <dd>Available in MochiKit 1.3.1+</dd>
481
- </dl>
482
- </blockquote>
483
- <p>
484
- <a name="fn-escapehtml"></a>
485
- <a class="mochidef reference" href="#fn-escapehtml">escapeHTML(s)</a>:</p>
486
- <blockquote>
487
- <p>Make a string safe for HTML, converting the usual suspects (<tt class="docutils literal"><span class="pre">&lt;</span></tt>,
488
- <tt class="docutils literal"><span class="pre">&gt;</span></tt>, <tt class="docutils literal"><span class="pre">&quot;</span></tt>, <tt class="docutils literal"><span class="pre">&amp;</span></tt>) to their HTML character entity equivalents.</p>
489
- <dl class="docutils">
490
- <dt><em>Availability</em>:</dt>
491
- <dd>Available in MochiKit 1.3.1+</dd>
492
- </dl>
493
- </blockquote>
494
- <p>
495
- <a name="fn-focusonload"></a>
496
- <a class="mochidef reference" href="#fn-focusonload">focusOnLoad(element)</a>:</p>
497
- <blockquote>
498
- <p>Note that <a class="mochiref reference" href="#fn-focusonload">focusOnLoad</a> can not be used in combination
499
- with <a class="mochiref reference" href="Signal.html">MochiKit.Signal</a> if the <tt class="docutils literal"><span class="pre">onload</span></tt> event is
500
- connected. Once an event is connected with
501
- <a class="mochiref reference" href="Signal.html">MochiKit.Signal</a>, no other APIs may be used for that
502
- same event.</p>
503
- <p>This adds an onload event to focus the given element.</p>
504
- <dl class="docutils">
505
- <dt><em>Availability</em>:</dt>
506
- <dd>Available in MochiKit 1.3.1+</dd>
507
- </dl>
508
- </blockquote>
509
- <p>
510
- <a name="fn-formcontents"></a>
511
- <a class="mochidef reference" href="#fn-formcontents">formContents(elem=document.body)</a>:</p>
512
- <blockquote>
513
- <p>Search the DOM tree, starting at <tt class="docutils literal"><span class="pre">elem</span></tt>, for any elements with a
514
- <tt class="docutils literal"><span class="pre">name</span></tt> and <tt class="docutils literal"><span class="pre">value</span></tt> attribute. Return a 2-element <tt class="docutils literal"><span class="pre">Array</span></tt> of
515
- <tt class="docutils literal"><span class="pre">names</span></tt> and <tt class="docutils literal"><span class="pre">values</span></tt> suitable for use with
516
- <a class="mochiref reference" href="Base.html#fn-querystring">MochiKit.Base.queryString</a>.</p>
517
- <dl class="docutils">
518
- <dt><em>Availability</em>:</dt>
519
- <dd>Available in MochiKit 1.3.1+</dd>
520
- </dl>
521
- </blockquote>
522
- <p>
523
- <a name="fn-getelement"></a>
524
- <a class="mochidef reference" href="#fn-getelement">getElement(id[, ...])</a>:</p>
525
- <blockquote>
526
- <p>A small quick little function to encapsulate the
527
- <tt class="docutils literal"><span class="pre">getElementById</span></tt> method. It includes a check to ensure we can
528
- use that method.</p>
529
- <p>If the id isn't a string, it will be returned as-is.</p>
530
- <p>Also available as <a class="mochiref reference" href="#fn-$">$(...)</a> for convenience and
531
- compatibility with other JavaScript frameworks.</p>
532
- <p>If multiple arguments are given, an <tt class="docutils literal"><span class="pre">Array</span></tt> will be returned.</p>
533
- <dl class="docutils">
534
- <dt><em>Availability</em>:</dt>
535
- <dd>Available in MochiKit 1.3.1+</dd>
536
- </dl>
537
- </blockquote>
538
- <p>
539
- <a name="fn-getelementsbytagandclassname"></a>
540
- <a class="mochidef reference" href="#fn-getelementsbytagandclassname">getElementsByTagAndClassName(tagName, className, parent=document)</a>:</p>
541
- <blockquote>
542
- <p>Returns an array of elements in <tt class="docutils literal"><span class="pre">parent</span></tt> that match the tag name
543
- and class name provided. If <tt class="docutils literal"><span class="pre">parent</span></tt> is a string, it will be
544
- looked up with <a class="mochiref reference" href="#fn-getelement">getElement</a>.</p>
545
- <p>If <tt class="docutils literal"><span class="pre">tagName</span></tt> is <tt class="docutils literal"><span class="pre">null</span></tt> or <tt class="docutils literal"><span class="pre">&quot;*&quot;</span></tt>, all elements will be
546
- searched for the matching class.</p>
547
- <p>If <tt class="docutils literal"><span class="pre">className</span></tt> is <tt class="docutils literal"><span class="pre">null</span></tt>, all elements matching the provided
548
- tag are returned.</p>
549
- <dl class="docutils">
550
- <dt><em>Availability</em>:</dt>
551
- <dd>Available in MochiKit 1.3.1+</dd>
552
- </dl>
553
- </blockquote>
554
- <p>
555
- <a name="fn-getfirstelementbytagandclassname"></a>
556
- <a class="mochidef reference" href="#fn-getfirstelementbytagandclassname">getFirstElementByTagAndClassName(tagName, className, parent=document)</a>:</p>
557
- <blockquote>
558
- <p>Return the first element in <tt class="docutils literal"><span class="pre">parent</span></tt> that matches the tag name
559
- and class name provided. If <tt class="docutils literal"><span class="pre">parent</span></tt> is a string, it will be
560
- looked up with <a class="mochiref reference" href="#fn-getelement">getElement</a>.</p>
561
- <p>If <tt class="docutils literal"><span class="pre">tagName</span></tt> is <tt class="docutils literal"><span class="pre">null</span></tt> or <tt class="docutils literal"><span class="pre">&quot;*&quot;</span></tt>, all elements will be searched
562
- for the matching class.</p>
563
- <p>If <tt class="docutils literal"><span class="pre">className</span></tt> is <tt class="docutils literal"><span class="pre">null</span></tt>, the first element matching the provided
564
- tag will be returned.</p>
565
- <dl class="docutils">
566
- <dt><em>Availability</em>:</dt>
567
- <dd>Available in MochiKit 1.4+</dd>
568
- </dl>
569
- </blockquote>
570
- <p>
571
- <a name="fn-getfirstparentbytagandclassname"></a>
572
- <a class="mochidef reference" href="#fn-getfirstparentbytagandclassname">getFirstParentByTagAndClassName(elem, tagName='*', className=null)</a>:</p>
573
- <blockquote>
574
- <p>Returns the first parent of <tt class="docutils literal"><span class="pre">elem</span></tt> that matches the tag name and class
575
- name provided. If <tt class="docutils literal"><span class="pre">elem</span></tt> is a string, it will be looked up using
576
- <a class="mochiref reference" href="#fn-getelement">getElement</a>.</p>
577
- <p>If <tt class="docutils literal"><span class="pre">tagName</span></tt> is <tt class="docutils literal"><span class="pre">null</span></tt> or <tt class="docutils literal"><span class="pre">&quot;*&quot;</span></tt>, all elements will be searched
578
- for the matching class.</p>
579
- <p>If <tt class="docutils literal"><span class="pre">className</span></tt> is <tt class="docutils literal"><span class="pre">null</span></tt>, the first element matching the provided
580
- tag name will be returned.</p>
581
- <p>If no match is found, <tt class="docutils literal"><span class="pre">null</span></tt> will be returned.</p>
582
- <dl class="docutils">
583
- <dt><em>Availability</em>:</dt>
584
- <dd>Available in MochiKit 1.4+</dd>
585
- </dl>
586
- </blockquote>
587
- <p>
588
- <a name="fn-getnodeattribute"></a>
589
- <a class="mochidef reference" href="#fn-getnodeattribute">getNodeAttribute(node, attr)</a>:</p>
590
- <blockquote>
591
- <p>Get the value of the given attribute for a DOM element without
592
- ever raising an exception (will return <tt class="docutils literal"><span class="pre">null</span></tt> on exception).</p>
593
- <dl class="docutils">
594
- <dt><tt class="docutils literal"><span class="pre">node</span></tt>:</dt>
595
- <dd>A reference to the DOM element to update (if a string is
596
- given, <a class="mochiref reference" href="#fn-getelement">getElement(node)</a> will be used to locate the
597
- node)</dd>
598
- <dt><tt class="docutils literal"><span class="pre">attr</span></tt>:</dt>
599
- <dd><p class="first">The name of the attribute</p>
600
- <p class="last">Note that it will do the right thing for IE, so don't do
601
- the <tt class="docutils literal"><span class="pre">class</span></tt> -&gt; <tt class="docutils literal"><span class="pre">className</span></tt> hack yourself.</p>
602
- </dd>
603
- <dt><em>returns</em>:</dt>
604
- <dd>The attribute's value, or <tt class="docutils literal"><span class="pre">null</span></tt></dd>
605
- <dt><em>Availability</em>:</dt>
606
- <dd>Available in MochiKit 1.3.1+</dd>
607
- </dl>
608
- </blockquote>
609
- <p>
610
- <a name="fn-haselementclass"></a>
611
- <a class="mochidef reference" href="#fn-haselementclass">hasElementClass(element, className[, ...])</a>:</p>
612
- <blockquote>
613
- <p>Return <tt class="docutils literal"><span class="pre">true</span></tt> if <tt class="docutils literal"><span class="pre">className</span></tt> is found on the <tt class="docutils literal"><span class="pre">element</span></tt>.
614
- <tt class="docutils literal"><span class="pre">element</span></tt> is looked up with <a class="mochiref reference" href="#fn-getelement">getElement</a>, so string
615
- identifiers are also acceptable.</p>
616
- <dl class="docutils">
617
- <dt><em>Availability</em>:</dt>
618
- <dd>Available in MochiKit 1.3.1+</dd>
619
- </dl>
620
- </blockquote>
621
- <p>
622
- <a name="fn-ischildnode"></a>
623
- <a class="mochidef reference" href="#fn-ischildnode">isChildNode(node, maybeParent)</a>:</p>
624
- <blockquote>
625
- <p>Determine whether <tt class="docutils literal"><span class="pre">node</span></tt> is a child node or decendant node of
626
- <tt class="docutils literal"><span class="pre">maybeParent</span></tt>. Returns <tt class="docutils literal"><span class="pre">true</span></tt> if so, and <tt class="docutils literal"><span class="pre">false</span></tt> if not.
627
- A node is considered a child node of itself for the purposes of
628
- this function.</p>
629
- <p>If either <tt class="docutils literal"><span class="pre">node</span></tt> or <tt class="docutils literal"><span class="pre">maybeParent</span></tt> are strings, the related
630
- nodes will be looked up with <a class="mochiref reference" href="#fn-getelement">getElement</a>.</p>
631
- <dl class="docutils">
632
- <dt><em>Availability</em>:</dt>
633
- <dd>Available in MochiKit 1.4+</dd>
634
- </dl>
635
- </blockquote>
636
- <p>
637
- <a name="fn-registerdomconverter"></a>
638
- <a class="mochidef reference" href="#fn-registerdomconverter">registerDOMConverter(name, check, wrap[, override])</a>:</p>
639
- <blockquote>
640
- <p>Register an adapter to convert objects that match <tt class="docutils literal"><span class="pre">check(obj,</span>
641
- <span class="pre">ctx)</span></tt> to a DOM element, or something that can be converted to a
642
- DOM element (i.e. number, bool, string, function, iterable).</p>
643
- <dl class="docutils">
644
- <dt><em>Availability</em>:</dt>
645
- <dd>Available in MochiKit 1.3.1+</dd>
646
- </dl>
647
- </blockquote>
648
- <p>
649
- <a name="fn-removeelement"></a>
650
- <a class="mochidef reference" href="#fn-removeelement">removeElement(node)</a>:</p>
651
- <blockquote>
652
- <p>Remove and return <tt class="docutils literal"><span class="pre">node</span></tt> from a DOM tree.</p>
653
- <dl class="docutils">
654
- <dt><tt class="docutils literal"><span class="pre">node</span></tt>:</dt>
655
- <dd>the DOM element (or string id of one) to be removed</dd>
656
- <dt><em>returns</em></dt>
657
- <dd>The removed element</dd>
658
- <dt><em>Availability</em>:</dt>
659
- <dd>Available in MochiKit 1.3.1+</dd>
660
- </dl>
661
- </blockquote>
662
- <p>
663
- <a name="fn-removeelementclass"></a>
664
- <a class="mochidef reference" href="#fn-removeelementclass">removeElementClass(element, className)</a>:</p>
665
- <blockquote>
666
- <p>Ensure that the given <tt class="docutils literal"><span class="pre">element</span></tt> does not have <tt class="docutils literal"><span class="pre">className</span></tt> set
667
- as part of its class attribute. This will not disturb other class
668
- names. <tt class="docutils literal"><span class="pre">element</span></tt> is looked up with <a class="mochiref reference" href="#fn-getelement">getElement</a>, so
669
- string identifiers are also acceptable.</p>
670
- <dl class="docutils">
671
- <dt><em>Availability</em>:</dt>
672
- <dd>Available in MochiKit 1.3.1+</dd>
673
- </dl>
674
- </blockquote>
675
- <p>
676
- <a name="fn-removeemptytextnodes"></a>
677
- <a class="mochidef reference" href="#fn-removeemptytextnodes">removeEmptyTextNodes(node)</a>:</p>
678
- <blockquote>
679
- <p>Remove all text node children that contain only whitespace from
680
- <tt class="docutils literal"><span class="pre">node</span></tt>. Useful in situations where such empty text nodes can
681
- interfere with DOM traversal.</p>
682
- <dl class="docutils">
683
- <dt><tt class="docutils literal"><span class="pre">node</span></tt>:</dt>
684
- <dd>the DOM element (or string id of one) to remove whitespace child
685
- nodes from.</dd>
686
- <dt><em>Availability</em>:</dt>
687
- <dd>Available in MochiKit 1.4+</dd>
688
- </dl>
689
- </blockquote>
690
- <p>
691
- <a name="fn-replacechildnodes"></a>
692
- <a class="mochidef reference" href="#fn-replacechildnodes">replaceChildNodes(node[, childNode[, ...]])</a>:</p>
693
- <blockquote>
694
- <p>Remove all children from the given DOM element, then append any
695
- given childNodes to it (by calling <a class="mochiref reference" href="#fn-appendchildnodes">appendChildNodes</a>).</p>
696
- <dl class="docutils">
697
- <dt><tt class="docutils literal"><span class="pre">node</span></tt>:</dt>
698
- <dd>A reference to the DOM element to add children to (if a string
699
- is given, <a class="mochiref reference" href="#fn-getelement">getElement(node)</a> will be used to locate
700
- the node)</dd>
701
- <dt><tt class="docutils literal"><span class="pre">childNode</span></tt>...:</dt>
702
- <dd>All additional arguments, if any, will be coerced into DOM
703
- nodes that are appended as children using the <a class="reference" href="#dom-coercion-rules">DOM Coercion
704
- Rules</a>.</dd>
705
- <dt><em>returns</em>:</dt>
706
- <dd>The given DOM element</dd>
707
- <dt><em>Availability</em>:</dt>
708
- <dd>Available in MochiKit 1.3.1+</dd>
709
- </dl>
710
- </blockquote>
711
- <p>
712
- <a name="fn-scrapetext"></a>
713
- <a class="mochidef reference" href="#fn-scrapetext">scrapeText(node[, asArray=false])</a>:</p>
714
- <blockquote>
715
- <p>Walk a DOM tree in-order and scrape all of the text out of it as a
716
- <tt class="docutils literal"><span class="pre">string</span></tt>.</p>
717
- <p>If <tt class="docutils literal"><span class="pre">asArray</span></tt> is <tt class="docutils literal"><span class="pre">true</span></tt>, then an <tt class="docutils literal"><span class="pre">Array</span></tt> will be returned
718
- with each individual text node. These two are equivalent:</p>
719
- <pre class="literal-block">
720
- assert( scrapeText(node) == scrapeText(node, true).join(&quot;&quot;) );
721
- </pre>
722
- <dl class="docutils">
723
- <dt><em>Availability</em>:</dt>
724
- <dd>Available in MochiKit 1.3.1+</dd>
725
- </dl>
726
- </blockquote>
727
- <p>
728
- <a name="fn-setelementclass"></a>
729
- <a class="mochidef reference" href="#fn-setelementclass">setElementClass(element, className)</a>:</p>
730
- <blockquote>
731
- <p>Set the entire class attribute of <tt class="docutils literal"><span class="pre">element</span></tt> to <tt class="docutils literal"><span class="pre">className</span></tt>.
732
- <tt class="docutils literal"><span class="pre">element</span></tt> is looked up with <a class="mochiref reference" href="#fn-getelement">getElement</a>, so string
733
- identifiers are also acceptable.</p>
734
- <dl class="docutils">
735
- <dt><em>Availability</em>:</dt>
736
- <dd>Available in MochiKit 1.3.1+</dd>
737
- </dl>
738
- </blockquote>
739
- <p>
740
- <a name="fn-setnodeattribute"></a>
741
- <a class="mochidef reference" href="#fn-setnodeattribute">setNodeAttribute(node, attr, value)</a>:</p>
742
- <blockquote>
743
- <p>Set the value of the given attribute for a DOM element without
744
- ever raising an exception (will return null on exception). If
745
- setting more than one attribute, you should use
746
- <a class="mochiref reference" href="#fn-updatenodeattributes">updateNodeAttributes</a>.</p>
747
- <dl class="docutils">
748
- <dt><tt class="docutils literal"><span class="pre">node</span></tt>:</dt>
749
- <dd>A reference to the DOM element to update (if a string is
750
- given, <a class="mochiref reference" href="#fn-getelement">getElement(node)</a> will be used to locate the
751
- node)</dd>
752
- <dt><tt class="docutils literal"><span class="pre">attr</span></tt>:</dt>
753
- <dd><p class="first">The name of the attribute</p>
754
- <p>Note that it will do the right thing for IE, so don't do the
755
- <tt class="docutils literal"><span class="pre">class</span></tt> -&gt; <tt class="docutils literal"><span class="pre">className</span></tt> hack yourself.</p>
756
- <p class="last">Also note that the DOM element object property with the same
757
- name will also be set if not already identical to the attribute
758
- value. This is needed to compensate for weird attributes that
759
- distinguish between the property and attribute values (i.e. the
760
- &quot;value&quot; attribute for fields).</p>
761
- </dd>
762
- <dt><tt class="docutils literal"><span class="pre">value</span></tt>:</dt>
763
- <dd>The value of the attribute, may be an object to be merged
764
- (e.g. for setting style).</dd>
765
- <dt><em>returns</em>:</dt>
766
- <dd>The given DOM element or <tt class="docutils literal"><span class="pre">null</span></tt> on failure</dd>
767
- <dt><em>Availability</em>:</dt>
768
- <dd>Available in MochiKit 1.3.1+</dd>
769
- </dl>
770
- </blockquote>
771
- <p>
772
- <a name="fn-swapdom"></a>
773
- <a class="mochidef reference" href="#fn-swapdom">swapDOM(dest, src)</a>:</p>
774
- <blockquote>
775
- <p>Replace <tt class="docutils literal"><span class="pre">dest</span></tt> in a DOM tree with <tt class="docutils literal"><span class="pre">src</span></tt>, returning <tt class="docutils literal"><span class="pre">src</span></tt>.</p>
776
- <dl class="docutils">
777
- <dt><tt class="docutils literal"><span class="pre">dest</span></tt>:</dt>
778
- <dd>a DOM element (or string id of one) to be replaced</dd>
779
- <dt><tt class="docutils literal"><span class="pre">src</span></tt>:</dt>
780
- <dd>the DOM element (or string id of one) to replace it with, or
781
- <tt class="docutils literal"><span class="pre">null</span></tt> if <tt class="docutils literal"><span class="pre">dest</span></tt> is to be removed (replaced with nothing).</dd>
782
- <dt><em>returns</em>:</dt>
783
- <dd>a DOM element (<tt class="docutils literal"><span class="pre">src</span></tt>)</dd>
784
- <dt><em>Availability</em>:</dt>
785
- <dd>Available in MochiKit 1.3.1+</dd>
786
- </dl>
787
- </blockquote>
788
- <p>
789
- <a name="fn-swapelementclass"></a>
790
- <a class="mochidef reference" href="#fn-swapelementclass">swapElementClass(element, fromClass, toClass)</a>:</p>
791
- <blockquote>
792
- <p>If <tt class="docutils literal"><span class="pre">fromClass</span></tt> is set on <tt class="docutils literal"><span class="pre">element</span></tt>, replace it with
793
- <tt class="docutils literal"><span class="pre">toClass</span></tt>. This will not disturb other classes on that element.
794
- <tt class="docutils literal"><span class="pre">element</span></tt> is looked up with <a class="mochiref reference" href="#fn-getelement">getElement</a>, so string
795
- identifiers are also acceptable.</p>
796
- <dl class="docutils">
797
- <dt><em>Availability</em>:</dt>
798
- <dd>Available in MochiKit 1.3.1+</dd>
799
- </dl>
800
- </blockquote>
801
- <p>
802
- <a name="fn-toggleelementclass"></a>
803
- <a class="mochidef reference" href="#fn-toggleelementclass">toggleElementClass(className[, element[, ...]])</a>:</p>
804
- <blockquote>
805
- <p>Toggle the presence of a given <tt class="docutils literal"><span class="pre">className</span></tt> in the class
806
- attribute of all given elements. All elements will be looked up
807
- with <a class="mochiref reference" href="#fn-getelement">getElement</a>, so string identifiers are acceptable.</p>
808
- <dl class="docutils">
809
- <dt><em>Availability</em>:</dt>
810
- <dd>Available in MochiKit 1.3.1+</dd>
811
- </dl>
812
- </blockquote>
813
- <p>
814
- <a name="fn-tohtml"></a>
815
- <a class="mochidef reference" href="#fn-tohtml">toHTML(dom)</a>:</p>
816
- <blockquote>
817
- <p>Convert a DOM tree to a HTML string using <a class="mochiref reference" href="#fn-emithtml">emitHTML</a>.
818
- This should be used for debugging/testing purposes only.</p>
819
- <p>The DOM property <tt class="docutils literal"><span class="pre">innerHTML</span></tt> or <tt class="docutils literal"><span class="pre">cloneNode(true)</span></tt> method should
820
- be used for most purposes.</p>
821
- <dl class="docutils">
822
- <dt><em>Availability</em>:</dt>
823
- <dd>Available in MochiKit 1.3.1+</dd>
824
- </dl>
825
- </blockquote>
826
- <p>
827
- <a name="fn-updatenodeattributes"></a>
828
- <a class="mochidef reference" href="#fn-updatenodeattributes">updateNodeAttributes(node, attrs)</a>:</p>
829
- <blockquote>
830
- <p>Update the attributes of a DOM element from a given object.</p>
831
- <dl class="docutils">
832
- <dt><tt class="docutils literal"><span class="pre">node</span></tt>:</dt>
833
- <dd>A reference to the DOM element to update (if a string is
834
- given, <a class="mochiref reference" href="#fn-getelement">getElement(node)</a> will be used to locate the
835
- node)</dd>
836
- <dt><tt class="docutils literal"><span class="pre">attrs</span></tt>:</dt>
837
- <dd><p class="first">An object whose properties will be used to set the attributes
838
- (e.g. <tt class="docutils literal"><span class="pre">{'class':</span> <span class="pre">'invisible'}</span></tt>), or <tt class="docutils literal"><span class="pre">null</span></tt> if no
839
- attributes need to be set. If an object is given for the
840
- attribute value (e.g. <tt class="docutils literal"><span class="pre">{'style':</span> <span class="pre">{'display':</span> <span class="pre">'block'}}</span></tt>)
841
- then <a class="mochiref reference" href="Base.html#fn-updatetree">MochiKit.Base.updatetree</a> will be used to set
842
- that attribute.</p>
843
- <p>Note that it will do the right thing for IE, so don't do the
844
- <tt class="docutils literal"><span class="pre">class</span></tt> -&gt; <tt class="docutils literal"><span class="pre">className</span></tt> hack yourself, and it deals with
845
- setting &quot;on...&quot; event handlers correctly.</p>
846
- <p class="last">Also note that the DOM element object property with the same
847
- name will also be set if not already identical to the attribute
848
- value. This is needed to compensate for weird attributes that
849
- distinguish between the property and attribute values (i.e. the
850
- &quot;value&quot; attribute for fields).</p>
851
- </dd>
852
- <dt><em>returns</em>:</dt>
853
- <dd>The given DOM element</dd>
854
- <dt><em>Availability</em>:</dt>
855
- <dd>Available in MochiKit 1.3.1+</dd>
856
- </dl>
857
- </blockquote>
858
- <p>
859
- <a name="fn-withwindow"></a>
860
- <a class="mochidef reference" href="#fn-withwindow">withWindow(win, func)</a>:</p>
861
- <blockquote>
862
- <p>Call <tt class="docutils literal"><span class="pre">func</span></tt> with the <tt class="docutils literal"><span class="pre">window</span></tt> <a class="reference" href="#dom-context">DOM Context</a> set to <tt class="docutils literal"><span class="pre">win</span></tt>
863
- and the <tt class="docutils literal"><span class="pre">document</span></tt> <a class="reference" href="#dom-context">DOM Context</a> set to <tt class="docutils literal"><span class="pre">win.document</span></tt>. When
864
- <tt class="docutils literal"><span class="pre">func()</span></tt> returns or throws an error, the <a class="reference" href="#dom-context">DOM Context</a> will be
865
- restored to its previous state.</p>
866
- <p>The return value of <tt class="docutils literal"><span class="pre">func()</span></tt> is returned by this function.</p>
867
- <dl class="docutils">
868
- <dt><em>Availability</em>:</dt>
869
- <dd>Available in MochiKit 1.3.1+</dd>
870
- </dl>
871
- </blockquote>
872
- <p>
873
- <a name="fn-withdocument"></a>
874
- <a class="mochidef reference" href="#fn-withdocument">withDocument(doc, func)</a>:</p>
875
- <blockquote>
876
- <p>Call <tt class="docutils literal"><span class="pre">func</span></tt> with the <tt class="docutils literal"><span class="pre">doc</span></tt> <a class="reference" href="#dom-context">DOM Context</a> set to <tt class="docutils literal"><span class="pre">doc</span></tt>.
877
- When <tt class="docutils literal"><span class="pre">func()</span></tt> returns or throws an error, the <a class="reference" href="#dom-context">DOM Context</a>
878
- will be restored to its previous state.</p>
879
- <p>The return value of <tt class="docutils literal"><span class="pre">func()</span></tt> is returned by this function.</p>
880
- <dl class="docutils">
881
- <dt><em>Availability</em>:</dt>
882
- <dd>Available in MochiKit 1.3.1+</dd>
883
- </dl>
884
- </blockquote>
885
- </div>
886
- <div class="section">
887
- <h2><a id="style-functions" name="style-functions">Style Functions</a></h2>
888
- <p>These functions were previously available in MochiKit.DOM, but have been
889
- moved to <a class="mochiref reference" href="Style.html">MochiKit.Style</a> in recent versions. Function aliases
890
- remain for backwards compability.</p>
891
- <p>
892
- <a name="fn-computedstyle"></a>
893
- <a class="mochidef reference" href="#fn-computedstyle">computedStyle(htmlElement, cssProperty, mozillaEquivalentCSS)</a>:</p>
894
- <blockquote>
895
- <p>Looks up a CSS property for the given element. The element can be
896
- specified as either a string with the element's ID or the element
897
- object itself.</p>
898
- <dl class="docutils">
899
- <dt><tt class="docutils literal"><span class="pre">cssProperty</span></tt>:</dt>
900
- <dd>MochiKit 1.3.1 expects camel case, e.g. <tt class="docutils literal"><span class="pre">backgroundColor</span></tt>.
901
- MochiKit 1.4+ expects CSS selector case, e.g. <tt class="docutils literal"><span class="pre">background-color</span></tt>,
902
- but will accept camel case for backwards-compatibility.</dd>
903
- <dt><tt class="docutils literal"><span class="pre">mozillaEquivalentCSS</span></tt>:</dt>
904
- <dd>MochiKit 1.3.1 expects selector case.
905
- MochiKit 1.4+ ignores this argument.</dd>
906
- <dt><em>Availability</em>:</dt>
907
- <dd>Available in MochiKit 1.3.1, deprecated in favor of
908
- <a class="mochiref reference" href="Style.html#fn-getstyle">MochiKit.Style.getStyle</a> in 1.4+</dd>
909
- </dl>
910
- </blockquote>
911
- <p>
912
- <a name="fn-elementdimensions"></a>
913
- <a class="mochidef reference" href="#fn-elementdimensions">elementDimensions(element)</a>:</p>
914
- <blockquote>
915
- <p>Return the absolute pixel width and height (including padding and border,
916
- but not margins) of <tt class="docutils literal"><span class="pre">element</span></tt> as an object with <tt class="docutils literal"><span class="pre">w</span></tt> and <tt class="docutils literal"><span class="pre">h</span></tt>
917
- properties, or <tt class="docutils literal"><span class="pre">undefined</span></tt> if <tt class="docutils literal"><span class="pre">element</span></tt> is not in the document.
918
- <tt class="docutils literal"><span class="pre">element</span></tt> may be specified as a string to be looked up with
919
- <a class="mochiref reference" href="#fn-getelement">getElement</a>, a DOM element, or trivially as an object with
920
- <tt class="docutils literal"><span class="pre">w</span></tt> and/or <tt class="docutils literal"><span class="pre">h</span></tt> properties.</p>
921
- <dl class="docutils">
922
- <dt><em>Availability</em>:</dt>
923
- <dd>Available in MochiKit 1.3.1, deprecated in favor of
924
- <a class="mochiref reference" href="Style.html#fn-getelementdimensions">MochiKit.Style.getElementDimensions</a> in 1.4+</dd>
925
- </dl>
926
- </blockquote>
927
- <p>
928
- <a name="fn-elementposition"></a>
929
- <a class="mochidef reference" href="#fn-elementposition">elementPosition(element[, relativeTo={x: 0, y: 0}])</a>:</p>
930
- <blockquote>
931
- <p>Return the absolute pixel position of <tt class="docutils literal"><span class="pre">element</span></tt> in the document
932
- as an object with <tt class="docutils literal"><span class="pre">x</span></tt> and <tt class="docutils literal"><span class="pre">y</span></tt> properties, or <tt class="docutils literal"><span class="pre">undefined</span></tt> if
933
- <tt class="docutils literal"><span class="pre">element</span></tt> is not in the document. <tt class="docutils literal"><span class="pre">element</span></tt> may be specified
934
- as a string to be looked up with <a class="mochiref reference" href="#fn-getelement">getElement</a>, a DOM
935
- element, or trivially as an object with <tt class="docutils literal"><span class="pre">x</span></tt> and/or <tt class="docutils literal"><span class="pre">y</span></tt>
936
- properties.</p>
937
- <p>If <tt class="docutils literal"><span class="pre">relativeTo</span></tt> is given, then its coordinates are subtracted from
938
- the absolute position of <tt class="docutils literal"><span class="pre">element</span></tt>, e.g.:</p>
939
- <pre class="literal-block">
940
- var elemPos = elementPosition(elem);
941
- var anotherElemPos = elementPosition(anotherElem);
942
- var relPos = elementPosition(elem, anotherElem);
943
- assert( relPos.x == (elemPos.x - anotherElemPos.x) );
944
- assert( relPos.y == (elemPos.y - anotherElemPos.y) );
945
- </pre>
946
- <p><tt class="docutils literal"><span class="pre">relativeTo</span></tt> may be specified as a string to be looked up with
947
- <a class="mochiref reference" href="#fn-getelement">getElement</a>, a DOM element, or trivially as an object
948
- with <tt class="docutils literal"><span class="pre">x</span></tt> and/or <tt class="docutils literal"><span class="pre">y</span></tt> properties.</p>
949
- <dl class="docutils">
950
- <dt><em>Availability</em>:</dt>
951
- <dd>Available in MochiKit 1.3.1, deprecated in favor of
952
- <a class="mochiref reference" href="Style.html#fn-getelementposition">MochiKit.Style.getElementPosition</a> in 1.4+</dd>
953
- </dl>
954
- </blockquote>
955
- <p>
956
- <a name="fn-getviewportdimensions"></a>
957
- <a class="mochidef reference" href="#fn-getviewportdimensions">getViewportDimensions()</a>:</p>
958
- <blockquote>
959
- <p>Return the pixel width and height of the viewport as an object
960
- with <tt class="docutils literal"><span class="pre">w</span></tt> and <tt class="docutils literal"><span class="pre">h</span></tt> properties. <tt class="docutils literal"><span class="pre">element</span></tt> is looked up with
961
- <a class="mochiref reference" href="#fn-getelement">getElement</a>, so string identifiers are also acceptable.</p>
962
- <dl class="docutils">
963
- <dt><em>Availability</em>:</dt>
964
- <dd>Available in MochiKit 1.3.1, moved to
965
- <a class="mochiref reference" href="Style.html#fn-getviewportdimensions">MochiKit.Style.getViewportDimensions</a> in 1.4+</dd>
966
- </dl>
967
- </blockquote>
968
- <p>
969
- <a name="fn-hideelement"></a>
970
- <a class="mochidef reference" href="#fn-hideelement">hideElement(element, ...)</a>:</p>
971
- <blockquote>
972
- <p>Partial form of <a class="mochiref reference" href="#fn-setdisplayforelement">setDisplayForElement</a>, specifically:</p>
973
- <pre class="literal-block">
974
- partial(setDisplayForElement, &quot;none&quot;)
975
- </pre>
976
- <p>For information about the caveats of using a <tt class="docutils literal"><span class="pre">style.display</span></tt>
977
- based show/hide mechanism, and a CSS based alternative, see
978
- <a class="reference" href="Style.html#element-visibility">Element Visibility</a>.</p>
979
- </blockquote>
980
- <blockquote>
981
- <dl class="docutils">
982
- <dt><em>Availability</em>:</dt>
983
- <dd>Available in MochiKit 1.3.1, moved to
984
- <a class="mochiref reference" href="Style.html#fn-hideelement">MochiKit.Style.hideElement</a> in 1.4+</dd>
985
- </dl>
986
- </blockquote>
987
- <p>
988
- <a name="fn-makeclipping"></a>
989
- <a class="mochidef reference" href="#fn-makeclipping">makeClipping(element)</a>:</p>
990
- <blockquote>
991
- <p>Ensure that <tt class="docutils literal"><span class="pre">element.style.overflow</span> <span class="pre">=</span> <span class="pre">'hidden'</span></tt>. If <tt class="docutils literal"><span class="pre">element</span></tt> is a
992
- string, then it will be looked up with <a class="mochiref reference" href="#fn-getelement">getElement</a>.</p>
993
- <p>Returns the original values of <tt class="docutils literal"><span class="pre">overflow</span></tt>, <tt class="docutils literal"><span class="pre">overflow-y</span></tt> and
994
- <tt class="docutils literal"><span class="pre">overflow-y</span></tt> so that they may be restored with
995
- <a class="mochiref reference" href="#fn-undoclipping">undoClipping(element, overflow)</a>.</p>
996
- <dl class="docutils">
997
- <dt><em>Availability</em>:</dt>
998
- <dd>Available in MochiKit 1.4+, moved to
999
- <a class="mochiref reference" href="Style.html#fn-makeclipping">MochiKit.Style.makeClipping</a> in 1.4.1+</dd>
1000
- </dl>
1001
- </blockquote>
1002
- <p>
1003
- <a name="fn-makepositioned"></a>
1004
- <a class="mochidef reference" href="#fn-makepositioned">makePositioned(element)</a>:</p>
1005
- <blockquote>
1006
- <p>Ensure that <tt class="docutils literal"><span class="pre">element.style.position</span></tt> is set to <tt class="docutils literal"><span class="pre">&quot;relative&quot;</span></tt> if it
1007
- is not set or is <tt class="docutils literal"><span class="pre">&quot;static&quot;</span></tt>. If <tt class="docutils literal"><span class="pre">element</span></tt> is a
1008
- string, then it will be looked up with <a class="mochiref reference" href="#fn-getelement">getElement</a>.</p>
1009
- <dl class="docutils">
1010
- <dt><em>Availability</em>:</dt>
1011
- <dd>Available in MochiKit 1.4+, moved to
1012
- <a class="mochiref reference" href="Style.html#fn-makepositioned">MochiKit.Style.makePositioned</a> in 1.4.1+</dd>
1013
- </dl>
1014
- </blockquote>
1015
- <p>
1016
- <a name="fn-setelementdimensions"></a>
1017
- <a class="mochidef reference" href="#fn-setelementdimensions">setElementDimensions(element, dimensions[, units='px'])</a>:</p>
1018
- <blockquote>
1019
- <p>Sets the dimensions of <tt class="docutils literal"><span class="pre">element</span></tt> in the document from an object
1020
- with <tt class="docutils literal"><span class="pre">w</span></tt> and <tt class="docutils literal"><span class="pre">h</span></tt> properties.</p>
1021
- <dl class="docutils">
1022
- <dt><tt class="docutils literal"><span class="pre">node</span></tt>:</dt>
1023
- <dd>A reference to the DOM element to update (if a string is
1024
- given, <a class="mochiref reference" href="#fn-getelement">getElement(node)</a> will be used to locate the
1025
- node)</dd>
1026
- <dt><tt class="docutils literal"><span class="pre">dimensions</span></tt>:</dt>
1027
- <dd>An object with <tt class="docutils literal"><span class="pre">w</span></tt> and <tt class="docutils literal"><span class="pre">h</span></tt> properties</dd>
1028
- <dt><tt class="docutils literal"><span class="pre">units</span></tt>:</dt>
1029
- <dd>Optionally set the units to use, default is <tt class="docutils literal"><span class="pre">px</span></tt></dd>
1030
- <dt><em>Availability</em>:</dt>
1031
- <dd>Available in MochiKit 1.3.1, moved to
1032
- <a class="mochiref reference" href="Style.html#fn-setelementdimensions">MochiKit.Style.setElementDimensions</a> in 1.4+</dd>
1033
- </dl>
1034
- </blockquote>
1035
- <p>
1036
- <a name="fn-setelementposition"></a>
1037
- <a class="mochidef reference" href="#fn-setelementposition">setElementPosition(element, position[, units='px'])</a>:</p>
1038
- <blockquote>
1039
- <p>Sets the absolute position of <tt class="docutils literal"><span class="pre">element</span></tt> in the document from an
1040
- object with <tt class="docutils literal"><span class="pre">x</span></tt> and <tt class="docutils literal"><span class="pre">y</span></tt> properties.</p>
1041
- <dl class="docutils">
1042
- <dt><tt class="docutils literal"><span class="pre">node</span></tt>:</dt>
1043
- <dd>A reference to the DOM element to update (if a string is
1044
- given, <a class="mochiref reference" href="#fn-getelement">getElement(node)</a> will be used to locate the
1045
- node)</dd>
1046
- <dt><tt class="docutils literal"><span class="pre">position</span></tt>:</dt>
1047
- <dd>An object with <tt class="docutils literal"><span class="pre">x</span></tt> and <tt class="docutils literal"><span class="pre">y</span></tt> properties</dd>
1048
- <dt><tt class="docutils literal"><span class="pre">units</span></tt>:</dt>
1049
- <dd>Optionally set the units to use, default is <tt class="docutils literal"><span class="pre">px</span></tt></dd>
1050
- <dt><em>Availability</em>:</dt>
1051
- <dd>Available in MochiKit 1.3.1, moved to
1052
- <a class="mochiref reference" href="Style.html#fn-setelementposition">MochiKit.Style.setElementPosition</a> in 1.4+</dd>
1053
- </dl>
1054
- </blockquote>
1055
- <p>
1056
- <a name="fn-setdisplayforelement"></a>
1057
- <a class="mochidef reference" href="#fn-setdisplayforelement">setDisplayForElement(display, element[, ...])</a>:</p>
1058
- <blockquote>
1059
- <p>Change the <tt class="docutils literal"><span class="pre">style.display</span></tt> for the given element(s). Usually
1060
- used as the partial forms:</p>
1061
- <ul class="simple">
1062
- <li><a class="mochiref reference" href="#fn-showelement">showElement(element, ...)</a></li>
1063
- <li><a class="mochiref reference" href="#fn-hideelement">hideElement(element, ...)</a></li>
1064
- </ul>
1065
- <p>Elements are looked up with <a class="mochiref reference" href="#fn-getelement">getElement</a>, so string
1066
- identifiers are acceptable.</p>
1067
- <p>For information about the caveats of using a <tt class="docutils literal"><span class="pre">style.display</span></tt>
1068
- based show/hide mechanism, and a CSS based alternative, see
1069
- <a class="reference" href="Style.html#element-visibility">Element Visibility</a>.</p>
1070
- <dl class="docutils">
1071
- <dt><em>Availability</em>:</dt>
1072
- <dd>Available in MochiKit 1.3.1, moved to
1073
- <a class="mochiref reference" href="Style.html#fn-setdisplayforelement">MochiKit.Style.setDisplayForElement</a> in 1.4+</dd>
1074
- </dl>
1075
- </blockquote>
1076
- <p>
1077
- <a name="fn-setopacity"></a>
1078
- <a class="mochidef reference" href="#fn-setopacity">setOpacity(element, opacity)</a>:</p>
1079
- <blockquote>
1080
- <p>Sets <tt class="docutils literal"><span class="pre">opacity</span></tt> for <tt class="docutils literal"><span class="pre">element</span></tt>. Valid <tt class="docutils literal"><span class="pre">opacity</span></tt> values range
1081
- from 0 (invisible) to 1 (opaque). <tt class="docutils literal"><span class="pre">element</span></tt> is looked up with
1082
- <a class="mochiref reference" href="#fn-getelement">getElement</a>, so string identifiers are also acceptable.</p>
1083
- <dl class="docutils">
1084
- <dt><em>Availability</em>:</dt>
1085
- <dd>Available in MochiKit 1.3.1, moved to
1086
- <a class="mochiref reference" href="Style.html#fn-setopacity">MochiKit.Style.setOpacity</a> in 1.4+</dd>
1087
- </dl>
1088
- </blockquote>
1089
- <p>
1090
- <a name="fn-showelement"></a>
1091
- <a class="mochidef reference" href="#fn-showelement">showElement(element, ...)</a>:</p>
1092
- <blockquote>
1093
- <p>Partial form of <a class="mochiref reference" href="#fn-setdisplayforelement">setDisplayForElement</a>, specifically:</p>
1094
- <pre class="literal-block">
1095
- partial(setDisplayForElement, &quot;block&quot;)
1096
- </pre>
1097
- <p>For information about the caveats of using a <tt class="docutils literal"><span class="pre">style.display</span></tt>
1098
- based show/hide mechanism, and a CSS based alternative, see
1099
- <a class="reference" href="Style.html#element-visibility">Element Visibility</a>.</p>
1100
- <dl class="docutils">
1101
- <dt><em>Availability</em>:</dt>
1102
- <dd>Available in MochiKit 1.3.1, moved to
1103
- <a class="mochiref reference" href="Style.html#fn-showelement">MochiKit.Style.showElement</a> in 1.4+</dd>
1104
- </dl>
1105
- </blockquote>
1106
- <p>
1107
- <a name="fn-undoclipping"></a>
1108
- <a class="mochidef reference" href="#fn-undoclipping">undoClipping(element, overflow)</a>:</p>
1109
- <blockquote>
1110
- <p>Restore the setting of <tt class="docutils literal"><span class="pre">element.style.overflow</span></tt> set by
1111
- <a class="mochiref reference" href="#fn-makeclipping">makeClipping(element)</a>. If <tt class="docutils literal"><span class="pre">element</span></tt> is a string, then
1112
- it will be looked up with <a class="mochiref reference" href="#fn-getelement">getElement</a>.</p>
1113
- <dl class="docutils">
1114
- <dt><em>Availability</em>:</dt>
1115
- <dd>Available in MochiKit 1.4+, moved to
1116
- <a class="mochiref reference" href="Style.html#fn-undoclipping">MochiKit.Style.undoClipping</a> in 1.4.1+</dd>
1117
- </dl>
1118
- </blockquote>
1119
- <p>
1120
- <a name="fn-undopositioned"></a>
1121
- <a class="mochidef reference" href="#fn-undopositioned">undoPositioned(element)</a>:</p>
1122
- <blockquote>
1123
- <p>Restore the setting of <tt class="docutils literal"><span class="pre">element.style.position</span></tt> set by
1124
- <a class="mochiref reference" href="#fn-makepositioned">makePositioned(element)</a>. If <tt class="docutils literal"><span class="pre">element</span></tt> is a string, then
1125
- it will be looked up with <a class="mochiref reference" href="#fn-getelement">getElement</a>.</p>
1126
- <dl class="docutils">
1127
- <dt><em>Availability</em>:</dt>
1128
- <dd>Available in MochiKit 1.4+, moved to
1129
- <a class="mochiref reference" href="Style.html#fn-undopositioned">MochiKit.Style.undoPositioned</a> in 1.4.1+</dd>
1130
- </dl>
1131
- </blockquote>
1132
- </div>
1133
- <div class="section">
1134
- <h2><a id="style-objects" name="style-objects">Style Objects</a></h2>
1135
- <p>These objects are available in MochiKit 1.3.1, but have been moved to
1136
- <a class="mochiref reference" href="Style.html">MochiKit.Style</a> in 1.4+.</p>
1137
- <p>
1138
- <a name="fn-coordinates"></a>
1139
- <a class="mochidef reference" href="#fn-coordinates">Coordinates(x, y)</a>:</p>
1140
- <blockquote>
1141
- <p>Constructs an object with <tt class="docutils literal"><span class="pre">x</span></tt> and <tt class="docutils literal"><span class="pre">y</span></tt> properties. <tt class="docutils literal"><span class="pre">obj.toString()</span></tt>
1142
- returns something like <tt class="docutils literal"><span class="pre">{x:</span> <span class="pre">0,</span> <span class="pre">y:</span> <span class="pre">42}</span></tt> for debugging.</p>
1143
- <p><em>Availability</em>:
1144
- Available in MochiKit 1.3.1, moved to
1145
- <a class="mochiref reference" href="Style.html#fn-coordinates">MochiKit.Style.Coordinates</a> in 1.4+</p>
1146
- </blockquote>
1147
- <p>
1148
- <a name="fn-dimensions"></a>
1149
- <a class="mochidef reference" href="#fn-dimensions">Dimensions(w, h)</a>:</p>
1150
- <blockquote>
1151
- <p>Constructs an object with <tt class="docutils literal"><span class="pre">w</span></tt> and <tt class="docutils literal"><span class="pre">h</span></tt> properties. <tt class="docutils literal"><span class="pre">obj.toString()</span></tt>
1152
- returns something like <tt class="docutils literal"><span class="pre">{w:</span> <span class="pre">0,</span> <span class="pre">h:</span> <span class="pre">42}</span></tt> for debugging.</p>
1153
- <p><em>Availability</em>:
1154
- Available in MochiKit 1.3.1, moved to
1155
- <a class="mochiref reference" href="Style.html#fn-dimensions">MochiKit.Style.Dimensions</a> in 1.4+</p>
1156
- </blockquote>
1157
- </div>
1158
- </div>
1159
- <div class="section">
1160
- <h1><a id="see-also" name="see-also">See Also</a></h1>
1161
- <table class="docutils footnote" frame="void" id="id5" rules="none">
1162
- <colgroup><col class="label" /><col /></colgroup>
1163
- <tbody valign="top">
1164
- <tr><td class="label"><a name="id5">[1]</a></td><td><em>(<a class="fn-backref" href="#id1">1</a>, <a class="fn-backref" href="#id3">2</a>)</em> Nevow, a web application construction kit for Python:
1165
- <a class="reference" href="http://divmod.org/trac/wiki/DivmodNevow">http://divmod.org/trac/wiki/DivmodNevow</a></td></tr>
1166
- </tbody>
1167
- </table>
1168
- <table class="docutils footnote" frame="void" id="id6" rules="none">
1169
- <colgroup><col class="label" /><col /></colgroup>
1170
- <tbody valign="top">
1171
- <tr><td class="label"><a name="id6">[2]</a></td><td><em>(<a class="fn-backref" href="#id2">1</a>, <a class="fn-backref" href="#id4">2</a>)</em> nevow.stan is a domain specific language for Python (read as
1172
- &quot;crazy getitem/call overloading abuse&quot;) that Donovan and I
1173
- schemed up at PyCon 2003 at this super ninja Python/C++
1174
- programmer's (David Abrahams) hotel room. Donovan later
1175
- inflicted this upon the masses in Nevow. Check out the Nevow
1176
- Guide for some examples:
1177
- <a class="reference" href="http://divmod.org/trac/wiki/DivmodNevow">http://divmod.org/trac/wiki/DivmodNevow</a></td></tr>
1178
- </tbody>
1179
- </table>
1180
- </div>
1181
- <div class="section">
1182
- <h1><a id="authors" name="authors">Authors</a></h1>
1183
- <ul class="simple">
1184
- <li>Bob Ippolito &lt;<a class="reference" href="mailto:bob&#64;redivi.com">bob&#64;redivi.com</a>&gt;</li>
1185
- </ul>
1186
- </div>
1187
- <div class="section">
1188
- <h1><a id="copyright" name="copyright">Copyright</a></h1>
1189
- <p>Copyright 2005 Bob Ippolito &lt;<a class="reference" href="mailto:bob&#64;redivi.com">bob&#64;redivi.com</a>&gt;. This program is
1190
- dual-licensed free software; you can redistribute it and/or modify it
1191
- under the terms of the <a class="reference" href="http://www.opensource.org/licenses/mit-license.php">MIT License</a> or the <a class="reference" href="http://www.opensource.org/licenses/afl-2.1.php">Academic Free License
1192
- v2.1</a>.</p>
1193
- </div>
1194
- </div>
1195
-
1196
- </body>
1197
- </html>