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

Convert the overlay manager to a class #8119

Closed
wants to merge 1 commit into from
Closed

Convert the overlay manager to a class #8119

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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 11 additions & 4 deletions web/app.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -392,15 +392,19 @@ var PDFViewerApplication = {
findBarConfig.eventBus = eventBus;
self.findBar = new PDFFindBar(findBarConfig);

self.overlayManager = OverlayManager;
self.overlayManager = new OverlayManager();

self.handTool = new HandTool({
container: container,
eventBus: eventBus,
});

// FIXME better PDFDocumentProperties constructor parameters
var documentPropertiesConfig =
Object.create(appConfig.documentProperties);
documentPropertiesConfig.overlayManager = self.overlayManager;
self.pdfDocumentProperties =
new PDFDocumentProperties(appConfig.documentProperties);
new PDFDocumentProperties(documentPropertiesConfig);

self.toolbar = new Toolbar(appConfig.toolbar, container, eventBus);

Expand All @@ -417,7 +421,10 @@ var PDFViewerApplication = {
});
}

self.passwordPrompt = new PasswordPrompt(appConfig.passwordOverlay);
// FIXME better PasswordPrompt constructor parameters
var passwordPromptConfig = Object.create(appConfig.passwordOverlay);
passwordPromptConfig.overlayManager = self.overlayManager;
self.passwordPrompt = new PasswordPrompt(passwordPromptConfig);

