@eclipse-scout/core/src/table/columns/LookupColumn.ts

Eclipse Scout runtime

/*
 * Copyright (c) 2010, 2024 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, Cell, ColumnValidationResult, LookupBox, LookupCallColumn, LookupColumnEventMap, LookupColumnModel, LookupEditor, scout, Status, TableRow, ValueField} from '../../index';

/**
 * This column is a multivalued LookupCallColumn. If editable it opens a popup containing a {@link LookupBox} in order to select multiple values.
 */
export class LookupColumn<TValue> extends LookupCallColumn<TValue[], TValue> implements LookupColumnModel<TValue> {
  declare model: LookupColumnModel<TValue>;
  declare eventMap: LookupColumnEventMap<TValue>;

  distinct = false;

  /** @see LookupColumnModel.distinct */
  setDistinct(distinct: boolean) {
    this.setProperty('distinct', distinct);
  }

  protected override _createEditor(row: TableRow): LookupEditor<TValue> {
    const editor = scout.create(LookupEditor<TValue>, {
      parent: this.table,
      lookupCall: this.lookupCall,
      codeType: this.codeType,
      browseHierarchy: this.browseHierarchy,
      browseMaxRowCount: this.browseMaxRowCount
    });

    editor.on('lookupCallDone', e => {
      if (!this.distinct) {
        return;
      }

      const valuesInOtherRows = [];
      this.table.rows.forEach(r => {
        if (r === row) {
          return;
        }
        valuesInOtherRows.push(...arrays.ensure(this.cellValue(r)));
      });
      arrays.removeAll(valuesInOtherRows, this.cellValue(row));
      e.result.lookupRows.forEach(lookupRow => {
        if (scout.isOneOf(lookupRow.key, valuesInOtherRows)) {
          lookupRow.setEnabled(false);
        }
      });
    });

    // pass editor events to column
    editor.on('prepareLookupCall', e => this.trigger('prepareLookupCall', {
      lookupCall: e.lookupCall,
      row
    }));
    editor.on('lookupCallDone', e => this.trigger('lookupCallDone', {
      result: e.result
    }));

    return editor;
  }

  protected override _updateEditorFromValidCell(field: ValueField<TValue[]>, cell: Cell<TValue[]>) {
    super._updateEditorFromValidCell(field, cell);
    field.setDisplayText(cell.text);
  }

  override isContentValid(row: TableRow): ColumnValidationResult {
    const validationResult = super.isContentValid(row);

    if (!this.distinct) {
      return validationResult;
    }

    const cell = this.cell(row);
    if (!this.table.rows.find(r => r !== row && arrays.containsAny(cell.value, this.cellValue(r)))) {
      return validationResult;
    }

    const distinctErrorStatus = Status.error(this.session.text('ui.LookupColumnDistinctErrorMessage'));
    const errorStatus = validationResult.errorStatus ? Status.error({children: [distinctErrorStatus, validationResult.errorStatus]}) : distinctErrorStatus;
    return {
      ...validationResult,
      valid: errorStatus.isValid(),
      errorStatus
    };
  }

  protected override _formatValue(value: TValue[], row?: TableRow): string | JQuery.Promise<string> {
    return LookupEditor.formatValues(value, this.lookupCall, lookupCall => this.trigger('prepareLookupCall', {lookupCall, row}));
  }
}