Sakurai/pdf.js
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[api-minor] Stop exposing the *raw* defaultAppearance-string on Annotation-instances

Browse Source 
The reasons for making this change are:
 - This property is not, nor has it ever been, used anywhere in the PDF.js display-layer.
 - Related to the previous point, the format of the `defaultAppearance`-string is such that it'd be difficult to use it as-is in the display-layer anyway.
 - It (usually) contains the "raw" appearance-string, from the PDF document, which is neither parsed nor validated and could thus be bogus.
 - We now expose a `defaultAppearanceData`-property, which is first of all used in the display-layer and secondly contains actually parsed/validated data.
 - In the event that a third-party implementation needs the `defaultAppearance`-string, it could be easily constructed from the recently added `defaultAppearanceData`-property.

All-in-all, I'm thus suggesting that we stop exposing an unused and unnecessary property on all Annotation-instances.
This commit is contained in:
Jonas Jenwald 2021-03-31 14:48:28 +02:00
parent 38acde8375
commit 3df24254e3
1 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
src/core/annotation.js
View File

@ -1115,14 +1115,15 @@ class WidgetAnnotation extends Annotation {
data.defaultFieldValue = this._decodeFormValue(defaultFieldValue);
data.alternativeText = stringToPDFString(dict.get("TU") || "");
const defaultAppearance =
getInheritableProperty({ dict, key: "DA" }) ||
params.acroForm.get("DA") ||
"";
data.defaultAppearance = isString(defaultAppearance)
getInheritableProperty({ dict, key: "DA" }) || params.acroForm.get("DA");
this._defaultAppearance = isString(defaultAppearance)
? defaultAppearance
: "";
data.defaultAppearanceData = parseDefaultAppearance(data.defaultAppearance);
data.defaultAppearanceData = parseDefaultAppearance(
this._defaultAppearance
);
const fieldType = getInheritableProperty({ dict, key: "FT" });
data.fieldType = isName(fieldType) ? fieldType.name : null;
@ -1228,7 +1229,7 @@ class WidgetAnnotation extends Annotation {
// Even if there is an appearance stream, ignore it. This is the
// behaviour used by Adobe Reader.
if (!this.data.defaultAppearance || content === null) {
if (!this._defaultAppearance || content === null) {
return operatorList;
}
@ -1374,15 +1375,14 @@ class WidgetAnnotation extends Annotation {
const totalHeight = this.data.rect[3] - this.data.rect[1];
const totalWidth = this.data.rect[2] - this.data.rect[0];
if (!this.data.defaultAppearance) {
if (!this._defaultAppearance) {
// The DA is required and must be a string.
// If there is no font named Helvetica in the resource dictionary,
// the evaluator will fall back to a default font.
// Doing so prevents exceptions and allows saving/printing
// the file as expected.
this.data.defaultAppearance = "/Helvetica 0 Tf 0 g";
this.data.defaultAppearanceData = parseDefaultAppearance(
this.data.defaultAppearance
(this._defaultAppearance = "/Helvetica 0 Tf 0 g")
);
}
@ -1483,7 +1483,7 @@ class WidgetAnnotation extends Annotation {
_computeFontSize(height, lineCount) {
let { fontSize } = this.data.defaultAppearanceData;
if (fontSize === null || fontSize === 0) {
if (!fontSize) {
// A zero value for size means that the font shall be auto-sized:
// its size shall be computed as a function of the height of the
// annotation rectangle (see 12.7.3.3).
@ -1512,13 +1512,13 @@ class WidgetAnnotation extends Annotation {
}
const { fontName, fontColor } = this.data.defaultAppearanceData;
this.data.defaultAppearance = createDefaultAppearance({
this._defaultAppearance = createDefaultAppearance({
fontSize,
fontName,
fontColor,
});
}
return [this.data.defaultAppearance, fontSize];
return [this._defaultAppearance, fontSize];
}
_renderText(text, font, fontSize, totalWidth, alignment, hPadding, vPadding) {