2ebf8745a2
It's a follow-up of #14950: some format actions are ran when the document is open but we must be sure we've everything ready for that, hence we have to run some named actions before runnig the global format. In playing with the form, I discovered that the blur event wasn't triggered when JS called `setFocus` (because in such a case the mouse was never down). So I removed the mouseState thing to just use the correct commitKey when blur is triggered by a TAB key.
375 lines
11 KiB
JavaScript
375 lines
11 KiB
JavaScript
/* Copyright 2020 Mozilla Foundation
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
import { USERACTIVATION_CALLBACKID } from "./doc.js";
|
|
|
|
const USERACTIVATION_MAXTIME_VALIDITY = 5000;
|
|
|
|
class Event {
|
|
constructor(data) {
|
|
this.change = data.change || "";
|
|
this.changeEx = data.changeEx || null;
|
|
this.commitKey = data.commitKey || 0;
|
|
this.fieldFull = data.fieldFull || false;
|
|
this.keyDown = data.keyDown || false;
|
|
this.modifier = data.modifier || false;
|
|
this.name = data.name;
|
|
this.rc = true;
|
|
this.richChange = data.richChange || [];
|
|
this.richChangeEx = data.richChangeEx || [];
|
|
this.richValue = data.richValue || [];
|
|
this.selEnd = data.selEnd ?? -1;
|
|
this.selStart = data.selStart ?? -1;
|
|
this.shift = data.shift || false;
|
|
this.source = data.source || null;
|
|
this.target = data.target || null;
|
|
this.targetName = "";
|
|
this.type = "Field";
|
|
this.value = data.value || "";
|
|
this.willCommit = data.willCommit || false;
|
|
}
|
|
}
|
|
|
|
class EventDispatcher {
|
|
constructor(document, calculationOrder, objects, externalCall) {
|
|
this._document = document;
|
|
this._calculationOrder = calculationOrder;
|
|
this._objects = objects;
|
|
this._externalCall = externalCall;
|
|
|
|
this._document.obj._eventDispatcher = this;
|
|
this._isCalculating = false;
|
|
}
|
|
|
|
mergeChange(event) {
|
|
let value = event.value;
|
|
if (Array.isArray(value)) {
|
|
return value;
|
|
}
|
|
if (typeof value !== "string") {
|
|
value = value.toString();
|
|
}
|
|
const prefix =
|
|
event.selStart >= 0 ? value.substring(0, event.selStart) : "";
|
|
const postfix =
|
|
event.selEnd >= 0 && event.selEnd <= value.length
|
|
? value.substring(event.selEnd)
|
|
: "";
|
|
|
|
return `${prefix}${event.change}${postfix}`;
|
|
}
|
|
|
|
userActivation() {
|
|
this._document.obj._userActivation = true;
|
|
this._externalCall("setTimeout", [
|
|
USERACTIVATION_CALLBACKID,
|
|
USERACTIVATION_MAXTIME_VALIDITY,
|
|
]);
|
|
}
|
|
|
|
dispatch(baseEvent) {
|
|
const id = baseEvent.id;
|
|
if (!(id in this._objects)) {
|
|
let event;
|
|
if (id === "doc" || id === "page") {
|
|
event = globalThis.event = new Event(baseEvent);
|
|
event.source = event.target = this._document.wrapped;
|
|
event.name = baseEvent.name;
|
|
}
|
|
if (id === "doc") {
|
|
const eventName = event.name;
|
|
if (eventName === "Open") {
|
|
// Initialize named actions before calling formatAll to avoid any
|
|
// errors in the case where a formatter is using one of those named
|
|
// actions (see #15818).
|
|
this._document.obj._initActions();
|
|
// Before running the Open event, we format all the fields
|
|
// (see bug 1766987).
|
|
this.formatAll();
|
|
}
|
|
if (
|
|
!["DidPrint", "DidSave", "WillPrint", "WillSave"].includes(eventName)
|
|
) {
|
|
this.userActivation();
|
|
}
|
|
this._document.obj._dispatchDocEvent(event.name);
|
|
} else if (id === "page") {
|
|
this.userActivation();
|
|
this._document.obj._dispatchPageEvent(
|
|
event.name,
|
|
baseEvent.actions,
|
|
baseEvent.pageNumber
|
|
);
|
|
} else if (id === "app" && baseEvent.name === "ResetForm") {
|
|
this.userActivation();
|
|
for (const fieldId of baseEvent.ids) {
|
|
const obj = this._objects[fieldId];
|
|
obj?.obj._reset();
|
|
}
|
|
}
|
|
return;
|
|
}
|
|
|
|
const name = baseEvent.name;
|
|
const source = this._objects[id];
|
|
const event = (globalThis.event = new Event(baseEvent));
|
|
let savedChange;
|
|
|
|
this.userActivation();
|
|
|
|
if (source.obj._isButton()) {
|
|
source.obj._id = id;
|
|
event.value = source.obj._getExportValue(event.value);
|
|
if (name === "Action") {
|
|
source.obj._value = event.value;
|
|
}
|
|
}
|
|
|
|
switch (name) {
|
|
case "Keystroke":
|
|
savedChange = {
|
|
value: event.value,
|
|
changeEx: event.changeEx,
|
|
change: event.change,
|
|
selStart: event.selStart,
|
|
selEnd: event.selEnd,
|
|
};
|
|
break;
|
|
case "Blur":
|
|
case "Focus":
|
|
Object.defineProperty(event, "value", {
|
|
configurable: false,
|
|
writable: false,
|
|
enumerable: true,
|
|
value: event.value,
|
|
});
|
|
break;
|
|
case "Validate":
|
|
this.runValidation(source, event);
|
|
return;
|
|
case "Action":
|
|
this.runActions(source, source, event, name);
|
|
this.runCalculate(source, event);
|
|
return;
|
|
}
|
|
|
|
this.runActions(source, source, event, name);
|
|
|
|
if (name !== "Keystroke") {
|
|
return;
|
|
}
|
|
|
|
if (event.rc) {
|
|
if (event.willCommit) {
|
|
this.runValidation(source, event);
|
|
} else {
|
|
if (source.obj._isChoice) {
|
|
source.obj.value = savedChange.changeEx;
|
|
source.obj._send({
|
|
id: source.obj._id,
|
|
siblings: source.obj._siblings,
|
|
value: source.obj.value,
|
|
});
|
|
return;
|
|
}
|
|
|
|
const value = (source.obj.value = this.mergeChange(event));
|
|
let selStart, selEnd;
|
|
if (
|
|
event.selStart !== savedChange.selStart ||
|
|
event.selEnd !== savedChange.selEnd
|
|
) {
|
|
// Selection has been changed by the script so apply the changes.
|
|
selStart = event.selStart;
|
|
selEnd = event.selEnd;
|
|
} else {
|
|
selEnd = selStart = savedChange.selStart + event.change.length;
|
|
}
|
|
source.obj._send({
|
|
id: source.obj._id,
|
|
siblings: source.obj._siblings,
|
|
value,
|
|
selRange: [selStart, selEnd],
|
|
});
|
|
}
|
|
} else if (!event.willCommit) {
|
|
source.obj._send({
|
|
id: source.obj._id,
|
|
siblings: source.obj._siblings,
|
|
value: savedChange.value,
|
|
selRange: [savedChange.selStart, savedChange.selEnd],
|
|
});
|
|
} else {
|
|
// Entry is not valid (rc == false) and it's a commit
|
|
// so just clear the field.
|
|
source.obj._send({
|
|
id: source.obj._id,
|
|
siblings: source.obj._siblings,
|
|
value: "",
|
|
formattedValue: null,
|
|
selRange: [0, 0],
|
|
});
|
|
}
|
|
}
|
|
|
|
formatAll() {
|
|
// Run format actions if any for all the fields.
|
|
const event = (globalThis.event = new Event({}));
|
|
for (const source of Object.values(this._objects)) {
|
|
event.value = source.obj.value;
|
|
if (this.runActions(source, source, event, "Format")) {
|
|
source.obj._send({
|
|
id: source.obj._id,
|
|
siblings: source.obj._siblings,
|
|
formattedValue: event.value?.toString?.(),
|
|
});
|
|
}
|
|
}
|
|
}
|
|
|
|
runValidation(source, event) {
|
|
const didValidateRun = this.runActions(source, source, event, "Validate");
|
|
if (event.rc) {
|
|
source.obj.value = event.value;
|
|
|
|
this.runCalculate(source, event);
|
|
|
|
const savedValue = (event.value = source.obj.value);
|
|
let formattedValue = null;
|
|
|
|
if (this.runActions(source, source, event, "Format")) {
|
|
formattedValue = event.value?.toString?.();
|
|
}
|
|
|
|
source.obj._send({
|
|
id: source.obj._id,
|
|
siblings: source.obj._siblings,
|
|
value: savedValue,
|
|
formattedValue,
|
|
});
|
|
event.value = savedValue;
|
|
} else if (didValidateRun) {
|
|
// The value is not valid.
|
|
source.obj._send({
|
|
id: source.obj._id,
|
|
siblings: source.obj._siblings,
|
|
value: "",
|
|
formattedValue: null,
|
|
selRange: [0, 0],
|
|
focus: true, // Stay in the field.
|
|
});
|
|
}
|
|
}
|
|
|
|
runActions(source, target, event, eventName) {
|
|
event.source = source.wrapped;
|
|
event.target = target.wrapped;
|
|
event.name = eventName;
|
|
event.targetName = target.obj.name;
|
|
event.rc = true;
|
|
|
|
return target.obj._runActions(event);
|
|
}
|
|
|
|
calculateNow() {
|
|
// This function can be called by a JS script (doc.calculateNow()).
|
|
// If !this._calculationOrder then there is nothing to calculate.
|
|
// _isCalculating is here to prevent infinite recursion with calculateNow.
|
|
// If !this._document.obj.calculate then the script doesn't want to have
|
|
// a calculate.
|
|
|
|
if (
|
|
!this._calculationOrder ||
|
|
this._isCalculating ||
|
|
!this._document.obj.calculate
|
|
) {
|
|
return;
|
|
}
|
|
this._isCalculating = true;
|
|
const first = this._calculationOrder[0];
|
|
const source = this._objects[first];
|
|
globalThis.event = new Event({});
|
|
|
|
try {
|
|
this.runCalculate(source, globalThis.event);
|
|
} catch (error) {
|
|
this._isCalculating = false;
|
|
throw error;
|
|
}
|
|
|
|
this._isCalculating = false;
|
|
}
|
|
|
|
runCalculate(source, event) {
|
|
// _document.obj.calculate is equivalent to doc.calculate and can be
|
|
// changed by a script to allow a future calculate or not.
|
|
// This function is either called by calculateNow or when an action
|
|
// is triggered (in this case we cannot be currently calculating).
|
|
// So there are no need to check for _isCalculating because it has
|
|
// been already done in calculateNow.
|
|
if (!this._calculationOrder || !this._document.obj.calculate) {
|
|
return;
|
|
}
|
|
|
|
for (const targetId of this._calculationOrder) {
|
|
if (!(targetId in this._objects)) {
|
|
continue;
|
|
}
|
|
|
|
if (!this._document.obj.calculate) {
|
|
// An action could have changed calculate value.
|
|
break;
|
|
}
|
|
|
|
event.value = null;
|
|
const target = this._objects[targetId];
|
|
let savedValue = target.obj.value;
|
|
this.runActions(source, target, event, "Calculate");
|
|
if (!event.rc) {
|
|
continue;
|
|
}
|
|
|
|
if (event.value !== null) {
|
|
// A new value has been calculated so set it.
|
|
target.obj.value = event.value;
|
|
}
|
|
|
|
event.value = target.obj.value;
|
|
this.runActions(target, target, event, "Validate");
|
|
if (!event.rc) {
|
|
if (target.obj.value !== savedValue) {
|
|
target.wrapped.value = savedValue;
|
|
}
|
|
continue;
|
|
}
|
|
|
|
savedValue = event.value = target.obj.value;
|
|
let formattedValue = null;
|
|
if (this.runActions(target, target, event, "Format")) {
|
|
formattedValue = event.value?.toString?.();
|
|
}
|
|
|
|
target.obj._send({
|
|
id: target.obj._id,
|
|
siblings: target.obj._siblings,
|
|
value: savedValue,
|
|
formattedValue,
|
|
});
|
|
}
|
|
}
|
|
}
|
|
|
|
export { Event, EventDispatcher };
|