[api-minor] Improve thumbnail handling in documents that contain interactive forms

src/core/annotation.js

@@ -881,7 +881,11 @@ class Annotation {
  );
  if (!appearance) {
  if (!isUsingOwnCanvas) {
- return new OperatorList();
+ return {
+ opList: new OperatorList(),
+ separateForm: false,
+ separateCanvas: false,
+ };
  }
  appearance = new StringStream("");
  appearance.dict = new Dict();
@@ -930,7 +934,7 @@ class Annotation {
  opList.addOp(OPS.endMarkedContent, []);
  }
  this.reset();
- return opList;
+ return { opList, separateForm: false, separateCanvas: isUsingOwnCanvas };
  }
 
  async save(evaluator, task, annotationStorage) {
@@ -1619,7 +1623,11 @@ class WidgetAnnotation extends Annotation {
  // Do not render form elements on the canvas when interactive forms are
  // enabled. The display layer is responsible for rendering them instead.
  if (renderForms && !(this instanceof SignatureWidgetAnnotation)) {
- return new OperatorList();
+ return {
+ opList: new OperatorList(),
+ separateForm: true,
+ separateCanvas: false,
+ };
  }
 
  if (!this._hasText) {
@@ -1647,12 +1655,12 @@ class WidgetAnnotation extends Annotation {
  );
  }
 
- const operatorList = new OperatorList();
+ const opList = new OperatorList();
 
  // Even if there is an appearance stream, ignore it. This is the
  // behaviour used by Adobe Reader.
  if (!this._defaultAppearance || content === null) {
- return operatorList;
+ return { opList, separateForm: false, separateCanvas: false };
  }
 
  const matrix = [1, 0, 0, 1, 0, 0];
@@ -1672,10 +1680,10 @@ class WidgetAnnotation extends Annotation {
  );
  }
  if (optionalContent !== undefined) {
- operatorList.addOp(OPS.beginMarkedContentProps, ["OC", optionalContent]);
+ opList.addOp(OPS.beginMarkedContentProps, ["OC", optionalContent]);
  }
 
- operatorList.addOp(OPS.beginAnnotation, [
+ opList.addOp(OPS.beginAnnotation, [
  this.data.id,
  this.data.rect,
  transform,
@@ -1688,14 +1696,14 @@ class WidgetAnnotation extends Annotation {
  stream,
  task,
  resources: this._fieldResources.mergedResources,
- operatorList,
+ operatorList: opList,
  });
- operatorList.addOp(OPS.endAnnotation, []);
+ opList.addOp(OPS.endAnnotation, []);
 
  if (optionalContent !== undefined) {
- operatorList.addOp(OPS.endMarkedContent, []);
+ opList.addOp(OPS.endMarkedContent, []);
  }
- return operatorList;
+ return { opList, separateForm: false, separateCanvas: false };
  }
 
  _getMKDict(rotation) {
@@ -2477,7 +2485,11 @@ class ButtonWidgetAnnotation extends WidgetAnnotation {
  }
 
  // No appearance
- return new OperatorList();
+ return {
+ opList: new OperatorList(),
+ separateForm: false,
+ separateCanvas: false,
+ };
  }
 
  async save(evaluator, task, annotationStorage) {

src/core/document.js

@@ -455,7 +455,7 @@ class Page {
  annotations.length === 0 ||
  intent & RenderingIntentFlag.ANNOTATIONS_DISABLE
  ) {
- pageOpList.flush(true);
+ pageOpList.flush(/* lastChunk = */ true);
  return { length: pageOpList.totalLength };
  }
  const renderForms = !!(intent & RenderingIntentFlag.ANNOTATIONS_FORMS),
@@ -493,10 +493,23 @@ class Page {
  }
 
  return Promise.all(opListPromises).then(function (opLists) {
- for (const opList of opLists) {
+ let form = false,
+ canvas = false;
+
+ for (const { opList, separateForm, separateCanvas } of opLists) {
  pageOpList.addOpList(opList);
+
+ if (separateForm) {
+ form = separateForm;
+ }
+ if (separateCanvas) {
+ canvas = separateCanvas;
+ }
  }
- pageOpList.flush(true);
+ pageOpList.flush(
+ /* lastChunk = */ true,
+ /* separateAnnots = */ { form, canvas }
+ );
  return { length: pageOpList.totalLength };
  });
  });

src/core/operator_list.js

@@ -690,7 +690,7 @@ class OperatorList {
  return transfers;
  }
 
- flush(lastChunk = false) {
+ flush(lastChunk = false, separateAnnots = null) {
  this.optimizer.flush();
  const length = this.length;
  this._totalLength += length;
@@ -700,6 +700,7 @@ class OperatorList {
  fnArray: this.fnArray,
  argsArray: this.argsArray,
  lastChunk,
+ separateAnnots,
  length,
  },
  1,

src/display/api.js

@@ -1477,6 +1477,7 @@ class PDFPageProxy {
  fnArray: [],
  argsArray: [],
  lastChunk: false,
+ separateAnnots: null,
  };
 
  if (this._stats) {
@@ -1599,6 +1600,7 @@ class PDFPageProxy {
  fnArray: [],
  argsArray: [],
  lastChunk: false,
+ separateAnnots: null,
  };
 
  if (this._stats) {
@@ -1795,6 +1797,7 @@ class PDFPageProxy {
  intentState.operatorList.argsArray.push(operatorListChunk.argsArray[i]);
  }
  intentState.operatorList.lastChunk = operatorListChunk.lastChunk;
+ intentState.operatorList.separateAnnots = operatorListChunk.separateAnnots;
 
  // Notify all the rendering tasks there are more operators to be consumed.
  for (const internalRenderTask of intentState.renderTasks) {
@@ -3194,8 +3197,10 @@ class PDFObjects {
  * Allows controlling of the rendering tasks.
  */
 class RenderTask {
+ #internalRenderTask = null;
+
  constructor(internalRenderTask) {
- this._internalRenderTask = internalRenderTask;
+ this.#internalRenderTask = internalRenderTask;
 
  /**
  * Callback for incremental rendering -- a function that will be called
@@ -3211,7 +3216,7 @@ class RenderTask {
  * @type {Promise<void>}
  */
  get promise() {
- return this._internalRenderTask.capability.promise;
+ return this.#internalRenderTask.capability.promise;
  }
 
  /**
@@ -3220,7 +3225,23 @@ class RenderTask {
  * this object extends will be rejected when cancelled.
  */
  cancel() {
- this._internalRenderTask.cancel();
+ this.#internalRenderTask.cancel();
+ }
+
+ /**
+ * Whether form fields are rendered separately from the main operatorList.
+ * @type {boolean}
+ */
+ get separateAnnots() {
+ const { separateAnnots } = this.#internalRenderTask.operatorList;
+ if (!separateAnnots) {
+ return false;
+ }
+ const { annotationCanvasMap } = this.#internalRenderTask;
+ return (
+ separateAnnots.form ||
+ (separateAnnots.canvas && annotationCanvasMap?.size > 0)
+ );
  }
 }