Feature: drawing annotation deletion #337
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,146 @@ | ||
| import EventEmitter from 'events'; | ||
|
|
||
| class AnnotationController extends EventEmitter { | ||
| /** @property {Array} - The array of annotation threads */ | ||
| threads = []; | ||
|
There was a problem hiding this comment. So would we be storing all the annotation threads both in the annotator and the controller then? Seems redundant to have it stored in 2 places There was a problem hiding this comment. The goal is to have each controller manage their respective type of threads. Right now we are at an in-between state where highlight and point annotation doesn't use a controller so we still need to store threads in the annotator and controller. In addition, the threadmap is in use in other functions that I did not want to modify. The good news is that these data structures simply store a reference to the thread so the memory overhead isn't that bad. The downside is that the thread reference needs to be removed from both (this is accomplished by listening to 'threaddeleted'). |
||
|
|
||
| /** @property {Array} - The array of annotation handlers */ | ||
| handlers = []; | ||
|
|
||
| /** | ||
| * [constructor] | ||
| * | ||
| * @return {AnnotationController} Annotation controller instance | ||
| */ | ||
| constructor() { | ||
| super(); | ||
|
|
||
| this.handleAnnotationEvent = this.handleAnnotationEvent.bind(this); | ||
| } | ||
|
|
||
| /** | ||
| * Register the annotator and any information associated with the annotator | ||
| * | ||
| * @public | ||
| * @param {Annotator} annotator - The annotator to be associated with the controller | ||
| * @return {void} | ||
| */ | ||
| registerAnnotator(annotator) { | ||
| // TODO (@minhnguyen): remove the need to register an annotator. Ideally, the annotator should know about the | ||
|
|
||
| // controller and the controller does not know about the annotator. | ||
| this.annotator = annotator; | ||
| } | ||
|
|
||
| /** | ||
| * Bind the mode listeners and store each handler for future unbinding | ||
| * | ||
| * @public | ||
| * @return {void} | ||
| */ | ||
| bindModeListeners() { | ||
| const handlers = this.setupAndGetHandlers(); | ||
| handlers.forEach((handler) => { | ||
| const eventNames = handler.type.split(' '); | ||
| eventNames.forEach((eventName) => handler.eventObj.addEventListener(eventName, handler.func)); | ||
| this.handlers.push(handler); | ||
| }); | ||
| } | ||
|
|
||
| /** | ||
| * Unbind the previously bound mode listeners | ||
| * | ||
| * @public | ||
| * @return {void} | ||
| */ | ||
| unbindModeListeners() { | ||
| while (this.handlers.length > 0) { | ||
| const handler = this.handlers.pop(); | ||
| const eventNames = handler.type.split(' '); | ||
|
There was a problem hiding this comment. I would just save the event types as an array so you can just loop through them instead of parsing a string into an array |
||
| eventNames.forEach((eventName) => { | ||
| handler.eventObj.removeEventListener(eventName, handler.func); | ||
| }); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Register a thread with the controller so that the controller can keep track of relevant threads | ||
| * | ||
| * @public | ||
| * @param {AnnotationThread} thread - The thread to register with the controller | ||
| * @return {void} | ||
| */ | ||
| registerThread(thread) { | ||
| this.threads.push(thread); | ||
| } | ||
|
|
||
| /** | ||
| * Unregister a previously registered thread | ||
| * | ||
| * @public | ||
| * @param {AnnotationThread} thread - The thread to unregister with the controller | ||
| * @return {void} | ||
| */ | ||
| unregisterThread(thread) { | ||
| this.threads = this.threads.filter((item) => item !== thread); | ||
| } | ||
|
|
||
| /** | ||
| * Binds custom event listeners for a thread. | ||
| * | ||
| * @protected | ||
| * @param {AnnotationThread} thread - Thread to bind events to | ||
| * @return {void} | ||
| */ | ||
| bindCustomListenersOnThread(thread) { | ||
| if (!thread) { | ||
| return; | ||
| } | ||
|
|
||
| // TODO (@minhnguyen): Move annotator.bindCustomListenersOnThread logic to AnnotationController | ||
| this.annotator.bindCustomListenersOnThread(thread); | ||
| thread.addListener('annotationevent', (data) => { | ||
| this.handleAnnotationEvent(thread, data); | ||
| }); | ||
| } | ||
|
|
||
| /** | ||
| * Unbinds custom event listeners for the thread. | ||
| * | ||
| * @protected | ||
| * @param {AnnotationThread} thread - Thread to unbind events from | ||
| * @return {void} | ||
| */ | ||
| unbindCustomListenersOnThread(thread) { | ||
| if (!thread) { | ||
| return; | ||
| } | ||
|
|
||
| thread.removeAllListeners('threaddeleted'); | ||
|
There was a problem hiding this comment. Pretty sure you can call this once without args and it will remove all listeners for the thread. There was a problem hiding this comment. Looks like you're right about this, but there is a comment in annotator regarding calling unbindCustomListenersOnThread on 'threadcleanup':
|
||
| thread.removeAllListeners('threadcleanup'); | ||
| thread.removeAllListeners('annotationsaved'); | ||
| thread.removeAllListeners('annotationevent'); | ||
| } | ||
|
|
||
| /** | ||
| * Set up and return the necessary handlers for the annotation mode | ||
| * | ||
| * @protected | ||
| * @return {Array} An array where each element is an object containing the object that will emit the event, | ||
| * the type of events to listen for, and the callback | ||
| */ | ||
| setupAndGetHandlers() {} | ||
|
|
||
| /** | ||
| * Handle an annotation event. | ||
| * | ||
| * @protected | ||
| * @param {AnnotationThread} thread - The thread that emitted the event | ||
| * @param {Object} data - Extra data related to the annotation event | ||
| * @return {void} | ||
| */ | ||
| /* eslint-disable no-unused-vars */ | ||
| handleAnnotationEvent(thread, data = {}) {} | ||
| /* eslint-enable no-unused-vars */ | ||
| } | ||
|
|
||
| export default AnnotationController; | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Might be clearer to label this AnnotationModeController since it only applies to annotation types that would enter a 'mode'. AKA not highlight annotations