suneditor 2.46.2 → 3.0.0-alpha.1

package/src/modules/Controller.js

@@ -0,0 +1,315 @@
+import EditorInjector from '../editorInjector';
+import { domUtils, env } from '../helper';
+import { _DragHandle } from '../modules';
+
+const { ON_OVER_COMPONENT } = env;
+const NON_RESPONSE_KEYCODE = /^(13|1[7-9]|20|27|45|11[2-9]|12[0-3]|144|145)$/;
+const INDEX_0 = 2147483647;
+const INDEX_1 = 2147483646;
+const INDEX_2 = 2147483645;
+
+/**
+ *
+ * @param {*} inst
+ * @param {*} element
+ * @param {{position: "top" | "bottom" | "position", disabled?: boolean}} params params
+ * When using the "top" position, there should not be an arrow on the controller.
+ * When using the "bottom" position there should be an arrow on the controller.
+ */
+const Controller = function (inst, element, params, _name) {
+	EditorInjector.call(this, inst.editor);
+
+	// members
+	this.kind = _name || inst.constructor.key || inst.constructor.name;
+	this.inst = inst;
+	this.form = element;
+	this.isOpen = false;
+	this.currentTarget = null;
+	this.currentPositionTarget = null;
+	this.isWWTarget = params.isWWTarget ?? true;
+	this.position = params.position;
+	this.disabled = !!params.disabled;
+	this.parents = params.parents || [];
+	this.parentsHide = !!params.parentsHide;
+	this.isInsideForm = !!params.isInsideForm;
+	this.isOutsideForm = !!params.isOutsideForm;
+	this._initMethod = typeof params.initMethod === 'function' ? params.initMethod : null;
+	this.__globalEventHandlers = { keydown: CloseListener_keydown.bind(this), mousedown: CloseListener_mousedown.bind(this) };
+	this._bindClose_key = null;
+	this._bindClose_mouse = null;
+	this.__offset = {};
+	this.__addOffset = { left: 0, top: 0 };
+
+	// add element
+	this.carrierWrapper.appendChild(element);
+
+	// init
+	this.eventManager.addEvent(element, 'click', Action.bind(this));
+	this.eventManager.addEvent(element, 'mouseenter', MouseEnter.bind(this));
+	this.eventManager.addEvent(element, 'mouseleave', MouseLeave.bind(this));
+};
+
+Controller.prototype = {
+	/**
+	 * @description Open a modal plugin
+	 */
+	open(target, positionTarget, { isWWTarget, initMethod, disabled, addOffset }) {
+		if (_DragHandle.get('__overInfo') === ON_OVER_COMPONENT) {
+			return;
+		}
+
+		if (!target) {
+			console.warn('[SUNEDITOR.Controller.open.fail] The target element is required.');
+			return;
+		}
+
+		if (this.editor.isBalloon) this.toolbar.hide();
+		else if (this.editor.isSubBalloon) this.subToolbar.hide();
+
+		if (disabled ?? this.disabled) domUtils.setDisabled(this.editor._controllerOnDisabledButtons, true);
+
+		this.currentTarget = target;
+		this.currentPositionTarget = positionTarget || target;
+		this.isWWTarget = isWWTarget ?? this.isWWTarget;
+		if (typeof initMethod === 'function') this._initMethod = initMethod;
+		this.editor.currentControllerName = this.kind;
+
+		if (addOffset) this.__addOffset = { ...this.__addOffset, ...addOffset };
+
+		const parents = this.isOutsideForm ? this.parents : [];
+		this.editor.opendControllers?.forEach((e) => {
+			if (!parents.includes(e.form)) e.form.style.zIndex = INDEX_2;
+		});
+
+		if (this.parentsHide) {
+			this.parents.forEach((e) => {
+				e.style.display = 'none';
+			});
+		}
+
+		this.__addGlobalEvent();
+		this._setControllerPosition(this.form, this.currentPositionTarget);
+		this._controllerOn(this.form, target);
+		this._w.setTimeout(() => _DragHandle.set('__overInfo', false), 0);
+	},
+
+	/**
+	 * @description Close a modal plugin
+	 * The plugin's "init" method is called.
+	 */
+	close(force) {
+		if (!this.isOpen) return;
+
+		this.isOpen = false;
+		this.editor._antiBlur = false;
+		this.__offset = {};
+		this.__addOffset = { left: 0, top: 0 };
+
+		this.__removeGlobalEvent();
+
+		if (typeof this._initMethod === 'function') this._initMethod();
+		this._controllerOff();
+
+		if (this.parentsHide && !force) {
+			this.parents.forEach((e) => {
+				e.style.display = 'block';
+			});
+		}
+
+		if (this.parents.length > 0) return;
+		if (typeof this.inst.close === 'function') this.inst.close();
+		this.component.deselect();
+	},
+
+	/**
+	 * @description Hide controller
+	 */
+	hide() {
+		this.form.style.display = 'none';
+	},
+
+	/**
+	 * @description Show controller
+	 */
+	show() {
+		this._setControllerPosition(this.form, this.currentPositionTarget);
+	},
+
+	/**
+	 * @description Reset controller position
+	 * @param {Element|undefined} target
+	 */
+	resetPosition(target) {
+		this._setControllerPosition(this.form, target || this.currentPositionTarget);
+	},
+
+	/**
+	 * @description Show controller at editor area (controller elements, function, "controller target element(@Required)", "controller name(@Required)", etc..)
+	 * @param {any} arguments controller elements, function..
+	 */
+	_controllerOn(form, target) {
+		const params = {
+			position: this.position,
+			form: form,
+			target: target,
+			inst: this
+		};
+
+		if (this.triggerEvent('onBeforeShowController', { caller: this.kind, frameContext: this.editor.frameContext, params }) === false) return;
+
+		form.style.display = 'block';
+		if (this._shadowRoot) {
+			form.addEventListener('mousedown', (e) => e.stopPropagation());
+		}
+
+		this.editor._controllerTargetContext = this.editor.frameContext.get('topArea');
+
+		if (!this.isOpen) {
+			this.editor.opendControllers.push({
+				position: this.position,
+				form: form,
+				target: target,
+				inst: this
+			});
+		}
+
+		this.isOpen = true;
+		this.editor._antiBlur = true;
+		this.triggerEvent('onShowController', { caller: this.kind, frameContext: this.editor.frameContext, params });
+	},
+
+	/**
+	 * @description Hide controller at editor area (link button, image resize button..)
+	 * @param {KeyboardEvent|MouseEvent|null} e Event object when called from mousedown and keydown events registered in "_controllerOn"
+	 * @private
+	 */
+	_controllerOff() {
+		this.form.style.display = 'none';
+		this.editor.opendControllers = this.editor.opendControllers.filter((v) => v.form !== this.form);
+		if (this.editor.currentControllerName !== this.kind && this.editor.opendControllers.length > 0) return;
+
+		if (this.disabled) domUtils.setDisabled(this.editor._controllerOnDisabledButtons, false);
+		this.editor.frameContext.get('lineBreaker_t').style.display = this.editor.frameContext.get('lineBreaker_b').style.display = 'none';
+		this.editor.effectNode = null;
+		this.editor.currentControllerName = '';
+		this.editor._antiBlur = false;
+		this.editor._controllerTargetContext = null;
+		if (typeof this.inst.reset === 'function') this.inst.reset();
+	},
+
+	/**
+	 * @description Specify the position of the controller.
+	 * @param {Element} controller Controller element.
+	 * @param {Element} referEl Element that is the basis of the controller's position.
+	 */
+	_setControllerPosition(controller, referEl) {
+		controller.style.zIndex = INDEX_1;
+		controller.style.visibility = 'hidden';
+		controller.style.display = 'block';
+
+		if (!this.offset.setAbsPosition(controller, referEl, { addOffset: this.__addOffset, position: this.position, isWWTarget: this.isWWTarget, inst: this })) {
+			this.hide();
+			return;
+		}
+
+		controller.style.visibility = '';
+	},
+
+	__addGlobalEvent() {
+		this.__removeGlobalEvent();
+		this._bindClose_key = this.eventManager.addGlobalEvent('keydown', this.__globalEventHandlers.keydown, true);
+		this._bindClose_mouse = this.eventManager.addGlobalEvent('mousedown', this.__globalEventHandlers.mousedown, true);
+	},
+
+	__removeGlobalEvent() {
+		this.component.__removeGlobalEvent();
+		if (this._bindClose_key) this._bindClose_key = this.eventManager.removeGlobalEvent(this._bindClose_key);
+		if (this._bindClose_mouse) this._bindClose_mouse = this.eventManager.removeGlobalEvent(this._bindClose_mouse);
+	},
+
+	_checkFixed() {
+		if (this.editor.selectMenuOn) return true;
+
+		const cont = this.editor.opendControllers;
+		for (let i = 0; i < cont.length; i++) {
+			if (cont[i].inst === this && cont[i].fixed) {
+				return true;
+			}
+		}
+		return false;
+	},
+
+	_checkForm(target) {
+		if (domUtils.isWysiwygFrame(target)) return false;
+		if (domUtils.hasClass(target, 'se-drag-handle')) return true;
+
+		let isParentForm = false;
+		if (this.isInsideForm && this.parents?.length > 0) {
+			this.parents.some((e) => {
+				if (e.contains(target)) {
+					isParentForm = true;
+					return true;
+				}
+			});
+		}
+
+		return !isParentForm && (domUtils.getParentElement(target, '.se-controller') || target?.contains(this.inst._element));
+	},
+
+	constructor: Controller
+};
+
+// @todo
+Controller.CreateHTML = function () {
+	const html = '';
+	return domUtils.createElement('DIV', { class: '' }, html);
+};
+
+function Action(e) {
+	const target = domUtils.getCommandTarget(e.target);
+	if (!target) return;
+
+	e.stopPropagation();
+	e.preventDefault();
+
+	this.inst.controllerAction(target);
+}
+
+function MouseEnter(e) {
+	this.editor.currentControllerName = this.kind;
+	if (this.parents.length > 0 && this.isInsideForm) return;
+	e.target.style.zIndex = INDEX_0;
+}
+
+function MouseLeave(e) {
+	if (this.parents.length > 0 && this.isInsideForm) return;
+	e.target.style.zIndex = INDEX_2;
+}
+
+function CloseListener_keydown(e) {
+	if (this._checkFixed()) return;
+	const keyCode = e.keyCode;
+	const ctrl = e.ctrlKey || e.metaKey || keyCode === 91 || keyCode === 92 || keyCode === 224;
+	if (ctrl || !NON_RESPONSE_KEYCODE.test(keyCode)) return;
+
+	if (this.form.contains(e.target) || this._checkForm(e.target)) return;
+	if (this.editor._fileManager.pluginRegExp.test(this.kind) && keyCode !== 27) return;
+
+	this.close();
+}
+
+function CloseListener_mousedown({ target }) {
+	if (this.inst?._element?.contains(target)) {
+		this.isOpen = false;
+		return;
+	}
+
+	this.isOpen = true;
+	if (target === this.inst._element || target === this.currentTarget || this._checkFixed() || this.form.contains(target) || this._checkForm(target)) {
+		return;
+	}
+
+	this.close(true);
+}
+
+export default Controller;