@eclipse-scout/core/src/tile/TileModel.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 {ColorScheme, GridData, ObjectOrModel, TileDisplayStyle, WidgetModel} from '../index';

export interface TileModel extends WidgetModel {
  /**
   * Specifies whether position or size changes should be animated.
   *
   * Default is true.
   */
  animateBoundsChange?: boolean;
  /**
   * Specifies the color scheme of the tile.
   *
   * It may be a {@link ColorScheme} object or a string.
   * The string needs to consist of the color scheme id and an optional inverted identifier separated by -, e.g. default-inverted.
   *
   * By default, the non-inverted DEFAULT scheme is used, see {@link colorSchemes}.
   */
  colorScheme?: ColorScheme | string;
  /**
   * Specifies the display style of the tile. Default is {@link Tile.DisplayStyle.DEFAULT};
   */
  displayStyle?: TileDisplayStyle;
  /**
   * Specifies, how the tile should be positioned in the grid, if the container uses a {@link LogicalGrid}.
   */
  gridDataHints?: ObjectOrModel<GridData>;
  /**
   * Specifies, whether the tile is selected
   *
   * Default is false.
   */
  selected?: boolean;
  /**
   * Specifies, whether the tile can be selected.
   *
   * Default is false.
   */
  selectable?: boolean;
  /**
   * Specifies whether the tile can be moved using drag & drop.
   *
   * Default is false.
   */
  movable?: boolean;
  /**
   * Specifies whether the tile can be resized using drag & drop.
   *
   * Default is false.
   */
  resizable?: boolean;
}