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 how PDFLayerViewer decides if the UI needs to updated on "optionalcontentconfigchanged" events #18829

Merged
merged 1 commit into from
Oct 1, 2024
Merged

Re-factor how PDFLayerViewer decides if the UI needs to updated on "optionalcontentconfigchanged" events #18829

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
39 changes: 28 additions & 11 deletions web/pdf_layer_viewer.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,9 @@ class PDFLayerViewer extends BaseTreeViewer {
reset() {
super.reset();
this._optionalContentConfig = null;
this._optionalContentHash = null;

this._optionalContentVisibility?.clear();
this._optionalContentVisibility = null;
}

/**
Expand All @@ -68,8 +70,13 @@ class PDFLayerViewer extends BaseTreeViewer {
*/
_bindLink(element, { groupId, input }) {
const setVisibility = () => {
this._optionalContentConfig.setVisibility(groupId, input.checked);
this._optionalContentHash = this._optionalContentConfig.getHash();
const visible = input.checked;
this._optionalContentConfig.setVisibility(groupId, visible);

const cached = this._optionalContentVisibility.get(groupId);
if (cached) {
cached.visible = visible;
}

this.eventBus.dispatch("optionalcontentconfig", {
source: this,
Expand Down Expand Up @@ -137,7 +144,7 @@ class PDFLayerViewer extends BaseTreeViewer {
this._dispatchEvent(/* layersCount = */ 0);
return;
}
this._optionalContentHash = optionalContentConfig.getHash();
this._optionalContentVisibility = new Map();

const fragment = document.createDocumentFragment(),
queue = [{ parent: fragment, groups }];
Expand Down Expand Up @@ -170,6 +177,11 @@ class PDFLayerViewer extends BaseTreeViewer {
input.type = "checkbox";
input.checked = group.visible;

this._optionalContentVisibility.set(groupId, {
input,
visible: input.checked,
});

const label = document.createElement("label");
label.textContent = this._normalizeTextContent(group.name);

Expand Down Expand Up @@ -197,15 +209,20 @@ class PDFLayerViewer extends BaseTreeViewer {
return; // The document was closed while the optional content resolved.
}
if (promise) {
if (optionalContentConfig.getHash() === this._optionalContentHash) {
return; // The optional content didn't change, hence no need to reset the UI.
// Ensure that the UI displays the correct state (e.g. with RBGroups).
for (const [groupId, cached] of this._optionalContentVisibility) {
const group = optionalContentConfig.getGroup(groupId);

if (group && cached.visible !== group.visible) {
cached.input.checked = cached.visible = !cached.visible;
}
}
} else {
this.eventBus.dispatch("optionalcontentconfig", {
source: this,
promise: Promise.resolve(optionalContentConfig),
});
return;
}
this.eventBus.dispatch("optionalcontentconfig", {
source: this,
promise: Promise.resolve(optionalContentConfig),
});

// Reset the sidebarView to the new state.
this.render({
Expand Down