@eclipse-scout/core/src/desktop/unsavedchanges/UnsavedFormChangesForm.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 {arrays, CancelMenu, Event, Form, FormModel, GroupBox, InitModelOf, ListBox, Menu, OkMenu, scout, SomeRequired, Status, TableRowsInsertedEvent, UnsavedFormChangesFormModel, UnsavedFormsLookupCall} from '../../index';

export class UnsavedFormChangesForm extends Form implements UnsavedFormChangesFormModel {
  declare model: UnsavedFormChangesFormModel;
  declare initModel: SomeRequired<this['model'], 'parent' | 'unsavedForms'>;

  unsavedForms: Form[];
  openFormsField: ListBox<Form>;

  constructor() {
    super();
    this.unsavedForms = [];
  }

  protected override _jsonModel(): FormModel {
    return {
      id: 'scout.UnsavedFormChangesForm',
      type: 'model',
      title: '${textKey:SaveChangesOfSelectedItems}',
      askIfNeedSave: false,
      rootGroupBox: {
        id: 'MainBox',
        objectType: GroupBox,
        menus: [{
          id: 'OkMenu',
          objectType: OkMenu
        }, {
          id: 'CancelMenu',
          objectType: CancelMenu
        }],
        fields: [{
          id: 'UnsavedChangesBox',
          objectType: GroupBox,
          labelVisible: false,
          gridColumnCount: 1,
          fields: [{
            id: 'OpenFormsField',
            objectType: ListBox,
            gridDataHints: {
              h: 5
            },
            labelVisible: false
          }]
        }]
      }
    };
  }

  protected override _init(model: InitModelOf<this>) {
    super._init(model);

    this.openFormsField = this.widget('OpenFormsField', ListBox<Form>);
    this.openFormsField.setLookupCall(scout.create(UnsavedFormsLookupCall, {
      session: this.session,
      unsavedForms: this.unsavedForms
    }));

    this.openFormsField.table.one('rowsInserted', (event: TableRowsInsertedEvent) => {
      event.source.checkAll(true);
    });

    let checkAllMenu = scout.create(Menu, {
      parent: this.openFormsField.table,
      id: 'CheckAllMenu',
      text: '${textKey:CheckAll}'
    });

    checkAllMenu.on('action', event => this.openFormsField.table.checkAll(true));

    let uncheckAllMenu = scout.create(Menu, {
      parent: this.openFormsField.table,
      id: 'UncheckAllMenu',
      text: '${textKey:UncheckAll}'
    });

    uncheckAllMenu.on('action', event => this.openFormsField.table.uncheckAll());

    this.openFormsField.table.setMenus([checkAllMenu, uncheckAllMenu]);

    this.on('postLoad', (event: Event<Form>) => this.touch());
  }

  protected override _validate(): Status {
    let invalidForms = this.getInvalidForms();
    if (invalidForms.length > 0) {
      let msg: string[] = [];
      msg.push('<p><b>', this.session.text('NotAllCheckedFormsCanBeSaved'), '</b></p>');
      msg.push(this.session.text('FormsCannotBeSaved'), '<br><br>');
      invalidForms.forEach(form => msg.push('- ', UnsavedFormChangesForm.getFormDisplayName(form), '<br>'));
      return Status.error({
        message: msg.join('')
      });
    }
    return Status.ok();
  }

  getInvalidForms(): Form[] {
    let invalidForms: Form[] = [];
    this.openFormsField.value.forEach((form: Form) => {
      let diagElem = form.lifecycle.invalidElements();
      let missingElements = diagElem.missingElements.slice();
      let invalidElements = diagElem.invalidElements.slice();
      form.visitDisplayChildren((dialog: Form) => {
        let diagElem = dialog.lifecycle.invalidElements();
        arrays.pushAll(missingElements, diagElem.missingElements);
        arrays.pushAll(invalidElements, diagElem.invalidElements);
      }, dialog => {
        // forms are the only display children with a lifecycle, only visit those.
        return dialog instanceof Form;
      });
      if (missingElements.length > 0 || invalidElements.length > 0) {
        invalidForms.push(form);
      }
    });
    return invalidForms;
  }

  static getFormDisplayName(form: Form): string {
    return [form.title, form.subTitle].filter(Boolean).join(' - ');
  }
}