/*
 * 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 {BasicFieldModel, MaxLengthHandler, StringFieldFormat} from '../../../index';

export interface StringFieldModel extends BasicFieldModel<string> {
  format?: StringFieldFormat;
  /**
   * Default is false.
   */
  hasAction?: boolean;
  /**
   * true if all characters should be masked (e.g. for a password field).
   *
   * Default is false.
   */
  inputMasked?: boolean;
  /**
   * Default is false.
   */
  inputObfuscated?: boolean;
  /**
   * Default is 4000.
   */
  maxLength?: number;
  maxLengthHandler?: MaxLengthHandler;
  /**
   * Default is false.
   */
  multilineText?: boolean;
  /**
   * Configures the start of the text selection.
   *
   * If the value is < 0, the browser takes care of the selection and typically sets the cursor at the end of the text.
   * The value will be updated whenever the selection changes but only if {@link selectionTrackingEnabled} is true.
   *
   * Default is -1 .
   */
  selectionStart?: number;
  /**
   * Configures the end of the text selection.
   *
   * If the value is < 0, the browser takes care of the selection and typically sets the cursor at the end of the text.
   * The value will be updated whenever the selection changes but only if {@link selectionTrackingEnabled} is true.
   *
   * Default is -1 .
   */
  selectionEnd?: number;
  /**
   * Defines whether a {@link StringFieldSelectionChangeEvent} should be triggered when the selection changes.
   *
   * Also, if set to true, {@link selectionStart} and {@link selectionEnd} will be updated when the selection changes.
   * Otherwise, {@link selectionStart} and {@link selectionEnd} won't reflect the actual selection.
   *
   * Default is false.
   */
  selectionTrackingEnabled?: boolean;
  /**
   * Default is false.
   */
  spellCheckEnabled?: boolean;
  /**
   * true if leading and trailing whitespace should be stripped from the entered text while validating the value.
   *
   * Default is true.
   */
  trimText?: boolean;
  /**
   * Default is false.
   */
  wrapText?: boolean;
}