Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Chore: Removing @protected #303

Closed
wants to merge 1 commit into from
Closed

Chore: Removing @protected #303

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
12 changes: 0 additions & 12 deletions src/lib/annotations/AnnotationDialog.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -243,16 +243,11 @@ class AnnotationDialog extends EventEmitter {
*/
position() {}

//--------------------------------------------------------------------------
// Protected
//--------------------------------------------------------------------------

/**
* Sets up the dialog element.
*
* @param {Annotation[]} annotations - to show in the dialog
* @return {void}
* @protected
*/
setup(annotations) {
// Generate HTML of dialog
Expand Down Expand Up @@ -284,7 +279,6 @@ class AnnotationDialog extends EventEmitter {
/**
* Binds DOM event listeners.
*
* @protected
* @return {void}
*/
bindDOMListeners() {
Expand All @@ -302,7 +296,6 @@ class AnnotationDialog extends EventEmitter {
/**
* Unbinds DOM event listeners.
*
* @protected
* @return {void}
*/
unbindDOMListeners() {
Expand All @@ -320,7 +313,6 @@ class AnnotationDialog extends EventEmitter {
/**
* Keydown handler for dialog.
*
* @protected
* @param {Event} event - DOM event
* @return {void}
*/
Expand All @@ -341,7 +333,6 @@ class AnnotationDialog extends EventEmitter {
/**
* Stops propagation of DOM event.
*
* @protected
* @param {Event} event - DOM event
* @return {void}
*/
Expand All @@ -352,7 +343,6 @@ class AnnotationDialog extends EventEmitter {
/**
* Mouseenter handler. Clears hide timeout.
*
* @protected
* @return {void}
*/
mouseenterHandler() {
Expand All @@ -373,7 +363,6 @@ class AnnotationDialog extends EventEmitter {
/**
* Mouseleave handler. Hides dialog if we aren't creating the first one.
*
* @protected
* @return {void}
*/
mouseleaveHandler() {
Expand All @@ -385,7 +374,6 @@ class AnnotationDialog extends EventEmitter {
/**
* Click handler on dialog.
*
* @protected
* @param {Event} event - DOM event
* @return {void}
*/
Expand Down
11 changes: 0 additions & 11 deletions src/lib/annotations/AnnotationThread.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -251,15 +251,10 @@ class AnnotationThread extends EventEmitter {
*/
createDialog() {}

//--------------------------------------------------------------------------
// Protected
//--------------------------------------------------------------------------

/**
* Sets up the thread. Creates HTML for annotation indicator, sets
* appropriate dialog, and binds event listeners.
*
* @protected
* @return {void}
*/
setup() {
Expand All @@ -282,7 +277,6 @@ class AnnotationThread extends EventEmitter {
/**
* Sets up indicator element.
*
* @protected
* @return {void}
*/
setupElement() {
Expand All @@ -293,7 +287,6 @@ class AnnotationThread extends EventEmitter {
/**
* Binds DOM event listeners for the thread.
*
* @protected
* @return {void}
*/
bindDOMListeners() {
Expand All @@ -312,7 +305,6 @@ class AnnotationThread extends EventEmitter {
/**
* Unbinds DOM event listeners for the thread.
*
* @protected
* @return {void}
*/
unbindDOMListeners() {
Expand All @@ -331,7 +323,6 @@ class AnnotationThread extends EventEmitter {
/**
* Binds custom event listeners for the dialog.
*
* @protected
* @return {void}
*/
bindCustomListenersOnDialog() {
Expand All @@ -347,7 +338,6 @@ class AnnotationThread extends EventEmitter {
/**
* Unbinds custom event listeners for the dialog.
*
* @protected
* @return {void}
*/
unbindCustomListenersOnDialog() {
Expand All @@ -363,7 +353,6 @@ class AnnotationThread extends EventEmitter {
/**
* Destroys mobile and pending/pending-active annotation threads
*
* @protected
* @return {void}
*/
cancelUnsavedAnnotation() {
Expand Down
17 changes: 0 additions & 17 deletions src/lib/annotations/Annotator.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -467,14 +467,9 @@ class Annotator extends EventEmitter {
getAnnotatedEl(containerEl) {}
/* eslint-enable no-unused-vars */

//--------------------------------------------------------------------------
// Protected
//--------------------------------------------------------------------------

/**
* Annotations setup.
*
* @protected
* @return {void}
*/
setupAnnotations() {
Expand All @@ -489,7 +484,6 @@ class Annotator extends EventEmitter {
* Fetches persisted annotations, creates threads as needed, and generates
* an in-memory map of page to threads.
*
* @protected
* @return {Promise} Promise for fetching saved annotations
*/
fetchAnnotations() {
Expand Down Expand Up @@ -527,15 +521,13 @@ class Annotator extends EventEmitter {
* needs to bind event listeners to the DOM in the normal state (ie not
* in any annotation mode).
*
* @protected
* @return {void}
*/
unbindDOMListeners() {}

/**
* Binds custom event listeners for the Annotation Service.
*
* @protected
* @return {void}
*/
bindCustomListenersOnService() {
Expand Down Expand Up @@ -585,7 +577,6 @@ class Annotator extends EventEmitter {
/**
* Unbinds custom event listeners for the Annotation Service.
*
* @protected
* @return {void}
*/
unbindCustomListenersOnService() {
Expand All @@ -599,7 +590,6 @@ class Annotator extends EventEmitter {
/**
* Binds custom event listeners for a thread.
*
* @protected
* @param {AnnotationThread} thread - Thread to bind events to
* @return {void}
*/
Expand Down Expand Up @@ -631,7 +621,6 @@ class Annotator extends EventEmitter {
/**
* Unbinds custom event listeners for the thread.
*
* @protected
* @param {AnnotationThread} thread - Thread to bind events to
* @return {void}
*/
Expand All @@ -643,7 +632,6 @@ class Annotator extends EventEmitter {
/**
* Binds event listeners for annotation modes.
*
* @protected
* @param {string} mode - Current annotation mode
* @return {void}
*/
Expand Down Expand Up @@ -708,7 +696,6 @@ class Annotator extends EventEmitter {
* Event handler for adding a point annotation. Creates a point annotation
* thread at the clicked location.
*
* @protected
* @param {Event} event - DOM event
* @return {void}
*/
Expand Down Expand Up @@ -748,7 +735,6 @@ class Annotator extends EventEmitter {
/**
* Unbinds event listeners for annotation modes.
*
* @protected
* @return {void}
*/
unbindModeListeners() {
Expand All @@ -761,7 +747,6 @@ class Annotator extends EventEmitter {
/**
* Adds thread to in-memory map.
*
* @protected
* @param {AnnotationThread} thread - Thread to add
* @return {void}
*/
Expand All @@ -775,7 +760,6 @@ class Annotator extends EventEmitter {
/**
* Returns whether or not annotator is in the specified annotation mode.
*
* @protected
* @param {string} mode - Current annotation mode
* @return {boolean} Whether or not in the specified annotation mode
*/
Expand All @@ -790,7 +774,6 @@ class Annotator extends EventEmitter {
/**
* Orient annotations to the correct scale and orientation of the annotated document.
*
* @protected
* @param {Object} data - Scale and orientation values needed to orient annotations.
* @return {void}
*/
Expand Down
9 changes: 0 additions & 9 deletions src/lib/annotations/doc/DocAnnotator.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -389,14 +389,9 @@ class DocAnnotator extends Annotator {
});
}

//--------------------------------------------------------------------------
// Protected
//--------------------------------------------------------------------------

/**
* Annotations setup.
*
* @protected
* @override
* @return {void}
*/
Expand All @@ -416,7 +411,6 @@ class DocAnnotator extends Annotator {
/**
* Binds DOM event listeners.
*
* @protected
* @override
* @return {void}
*/
Expand All @@ -436,7 +430,6 @@ class DocAnnotator extends Annotator {
/**
* Unbinds DOM event listeners.
*
* @protected
* @override
* @return {void}
*/
Expand All @@ -462,7 +455,6 @@ class DocAnnotator extends Annotator {
/**
* Binds custom event listeners for a thread.
*
* @protected
* @override
* @param {AnnotationThread} thread - Thread to bind events to
* @return {void}
Expand All @@ -481,7 +473,6 @@ class DocAnnotator extends Annotator {
/**
* Checks whether mouse is inside any dialog on the current page
*
* @protected
* @param {Event} event - Mouse event
* @param {number} page - Current page number
* @return {boolean} Whether or not mouse is inside a dialog on the page
Expand Down
9 changes: 0 additions & 9 deletions src/lib/annotations/doc/DocHighlightDialog.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,16 +179,11 @@ class DocHighlightDialog extends AnnotationDialog {
}
}

//--------------------------------------------------------------------------
// Protected
//--------------------------------------------------------------------------

/**
* Sets up the dialog element.
*
* @override
* @return {void}
* @protected
*/
setup(annotations) {
// Only create an dialog element, if one doesn't already exist
Expand Down Expand Up @@ -268,7 +263,6 @@ class DocHighlightDialog extends AnnotationDialog {
*
* @override
* @return {void}
* @protected
*/
bindDOMListeners() {
this.element.addEventListener('mousedown', this.mousedownHandler);
Expand All @@ -285,7 +279,6 @@ class DocHighlightDialog extends AnnotationDialog {
*
* @override
* @return {void}
* @protected
*/
unbindDOMListeners() {
this.element.removeEventListener('mousedown', this.mousedownHandler);
Expand All @@ -303,7 +296,6 @@ class DocHighlightDialog extends AnnotationDialog {
*
* @override
* @return {void}
* @protected
*/
keydownHandler(event) {
event.stopPropagation();
Expand All @@ -318,7 +310,6 @@ class DocHighlightDialog extends AnnotationDialog {
*
* @param {Event} event - DOM event
* @return {void}
* @protected
*/
mousedownHandler(event) {
event.stopPropagation();
Expand Down
7 changes: 0 additions & 7 deletions src/lib/annotations/doc/DocHighlightThread.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -279,15 +279,10 @@ class DocHighlightThread extends AnnotationThread {
}
}

//--------------------------------------------------------------------------
// Protected
//--------------------------------------------------------------------------

/**
* No-op setup element. Highlight threads have no HTML indicator since
* they are drawn onto the canvas.
*
* @protected
* @override
* @return {void}
*/
Expand All @@ -296,7 +291,6 @@ class DocHighlightThread extends AnnotationThread {
/**
* Binds custom event listeners for the dialog.
*
* @protected
* @override
* @return {void}
*/
Expand Down Expand Up @@ -344,7 +338,6 @@ class DocHighlightThread extends AnnotationThread {
/**
* Unbinds custom event listeners for the dialog.
*
* @protected
* @override
* @return {void}
*/
Expand Down