@eclipse-scout/core/src/testing/form/FormSpecHelper.ts

Eclipse Scout runtime

/*
 * Copyright (c) 2010, 2023 BSI Business Systems Integration AG
 *
 * This program and the accompanying materials are made
 * available under the terms of the Eclipse Public License 2.0
 * which is available at https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 */
import {SpecForm, SpecRadioButtonGroup} from '../index';
import {
  arrays, Column, Form, FormField, FormModel, FullModelOf, GroupBox, InitModelOf, MessageBox, MessageBoxOption, Mode, ModeSelector, ObjectType, RadioButton, scout, Session, StringField, TabBox, TabItem, Table, TableField, Widget
} from '../../index';
import $ from 'jquery';

export class FormSpecHelper {
  session: Session;

  constructor(session: Session) {
    this.session = session;
  }

  closeMessageBoxes(option?: MessageBoxOption) {
    if (!this.session) {
      return;
    }
    let button = option || MessageBox.Buttons.YES;
    this.findMessageBoxes().forEach(messageBox => messageBox.trigger('action', {option: button}));
  }

  findMessageBoxes(): Set<MessageBox> {
    if (!this.session) {
      return new Set();
    }

    const result: Set<MessageBox> = new Set();

    if (this.session.$entryPoint) {
      // collect rendered MessageBoxes
      this.session.$entryPoint
        .find('.messagebox').get()
        .map(domElement => scout.widget(domElement, MessageBox))
        .filter(messageBox => !!messageBox)
        .forEach(messageBox => result.add(messageBox));
    }

    // collect the remaining (possibly not rendered) boxes on the Desktop
    if (this.session.desktop) {
      this.session.desktop.messageBoxes
        .forEach(messageBox => result.add(messageBox));
    }

    return result;
  }

  createViewWithOneField(model?: FormModel): SpecForm {
    let form = this.createFormWithOneField(model);
    form.displayHint = Form.DisplayHint.VIEW;
    return form;
  }

  createFormWithOneField(model?: FormModel): SpecForm {
    let defaults = {
      parent: this.session.desktop
    };
    model = $.extend({}, defaults, model);
    let form = scout.create(SpecForm, model as InitModelOf<Form>);
    let rootGroupBox = this.createGroupBoxWithFields(form, 1);
    form.setRootGroupBox(rootGroupBox);
    return form;
  }

  createFormWithFieldsAndTabBoxes(model?: FormModel): Form {
    let fieldModelPart = (id, mandatory) => ({
        id: id,
        objectType: StringField,
        label: id,
        mandatory: mandatory
      }),
      tabBoxModelPart = (id, tabItems) => ({
        id: id,
        objectType: TabBox,
        tabItems: tabItems
      }),
      tabItemModelPart = (id, fields) => ({
        id: id,
        objectType: TabItem,
        label: 'id',
        fields: fields
      }),
      tableFieldModelPart = (id, columns) => ({
        id: id,
        objectType: TableField,
        label: id,
        table: {
          id: id + 'Table',
          objectType: Table,
          columns: columns
        }
      }),
      columnModelPart = (id, mandatory) => ({
        id: id,
        objectType: Column,
        text: id,
        editable: true,
        mandatory: mandatory
      });

    let defaults = {
      parent: this.session.desktop,
      id: 'Form',
      title: 'Form',
      rootGroupBox: {
        id: 'RootGroupBox',
        objectType: GroupBox,
        fields: [
          fieldModelPart('Field1', false),
          fieldModelPart('Field2', false),
          fieldModelPart('Field3', true),
          fieldModelPart('Field4', true),
          tabBoxModelPart('TabBox', [
            tabItemModelPart('TabA', [
              fieldModelPart('FieldA1', false),
              fieldModelPart('FieldA2', true),
              tabBoxModelPart('TabBoxA', [
                tabItemModelPart('TabAA', [
                  fieldModelPart('FieldAA1', false),
                  fieldModelPart('FieldAA2', true)
                ]),
                tabItemModelPart('TabAB', [
                  fieldModelPart('FieldAB1', false),
                  fieldModelPart('FieldAB2', true)
                ]),
                tabItemModelPart('TabAC', [
                  fieldModelPart('FieldAC1', false),
                  fieldModelPart('FieldAC2', true)
                ])
              ])
            ]),
            tabItemModelPart('TabB', [
              fieldModelPart('FieldB1', false),
              fieldModelPart('FieldB2', false),
              fieldModelPart('FieldB3', true),
              fieldModelPart('FieldB4', true),
              tableFieldModelPart('TableFieldB5', [
                columnModelPart('ColumnB51', false),
                columnModelPart('ColumnB52', true)
              ])
            ])
          ])
        ]
      }
    };

    model = $.extend({}, defaults, model);
    let form = scout.create(Form, model as InitModelOf<Form>);
    form.widget('TableFieldB5', TableField).table.insertRows([{cells: arrays.init(2, null)}, {cells: arrays.init(2, null)}]);
    return form;
  }

  createGroupBoxWithOneField(parent: Widget): GroupBox {
    return this.createGroupBoxWithFields(parent, 1);
  }

  createGroupBoxWithFields(parent?: Widget, numFields?: number): GroupBox {
    parent = scout.nvl(parent, this.session.desktop);
    numFields = scout.nvl(numFields, 1);
    let
      fields = [],
      groupBox = scout.create(GroupBox, {
        parent: parent
      });
    for (let i = 0; i < numFields; i++) {
      fields.push(scout.create(StringField, {
        parent: groupBox
      }));
    }
    groupBox.setProperty('fields', fields);
    return groupBox;
  }

  createRadioButtonGroup(parent?: Widget, numRadioButtons?: number): SpecRadioButtonGroup {
    parent = scout.nvl(parent, this.session.desktop);
    numRadioButtons = scout.nvl(numRadioButtons, 2);
    let fields = [];
    for (let i = 0; i < numRadioButtons; i++) {
      fields.push({
        objectType: RadioButton
      });
    }
    return scout.create(SpecRadioButtonGroup, {
      parent: parent,
      fields: fields
    });
  }

  createFormWithFields(parent: Widget, isModal: boolean, numFields?: number): Form {
    parent = scout.nvl(parent, this.session.desktop);
    let form = scout.create(Form, {
      parent: parent,
      displayHint: isModal ? 'dialog' : 'view'
    });
    let rootGroupBox = this.createGroupBoxWithFields(form, numFields);
    form.setRootGroupBox(rootGroupBox);
    return form;
  }

  createFieldModel<T extends FormField = StringField>(objectType?: ObjectType<T>, parent?: Widget, modelProperties?: Record<string, any>): FullModelOf<T> & { id: string; session: Session } {
    parent = scout.nvl(parent, this.session.desktop);
    let model = createSimpleModel((objectType || 'StringField') as any, this.session);
    model.parent = parent;
    if (modelProperties) {
      $.extend(model, modelProperties);
    }
    return model as FullModelOf<T> & { id: string; session: Session };
  }

  createField<T extends FormField>(objectType: ObjectType<T>, parent?: Widget, modelProperties?: Record<string, any>): T {
    return scout.create(objectType, this.createFieldModel(objectType, parent, modelProperties));
  }

  createModeSelector(parent?: Widget, numModes?: number): ModeSelector {
    parent = scout.nvl(parent, this.session.desktop);
    numModes = scout.nvl(numModes, 2);
    let modes = [];
    for (let i = 0; i < numModes; i++) {
      modes.push({
        objectType: Mode
      });
    }
    return scout.create(ModeSelector, {
      parent: parent,
      modes: modes
    });
  }
}