[Editor] Add the possibility to change the thickness of a free highli…

…ght (bug 1876096)
mozilla · Jan 23, 2024 · 8691355 · 8691355
1 parent ae62787
commit 8691355
Show file tree

Hide file tree

Showing 12 changed files with 346 additions and 52 deletions.
diff --git a/l10n/en-US/viewer.ftl b/l10n/en-US/viewer.ftl
@@ -349,6 +349,8 @@ pdfjs-editor-ink-opacity-input = Opacity
 pdfjs-editor-stamp-add-image-button =
     .title = Add image
 pdfjs-editor-stamp-add-image-button-label = Add image
+# This refers to the thickness of the line used for free highlighting (not bound to text)
+pdfjs-editor-free-highlight-thickness-input = Thickness
 
 pdfjs-free-text =
     .aria-label = Text Editor

diff --git a/src/display/draw_layer.js b/src/display/draw_layer.js
@@ -155,6 +155,14 @@ class DrawLayer {
     path.setAttribute("d", line.toSVGPath());
   }
 
+  updateLine(id, line) {
+    const root = this.#mapping.get(id);
+    const defs = root.firstChild;
+    const path = defs.firstChild;
+    this.updateBox(id, line.box);
+    path.setAttribute("d", line.toSVGPath());
+  }
+
   removeFreeHighlight(id) {
     this.remove(id);
     this.#toUpdate.delete(id);

diff --git a/src/display/editor/annotation_editor_layer.js b/src/display/editor/annotation_editor_layer.js
@@ -359,7 +359,11 @@ class AnnotationEditorLayer {
         // Do nothing on right click.
         return;
       }
-      HighlightEditor.startHighlighting(this, event);
+      HighlightEditor.startHighlighting(
+        this,
+        this.#uiManager.direction === "ltr",
+        event
+      );
       event.preventDefault();
     }
   }

