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

Re-factor SimpleLinkService to extend PDFLinkService #18013

Merged
merged 1 commit into from
Apr 29, 2024
Merged

Re-factor SimpleLinkService to extend PDFLinkService #18013

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
215 changes: 56 additions & 159 deletions web/pdf_link_service.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,57 +28,6 @@ const LinkTarget = {
TOP: 4,
};

/**
* @typedef {Object} ExternalLinkParameters
* @property {string} url - An absolute URL.
* @property {LinkTarget} [target] - The link target. The default value is
* `LinkTarget.NONE`.
* @property {string} [rel] - The link relationship. The default value is
* `DEFAULT_LINK_REL`.
* @property {boolean} [enabled] - Whether the link should be enabled. The
* default value is true.
*/

/**
* Adds various attributes (href, title, target, rel) to hyperlinks.
* @param {HTMLAnchorElement} link - The link element.
* @param {ExternalLinkParameters} params
*/
function addLinkAttributes(link, { url, target, rel, enabled = true } = {}) {
if (!url || typeof url !== "string") {
throw new Error('A valid "url" parameter must provided.');
}

if (enabled) {
link.href = link.title = url;
} else {
link.href = "";
link.title = `Disabled: ${url}`;
link.onclick = () => false;
}

let targetStr = ""; // LinkTarget.NONE
switch (target) {
case LinkTarget.NONE:
break;
case LinkTarget.SELF:
targetStr = "_self";
break;
case LinkTarget.BLANK:
targetStr = "_blank";
break;
case LinkTarget.PARENT:
targetStr = "_parent";
break;
case LinkTarget.TOP:
targetStr = "_top";
break;
}
link.target = targetStr;

link.rel = typeof rel === "string" ? rel : DEFAULT_LINK_REL;
}

