Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add tooltip if any in annotations layer #12333

Merged
merged 1 commit into from
Oct 3, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion src/core/annotation.js
Original file line number Diff line number Diff line change
Expand Up @@ -1533,6 +1533,7 @@ class ButtonWidgetAnnotation extends WidgetAnnotation {
this.hasFieldFlag(AnnotationFieldFlag.RADIO) &&
!this.hasFieldFlag(AnnotationFieldFlag.PUSHBUTTON);
this.data.pushButton = this.hasFieldFlag(AnnotationFieldFlag.PUSHBUTTON);
this.data.isTooltipOnly = false;

if (this.data.checkBox) {
this._processCheckBox(params);
Expand Down Expand Up @@ -1770,11 +1771,13 @@ class ButtonWidgetAnnotation extends WidgetAnnotation {
}

_processPushButton(params) {
if (!params.dict.has("A")) {
if (!params.dict.has("A") && !this.data.alternativeText) {
warn("Push buttons without action dictionaries are not supported");
return;
}

this.data.isTooltipOnly = !params.dict.has("A");
calixteman marked this conversation as resolved.
Show resolved Hide resolved

Catalog.parseDestDictionary({
destDict: params.dict,
resultObj: this.data,
Expand Down
16 changes: 14 additions & 2 deletions src/display/annotation_layer.js
Original file line number Diff line number Diff line change
Expand Up @@ -293,7 +293,8 @@ class LinkAnnotationElement extends AnnotationElement {
const isRenderable = !!(
parameters.data.url ||
parameters.data.dest ||
parameters.data.action
parameters.data.action ||
parameters.data.isTooltipOnly
calixteman marked this conversation as resolved.
Show resolved Hide resolved
);
super(parameters, isRenderable);
}
Expand Down Expand Up @@ -322,8 +323,10 @@ class LinkAnnotationElement extends AnnotationElement {
});
} else if (data.action) {
this._bindNamedAction(link, data.action);
} else {
} else if (data.dest) {
this._bindLink(link, data.dest);
} else {
this._bindLink(link, "");
}

this.container.appendChild(link);
Expand Down Expand Up @@ -420,6 +423,10 @@ class WidgetAnnotationElement extends AnnotationElement {
*/
render() {
// Show only the container for unsupported field types.
if (this.data.alternativeText) {
this.container.title = this.data.alternativeText;
}

return this.container;
}
}
Expand Down Expand Up @@ -647,6 +654,11 @@ class PushButtonWidgetAnnotationElement extends LinkAnnotationElement {
// as performing actions on form fields (resetting, submitting, et cetera).
const container = super.render();
container.className = "buttonWidgetAnnotation pushButton";

if (this.data.alternativeText) {
container.title = this.data.alternativeText;
}

return container;
}
}
Expand Down
43 changes: 43 additions & 0 deletions test/unit/annotation_spec.js
Original file line number Diff line number Diff line change
Expand Up @@ -2436,6 +2436,49 @@ describe("annotation", function () {
})
.catch(done.fail);
});

it("should handle push buttons", function (done) {
const buttonWidgetRef = Ref.get(124, 0);
buttonWidgetDict.set("Ff", AnnotationFieldFlag.PUSHBUTTON);
buttonWidgetDict.set("A", "whatever");

const xref = new XRefMock([
{ ref: buttonWidgetRef, data: buttonWidgetDict },
]);

AnnotationFactory.create(
xref,
buttonWidgetRef,
pdfManagerMock,
idFactoryMock
).then(({ data }) => {
expect(data.annotationType).toEqual(AnnotationType.WIDGET);
expect(data.pushButton).toEqual(true);
done();
}, done.fail);
});

it("should handle push buttons that act as a tooltip only", function (done) {
const buttonWidgetRef = Ref.get(124, 0);
buttonWidgetDict.set("Ff", AnnotationFieldFlag.PUSHBUTTON);
buttonWidgetDict.set("TU", "An alternative text");

const xref = new XRefMock([
{ ref: buttonWidgetRef, data: buttonWidgetDict },
]);

AnnotationFactory.create(
xref,
buttonWidgetRef,
pdfManagerMock,
idFactoryMock
).then(({ data }) => {
expect(data.annotationType).toEqual(AnnotationType.WIDGET);
expect(data.pushButton).toEqual(true);
expect(data.alternativeText).toEqual("An alternative text");
done();
}, done.fail);
});
});

describe("ChoiceWidgetAnnotation", function () {
Expand Down