self.pdfOutlineViewer = new PDFOutlineViewer({
container: appConfig.sidebar.outlineView,
Expand Down Expand Up @@ -1977,7 +1984,7 @@ function webViewerClick(evt) {
}

function webViewerKeyDown(evt) {
if (OverlayManager.active) {
if (PDFViewerApplication.overlayManager.active) {
return;
}

Expand Down
20 changes: 9 additions & 11 deletions web/chromecom.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,25 +19,22 @@
(function (root, factory) {
if (typeof define === 'function' && define.amd) {
define('pdfjs-web/chromecom', ['exports', 'pdfjs-web/app',
'pdfjs-web/overlay_manager', 'pdfjs-web/preferences', 'pdfjs-web/pdfjs'],
factory);
'pdfjs-web/preferences', 'pdfjs-web/pdfjs'], factory);
} else if (typeof exports !== 'undefined') {
factory(exports, require('./app.js'), require('./overlay_manager.js'),
require('./preferences.js'), require('./pdfjs.js'));
factory(exports, require('./app.js'), require('./preferences.js'),
require('./pdfjs.js'));
} else {
factory((root.pdfjsWebChromeCom = {}), root.pdfjsWebApp,
root.pdfjsWebOverlayManager, root.pdfjsWebPreferences,
root.pdfjsWebPDFJS);
root.pdfjsWebPreferences, root.pdfjsWebPDFJS);
}
}(this, function (exports, app, overlayManager, preferences, pdfjsLib) {
}(this, function (exports, app, preferences, pdfjsLib) {
if (typeof PDFJSDev === 'undefined' || !PDFJSDev.test('CHROME')) {
throw new Error('Module "pdfjs-web/chromecom" shall not be used outside ' +
'CHROME build.');
}

var PDFViewerApplication = app.PDFViewerApplication;
var DefaultExernalServices = app.DefaultExernalServices;
var OverlayManager = overlayManager.OverlayManager;
var Preferences = preferences.Preferences;

var ChromeCom = {};
Expand Down Expand Up @@ -171,6 +168,7 @@

var chromeFileAccessOverlayPromise;
function requestAccessToLocalFile(fileUrl) {
var overlayManager = PDFViewerApplication.overlayManager;
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: I'm wondering if it might not be a bit cleaner to just have this definition at the top of the file instead (like it currently is).

var onCloseOverlay = null;
if (top !== window) {
// When the extension reloads after receiving new permissions, the pages
Expand All @@ -184,11 +182,11 @@
onCloseOverlay = function() {
window.removeEventListener('focus', reloadIfRuntimeIsUnavailable);
reloadIfRuntimeIsUnavailable();
OverlayManager.close('chromeFileAccessOverlay');
overlayManager.close('chromeFileAccessOverlay');
};
}
if (!chromeFileAccessOverlayPromise) {
chromeFileAccessOverlayPromise = OverlayManager.register(
chromeFileAccessOverlayPromise = overlayManager.register(
'chromeFileAccessOverlay',
document.getElementById('chromeFileAccessOverlay'),
onCloseOverlay, true);
Expand Down Expand Up @@ -230,7 +228,7 @@
// why this permission request is shown.
document.getElementById('chrome-url-of-local-file').textContent = fileUrl;

OverlayManager.open('chromeFileAccessOverlay');
PDFViewerApplication.overlayManager.open('chromeFileAccessOverlay');
});
}

Expand Down
52 changes: 32 additions & 20 deletions web/overlay_manager.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,25 +25,35 @@
}
}(this, function (exports) {

var OverlayManager = {
overlays: {},
active: null,
/**
* @class
*/
var OverlayManager = (function OverlayManagerClosure() {
/**
* @constructs OverlayManager
*/
function OverlayManager() {
this.overlays = {};
this.active = null;
}

OverlayManager.prototype = {
/**
* @param {string} name The name of the overlay that is registered.
* @param {HTMLDivElement} element The overlay's DOM element.
* @param {function} callerCloseMethod (optional) The method that, if present,
* will call OverlayManager.close from the Object
* @param {function} callerCloseMethod (optional) The method that, if
* present, calls OverlayManager.close from the Object
* registering the overlay. Access to this method is
* necessary in order to run cleanup code when e.g.
* the overlay is force closed. The default is null.
* @param {boolean} canForceClose (optional) Indicates if opening the overlay
* will close an active overlay. The default is false.
* @param {boolean} canForceClose (optional) Indicates if opening the
* overlay closes an active overlay. The default is false.
* @returns {Promise} A promise that is resolved when the overlay has been
* registered.
*/
register: function overlayManagerRegister(name, element,
callerCloseMethod, canForceClose) {
register:
function OverlayManager_register(name, element, callerCloseMethod,
canForceClose) {
return new Promise(function (resolve) {
var container;
if (!name || !element || !(container = element.parentNode)) {
Expand All @@ -64,7 +74,7 @@ var OverlayManager = {
* @returns {Promise} A promise that is resolved when the overlay has been
* unregistered.
*/
unregister: function overlayManagerUnregister(name) {
unregister: function OverlayManager_unregister(name) {
return new Promise(function (resolve) {
if (!this.overlays[name]) {
throw new Error('The overlay does not exist.');
Expand All @@ -82,7 +92,7 @@ var OverlayManager = {
* @returns {Promise} A promise that is resolved when the overlay has been
* opened.
*/
open: function overlayManagerOpen(name) {
open: function OverlayManager_open(name) {
return new Promise(function (resolve) {
if (!this.overlays[name]) {
throw new Error('The overlay does not exist.');
Expand All @@ -99,7 +109,7 @@ var OverlayManager = {
this.overlays[this.active].element.classList.remove('hidden');
this.overlays[this.active].container.classList.remove('hidden');

window.addEventListener('keydown', this._keyDown);
window.addEventListener('keydown', this._keyDown.bind(this));
Copy link
Collaborator

@Snuffleupagus Snuffleupagus Mar 1, 2017 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unfortunately you'll not be able to remove the event listener if you define it like this.
You'll need to add this._keyDownBound = this._keyDown.bind(this); to e.g. the constructor and then use this._keyDownBound here (and below).

resolve();
}.bind(this));
},
Expand All @@ -109,7 +119,7 @@ var OverlayManager = {
* @returns {Promise} A promise that is resolved when the overlay has been
* closed.
*/
close: function overlayManagerClose(name) {
close: function OverlayManager_close(name) {
return new Promise(function (resolve) {
if (!this.overlays[name]) {
throw new Error('The overlay does not exist.');
Expand All @@ -122,34 +132,36 @@ var OverlayManager = {
this.overlays[this.active].element.classList.add('hidden');
this.active = null;

window.removeEventListener('keydown', this._keyDown);
window.removeEventListener('keydown', this._keyDown.bind(this));
resolve();
}.bind(this));
},

/**
* @private
*/
_keyDown: function overlayManager_keyDown(evt) {
var self = OverlayManager;
if (self.active && evt.keyCode === 27) { // Esc key.
self._closeThroughCaller();
_keyDown: function OverlayManager_keyDown(evt) {
if (this.active && evt.keyCode === 27) { // Esc key.
this._closeThroughCaller();
evt.preventDefault();
}
},

/**
* @private
*/
_closeThroughCaller: function overlayManager_closeThroughCaller() {
_closeThroughCaller: function OverlayManager_closeThroughCaller() {
if (this.overlays[this.active].callerCloseMethod) {
this.overlays[this.active].callerCloseMethod();
}
if (this.active) {
this.close(this.active);
}
}
},
};

return OverlayManager;
})();

exports.OverlayManager = OverlayManager;
}));
21 changes: 10 additions & 11 deletions web/password_prompt.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,23 +17,21 @@

(function (root, factory) {
if (typeof define === 'function' && define.amd) {
define('pdfjs-web/password_prompt', ['exports',
'pdfjs-web/ui_utils', 'pdfjs-web/overlay_manager', 'pdfjs-web/pdfjs'],
factory);
define('pdfjs-web/password_prompt', ['exports', 'pdfjs-web/ui_utils',
'pdfjs-web/pdfjs'], factory);
} else if (typeof exports !== 'undefined') {
factory(exports, require('./ui_utils.js'), require('./overlay_manager.js'),
require('./pdfjs.js'));
factory(exports, require('./ui_utils.js'), require('./pdfjs.js'));
} else {
factory((root.pdfjsWebPasswordPrompt = {}), root.pdfjsWebUIUtils,
root.pdfjsWebOverlayManager, root.pdfjsWebPDFJS);
root.pdfjsWebPDFJS);
}
}(this, function (exports, uiUtils, overlayManager, pdfjsLib) {
}(this, function (exports, uiUtils, pdfjsLib) {

var mozL10n = uiUtils.mozL10n;
var OverlayManager = overlayManager.OverlayManager;

/**
* @typedef {Object} PasswordPromptOptions
* @property {OverlayManager} overlayManager - Controls the app's overlays.
* @property {string} overlayName - Name of the overlay for the overlay manager.
* @property {HTMLDivElement} container - Div container for the overlay.
* @property {HTMLParagraphElement} label - Label containing instructions for
Expand All @@ -54,6 +52,7 @@ var PasswordPrompt = (function PasswordPromptClosure() {
* @param {PasswordPromptOptions} options
*/
function PasswordPrompt(options) {
this.overlayManager = options.overlayManager;
this.overlayName = options.overlayName;
this.container = options.container;
this.label = options.label;
Expand All @@ -73,13 +72,13 @@ var PasswordPrompt = (function PasswordPromptClosure() {
}
}.bind(this));

OverlayManager.register(this.overlayName, this.container,
this.overlayManager.register(this.overlayName, this.container,
this.close.bind(this), true);
}

PasswordPrompt.prototype = {
open: function PasswordPrompt_open() {
OverlayManager.open(this.overlayName).then(function () {
this.overlayManager.open(this.overlayName).then(function () {
this.input.type = 'password';
this.input.focus();

Expand All @@ -96,7 +95,7 @@ var PasswordPrompt = (function PasswordPromptClosure() {
},

close: function PasswordPrompt_close() {
OverlayManager.close(this.overlayName).then(function () {
this.overlayManager.close(this.overlayName).then(function () {
this.input.value = '';
this.input.type = '';
}.bind(this));
Expand Down
21 changes: 11 additions & 10 deletions web/pdf_document_properties.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,22 +18,22 @@
(function (root, factory) {
if (typeof define === 'function' && define.amd) {
define('pdfjs-web/pdf_document_properties', ['exports',
'pdfjs-web/ui_utils', 'pdfjs-web/overlay_manager'], factory);
'pdfjs-web/ui_utils'], factory);
} else if (typeof exports !== 'undefined') {
factory(exports, require('./ui_utils.js'), require('./overlay_manager.js'));
factory(exports, require('./ui_utils.js'));
} else {
factory((root.pdfjsWebPDFDocumentProperties = {}), root.pdfjsWebUIUtils,
root.pdfjsWebOverlayManager);
factory((root.pdfjsWebPDFDocumentProperties = {}), root.pdfjsWebUIUtils);
}
}(this, function (exports, uiUtils, overlayManager) {

var getPDFFileNameFromURL = uiUtils.getPDFFileNameFromURL;
var mozL10n = uiUtils.mozL10n;
var OverlayManager = overlayManager.OverlayManager;

/**
* @typedef {Object} PDFDocumentPropertiesOptions
* @property {OverlayManager} overlayManager - Controls the app's overlays.
* @property {string} overlayName - Name/identifier for the overlay.
* @property {HTMLDivElement} container - Div container for the overlay.
* @property {Object} fields - Names and elements of the overlay's fields.
* @property {HTMLButtonElement} closeButton - Button for closing the overlay.
*/
Expand All @@ -47,9 +47,10 @@ var PDFDocumentProperties = (function PDFDocumentPropertiesClosure() {
* @param {PDFDocumentPropertiesOptions} options
*/
function PDFDocumentProperties(options) {
this.fields = options.fields;
this.overlayManager = options.overlayManager;
this.overlayName = options.overlayName;
this.container = options.container;
this.fields = options.fields;

this.rawFileSize = 0;
this.url = null;
Expand All @@ -64,7 +65,7 @@ var PDFDocumentProperties = (function PDFDocumentPropertiesClosure() {
this.resolveDataAvailable = resolve;
}.bind(this));

OverlayManager.register(this.overlayName, this.container,
this.overlayManager.register(this.overlayName, this.container,
this.close.bind(this));
}

Expand All @@ -73,7 +74,7 @@ var PDFDocumentProperties = (function PDFDocumentPropertiesClosure() {
* Open the document properties overlay.
*/
open: function PDFDocumentProperties_open() {
Promise.all([OverlayManager.open(this.overlayName),
Promise.all([this.overlayManager.open(this.overlayName),
this.dataAvailablePromise]).then(function () {
this._getProperties();
}.bind(this));
Expand All @@ -83,7 +84,7 @@ var PDFDocumentProperties = (function PDFDocumentPropertiesClosure() {
* Close the document properties overlay.
*/
close: function PDFDocumentProperties_close() {
OverlayManager.close(this.overlayName);
this.overlayManager.close(this.overlayName);
},

/**
Expand Down Expand Up @@ -119,7 +120,7 @@ var PDFDocumentProperties = (function PDFDocumentPropertiesClosure() {
* @private
*/
_getProperties: function PDFDocumentProperties_getProperties() {
if (!OverlayManager.active) {
if (!this.overlayManager.active) {
// If the dialog was closed before dataAvailablePromise was resolved,
// don't bother updating the properties.
return;
Expand Down
Loading