Sakurai/pdf.js
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #8324 from timvandermeij/es6-annotation-presentation-rendering

Browse Source 
Convert the annotation layer builder, presentation mode and rendering queue to ES6 syntax
This commit is contained in:
Tim van der Meij 2017-04-27 16:30:07 +02:00 committed by GitHub
commit 32c0ea5909
4 changed files with 588 additions and 629 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

116
web/annotation_layer_builder.js
View File

@ -26,15 +26,11 @@ import { SimpleLinkService } from './pdf_link_service';
* @property {DownloadManager} downloadManager * @property {DownloadManager} downloadManager
*/ */
/** class AnnotationLayerBuilder {
* @class
*/
var AnnotationLayerBuilder = (function AnnotationLayerBuilderClosure() {
/** /**
* @param {AnnotationLayerBuilderOptions} options * @param {AnnotationLayerBuilderOptions} options
* @constructs AnnotationLayerBuilder
*/ */
function AnnotationLayerBuilder(options) { constructor(options) {
this.pageDiv = options.pageDiv; this.pageDiv = options.pageDiv;
this.pdfPage = options.pdfPage; this.pdfPage = options.pdfPage;
this.renderInteractiveForms = options.renderInteractiveForms; this.renderInteractiveForms = options.renderInteractiveForms;
@ -44,88 +40,74 @@ var AnnotationLayerBuilder = (function AnnotationLayerBuilderClosure() {
this.div = null; this.div = null;
} }
AnnotationLayerBuilder.prototype = /**
/** @lends AnnotationLayerBuilder.prototype */ { * @param {PageViewport} viewport
* @param {string} intent (default value is 'display')
/** */
* @param {PageViewport} viewport render(viewport, intent = 'display') {
* @param {string} intent (default value is 'display') this.pdfPage.getAnnotations({ intent }).then((annotations) => {
*/
render: function AnnotationLayerBuilder_render(viewport, intent) {
var self = this;
var parameters = { var parameters = {
intent: (intent === undefined ? 'display' : intent), viewport: viewport.clone({ dontFlip: true }),
div: this.div,
annotations,
page: this.pdfPage,
renderInteractiveForms: this.renderInteractiveForms,
linkService: this.linkService,
downloadManager: this.downloadManager,
}; };
this.pdfPage.getAnnotations(parameters).then(function (annotations) { if (this.div) {
viewport = viewport.clone({ dontFlip: true }); // If an annotationLayer already exists, refresh its children's
parameters = { // transformation matrices.
viewport: viewport, AnnotationLayer.update(parameters);
div: self.div, } else {
annotations: annotations, // Create an annotation layer div and render the annotations
page: self.pdfPage, // if there is at least one annotation.
renderInteractiveForms: self.renderInteractiveForms, if (annotations.length === 0) {
linkService: self.linkService, return;
downloadManager: self.downloadManager,
};
if (self.div) {
// If an annotationLayer already exists, refresh its children's
// transformation matrices.
AnnotationLayer.update(parameters);
} else {
// Create an annotation layer div and render the annotations
// if there is at least one annotation.
if (annotations.length === 0) {
return;
}
self.div = document.createElement('div');
self.div.className = 'annotationLayer';
self.pageDiv.appendChild(self.div);
parameters.div = self.div;
AnnotationLayer.render(parameters);
if (typeof mozL10n !== 'undefined') {
mozL10n.translate(self.div);
}
} }
});
},
hide: function AnnotationLayerBuilder_hide() { this.div = document.createElement('div');
if (!this.div) { this.div.className = 'annotationLayer';
return; this.pageDiv.appendChild(this.div);
parameters.div = this.div;
AnnotationLayer.render(parameters);
if (typeof mozL10n !== 'undefined') {
mozL10n.translate(this.div);
}
} }
this.div.setAttribute('hidden', 'true'); });
} }
};
return AnnotationLayerBuilder; hide() {
})(); if (!this.div) {
return;
}
this.div.setAttribute('hidden', 'true');
}
}
/** /**
* @constructor
* @implements IPDFAnnotationLayerFactory * @implements IPDFAnnotationLayerFactory
*/ */
function DefaultAnnotationLayerFactory() {} class DefaultAnnotationLayerFactory {
DefaultAnnotationLayerFactory.prototype = {
/** /**
* @param {HTMLDivElement} pageDiv * @param {HTMLDivElement} pageDiv
* @param {PDFPage} pdfPage * @param {PDFPage} pdfPage
* @param {boolean} renderInteractiveForms * @param {boolean} renderInteractiveForms
* @returns {AnnotationLayerBuilder} * @returns {AnnotationLayerBuilder}
*/ */
createAnnotationLayerBuilder: function (pageDiv, pdfPage, createAnnotationLayerBuilder(pageDiv, pdfPage,
renderInteractiveForms) { renderInteractiveForms = false) {
return new AnnotationLayerBuilder({ return new AnnotationLayerBuilder({
pageDiv: pageDiv, pageDiv,
pdfPage: pdfPage, pdfPage,
renderInteractiveForms: renderInteractiveForms, renderInteractiveForms,
linkService: new SimpleLinkService(), linkService: new SimpleLinkService(),
}); });
} }
}; }
export { export {
AnnotationLayerBuilder, AnnotationLayerBuilder,

9
web/interfaces.js
View File

@ -108,14 +108,13 @@ IPDFTextLayerFactory.prototype = {
/** /**
* @interface * @interface
*/ */
function IPDFAnnotationLayerFactory() {} class IPDFAnnotationLayerFactory { // eslint-disable-line no-unused-vars
IPDFAnnotationLayerFactory.prototype = {
/** /**
* @param {HTMLDivElement} pageDiv * @param {HTMLDivElement} pageDiv
* @param {PDFPage} pdfPage * @param {PDFPage} pdfPage
* @param {boolean} renderInteractiveForms * @param {boolean} renderInteractiveForms
* @returns {AnnotationLayerBuilder} * @returns {AnnotationLayerBuilder}
*/ */
createAnnotationLayerBuilder: function (pageDiv, pdfPage, createAnnotationLayerBuilder(pageDiv, pdfPage,
renderInteractiveForms) {} renderInteractiveForms = false) {}
}; }

842
web/pdf_presentation_mode.js
View File

@ -15,10 +15,19 @@
import { normalizeWheelEventDelta } from './ui_utils'; import { normalizeWheelEventDelta } from './ui_utils';
var DELAY_BEFORE_RESETTING_SWITCH_IN_PROGRESS = 1500; // in ms const DELAY_BEFORE_RESETTING_SWITCH_IN_PROGRESS = 1500; // in ms
var DELAY_BEFORE_HIDING_CONTROLS = 3000; // in ms const DELAY_BEFORE_HIDING_CONTROLS = 3000; // in ms
var ACTIVE_SELECTOR = 'pdfPresentationMode'; const ACTIVE_SELECTOR = 'pdfPresentationMode';
var CONTROLS_SELECTOR = 'pdfPresentationModeControls'; const CONTROLS_SELECTOR = 'pdfPresentationModeControls';
const MOUSE_SCROLL_COOLDOWN_TIME = 50; // in ms
const PAGE_SWITCH_THRESHOLD = 0.1;
// Number of CSS pixels for a movement to count as a swipe.
const SWIPE_MIN_DISTANCE_THRESHOLD = 50;
// Swipe angle deviation from the x or y axis before it is not
// considered a swipe in that direction any more.
const SWIPE_ANGLE_THRESHOLD = Math.PI / 6;
/** /**
* @typedef {Object} PDFPresentationModeOptions * @typedef {Object} PDFPresentationModeOptions
@ -30,15 +39,11 @@ var CONTROLS_SELECTOR = 'pdfPresentationModeControls';
* to the context menu in Presentation Mode. * to the context menu in Presentation Mode.
*/ */
/** class PDFPresentationMode {
* @class
*/
var PDFPresentationMode = (function PDFPresentationModeClosure() {
/** /**
* @constructs PDFPresentationMode
* @param {PDFPresentationModeOptions} options * @param {PDFPresentationModeOptions} options
*/ */
function PDFPresentationMode(options) { constructor(options) {
this.container = options.container; this.container = options.container;
this.viewer = options.viewer || options.container.firstElementChild; this.viewer = options.viewer || options.container.firstElementChild;
this.pdfViewer = options.pdfViewer; this.pdfViewer = options.pdfViewer;
@ -53,457 +58,432 @@ var PDFPresentationMode = (function PDFPresentationModeClosure() {
this.touchSwipeState = null; this.touchSwipeState = null;
if (contextMenuItems) { if (contextMenuItems) {
contextMenuItems.contextFirstPage.addEventListener('click', contextMenuItems.contextFirstPage.addEventListener('click', () => {
function PDFPresentationMode_contextFirstPageClick(e) {
this.contextMenuOpen = false; this.contextMenuOpen = false;
this.eventBus.dispatch('firstpage'); this.eventBus.dispatch('firstpage');
}.bind(this)); });
contextMenuItems.contextLastPage.addEventListener('click', contextMenuItems.contextLastPage.addEventListener('click', () => {
function PDFPresentationMode_contextLastPageClick(e) {
this.contextMenuOpen = false; this.contextMenuOpen = false;
this.eventBus.dispatch('lastpage'); this.eventBus.dispatch('lastpage');
}.bind(this)); });
contextMenuItems.contextPageRotateCw.addEventListener('click', contextMenuItems.contextPageRotateCw.addEventListener('click', () => {
function PDFPresentationMode_contextPageRotateCwClick(e) {
this.contextMenuOpen = false; this.contextMenuOpen = false;
this.eventBus.dispatch('rotatecw'); this.eventBus.dispatch('rotatecw');
}.bind(this)); });
contextMenuItems.contextPageRotateCcw.addEventListener('click', contextMenuItems.contextPageRotateCcw.addEventListener('click', () => {
function PDFPresentationMode_contextPageRotateCcwClick(e) {
this.contextMenuOpen = false; this.contextMenuOpen = false;
this.eventBus.dispatch('rotateccw'); this.eventBus.dispatch('rotateccw');
}.bind(this)); });
} }
} }
PDFPresentationMode.prototype = { /**
/** * Request the browser to enter fullscreen mode.
* Request the browser to enter fullscreen mode. * @returns {boolean} Indicating if the request was successful.
* @returns {boolean} Indicating if the request was successful. */
*/ request() {
request: function PDFPresentationMode_request() { if (this.switchInProgress || this.active || !this.viewer.hasChildNodes()) {
if (this.switchInProgress || this.active || return false;
!this.viewer.hasChildNodes()) { }
return false; this._addFullscreenChangeListeners();
} this._setSwitchInProgress();
this._addFullscreenChangeListeners(); this._notifyStateChange();
this._setSwitchInProgress();
this._notifyStateChange();
if (this.container.requestFullscreen) { if (this.container.requestFullscreen) {
this.container.requestFullscreen(); this.container.requestFullscreen();
} else if (this.container.mozRequestFullScreen) { } else if (this.container.mozRequestFullScreen) {
this.container.mozRequestFullScreen(); this.container.mozRequestFullScreen();
} else if (this.container.webkitRequestFullscreen) { } else if (this.container.webkitRequestFullscreen) {
this.container.webkitRequestFullscreen(Element.ALLOW_KEYBOARD_INPUT); this.container.webkitRequestFullscreen(Element.ALLOW_KEYBOARD_INPUT);
} else if (this.container.msRequestFullscreen) { } else if (this.container.msRequestFullscreen) {
this.container.msRequestFullscreen(); this.container.msRequestFullscreen();
} else { } else {
return false; return false;
} }
this.args = { this.args = {
page: this.pdfViewer.currentPageNumber, page: this.pdfViewer.currentPageNumber,
previousScale: this.pdfViewer.currentScaleValue, previousScale: this.pdfViewer.currentScaleValue,
}; };
return true; return true;
}, }
/** /**
* @private * @private
*/ */
_mouseWheel: function PDFPresentationMode_mouseWheel(evt) { _mouseWheel(evt) {
if (!this.active) { if (!this.active) {
return; return;
} }
evt.preventDefault(); evt.preventDefault();
var delta = normalizeWheelEventDelta(evt); var delta = normalizeWheelEventDelta(evt);
var currentTime = (new Date()).getTime();
var storedTime = this.mouseScrollTimeStamp;
var MOUSE_SCROLL_COOLDOWN_TIME = 50; // If we've already switched page, avoid accidentally switching again.
var PAGE_SWITCH_THRESHOLD = 0.1; if (currentTime > storedTime &&
currentTime - storedTime < MOUSE_SCROLL_COOLDOWN_TIME) {
var currentTime = (new Date()).getTime(); return;
var storedTime = this.mouseScrollTimeStamp; }
// If the scroll direction changed, reset the accumulated scroll delta.
// If we've already switched page, avoid accidentally switching again. if ((this.mouseScrollDelta > 0 && delta < 0) ||
if (currentTime > storedTime && (this.mouseScrollDelta < 0 && delta > 0)) {
currentTime - storedTime < MOUSE_SCROLL_COOLDOWN_TIME) {
return;
}
// If the scroll direction changed, reset the accumulated scroll delta.
if ((this.mouseScrollDelta > 0 && delta < 0) ||
(this.mouseScrollDelta < 0 && delta > 0)) {
this._resetMouseScrollState();
}
this.mouseScrollDelta += delta;
if (Math.abs(this.mouseScrollDelta) >= PAGE_SWITCH_THRESHOLD) {
var totalDelta = this.mouseScrollDelta;
this._resetMouseScrollState();
var success = totalDelta > 0 ? this._goToPreviousPage()
: this._goToNextPage();
if (success) {
this.mouseScrollTimeStamp = currentTime;
}
}
},
get isFullscreen() {
return !!(document.fullscreenElement ||
document.mozFullScreen ||
document.webkitIsFullScreen ||
document.msFullscreenElement);
},
/**
* @private
*/
_goToPreviousPage: function PDFPresentationMode_goToPreviousPage() {
var page = this.pdfViewer.currentPageNumber;
// If we're at the first page, we don't need to do anything.
if (page <= 1) {
return false;
}
this.pdfViewer.currentPageNumber = (page - 1);
return true;
},
/**
* @private
*/
_goToNextPage: function PDFPresentationMode_goToNextPage() {
var page = this.pdfViewer.currentPageNumber;
// If we're at the last page, we don't need to do anything.
if (page >= this.pdfViewer.pagesCount) {
return false;
}
this.pdfViewer.currentPageNumber = (page + 1);
return true;
},
/**
* @private
*/
_notifyStateChange: function PDFPresentationMode_notifyStateChange() {
this.eventBus.dispatch('presentationmodechanged', {
source: this,
active: this.active,
switchInProgress: !!this.switchInProgress
});
},
/**
* Used to initialize a timeout when requesting Presentation Mode,
* i.e. when the browser is requested to enter fullscreen mode.
* This timeout is used to prevent the current page from being scrolled
* partially, or completely, out of view when entering Presentation Mode.
* NOTE: This issue seems limited to certain zoom levels (e.g. page-width).
* @private
*/
_setSwitchInProgress: function PDFPresentationMode_setSwitchInProgress() {
if (this.switchInProgress) {
clearTimeout(this.switchInProgress);
}
this.switchInProgress = setTimeout(function switchInProgressTimeout() {
this._removeFullscreenChangeListeners();
delete this.switchInProgress;
this._notifyStateChange();
}.bind(this), DELAY_BEFORE_RESETTING_SWITCH_IN_PROGRESS);
},
/**
* @private
*/
_resetSwitchInProgress:
function PDFPresentationMode_resetSwitchInProgress() {
if (this.switchInProgress) {
clearTimeout(this.switchInProgress);
delete this.switchInProgress;
}
},
/**
* @private
*/
_enter: function PDFPresentationMode_enter() {
this.active = true;
this._resetSwitchInProgress();
this._notifyStateChange();
this.container.classList.add(ACTIVE_SELECTOR);
// Ensure that the correct page is scrolled into view when entering
// Presentation Mode, by waiting until fullscreen mode in enabled.
setTimeout(function enterPresentationModeTimeout() {
this.pdfViewer.currentPageNumber = this.args.page;
this.pdfViewer.currentScaleValue = 'page-fit';
}.bind(this), 0);
this._addWindowListeners();
this._showControls();
this.contextMenuOpen = false;
this.container.setAttribute('contextmenu', 'viewerContextMenu');
// Text selection is disabled in Presentation Mode, thus it's not possible
// for the user to deselect text that is selected (e.g. with "Select all")
// when entering Presentation Mode, hence we remove any active selection.
window.getSelection().removeAllRanges();
},
/**
* @private
*/
_exit: function PDFPresentationMode_exit() {
var page = this.pdfViewer.currentPageNumber;
this.container.classList.remove(ACTIVE_SELECTOR);
// Ensure that the correct page is scrolled into view when exiting
// Presentation Mode, by waiting until fullscreen mode is disabled.
setTimeout(function exitPresentationModeTimeout() {
this.active = false;
this._removeFullscreenChangeListeners();
this._notifyStateChange();
this.pdfViewer.currentScaleValue = this.args.previousScale;
this.pdfViewer.currentPageNumber = page;
this.args = null;
}.bind(this), 0);
this._removeWindowListeners();
this._hideControls();
this._resetMouseScrollState(); this._resetMouseScrollState();
this.container.removeAttribute('contextmenu'); }
this.mouseScrollDelta += delta;
if (Math.abs(this.mouseScrollDelta) >= PAGE_SWITCH_THRESHOLD) {
var totalDelta = this.mouseScrollDelta;
this._resetMouseScrollState();
var success = totalDelta > 0 ? this._goToPreviousPage()
: this._goToNextPage();
if (success) {
this.mouseScrollTimeStamp = currentTime;
}
}
}
get isFullscreen() {
return !!(document.fullscreenElement || document.mozFullScreen ||
document.webkitIsFullScreen || document.msFullscreenElement);
}
/**
* @private
*/
_goToPreviousPage() {
var page = this.pdfViewer.currentPageNumber;
// If we're at the first page, we don't need to do anything.
if (page <= 1) {
return false;
}
this.pdfViewer.currentPageNumber = (page - 1);
return true;
}
/**
* @private
*/
_goToNextPage() {
var page = this.pdfViewer.currentPageNumber;
// If we're at the last page, we don't need to do anything.
if (page >= this.pdfViewer.pagesCount) {
return false;
}
this.pdfViewer.currentPageNumber = (page + 1);
return true;
}
/**
* @private
*/
_notifyStateChange() {
this.eventBus.dispatch('presentationmodechanged', {
source: this,
active: this.active,
switchInProgress: !!this.switchInProgress,
});
}
/**
* Used to initialize a timeout when requesting Presentation Mode,
* i.e. when the browser is requested to enter fullscreen mode.
* This timeout is used to prevent the current page from being scrolled
* partially, or completely, out of view when entering Presentation Mode.
* NOTE: This issue seems limited to certain zoom levels (e.g. page-width).
*
* @private
*/
_setSwitchInProgress() {
if (this.switchInProgress) {
clearTimeout(this.switchInProgress);
}
this.switchInProgress = setTimeout(() => {
this._removeFullscreenChangeListeners();
delete this.switchInProgress;
this._notifyStateChange();
}, DELAY_BEFORE_RESETTING_SWITCH_IN_PROGRESS);
}
/**
* @private
*/
_resetSwitchInProgress() {
if (this.switchInProgress) {
clearTimeout(this.switchInProgress);
delete this.switchInProgress;
}
}
/**
* @private
*/
_enter() {
this.active = true;
this._resetSwitchInProgress();
this._notifyStateChange();
this.container.classList.add(ACTIVE_SELECTOR);
// Ensure that the correct page is scrolled into view when entering
// Presentation Mode, by waiting until fullscreen mode in enabled.
setTimeout(() => {
this.pdfViewer.currentPageNumber = this.args.page;
this.pdfViewer.currentScaleValue = 'page-fit';
}, 0);
this._addWindowListeners();
this._showControls();
this.contextMenuOpen = false;
this.container.setAttribute('contextmenu', 'viewerContextMenu');
// Text selection is disabled in Presentation Mode, thus it's not possible
// for the user to deselect text that is selected (e.g. with "Select all")
// when entering Presentation Mode, hence we remove any active selection.
window.getSelection().removeAllRanges();
}
/**
* @private
*/
_exit() {
var page = this.pdfViewer.currentPageNumber;
this.container.classList.remove(ACTIVE_SELECTOR);
// Ensure that the correct page is scrolled into view when exiting
// Presentation Mode, by waiting until fullscreen mode is disabled.
setTimeout(() => {
this.active = false;
this._removeFullscreenChangeListeners();
this._notifyStateChange();
this.pdfViewer.currentScaleValue = this.args.previousScale;
this.pdfViewer.currentPageNumber = page;
this.args = null;
}, 0);
this._removeWindowListeners();
this._hideControls();
this._resetMouseScrollState();
this.container.removeAttribute('contextmenu');
this.contextMenuOpen = false;
}
/**
* @private
*/
_mouseDown(evt) {
if (this.contextMenuOpen) {
this.contextMenuOpen = false; this.contextMenuOpen = false;
}, evt.preventDefault();
return;
/** }
* @private if (evt.button === 0) {
*/ // Enable clicking of links in presentation mode. Note: only links
_mouseDown: function PDFPresentationMode_mouseDown(evt) { // pointing to destinations in the current PDF document work.
if (this.contextMenuOpen) { var isInternalLink = (evt.target.href &&
this.contextMenuOpen = false; evt.target.classList.contains('internalLink'));
if (!isInternalLink) {
// Unless an internal link was clicked, advance one page.
evt.preventDefault(); evt.preventDefault();
return; this.pdfViewer.currentPageNumber += (evt.shiftKey ? -1 : 1);
} }
if (evt.button === 0) { }
// Enable clicking of links in presentation mode. Please note: }
// Only links pointing to destinations in the current PDF document work.
var isInternalLink = (evt.target.href &&
evt.target.classList.contains('internalLink'));
if (!isInternalLink) {
// Unless an internal link was clicked, advance one page.
evt.preventDefault();
this.pdfViewer.currentPageNumber += (evt.shiftKey ? -1 : 1);
}
}
},
/** /**
* @private * @private
*/ */
_contextMenu: function PDFPresentationMode_contextMenu() { _contextMenu() {
this.contextMenuOpen = true; this.contextMenuOpen = true;
}, }
/** /**
* @private * @private
*/ */
_showControls: function PDFPresentationMode_showControls() { _showControls() {
if (this.controlsTimeout) { if (this.controlsTimeout) {
clearTimeout(this.controlsTimeout);
} else {
this.container.classList.add(CONTROLS_SELECTOR);
}
this.controlsTimeout = setTimeout(function showControlsTimeout() {
this.container.classList.remove(CONTROLS_SELECTOR);
delete this.controlsTimeout;
}.bind(this), DELAY_BEFORE_HIDING_CONTROLS);
},
/**
* @private
*/
_hideControls: function PDFPresentationMode_hideControls() {
if (!this.controlsTimeout) {
return;
}
clearTimeout(this.controlsTimeout); clearTimeout(this.controlsTimeout);
} else {
this.container.classList.add(CONTROLS_SELECTOR);
}
this.controlsTimeout = setTimeout(() => {
this.container.classList.remove(CONTROLS_SELECTOR); this.container.classList.remove(CONTROLS_SELECTOR);
delete this.controlsTimeout; delete this.controlsTimeout;
}, }, DELAY_BEFORE_HIDING_CONTROLS);
}
/** /**
* Resets the properties used for tracking mouse scrolling events. * @private
* @private */
*/ _hideControls() {
_resetMouseScrollState: if (!this.controlsTimeout) {
function PDFPresentationMode_resetMouseScrollState() { return;
this.mouseScrollTimeStamp = 0;
this.mouseScrollDelta = 0;
},
/**
* @private
*/
_touchSwipe: function PDFPresentationMode_touchSwipe(evt) {
if (!this.active) {
return;
}
// Must move at least these many CSS pixels for it to count as a swipe
var SWIPE_MIN_DISTANCE_THRESHOLD = 50;
// The swipe angle is allowed to deviate from the x or y axis by this much
// before it is not considered a swipe in that direction any more.
var SWIPE_ANGLE_THRESHOLD = Math.PI / 6;
if (evt.touches.length > 1) {
// Multiple touch points detected, cancel the swipe.
this.touchSwipeState = null;
return;
}
switch (evt.type) {
case 'touchstart':
this.touchSwipeState = {
startX: evt.touches[0].pageX,
startY: evt.touches[0].pageY,
endX: evt.touches[0].pageX,
endY: evt.touches[0].pageY
};
break;
case 'touchmove':
if (this.touchSwipeState === null) {
return;
}
this.touchSwipeState.endX = evt.touches[0].pageX;
this.touchSwipeState.endY = evt.touches[0].pageY;
// Do a preventDefault to avoid the swipe from triggering browser
// gestures (Chrome in particular has some sort of swipe gesture in
// fullscreen mode).
evt.preventDefault();
break;
case 'touchend':
if (this.touchSwipeState === null) {
return;
}
var delta = 0;
var dx = this.touchSwipeState.endX - this.touchSwipeState.startX;
var dy = this.touchSwipeState.endY - this.touchSwipeState.startY;
var absAngle = Math.abs(Math.atan2(dy, dx));
if (Math.abs(dx) > SWIPE_MIN_DISTANCE_THRESHOLD &&
(absAngle <= SWIPE_ANGLE_THRESHOLD ||
absAngle >= (Math.PI - SWIPE_ANGLE_THRESHOLD))) {
// horizontal swipe
delta = dx;
} else if (Math.abs(dy) > SWIPE_MIN_DISTANCE_THRESHOLD &&
Math.abs(absAngle - (Math.PI / 2)) <= SWIPE_ANGLE_THRESHOLD) {
// vertical swipe
delta = dy;
}
if (delta > 0) {
this._goToPreviousPage();
} else if (delta < 0) {
this._goToNextPage();
}
break;
}
},
/**
* @private
*/
_addWindowListeners: function PDFPresentationMode_addWindowListeners() {
this.showControlsBind = this._showControls.bind(this);
this.mouseDownBind = this._mouseDown.bind(this);
this.mouseWheelBind = this._mouseWheel.bind(this);
this.resetMouseScrollStateBind = this._resetMouseScrollState.bind(this);
this.contextMenuBind = this._contextMenu.bind(this);
this.touchSwipeBind = this._touchSwipe.bind(this);
window.addEventListener('mousemove', this.showControlsBind);
window.addEventListener('mousedown', this.mouseDownBind);
window.addEventListener('wheel', this.mouseWheelBind);
window.addEventListener('keydown', this.resetMouseScrollStateBind);
window.addEventListener('contextmenu', this.contextMenuBind);
window.addEventListener('touchstart', this.touchSwipeBind);
window.addEventListener('touchmove', this.touchSwipeBind);
window.addEventListener('touchend', this.touchSwipeBind);
},
/**
* @private
*/
_removeWindowListeners:
function PDFPresentationMode_removeWindowListeners() {
window.removeEventListener('mousemove', this.showControlsBind);
window.removeEventListener('mousedown', this.mouseDownBind);
window.removeEventListener('wheel', this.mouseWheelBind);
window.removeEventListener('keydown', this.resetMouseScrollStateBind);
window.removeEventListener('contextmenu', this.contextMenuBind);
window.removeEventListener('touchstart', this.touchSwipeBind);
window.removeEventListener('touchmove', this.touchSwipeBind);
window.removeEventListener('touchend', this.touchSwipeBind);
delete this.showControlsBind;
delete this.mouseDownBind;
delete this.mouseWheelBind;
delete this.resetMouseScrollStateBind;
delete this.contextMenuBind;
delete this.touchSwipeBind;
},
/**
* @private
*/
_fullscreenChange: function PDFPresentationMode_fullscreenChange() {
if (this.isFullscreen) {
this._enter();
} else {
this._exit();
}
},
/**
* @private
*/
_addFullscreenChangeListeners:
function PDFPresentationMode_addFullscreenChangeListeners() {
this.fullscreenChangeBind = this._fullscreenChange.bind(this);
window.addEventListener('fullscreenchange', this.fullscreenChangeBind);
window.addEventListener('mozfullscreenchange', this.fullscreenChangeBind);
if (typeof PDFJSDev === 'undefined' ||
!PDFJSDev.test('FIREFOX || MOZCENTRAL')) {
window.addEventListener('webkitfullscreenchange',
this.fullscreenChangeBind);
window.addEventListener('MSFullscreenChange',
this.fullscreenChangeBind);
}
},
/**
* @private
*/
_removeFullscreenChangeListeners:
function PDFPresentationMode_removeFullscreenChangeListeners() {
window.removeEventListener('fullscreenchange', this.fullscreenChangeBind);
window.removeEventListener('mozfullscreenchange',
this.fullscreenChangeBind);
if (typeof PDFJSDev === 'undefined' ||
!PDFJSDev.test('FIREFOX || MOZCENTRAL')) {
window.removeEventListener('webkitfullscreenchange',
this.fullscreenChangeBind);
window.removeEventListener('MSFullscreenChange',
this.fullscreenChangeBind);
}
delete this.fullscreenChangeBind;
} }
}; clearTimeout(this.controlsTimeout);
this.container.classList.remove(CONTROLS_SELECTOR);
delete this.controlsTimeout;
}
return PDFPresentationMode; /**
})(); * Resets the properties used for tracking mouse scrolling events.
*
* @private
*/
_resetMouseScrollState() {
this.mouseScrollTimeStamp = 0;
this.mouseScrollDelta = 0;
}
/**
* @private
*/
_touchSwipe(evt) {
if (!this.active) {
return;
}
if (evt.touches.length > 1) {
// Multiple touch points detected; cancel the swipe.
this.touchSwipeState = null;
return;
}
switch (evt.type) {
case 'touchstart':
this.touchSwipeState = {
startX: evt.touches[0].pageX,
startY: evt.touches[0].pageY,
endX: evt.touches[0].pageX,
endY: evt.touches[0].pageY,
};
break;
case 'touchmove':
if (this.touchSwipeState === null) {
return;
}
this.touchSwipeState.endX = evt.touches[0].pageX;
this.touchSwipeState.endY = evt.touches[0].pageY;
// Avoid the swipe from triggering browser gestures (Chrome in
// particular has some sort of swipe gesture in fullscreen mode).
evt.preventDefault();
break;
case 'touchend':
if (this.touchSwipeState === null) {
return;
}
var delta = 0;
var dx = this.touchSwipeState.endX - this.touchSwipeState.startX;
var dy = this.touchSwipeState.endY - this.touchSwipeState.startY;
var absAngle = Math.abs(Math.atan2(dy, dx));
if (Math.abs(dx) > SWIPE_MIN_DISTANCE_THRESHOLD &&
(absAngle <= SWIPE_ANGLE_THRESHOLD ||
absAngle >= (Math.PI - SWIPE_ANGLE_THRESHOLD))) {
// Horizontal swipe.
delta = dx;
} else if (Math.abs(dy) > SWIPE_MIN_DISTANCE_THRESHOLD &&
Math.abs(absAngle - (Math.PI / 2)) <= SWIPE_ANGLE_THRESHOLD) {
// Vertical swipe.
delta = dy;
}
if (delta > 0) {
this._goToPreviousPage();
} else if (delta < 0) {
this._goToNextPage();
}
break;
}
}
/**
* @private
*/
_addWindowListeners() {
this.showControlsBind = this._showControls.bind(this);
this.mouseDownBind = this._mouseDown.bind(this);
this.mouseWheelBind = this._mouseWheel.bind(this);
this.resetMouseScrollStateBind = this._resetMouseScrollState.bind(this);
this.contextMenuBind = this._contextMenu.bind(this);
this.touchSwipeBind = this._touchSwipe.bind(this);
window.addEventListener('mousemove', this.showControlsBind);
window.addEventListener('mousedown', this.mouseDownBind);
window.addEventListener('wheel', this.mouseWheelBind);
window.addEventListener('keydown', this.resetMouseScrollStateBind);
window.addEventListener('contextmenu', this.contextMenuBind);
window.addEventListener('touchstart', this.touchSwipeBind);
window.addEventListener('touchmove', this.touchSwipeBind);
window.addEventListener('touchend', this.touchSwipeBind);
}
/**
* @private
*/
_removeWindowListeners() {
window.removeEventListener('mousemove', this.showControlsBind);
window.removeEventListener('mousedown', this.mouseDownBind);
window.removeEventListener('wheel', this.mouseWheelBind);
window.removeEventListener('keydown', this.resetMouseScrollStateBind);
window.removeEventListener('contextmenu', this.contextMenuBind);
window.removeEventListener('touchstart', this.touchSwipeBind);
window.removeEventListener('touchmove', this.touchSwipeBind);
window.removeEventListener('touchend', this.touchSwipeBind);
delete this.showControlsBind;
delete this.mouseDownBind;
delete this.mouseWheelBind;
delete this.resetMouseScrollStateBind;
delete this.contextMenuBind;
delete this.touchSwipeBind;
}
/**
* @private
*/
_fullscreenChange() {
if (this.isFullscreen) {
this._enter();
} else {
this._exit();
}
}
/**
* @private
*/
_addFullscreenChangeListeners() {
this.fullscreenChangeBind = this._fullscreenChange.bind(this);
window.addEventListener('fullscreenchange', this.fullscreenChangeBind);
window.addEventListener('mozfullscreenchange', this.fullscreenChangeBind);
if (typeof PDFJSDev === 'undefined' ||
!PDFJSDev.test('FIREFOX || MOZCENTRAL')) {
window.addEventListener('webkitfullscreenchange',
this.fullscreenChangeBind);
window.addEventListener('MSFullscreenChange',
this.fullscreenChangeBind);
}
}
/**
* @private
*/
_removeFullscreenChangeListeners() {
window.removeEventListener('fullscreenchange', this.fullscreenChangeBind);
window.removeEventListener('mozfullscreenchange',
this.fullscreenChangeBind);
if (typeof PDFJSDev === 'undefined' ||
!PDFJSDev.test('FIREFOX || MOZCENTRAL')) {
window.removeEventListener('webkitfullscreenchange',
this.fullscreenChangeBind);
window.removeEventListener('MSFullscreenChange',
this.fullscreenChangeBind);
}
delete this.fullscreenChangeBind;
}
}
export { export {
PDFPresentationMode, PDFPresentationMode,

250
web/pdf_rendering_queue.js
View File

@ -13,166 +13,164 @@
* limitations under the License. * limitations under the License.
*/ */
var CLEANUP_TIMEOUT = 30000; const CLEANUP_TIMEOUT = 30000;
var RenderingStates = { const RenderingStates = {
INITIAL: 0, INITIAL: 0,
RUNNING: 1, RUNNING: 1,
PAUSED: 2, PAUSED: 2,
FINISHED: 3 FINISHED: 3,
}; };
/** /**
* Controls rendering of the views for pages and thumbnails. * Controls rendering of the views for pages and thumbnails.
* @class
*/ */
var PDFRenderingQueue = (function PDFRenderingQueueClosure() { class PDFRenderingQueue {
/** constructor() {
* @constructs
*/
function PDFRenderingQueue() {
this.pdfViewer = null; this.pdfViewer = null;
this.pdfThumbnailViewer = null; this.pdfThumbnailViewer = null;
this.onIdle = null; this.onIdle = null;
this.highestPriorityPage = null; this.highestPriorityPage = null;
this.idleTimeout = null; this.idleTimeout = null;
this.printing = false; this.printing = false;
this.isThumbnailViewEnabled = false; this.isThumbnailViewEnabled = false;
} }
PDFRenderingQueue.prototype = /** @lends PDFRenderingQueue.prototype */ { /**
/** * @param {PDFViewer} pdfViewer
* @param {PDFViewer} pdfViewer */
*/ setViewer(pdfViewer) {
setViewer: function PDFRenderingQueue_setViewer(pdfViewer) { this.pdfViewer = pdfViewer;
this.pdfViewer = pdfViewer; }
},
/** /**
* @param {PDFThumbnailViewer} pdfThumbnailViewer * @param {PDFThumbnailViewer} pdfThumbnailViewer
*/ */
setThumbnailViewer: setThumbnailViewer(pdfThumbnailViewer) {
function PDFRenderingQueue_setThumbnailViewer(pdfThumbnailViewer) { this.pdfThumbnailViewer = pdfThumbnailViewer;
this.pdfThumbnailViewer = pdfThumbnailViewer; }
},
/** /**
* @param {IRenderableView} view * @param {IRenderableView} view
* @returns {boolean} * @returns {boolean}
*/ */
isHighestPriority: function PDFRenderingQueue_isHighestPriority(view) { isHighestPriority(view) {
return this.highestPriorityPage === view.renderingId; return this.highestPriorityPage === view.renderingId;
}, }
renderHighestPriority: function /**
PDFRenderingQueue_renderHighestPriority(currentlyVisiblePages) { * @param {Object} currentlyVisiblePages
if (this.idleTimeout) { */
clearTimeout(this.idleTimeout); renderHighestPriority(currentlyVisiblePages) {
this.idleTimeout = null; if (this.idleTimeout) {
} clearTimeout(this.idleTimeout);
this.idleTimeout = null;
}
// Pages have a higher priority than thumbnails, so check them first. // Pages have a higher priority than thumbnails, so check them first.
if (this.pdfViewer.forceRendering(currentlyVisiblePages)) { if (this.pdfViewer.forceRendering(currentlyVisiblePages)) {
return;
}
// No pages needed rendering, so check thumbnails.
if (this.pdfThumbnailViewer && this.isThumbnailViewEnabled) {
if (this.pdfThumbnailViewer.forceRendering()) {
return; return;
} }
// No pages needed rendering so check thumbnails. }
if (this.pdfThumbnailViewer && this.isThumbnailViewEnabled) {
if (this.pdfThumbnailViewer.forceRendering()) {
return;
}
}
if (this.printing) { if (this.printing) {
// If printing is currently ongoing do not reschedule cleanup. // If printing is currently ongoing do not reschedule cleanup.
return; return;
} }
if (this.onIdle) { if (this.onIdle) {
this.idleTimeout = setTimeout(this.onIdle.bind(this), CLEANUP_TIMEOUT); this.idleTimeout = setTimeout(this.onIdle.bind(this), CLEANUP_TIMEOUT);
} }
}, }
getHighestPriority: function /**
PDFRenderingQueue_getHighestPriority(visible, views, scrolledDown) { * @param {Object} visible
// The state has changed figure out which page has the highest priority to * @param {Array} views
// render next (if any). * @param {boolean} scrolledDown
// Priority: */
// 1 visible pages getHighestPriority(visible, views, scrolledDown) {
// 2 if last scrolled down page after the visible pages /**
// 2 if last scrolled up page before the visible pages * The state has changed. Figure out which page has the highest priority to
var visibleViews = visible.views; * render next (if any).
*
* Priority:
* 1. visible pages
* 2. if last scrolled down, the page after the visible pages, or
* if last scrolled up, the page before the visible pages
*/
var visibleViews = visible.views;
var numVisible = visibleViews.length; var numVisible = visibleViews.length;
if (numVisible === 0) { if (numVisible === 0) {
return false; return false;
} }
for (var i = 0; i < numVisible; ++i) { for (var i = 0; i < numVisible; ++i) {
var view = visibleViews[i].view; var view = visibleViews[i].view;
if (!this.isViewFinished(view)) { if (!this.isViewFinished(view)) {
return view; return view;
}
} }
}
// All the visible views have rendered, try to render next/previous pages. // All the visible views have rendered; try to render next/previous pages.
if (scrolledDown) { if (scrolledDown) {
var nextPageIndex = visible.last.id; var nextPageIndex = visible.last.id;
// ID's start at 1 so no need to add 1. // IDs start at 1, so no need to add 1.
if (views[nextPageIndex] && if (views[nextPageIndex] && !this.isViewFinished(views[nextPageIndex])) {
!this.isViewFinished(views[nextPageIndex])) { return views[nextPageIndex];
return views[nextPageIndex]; }
} } else {
} else { var previousPageIndex = visible.first.id - 2;
var previousPageIndex = visible.first.id - 2; if (views[previousPageIndex] &&
if (views[previousPageIndex] &&
!this.isViewFinished(views[previousPageIndex])) { !this.isViewFinished(views[previousPageIndex])) {
return views[previousPageIndex]; return views[previousPageIndex];
}
} }
// Everything that needs to be rendered has been. }
return null; // Everything that needs to be rendered has been.
}, return null;
}
/** /**
* @param {IRenderableView} view * @param {IRenderableView} view
* @returns {boolean} * @returns {boolean}
*/ */
isViewFinished: function PDFRenderingQueue_isViewFinished(view) { isViewFinished(view) {
return view.renderingState === RenderingStates.FINISHED; return view.renderingState === RenderingStates.FINISHED;
}, }
/** /**
* Render a page or thumbnail view. This calls the appropriate function * Render a page or thumbnail view. This calls the appropriate function
* based on the views state. If the view is already rendered it will return * based on the views state. If the view is already rendered it will return
* false. * `false`.
* @param {IRenderableView} view *
*/ * @param {IRenderableView} view
renderView: function PDFRenderingQueue_renderView(view) { */
var state = view.renderingState; renderView(view) {
switch (state) { switch (view.renderingState) {
case RenderingStates.FINISHED: case RenderingStates.FINISHED:
return false; return false;
case RenderingStates.PAUSED: case RenderingStates.PAUSED:
this.highestPriorityPage = view.renderingId; this.highestPriorityPage = view.renderingId;
view.resume(); view.resume();
break; break;
case RenderingStates.RUNNING: case RenderingStates.RUNNING:
this.highestPriorityPage = view.renderingId; this.highestPriorityPage = view.renderingId;
break; break;
case RenderingStates.INITIAL: case RenderingStates.INITIAL:
this.highestPriorityPage = view.renderingId; this.highestPriorityPage = view.renderingId;
var continueRendering = function () { var continueRendering = () => {
this.renderHighestPriority(); this.renderHighestPriority();
}.bind(this); };
view.draw().then(continueRendering, continueRendering); view.draw().then(continueRendering, continueRendering);
break; break;
} }
return true; return true;
}, }
}; }
return PDFRenderingQueue;
})();
export { export {
RenderingStates, RenderingStates,