Moving code from the Annotator Monkey to Guest

h/static/scripts/annotator/monkey.coffee

@@ -3,21 +3,10 @@
 Range = Annotator.Range
 Util = Annotator.Util
 
-
 # Disable Annotator's default highlight events
 delete Annotator.prototype.events[".annotator-hl mouseover"]
 delete Annotator.prototype.events[".annotator-hl mouseout"]
 
-
-# Disable Annotator's default selection detection
-Annotator.prototype._setupDocumentEvents = ->
-  $(document).bind({
-    # omit the "mouseup" check
-    "mousedown": this.checkForStartSelection
-  })
-  this
-
-
 # Override setupAnnotation
 Annotator.prototype.setupAnnotation = (annotation) ->
   # If this is a new annotation, we might have to add the targets
@@ -57,130 +46,6 @@ Annotator.prototype.deleteAnnotation = (annotation) ->
   annotation
 
 
-# This method is to be called by the mechanisms responsible for
-# triggering annotation (and highlight) creation.
-#
-# event - any event which has triggered this.
-#         The following fields are used:
-#   targets: an array of targets, which should be used to anchor the
-#            newly created annotation
-#   pageX and pageY: if the adder button is shown, use there coordinates
-#
-# immadiate - should we show the adder button, or should be proceed
-#             to create the annotation/highlight immediately ?
-#
-# returns false if the creation of annotations is forbidden at the moment,
-# true otherwise.
-Annotator.prototype.onSuccessfulSelection = (event, immediate = false) ->
-  # Check whether we got a proper event
-  unless event?
-    throw "Called onSuccessfulSelection without an event!"
-  unless event.segments?
-    throw "Called onSuccessulSelection with an event with missing segments!"
-
-  # Describe the selection with targets
-  @selectedTargets = (@_getTargetFromSelection s for s in event.segments)
-
-  # Do we want immediate annotation?
-  if immediate
-    # Create an annotation
-    @onAdderClick event
-  else
-    # Show the adder button
-    @adder
-      .css(Util.mousePosition(event, @wrapper[0]))
-      .show()
-
-  true
-
-
-# This is called to create a target from a raw selection,
-# using selectors created by the registered selector creators
-Annotator.prototype._getTargetFromSelection = (selection) ->
-  source: @getHref()
-  selector: @anchoring.getSelectorsFromSelection(selection)
-
-
-Annotator.prototype.onFailedSelection = (event) ->
-  @adder.hide()
-  @selectedTargets = []
-
-
-# Override the onAdderClick event handler.
-#
-# N.B. (Convenient) CoffeeScript horror. The original handler is bound to the
-# instance using =>, which means that despite the fact this has a single arrow,
-# it will end up bound to the instance regardless.
-Annotator.prototype.onAdderClick = (event) ->
-  event?.preventDefault()
-
-  # Hide the adder
-  position = @adder.position()
-  @adder.hide()
-  @ignoreMouseup = false
-
-  # Create a new annotation.
-  annotation = this.createAnnotation()
-
-  # Extract the quotation and serialize the ranges
-  annotation = this.setupAnnotation(annotation)
-
-  # Show a temporary highlight so the user can see what they selected
-  for anchor in annotation.anchors
-    for page, hl of anchor.highlight
-      hl.setTemporary true
-
-  # Make the highlights permanent if the annotation is saved
-  save = =>
-    do cleanup
-    for anchor in annotation.anchors
-      for page, hl of anchor.highlight
-        hl.setTemporary false
-    # Fire annotationCreated events so that plugins can react to them
-    this.publish('annotationCreated', [annotation])
-
-  # Remove the highlights if the edit is cancelled
-  cancel = =>
-    do cleanup
-    this.deleteAnnotation(annotation)
-
-  # Don't leak handlers at the end
-  cleanup = =>
-    this.unsubscribe('annotationEditorHidden', cancel)
-    this.unsubscribe('annotationEditorSubmit', save)
-
-  this.subscribe('annotationEditorHidden', cancel)
-  this.subscribe('annotationEditorSubmit', save)
-
-  # Display the editor.
-  this.showEditor(annotation, position)
-
-
-# Provide a bunch of event handlers for anchors. N.B. These aren't explicitly
-# bound to the instances, so can't actually be used as event handlers. They must
-# be bound as closures:
-#
-#    elem.on('mouseover', (e) => annotator.onAnchorMouseover(e))
-#
-Annotator.prototype.onAnchorMouseover = (event) ->
-  # Cancel any pending hiding of the viewer.
-  this.clearViewerHideTimer()
-
-  # Don't do anything if we're making a selection or
-  # already displaying the viewer
-  return false if @mouseIsDown or @viewer.isShown()
-
-  this.showViewer event.data.getAnnotations(event),
-    Util.mousePosition(event, @wrapper[0])
-
-Annotator.prototype.onAnchorMouseout = (event) ->
-  this.startViewerHideTimer()
-
-Annotator.prototype.onAnchorMousedown = ->
-
-Annotator.prototype.onAnchorClick = ->
-
-
 # Checks for the presence of wicked-good-xpath
 # It is always safe to install it, it'll not overwrite existing functions
 g = Annotator.Util.getGlobal()

h/static/scripts/guest.coffee

@@ -189,6 +189,12 @@ class Annotator.Guest extends Annotator
   _setupDynamicStyle: -> this
   _setupViewer: -> this
   _setupEditor: -> this
+  _setupDocumentEvents: ->
+    $(document).bind({
+      # omit the "mouseup" check
+      "mousedown": this.checkForStartSelection
+    })
+    this
 
   destroy: ->
     $(document).unbind({
@@ -251,6 +257,12 @@ class Annotator.Guest extends Annotator
     unless event and this.isAnnotator(event.target)
       @mouseIsDown = true
 
+  # This is called to create a target from a raw selection,
+  # using selectors created by the registered selector creators
+  _getTargetFromSelection: (selection) ->
+    source: @getHref()
+    selector: @anchoring.getSelectorsFromSelection(selection)
+
   confirmSelection: ->
     return true unless @selectedTargets.length is 1
 
@@ -267,7 +279,30 @@ class Annotator.Guest extends Annotator
       # Describe the selection with targets
       @selectedTargets = (@_getTargetFromSelection(s) for s in event.segments)
       return
-    super
+
+    unless event?
+      throw "Called onSuccessfulSelection without an event!"
+    unless event.segments?
+      throw "Called onSuccessulSelection with an event with missing segments!"
+
+    # Describe the selection with targets
+    @selectedTargets = (@_getTargetFromSelection s for s in event.segments)
+
+    # Do we want immediate annotation?
+    if immediate
+      # Create an annotation
+      @onAdderClick event
+    else
+      # Show the adder button
+      @adder
+        .css(Annotator.Util.mousePosition(event, @wrapper[0]))
+        .show()
+
+    true
+
+  onFailedSelection: (event) ->
+    @adder.hide()
+    @selectedTargets = []
 
   # Select some annotations.
   #