Skip to content

Commit

Permalink
[api-minor][Editor] When switching to editing mode, redraw pages cont…
Browse files Browse the repository at this point in the history
…aining editable annotations

Right now, editable annotations are using their own canvas when they're drawn, but
it induces several issues:
 - if the annotation has to be composed with the page then the canvas must be correctly
   composed with its parent. That means we should move the canvas under canvasWrapper
   and we should extract composing info from the drawing instructions...
   Currently it's the case with highlight annotations.
 - we use some extra memory for those canvas even if the user will never edit them, which
   the case for example when opening a pdf in Fenix.

So with this patch, all the editable annotations are drawn on the canvas. When the
user switches to editing mode, then the pages with some editable annotations are redrawn but
without them: they'll be replaced by their counterpart in the annotation editor layer.
  • Loading branch information
calixteman committed May 31, 2024
1 parent 4d9c25a commit bf93f39
Show file tree
Hide file tree
Showing 13 changed files with 313 additions and 95 deletions.
8 changes: 7 additions & 1 deletion src/core/annotation.js
Original file line number Diff line number Diff line change
Expand Up @@ -680,6 +680,7 @@ class Annotation {
hasOwnCanvas: false,
noRotate: !!(this.flags & AnnotationFlag.NOROTATE),
noHTML: isLocked && isContentLocked,
isEditable: false,
};

if (params.collectFields) {
Expand Down Expand Up @@ -776,6 +777,10 @@ class Annotation {
return this.printable;
}

mustBeViewedWhenEditing() {
return !this.data.isEditable;
}

/**
* @type {boolean}
*/
Expand Down Expand Up @@ -3794,7 +3799,8 @@ class FreeTextAnnotation extends MarkupAnnotation {
// It uses its own canvas in order to be hidden if edited.
// But if it has the noHTML flag, it means that we don't want to be able
// to modify it so we can just draw it on the main canvas.
this.data.hasOwnCanvas = !this.data.noHTML;
this.data.hasOwnCanvas = this.data.noRotate;
this.data.isEditable = !this.data.noHTML;
// We want to be able to add mouse listeners to the annotation.
this.data.noHTML = false;

Expand Down
6 changes: 5 additions & 1 deletion src/core/document.js
Original file line number Diff line number Diff line change
Expand Up @@ -531,6 +531,8 @@ class Page {
});
});

const { isEditing, modifiedIds } = this.pdfManager;