diff --git a/src/display/editor/editor.js b/src/display/editor/editor.js
@@ -472,7 +472,7 @@ class AnnotationEditor {
     // the position: it'll be done when the user will release the mouse button.
 
     let { x, y } = this;
-    const [bx, by] = this.#getBaseTranslation();
+    const [bx, by] = this.getBaseTranslation();
     x += bx;
     y += by;
 
@@ -481,7 +481,14 @@ class AnnotationEditor {
     this.div.scrollIntoView({ block: "nearest" });
   }
 
-  #getBaseTranslation() {
+  /**
+   * Get the translation to take into account the editor border.
+   * The CSS engine positions the element in taking into account the border so
+   * we must apply the opposite translation to have the editor in the right
+   * position.
+   * @returns {Array<number>}
+   */
+  getBaseTranslation() {
     const [parentWidth, parentHeight] = this.parentDimensions;
     const { _borderLineWidth } = AnnotationEditor;
     const x = _borderLineWidth / parentWidth;
@@ -532,7 +539,7 @@ class AnnotationEditor {
     this.x = x /= pageWidth;
     this.y = y /= pageHeight;
 
-    const [bx, by] = this.#getBaseTranslation();
+    const [bx, by] = this.getBaseTranslation();
     x += bx;
     y += by;
 

diff --git a/src/display/editor/highlight.js b/src/display/editor/highlight.js
@@ -19,10 +19,10 @@ import {
   Util,
 } from "../../shared/util.js";
 import { FreeOutliner, Outliner } from "./outliner.js";
+import { noContextMenu, PixelsPerInch } from "../display_utils.js";
 import { AnnotationEditor } from "./editor.js";
 import { bindEvents } from "./tools.js";
 import { ColorPicker } from "./color_picker.js";
-import { noContextMenu } from "../display_utils.js";
 
 /**
  * Basic draw editor in order to generate an Highlight annotation.
@@ -50,11 +50,13 @@ class HighlightEditor extends AnnotationEditor {
 
   #outlineId = null;
 
+  #thickness;
+
   static _defaultColor = null;
 
   static _defaultOpacity = 1;
 
-  static _defaultThickness = 10;
+  static _defaultThickness = 12;
 
   static _l10nPromise;
 
@@ -71,6 +73,7 @@ class HighlightEditor extends AnnotationEditor {
   constructor(params) {
     super({ ...params, name: "highlightEditor" });
     this.color = params.color || HighlightEditor._defaultColor;
+    this.#thickness = params.thickness || HighlightEditor._defaultThickness;
     this.#opacity = params.opacity || HighlightEditor._defaultOpacity;
     this.#boxes = params.boxes || null;
     this._isDraggable = false;
@@ -113,16 +116,20 @@ class HighlightEditor extends AnnotationEditor {
   }
 
   #createFreeOutlines({ highlight, highlightId, clipPathId }) {
-    this.#highlightOutlines = highlight.getOutlines(
-      this._uiManager.direction === "ltr"
-    );
-    this.#id = highlightId;
-    this.#clipPathId = clipPathId;
-    const { x, y, width, height, lastPoint } = this.#highlightOutlines.box;
+    this.#highlightOutlines = highlight;
+    if (highlightId >= 0) {
+      this.#id = highlightId;
+      this.#clipPathId = clipPathId;
+    }
+    const { x, y, width, height, lastPoint } = highlight.box;
 
-    // We need to redraw the highlight because we change the coordinates to be
-    // in the box coordinate system.
-    this.parent.drawLayer.finalizeLine(this.#id, this.#highlightOutlines);
+    if (highlightId >= 0) {
+      // We need to redraw the highlight because we change the coordinates to be
+      // in the box coordinate system.
+      this.parent.drawLayer.finalizeLine(highlightId, highlight);
+    } else {
+      this.parent?.drawLayer.updateLine(this.#id, highlight);
+    }
     switch (this.rotation) {
       case 0:
         this.x = x;
@@ -154,29 +161,43 @@ class HighlightEditor extends AnnotationEditor {
       }
     }
 
-    const innerMargin = 1.5;
-    this.#focusOutlines = highlight.getFocusOutline(
+    const extraThickness = 1.5;
+    this.#focusOutlines = highlight.getNewOutline(
       /* Slightly bigger than the highlight in order to have a little
          space between the highlight and the outline. */
-      HighlightEditor._defaultThickness + innerMargin
-    );
-    this.#outlineId = this.parent.drawLayer.highlightOutline(
-      this.#focusOutlines
+      this.#thickness / 2 + extraThickness,
+      /* innerMargin = */ 0.0025
     );
+
+    if (highlightId >= 0) {
+      this.#outlineId = this.parent.drawLayer.highlightOutline(
+        this.#focusOutlines
+      );
+    } else {
+      this.parent?.drawLayer.updateLine(this.#outlineId, this.#focusOutlines);
+    }
     this.#lastPoint = lastPoint;
   }
 
+  /** @inheritdoc */
   static initialize(l10n, uiManager) {
     AnnotationEditor.initialize(l10n, uiManager);
     HighlightEditor._defaultColor ||=
       uiManager.highlightColors?.values().next().value || "#fff066";
+    document
+      .getElementById("editorHighlightThickness")
+      .style.setProperty("--pdf-to-css-units", PixelsPerInch.PDF_TO_CSS_UNITS);
   }
 
+  /** @inheritdoc */
   static updateDefaultParams(type, value) {
     switch (type) {
       case AnnotationEditorParamsType.HIGHLIGHT_DEFAULT_COLOR:
         HighlightEditor._defaultColor = value;
         break;
+      case AnnotationEditorParamsType.HIGHLIGHT_THICKNESS:
+        HighlightEditor._defaultThickness = value;
+        break;
     }
   }
 
@@ -194,6 +215,9 @@ class HighlightEditor extends AnnotationEditor {
       case AnnotationEditorParamsType.HIGHLIGHT_COLOR:
         this.#updateColor(value);
         break;
+      case AnnotationEditorParamsType.HIGHLIGHT_THICKNESS:
+        this.#updateThickness(value);
+        break;
     }
   }
 
@@ -203,6 +227,10 @@ class HighlightEditor extends AnnotationEditor {
         AnnotationEditorParamsType.HIGHLIGHT_DEFAULT_COLOR,
         HighlightEditor._defaultColor,
       ],
