@eclipse-scout/core/src/tile/TileGridAdapter.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 {App, Event, ModelAdapter, objects, RemoteTileFilter, scout, TileActionEvent, TileClickEvent, TileGrid, TileGridModel} from '../index';

export class TileGridAdapter extends ModelAdapter {
  declare widget: TileGrid;
  tileFilter: RemoteTileFilter;

  constructor() {
    super();
    this.tileFilter = null;
    this._addRemoteProperties(['selectedTiles']);
  }

  protected _syncSelectedTiles(tileIds: string[]) {
    // TileGrid.js won't modify the selectedTiles array while processing the response -> ignore every selectedTiles property change
    this.addFilterForPropertyName('selectedTiles');
    this.widget.selectTiles(tileIds);
  }

  protected _syncTiles(tileIds: any[]) { // actually string[] but "official" Scout JS API of setTiles should not reflect that capability
    this.addFilterForPropertyName('selectedTiles');
    this.widget.setTiles(tileIds);
  }

  protected override _initProperties(model: TileGridModel & { filteredTiles?: string[] }) {
    super._initProperties(model);
    if (!objects.isNullOrUndefined(model.filteredTiles)) {
      // If filteredTiles is set a server side filter is active -> add a tile filter on JS side as well
      this.tileFilter = scout.create(RemoteTileFilter, {
        tileIds: model.filteredTiles
      });
      model.filters = [this.tileFilter];
    }
    // filtered tiles are set by TileGrid.js as soon a applyFilters is called -> don't override with the values sent by the server
    delete model.filteredTiles;
  }

  protected _syncFilteredTiles(tileIds: string[]) {
    // If filteredTiles property changes on the fly, create or remove the filter accordingly
    // -> If filteredTiles is null, no server side filter is active
    // -> If filteredTiles is an empty array, the server side filter rejects every tile
    if (!objects.isNullOrUndefined(tileIds)) {
      if (!this.tileFilter) {
        this.tileFilter = scout.create(RemoteTileFilter);
        this.widget.addFilter(this.tileFilter, false);
      }
      this.tileFilter.setTileIds(tileIds);
      this.widget.filter();
    } else {
      this.widget.removeFilter(this.tileFilter);
      this.tileFilter = null;
    }
  }

  protected _onWidgetTileClick(event: TileClickEvent) {
    let data = {
      tile: event.tile.id,
      mouseButton: event.mouseButton
    };
    this._send('tileClick', data);
  }

  protected _onWidgetTileAction(event: TileActionEvent) {
    let data = {
      tile: event.tile.id
    };
    this._send('tileAction', data);
  }

  protected override _onWidgetEvent(event: Event<TileGrid>) {
    if (event.type === 'tileClick') {
      this._onWidgetTileClick(event as TileClickEvent);
    } else if (event.type === 'tileAction') {
      this._onWidgetTileAction(event as TileActionEvent);
    } else {
      super._onWidgetEvent(event);
    }
  }

  static modifyTileGridPrototype() {
    if (!App.get().remote) {
      return;
    }

    // _sortWhileInit
    objects.replacePrototypeFunction(TileGrid, '_sortWhileInit', function(this: TileGrid & { _sortWhileInitOrig }) {
      if (this.modelAdapter) {
        return; // Do nothing. Was sorted in Java UI already.
      }
      this._sortWhileInitOrig();
    }, true);
  }
}

App.addListener('bootstrap', TileGridAdapter.modifyTileGridPrototype);