// Fetch the page's annotations and add their operator lists to the
// page's operator list to render them.
return Promise.all([
Expand Down Expand Up @@ -579,7 +581,9 @@ class Page {
if (
intentAny ||
(intentDisplay &&
annotation.mustBeViewed(annotationStorage, renderForms)) ||
annotation.mustBeViewed(annotationStorage, renderForms) &&
((isEditing && annotation.mustBeViewedWhenEditing()) ||
(!isEditing && !modifiedIds?.has(annotation.data.id)))) ||
(intentPrint && annotation.mustBePrinted(annotationStorage))
) {
opListPromises.push(
Expand Down
7 changes: 7 additions & 0 deletions src/core/pdf_manager.js
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,8 @@ class BasePdfManager {
this._docId = args.docId;
this._password = args.password;
this.enableXfa = args.enableXfa;
this.isEditing = false;
this.modifiedIds = null;

// Check `OffscreenCanvas` support once, rather than repeatedly throughout
// the worker-thread code.
Expand Down Expand Up @@ -127,6 +129,11 @@ class BasePdfManager {
terminate(reason) {
unreachable("Abstract method `terminate` called");
}

switchToEditingMode({ isEditing, modifiedIds }) {
this.isEditing = isEditing;
this.modifiedIds = modifiedIds ? new Set(modifiedIds) : null;
}
}

class LocalPdfManager extends BasePdfManager {
Expand Down
4 changes: 4 additions & 0 deletions src/core/worker.js
Original file line number Diff line number Diff line change
Expand Up @@ -873,6 +873,10 @@ class WorkerMessageHandler {
docParams = null; // we don't need docParams anymore -- saving memory.
});

handler.on("SwitchToEditingMode", function (data) {
return pdfManager.switchToEditingMode(data);
});

if (typeof PDFJSDev === "undefined" || PDFJSDev.test("TESTING")) {
handler.on("GetXFADatasets", function (data) {
return pdfManager.ensureDoc("xfaDatasets");
Expand Down
18 changes: 9 additions & 9 deletions src/display/annotation_layer.js
Original file line number Diff line number Diff line change
Expand Up @@ -198,6 +198,10 @@ class AnnotationElement {
return !!(titleObj?.str || contentsObj?.str || richText?.str);
}

get _isEditable() {
return this.data.isEditable;
}

get hasPopupData() {
return AnnotationElement._hasPopupData(this.data);
}
Expand Down Expand Up @@ -734,10 +738,6 @@ class AnnotationElement {
}
}

get _isEditable() {
return false;
}

_editOnDoubleClick() {
if (!this._isEditable) {
return;
Expand Down Expand Up @@ -2530,10 +2530,6 @@ class FreeTextAnnotationElement extends AnnotationElement {

return this.container;
}

get _isEditable() {
return this.data.hasOwnCanvas;
}
}

class LineAnnotationElement extends AnnotationElement {
Expand Down Expand Up @@ -3107,6 +3103,10 @@ class AnnotationLayer {
}
}

hasEditableAnnotations() {
return this.#editableAnnotations.size > 0;
}

#appendElement(element, id) {
const contentElement = element.firstChild || element;
contentElement.id = `${AnnotationPrefix}${id}`;
Expand Down Expand Up @@ -3188,7 +3188,7 @@ class AnnotationLayer {
}
this.#appendElement(rendered, data.id);

if (element.annotationEditorType > 0) {
if (element._isEditable) {
this.#editableAnnotations.set(element.data.id, element);
this._annotationEditorUIManager?.renderAnnotationElement(element);
}
Expand Down
15 changes: 15 additions & 0 deletions src/display/annotation_storage.js
Original file line number Diff line number Diff line change
Expand Up @@ -248,6 +248,21 @@ class AnnotationStorage {
}
return stats;
}

get modifiedIds() {
let ids = null;
for (const value of this.#storage.values()) {
if (
!(value instanceof AnnotationEditor) ||
!value.annotationElementId ||
!value.serialize()
) {
continue;
}
(ids ||= []).push(value.annotationElementId);
}
return ids;
}
}

/**
Expand Down
18 changes: 17 additions & 1 deletion src/display/api.js
Original file line number Diff line number Diff line change
Expand Up @@ -1103,6 +1103,13 @@ class PDFDocumentProxy {
getCalculationOrderIds() {
return this._transport.getCalculationOrderIds();
}

/**
* Switch to editing mode, which allows for editing annotations.
*/
switchToEditingMode(isEditing) {
return this._transport.switchToEditingMode(isEditing);
}
}

/**
Expand Down Expand Up @@ -1422,6 +1429,7 @@ class PDFPageProxy {
annotationCanvasMap = null,
pageColors = null,
printAnnotationStorage = null,
noCache = false,
}) {
this._stats?.time("Overall");

Expand All @@ -1440,7 +1448,7 @@ class PDFPageProxy {
optionalContentConfigPromise ||=
this._transport.getOptionalContentConfig(renderingIntent);

let intentState = this._intentStates.get(cacheKey);
let intentState = noCache ? null : this._intentStates.get(cacheKey);
if (!intentState) {
intentState = Object.create(null);
this._intentStates.set(cacheKey, intentState);
Expand Down Expand Up @@ -3098,6 +3106,14 @@ class WorkerTransport {
const refStr = ref.gen === 0 ? `${ref.num}R` : `${ref.num}R${ref.gen}`;
return this.#pageRefCache.get(refStr) ?? null;
}

switchToEditingMode(isEditing) {
const modifiedIds = isEditing ? null : this.annotationStorage.modifiedIds;
this.messageHandler.sendWithPromise("SwitchToEditingMode", {
isEditing,
modifiedIds,
});
}
}

const INITIAL_DATA = Symbol("INITIAL_DATA");
Expand Down
Loading

0 comments on commit bf93f39

Please sign in to comment.