Spaces:
Running
Running
File size: 16,259 Bytes
3c778ff | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 | import PDFDocument from 'src/api/PDFDocument';
import PDFFont from 'src/api/PDFFont';
import { AppearanceMapping } from 'src/api/form/appearances';
import { Color, colorToComponents, setFillingColor } from 'src/api/colors';
import {
Rotation,
toDegrees,
rotateRectangle,
reduceRotation,
adjustDimsForRotation,
degrees,
} from 'src/api/rotations';
import {
PDFRef,
PDFWidgetAnnotation,
PDFOperator,
PDFName,
PDFDict,
MethodNotImplementedError,
AcroFieldFlags,
PDFAcroTerminal,
AnnotationFlags,
} from 'src/core';
import { assertIs, assertMultiple, assertOrUndefined } from 'src/utils';
import { ImageAlignment } from '../image';
import PDFImage from '../PDFImage';
import { drawImage, rotateInPlace } from '../operations';
export interface FieldAppearanceOptions {
x?: number;
y?: number;
width?: number;
height?: number;
textColor?: Color;
backgroundColor?: Color;
borderColor?: Color;
borderWidth?: number;
rotate?: Rotation;
font?: PDFFont;
hidden?: boolean;
}
export const assertFieldAppearanceOptions = (
options?: FieldAppearanceOptions,
) => {
assertOrUndefined(options?.x, 'options.x', ['number']);
assertOrUndefined(options?.y, 'options.y', ['number']);
assertOrUndefined(options?.width, 'options.width', ['number']);
assertOrUndefined(options?.height, 'options.height', ['number']);
assertOrUndefined(options?.textColor, 'options.textColor', [
[Object, 'Color'],
]);
assertOrUndefined(options?.backgroundColor, 'options.backgroundColor', [
[Object, 'Color'],
]);
assertOrUndefined(options?.borderColor, 'options.borderColor', [
[Object, 'Color'],
]);
assertOrUndefined(options?.borderWidth, 'options.borderWidth', ['number']);
assertOrUndefined(options?.rotate, 'options.rotate', [[Object, 'Rotation']]);
};
/**
* Represents a field of a [[PDFForm]].
*
* This class is effectively abstract. All fields in a [[PDFForm]] will
* actually be an instance of a subclass of this class.
*
* Note that each field in a PDF is represented by a single field object.
* However, a given field object may be rendered at multiple locations within
* the document (across one or more pages). The rendering of a field is
* controlled by its widgets. Each widget causes its field to be displayed at a
* particular location in the document.
*
* Most of the time each field in a PDF has only a single widget, and thus is
* only rendered once. However, if a field is rendered multiple times, it will
* have multiple widgets - one for each location it is rendered.
*
* This abstraction of field objects and widgets is defined in the PDF
* specification and dictates how PDF files store fields and where they are
* to be rendered.
*/
export default class PDFField {
/** The low-level PDFAcroTerminal wrapped by this field. */
readonly acroField: PDFAcroTerminal;
/** The unique reference assigned to this field within the document. */
readonly ref: PDFRef;
/** The document to which this field belongs. */
readonly doc: PDFDocument;
protected constructor(
acroField: PDFAcroTerminal,
ref: PDFRef,
doc: PDFDocument,
) {
assertIs(acroField, 'acroField', [[PDFAcroTerminal, 'PDFAcroTerminal']]);
assertIs(ref, 'ref', [[PDFRef, 'PDFRef']]);
assertIs(doc, 'doc', [[PDFDocument, 'PDFDocument']]);
this.acroField = acroField;
this.ref = ref;
this.doc = doc;
}
/**
* Get the fully qualified name of this field. For example:
* ```js
* const fields = form.getFields()
* fields.forEach(field => {
* const name = field.getName()
* console.log('Field name:', name)
* })
* ```
* Note that PDF fields are structured as a tree. Each field is the
* descendent of a series of ancestor nodes all the way up to the form node,
* which is always the root of the tree. Each node in the tree (except for
* the form node) has a partial name. Partial names can be composed of any
* unicode characters except a period (`.`). The fully qualified name of a
* field is composed of the partial names of all its ancestors joined
* with periods. This means that splitting the fully qualified name on
* periods and taking the last element of the resulting array will give you
* the partial name of a specific field.
* @returns The fully qualified name of this field.
*/
getName(): string {
return this.acroField.getFullyQualifiedName() ?? '';
}
/**
* Returns `true` if this field is read only. This means that PDF readers
* will not allow users to interact with the field or change its value. See
* [[PDFField.enableReadOnly]] and [[PDFField.disableReadOnly]].
* For example:
* ```js
* const field = form.getField('some.field')
* if (field.isReadOnly()) console.log('Read only is enabled')
* ```
* @returns Whether or not this is a read only field.
*/
isReadOnly(): boolean {
return this.acroField.hasFlag(AcroFieldFlags.ReadOnly);
}
/**
* Prevent PDF readers from allowing users to interact with this field or
* change its value. The field will not respond to mouse or keyboard input.
* For example:
* ```js
* const field = form.getField('some.field')
* field.enableReadOnly()
* ```
* Useful for fields whose values are computed, imported from a database, or
* prefilled by software before being displayed to the user.
*/
enableReadOnly() {
this.acroField.setFlagTo(AcroFieldFlags.ReadOnly, true);
}
/**
* Allow users to interact with this field and change its value in PDF
* readers via mouse and keyboard input. For example:
* ```js
* const field = form.getField('some.field')
* field.disableReadOnly()
* ```
*/
disableReadOnly() {
this.acroField.setFlagTo(AcroFieldFlags.ReadOnly, false);
}
/**
* Returns `true` if this field must have a value when the form is submitted.
* See [[PDFField.enableRequired]] and [[PDFField.disableRequired]].
* For example:
* ```js
* const field = form.getField('some.field')
* if (field.isRequired()) console.log('Field is required')
* ```
* @returns Whether or not this field is required.
*/
isRequired(): boolean {
return this.acroField.hasFlag(AcroFieldFlags.Required);
}
/**
* Require this field to have a value when the form is submitted.
* For example:
* ```js
* const field = form.getField('some.field')
* field.enableRequired()
* ```
*/
enableRequired() {
this.acroField.setFlagTo(AcroFieldFlags.Required, true);
}
/**
* Do not require this field to have a value when the form is submitted.
* For example:
* ```js
* const field = form.getField('some.field')
* field.disableRequired()
* ```
*/
disableRequired() {
this.acroField.setFlagTo(AcroFieldFlags.Required, false);
}
/**
* Returns `true` if this field's value should be exported when the form is
* submitted. See [[PDFField.enableExporting]] and
* [[PDFField.disableExporting]].
* For example:
* ```js
* const field = form.getField('some.field')
* if (field.isExported()) console.log('Exporting is enabled')
* ```
* @returns Whether or not this field's value should be exported.
*/
isExported(): boolean {
return !this.acroField.hasFlag(AcroFieldFlags.NoExport);
}
/**
* Indicate that this field's value should be exported when the form is
* submitted in a PDF reader. For example:
* ```js
* const field = form.getField('some.field')
* field.enableExporting()
* ```
*/
enableExporting() {
this.acroField.setFlagTo(AcroFieldFlags.NoExport, false);
}
/**
* Indicate that this field's value should **not** be exported when the form
* is submitted in a PDF reader. For example:
* ```js
* const field = form.getField('some.field')
* field.disableExporting()
* ```
*/
disableExporting() {
this.acroField.setFlagTo(AcroFieldFlags.NoExport, true);
}
/** @ignore */
needsAppearancesUpdate(): boolean {
throw new MethodNotImplementedError(
this.constructor.name,
'needsAppearancesUpdate',
);
}
/** @ignore */
defaultUpdateAppearances(_font: PDFFont) {
throw new MethodNotImplementedError(
this.constructor.name,
'defaultUpdateAppearances',
);
}
protected markAsDirty() {
this.doc.getForm().markFieldAsDirty(this.ref);
}
protected markAsClean() {
this.doc.getForm().markFieldAsClean(this.ref);
}
protected isDirty(): boolean {
return this.doc.getForm().fieldIsDirty(this.ref);
}
protected createWidget(options: {
x: number;
y: number;
width: number;
height: number;
textColor?: Color;
backgroundColor?: Color;
borderColor?: Color;
borderWidth: number;
rotate: Rotation;
caption?: string;
hidden?: boolean;
page?: PDFRef;
}): PDFWidgetAnnotation {
const textColor = options.textColor;
const backgroundColor = options.backgroundColor;
const borderColor = options.borderColor;
const borderWidth = options.borderWidth;
const degreesAngle = toDegrees(options.rotate);
const caption = options.caption;
const x = options.x;
const y = options.y;
const width = options.width + borderWidth;
const height = options.height + borderWidth;
const hidden = Boolean(options.hidden);
const pageRef = options.page;
assertMultiple(degreesAngle, 'degreesAngle', 90);
// Create a widget for this field
const widget = PDFWidgetAnnotation.create(this.doc.context, this.ref);
// Set widget properties
const rect = rotateRectangle(
{ x, y, width, height },
borderWidth,
degreesAngle,
);
widget.setRectangle(rect);
if (pageRef) widget.setP(pageRef);
const ac = widget.getOrCreateAppearanceCharacteristics();
if (backgroundColor) {
ac.setBackgroundColor(colorToComponents(backgroundColor));
}
ac.setRotation(degreesAngle);
if (caption) ac.setCaptions({ normal: caption });
if (borderColor) ac.setBorderColor(colorToComponents(borderColor));
const bs = widget.getOrCreateBorderStyle();
if (borderWidth !== undefined) bs.setWidth(borderWidth);
widget.setFlagTo(AnnotationFlags.Print, true);
widget.setFlagTo(AnnotationFlags.Hidden, hidden);
widget.setFlagTo(AnnotationFlags.Invisible, false);
// Set acrofield properties
if (textColor) {
const da = this.acroField.getDefaultAppearance() ?? '';
const newDa = da + '\n' + setFillingColor(textColor).toString();
this.acroField.setDefaultAppearance(newDa);
}
return widget;
}
protected updateWidgetAppearanceWithFont(
widget: PDFWidgetAnnotation,
font: PDFFont,
{ normal, rollover, down }: AppearanceMapping<PDFOperator[]>,
) {
this.updateWidgetAppearances(widget, {
normal: this.createAppearanceStream(widget, normal, font),
rollover: rollover && this.createAppearanceStream(widget, rollover, font),
down: down && this.createAppearanceStream(widget, down, font),
});
}
protected updateOnOffWidgetAppearance(
widget: PDFWidgetAnnotation,
onValue: PDFName,
{
normal,
rollover,
down,
}: AppearanceMapping<{ on: PDFOperator[]; off: PDFOperator[] }>,
) {
this.updateWidgetAppearances(widget, {
normal: this.createAppearanceDict(widget, normal, onValue),
rollover:
rollover && this.createAppearanceDict(widget, rollover, onValue),
down: down && this.createAppearanceDict(widget, down, onValue),
});
}
protected updateWidgetAppearances(
widget: PDFWidgetAnnotation,
{ normal, rollover, down }: AppearanceMapping<PDFRef | PDFDict>,
) {
widget.setNormalAppearance(normal);
if (rollover) {
widget.setRolloverAppearance(rollover);
} else {
widget.removeRolloverAppearance();
}
if (down) {
widget.setDownAppearance(down);
} else {
widget.removeDownAppearance();
}
}
// // TODO: Do we need to do this...?
// private foo(font: PDFFont, dict: PDFDict) {
// if (!dict.lookup(PDFName.of('DR'))) {
// dict.set(PDFName.of('DR'), dict.context.obj({}));
// }
// const DR = dict.lookup(PDFName.of('DR'), PDFDict);
// if (!DR.lookup(PDFName.of('Font'))) {
// DR.set(PDFName.of('Font'), dict.context.obj({}));
// }
// const Font = DR.lookup(PDFName.of('Font'), PDFDict);
// Font.set(PDFName.of(font.name), font.ref);
// }
private createAppearanceStream(
widget: PDFWidgetAnnotation,
appearance: PDFOperator[],
font?: PDFFont,
): PDFRef {
const { context } = this.acroField.dict;
const { width, height } = widget.getRectangle();
// TODO: Do we need to do this...?
// if (font) {
// this.foo(font, widget.dict);
// this.foo(font, this.doc.getForm().acroForm.dict);
// }
// END TODO
const Resources = font && { Font: { [font.name]: font.ref } };
const stream = context.formXObject(appearance, {
Resources,
BBox: context.obj([0, 0, width, height]),
Matrix: context.obj([1, 0, 0, 1, 0, 0]),
});
const streamRef = context.register(stream);
return streamRef;
}
/**
* Create a FormXObject of the supplied image and add it to context.
* The FormXObject size is calculated based on the widget (including
* the alignment).
* @param widget The widget that should display the image.
* @param alignment The alignment of the image.
* @param image The image that should be displayed.
* @returns The ref for the FormXObject that was added to the context.
*/
protected createImageAppearanceStream(
widget: PDFWidgetAnnotation,
image: PDFImage,
alignment: ImageAlignment,
): PDFRef {
// NOTE: This implementation doesn't handle image borders.
// NOTE: Acrobat seems to resize the image (maybe even skewing its aspect
// ratio) to fit perfectly within the widget's rectangle. This method
// does not currently do that. Should there be an option for that?
const { context } = this.acroField.dict;
const rectangle = widget.getRectangle();
const ap = widget.getAppearanceCharacteristics();
const bs = widget.getBorderStyle();
const borderWidth = bs?.getWidth() ?? 0;
const rotation = reduceRotation(ap?.getRotation());
const rotate = rotateInPlace({ ...rectangle, rotation });
const adj = adjustDimsForRotation(rectangle, rotation);
const imageDims = image.scaleToFit(
adj.width - borderWidth * 2,
adj.height - borderWidth * 2,
);
// Support borders on images and maybe other properties
const options = {
x: borderWidth,
y: borderWidth,
width: imageDims.width,
height: imageDims.height,
//
rotate: degrees(0),
xSkew: degrees(0),
ySkew: degrees(0),
};
if (alignment === ImageAlignment.Center) {
options.x += (adj.width - borderWidth * 2) / 2 - imageDims.width / 2;
options.y += (adj.height - borderWidth * 2) / 2 - imageDims.height / 2;
} else if (alignment === ImageAlignment.Right) {
options.x = adj.width - borderWidth - imageDims.width;
options.y = adj.height - borderWidth - imageDims.height;
}
const imageName = this.doc.context.addRandomSuffix('Image', 10);
const appearance = [...rotate, ...drawImage(imageName, options)];
////////////
const Resources = { XObject: { [imageName]: image.ref } };
const stream = context.formXObject(appearance, {
Resources,
BBox: context.obj([0, 0, rectangle.width, rectangle.height]),
Matrix: context.obj([1, 0, 0, 1, 0, 0]),
});
return context.register(stream);
}
private createAppearanceDict(
widget: PDFWidgetAnnotation,
appearance: { on: PDFOperator[]; off: PDFOperator[] },
onValue: PDFName,
): PDFDict {
const { context } = this.acroField.dict;
const onStreamRef = this.createAppearanceStream(widget, appearance.on);
const offStreamRef = this.createAppearanceStream(widget, appearance.off);
const appearanceDict = context.obj({});
appearanceDict.set(onValue, onStreamRef);
appearanceDict.set(PDFName.of('Off'), offStreamRef);
return appearanceDict;
}
}
|