/**
* @typedef {Object} PDFLinkServiceOptions
* @property {EventBus} eventBus - The application event bus.
Expand All @@ -98,6 +47,8 @@ function addLinkAttributes(link, { url, target, rel, enabled = true } = {}) {
* @implements {IPDFLinkService}
*/
class PDFLinkService {
externalLinkEnabled = true;

#pagesRefCache = new Map();

/**
Expand All @@ -112,7 +63,6 @@ class PDFLinkService {
this.eventBus = eventBus;
this.externalLinkTarget = externalLinkTarget;
this.externalLinkRel = externalLinkRel;
this.externalLinkEnabled = true;
this._ignoreDestinationZoom = ignoreDestinationZoom;

this.baseUrl = null;
Expand Down Expand Up @@ -146,35 +96,39 @@ class PDFLinkService {
* @type {number}
*/
get page() {
return this.pdfViewer.currentPageNumber;
return this.pdfDocument ? this.pdfViewer.currentPageNumber : 1;
timvandermeij marked this conversation as resolved.
Show resolved Hide resolved
}

/**
* @param {number} value
*/
set page(value) {
this.pdfViewer.currentPageNumber = value;
if (this.pdfDocument) {
this.pdfViewer.currentPageNumber = value;
}
}

/**
* @type {number}
*/
get rotation() {
return this.pdfViewer.pagesRotation;
return this.pdfDocument ? this.pdfViewer.pagesRotation : 0;
}

/**
* @param {number} value
*/
set rotation(value) {
this.pdfViewer.pagesRotation = value;
if (this.pdfDocument) {
this.pdfViewer.pagesRotation = value;
}
}

/**
* @type {boolean}
*/
get isInPresentationMode() {
return this.pdfViewer.isInPresentationMode;
return this.pdfDocument ? this.pdfViewer.isInPresentationMode : false;
}

#goToDestinationHelper(rawDest, namedDest = null, explicitDest) {
Expand Down Expand Up @@ -294,18 +248,46 @@ class PDFLinkService {
}

/**
* Wrapper around the `addLinkAttributes` helper function.
* Adds various attributes (href, title, target, rel) to hyperlinks.
* @param {HTMLAnchorElement} link
* @param {string} url
* @param {boolean} [newWindow]
*/
addLinkAttributes(link, url, newWindow = false) {
addLinkAttributes(link, {
url,
target: newWindow ? LinkTarget.BLANK : this.externalLinkTarget,
rel: this.externalLinkRel,
enabled: this.externalLinkEnabled,
});
if (!url || typeof url !== "string") {
throw new Error('A valid "url" parameter must provided.');
}
const target = newWindow ? LinkTarget.BLANK : this.externalLinkTarget,
rel = this.externalLinkRel;

if (this.externalLinkEnabled) {
link.href = link.title = url;
} else {
link.href = "";
link.title = `Disabled: ${url}`;
link.onclick = () => false;
}

let targetStr = ""; // LinkTarget.NONE
switch (target) {
case LinkTarget.NONE:
break;
case LinkTarget.SELF:
targetStr = "_self";
break;
case LinkTarget.BLANK:
targetStr = "_blank";
break;
case LinkTarget.PARENT:
targetStr = "_parent";
break;
case LinkTarget.TOP:
targetStr = "_top";
break;
}
link.target = targetStr;

link.rel = typeof rel === "string" ? rel : DEFAULT_LINK_REL;
}

/**
Expand Down Expand Up @@ -467,6 +449,9 @@ class PDFLinkService {
* @param {string} action
*/
executeNamedAction(action) {
if (!this.pdfDocument) {
return;
}
// See PDF reference, table 8.45 - Named action
switch (action) {
case "GoBack":
Expand Down Expand Up @@ -507,9 +492,11 @@ class PDFLinkService {
* @param {Object} action
*/
async executeSetOCGState(action) {
const pdfDocument = this.pdfDocument;
const optionalContentConfig =
await this.pdfViewer.optionalContentConfigPromise;
if (!this.pdfDocument) {
return;
}
const pdfDocument = this.pdfDocument,
optionalContentConfig = await this.pdfViewer.optionalContentConfigPromise;

if (pdfDocument !== this.pdfDocument) {
return; // The document was closed while the optional content resolved.
Expand Down Expand Up @@ -603,98 +590,8 @@ class PDFLinkService {
/**
* @implements {IPDFLinkService}
*/
class SimpleLinkService {
constructor() {
this.externalLinkEnabled = true;
}

/**
* @type {number}
*/
get pagesCount() {
return 0;
}

/**
* @type {number}
*/
get page() {
return 0;
}

/**
* @param {number} value
*/
set page(value) {}

/**
* @type {number}
*/
get rotation() {
return 0;
}

/**
* @param {number} value
*/
set rotation(value) {}

/**
* @type {boolean}
*/
get isInPresentationMode() {
return false;
}

/**
* @param {string|Array} dest - The named, or explicit, PDF destination.
*/
async goToDestination(dest) {}

/**
* @param {number|string} val - The page number, or page label.
*/
goToPage(val) {}

/**
* @param {HTMLAnchorElement} link
* @param {string} url
* @param {boolean} [newWindow]
*/
addLinkAttributes(link, url, newWindow = false) {
addLinkAttributes(link, { url, enabled: this.externalLinkEnabled });
}

/**
* @param dest - The PDF destination object.
* @returns {string} The hyperlink to the PDF object.
*/
getDestinationHash(dest) {
return "#";
}

/**
* @param hash - The PDF parameters/hash.
* @returns {string} The hyperlink to the PDF object.
*/
getAnchorUrl(hash) {
return "#";
}

/**
* @param {string} hash
*/
setHash(hash) {}

/**
* @param {string} action
*/
executeNamedAction(action) {}

/**
* @param {Object} action
*/
executeSetOCGState(action) {}
class SimpleLinkService extends PDFLinkService {
setDocument(pdfDocument, baseUrl = null) {}

/**
* @param {number} pageNum - page number.
Expand Down