Introduce an option to disable inplace editing for form string elements (#7152)

* Introduce an option to disable inplace editing for form string elements
Fixes #6264
Fixes #7148

* Fixed u-test

---------

Co-authored-by: tsv2013 <[email protected]>

Author: tsv2013

packages/survey-creator-core/src/creator-base.ts

@@ -4675,6 +4675,17 @@ export class SurveyCreatorModel extends Base
    * @see showTranslationTab
    */
   public clearTranslationsOnSourceTextChange: boolean = false;
+
+  /**
+   * An event that is raised when creator decides whether certain string is inplace editable on design surface or not.
+   */
+  public onGetIsStringInplacelyEditable: EventBase<SurveyCreatorModel, { element: Base, name: string, allowEdit: boolean }> = this.addCreatorEvent<SurveyCreatorModel, { element: Base, name: string, allowEdit: boolean }>();
+
+  public isStringInplacelyEditable(element: Base, stringName: string) {
+    const options = { element, name: stringName, allowEdit: !this.readOnly && !!isStringEditable(element, stringName) };
+    this.onGetIsStringInplacelyEditable.fire(this, options);
+    return options.allowEdit;
+  }
 }
 
 export class CreatorBase extends SurveyCreatorModel { }
@@ -4712,14 +4723,14 @@ export function initializeDesignTimeSurveyModel(model: any, creator: SurveyCreat
     opt.data = opt.data || data;
   });
   model.getRendererForString = (element: Base, name: string): string => {
-    if (!creator.readOnly && isStringEditable(element, name)) {
+    if (creator.isStringInplacelyEditable(element, name)) {
       return editableStringRendererName;
     }
     return undefined;
   };
 
   model.getRendererContextForString = (element: Base, locStr: LocalizableString): any => {
-    if (!creator.readOnly && isStringEditable(element, locStr.name)) {
+    if (creator.isStringInplacelyEditable(element, locStr.name)) {
       return {
         creator: creator,
         element,

packages/survey-creator-core/tests/creator-base-1.tests.ts

@@ -1711,26 +1711,6 @@ test("getElementWrapperComponentName for inner component elements", () => {
   ComponentCollection.Instance.clear();
 });
 
-test("isStringEditable", (): any => {
-  expect(isStringEditable({ isContentElement: true }, "")).toBeFalsy();
-  expect(isStringEditable({}, "")).toBeTruthy();
-  expect(
-    isStringEditable({ isEditableTemplateElement: true }, "")
-  ).toBeTruthy();
-  expect(
-    isStringEditable(
-      { isContentElement: true, isEditableTemplateElement: true },
-      ""
-    )
-  ).toBeTruthy();
-});
-test("isStringEditable for matrix dynamic", (): any => {
-  const matrix = new QuestionMatrixDynamicModel("q1");
-  matrix.addColumn("col1");
-  matrix.rowCount = 1;
-  expect(isStringEditable(matrix.columns[0].templateQuestion, "")).toBeTruthy();
-  expect(isStringEditable(matrix.visibleRows[0].cells[0].question, "")).toBeFalsy();
-});
 test("Test plug-ins in creator", (): any => {
   const creator = new CreatorTester({
     showTranslationTab: true,

packages/survey-creator-core/tests/creator-base-2.tests.ts

@@ -807,3 +807,52 @@ test("License text for default locale and another default locale", (): any => {
 
   editorLocalization.defaultLocale = "en";
 });
+
+test("isStringEditable", (): any => {
+  expect(isStringEditable({ isContentElement: true }, "")).toBeFalsy();
+  expect(isStringEditable({}, "")).toBeTruthy();
+  expect(
+    isStringEditable({ isEditableTemplateElement: true }, "")
+  ).toBeTruthy();
+  expect(
+    isStringEditable(
+      { isContentElement: true, isEditableTemplateElement: true },
+      ""
+    )
+  ).toBeTruthy();
+});
+test("isStringEditable for matrix dynamic", (): any => {
+  const matrix = new QuestionMatrixDynamicModel("q1");
+  matrix.addColumn("col1");
+  matrix.rowCount = 1;
+  expect(isStringEditable(matrix.columns[0].templateQuestion, "")).toBeTruthy();
+  expect(isStringEditable(matrix.visibleRows[0].cells[0].question, "")).toBeFalsy();
+});
+test("onGetIsStringEditable", (): any => {
+  const creator = new CreatorTester();
+  let lastEditableValue;
+  let callCount = 0;
+  let newValue;
+  creator.onGetIsStringInplacelyEditable.add((s, o) => {
+    lastEditableValue = o.allowEdit;
+    callCount++;
+    if (newValue !== undefined) {
+      o.allowEdit = newValue;
+    }
+  });
+  expect(lastEditableValue).toBeUndefined();
+  expect(callCount).toBe(0);
+
+  expect(creator.isStringInplacelyEditable({ isContentElement: true } as any, "")).toBeFalsy();
+  expect(lastEditableValue).toBeFalsy();
+  expect(callCount).toBe(1);
+
+  expect(creator.isStringInplacelyEditable({ } as any, "")).toBeTruthy();
+  expect(lastEditableValue).toBeTruthy();
+  expect(callCount).toBe(2);
+
+  newValue = true;
+  expect(creator.isStringInplacelyEditable({ isContentElement: true } as any, "")).toBeTruthy();
+  expect(lastEditableValue).toBeFalsy();
+  expect(callCount).toBe(3);
+});