+      [
+        AnnotationEditorParamsType.HIGHLIGHT_THICKNESS,
+        HighlightEditor._defaultThickness,
+      ],
     ];
   }
 
@@ -213,6 +241,10 @@ class HighlightEditor extends AnnotationEditor {
         AnnotationEditorParamsType.HIGHLIGHT_COLOR,
         this.color || HighlightEditor._defaultColor,
       ],
+      [
+        AnnotationEditorParamsType.HIGHLIGHT_THICKNESS,
+        this.#thickness || HighlightEditor._defaultThickness,
+      ],
     ];
   }
 
@@ -240,6 +272,28 @@ class HighlightEditor extends AnnotationEditor {
     });
   }
 
+  /**
+   * Update the thickness and make this action undoable.
+   * @param {number} thickness
+   */
+  #updateThickness(thickness) {
+    const savedThickness = this.#thickness;
+    this.addCommands({
+      cmd: () => {
+        this.#thickness = thickness;
+        this.#changeThickness(thickness);
+      },
+      undo: () => {
+        this.#thickness = savedThickness;
+        this.#changeThickness(savedThickness);
+      },
+      mustExec: true,
+      type: AnnotationEditorParamsType.INK_THICKNESS,
+      overwriteIfSameType: true,
+      keepUndo: true,
+    });
+  }
+
   /** @inheritdoc */
   async addEditToolbar() {
     const toolbar = await super.addEditToolbar();
@@ -270,6 +324,13 @@ class HighlightEditor extends AnnotationEditor {
     return super.fixAndSetPosition(this.#getRotation());
   }
 
+  /** @inheritdoc */
+  getBaseTranslation() {
+    // The editor itself doesn't have any CSS border (we're drawing one
+    // ourselves in using SVG).
+    return [0, 0];
+  }
+
   /** @inheritdoc */
   getRect(tx, ty) {
     return super.getRect(tx, ty, this.#getRotation());
@@ -324,6 +385,18 @@ class HighlightEditor extends AnnotationEditor {
     }
   }
 
+  #changeThickness(thickness) {
+    if (!this.#isFreeHighlight) {
+      return;
+    }
+    this.#createFreeOutlines({
+      highlight: this.#highlightOutlines.getNewOutline(thickness / 2),
+    });
+    this.fixAndSetPosition();
+    const [parentWidth, parentHeight] = this.parentDimensions;
+    this.setDims(this.width * parentWidth, this.height * parentHeight);
+  }
+
   #cleanDrawLayer() {
     if (this.#id === null || !this.parent) {
       return;
@@ -482,7 +555,7 @@ class HighlightEditor extends AnnotationEditor {
     return this.#highlightOutlines.serialize(rect, this.#getRotation());
   }
 
-  static startHighlighting(parent, { target: textLayer, x, y }) {
+  static startHighlighting(parent, isLTR, { target: textLayer, x, y }) {
     const {
       x: layerX,
       y: layerY,
@@ -520,7 +593,8 @@ class HighlightEditor extends AnnotationEditor {
       { x, y },
       [layerX, layerY, parentWidth, parentHeight],
       parent.scale,
-      this._defaultThickness,
+      this._defaultThickness / 2,
+      isLTR,
       /* innerMargin = */ 0.001
     );
     ({ id: this._freeHighlightId, clipPathId: this._freeHighlightClipId } =
@@ -543,7 +617,7 @@ class HighlightEditor extends AnnotationEditor {
     if (!this._freeHighlight.isEmpty()) {
       parent.createAndAddNewEditor(event, false, {
         highlightId: this._freeHighlightId,
-        highlight: this._freeHighlight,
+        highlight: this._freeHighlight.getOutlines(),
         clipPathId: this._freeHighlightClipId,
       });
     } else {
@@ -597,7 +671,7 @@ class HighlightEditor extends AnnotationEditor {
       annotationType: AnnotationEditorType.HIGHLIGHT,
       color,
       opacity: this.#opacity,
-      thickness: 2 * HighlightEditor._defaultThickness,
+      thickness: this.#thickness,
       quadPoints: this.#serializeBoxes(rect),
       outlines: this.#serializeOutlines(rect),
       pageIndex: this.pageIndex,