All files / lib/tree-picker tree-picker.component.ts

96.61% Statements 456/472
93.02% Branches 80/86
93.75% Functions 30/32
96.61% Lines 456/472

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 4731x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 25x 25x 2x 2x 25x 25x 1x 1x 2880x 2880x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 35x 35x 35x 1x 1x 1x 35x 35x 35x 35x 35x 35x 35x 35x 35x 1x 1x 1x 79x 26x 26x 3x 26x 26x 3x 3x 3x 3x 79x 79x 79x 79x 40x 79x 79x 1x 1x 1x         1x 1x 1x 13x 13x 13x 13x 4x 4x 4x 4x 9x 5x 5x 13x 13x 13x 1x 1x 1x 41x 41x 2x 39x 1x 1x 1x 1x 1x 41x 41x 1x 1x 1x 19x 19x       19x 1x 1x 1x 443x 443x 1x 1x 1x 13x 13x 13x 13x 1x 1x 1x 21x 21x 21x 21x 21x 1x 20x 20x 21x 21x 1x 1x 1x 29x 29x 29x 29x 1x 1x 1x 613x 613x 1x 1x 1x           1x 1x 1x 37x 37x 37x 37x 37x 37x 37x 17x 17x 20x 20x 3x 37x 37x 37x 37x 1x 1x 1x 212x 212x 212x 212x 179x 33x 33x 33x 212x 212x 212x 212x 212x 1x 1x 1x 43x 14x 14x 14x 14x 14x 14x 14x 14x 43x 43x 43x 43x 1x 1x 1x 656x 656x 1x 1x 1x 46x 27x 27x 46x 46x 1x 1x 1x 1x 666x 666x 666x 666x 666x 666x       666x 1x 1x 1x 1x 40x 4x 36x 36x 40x 40x 1x 1x 1x 61x 58x 58x 61x 61x 1x 1x 58x 58x 46x 12x 12x 12x 58x 1x 1x 1x 2x 2x 2x 2x 2x 2x 2x 1x 1x 1x 62x   62x 62x 1x  
/*******************************************************************************
 * Copyright bei
 * Entwicklungs- und Pflegeverbund für das gemeinsame Fachverfahren gefa
 *
 *******************************************************************************/
import {
  AfterViewInit,
  Component,
  ElementRef,
  EventEmitter,
  Input,
  NgZone,
  OnChanges,
  OnDestroy,
  Output,
  SimpleChanges,
  ViewChild,
} from '@angular/core';
 
import {
  isOnlyAltPressedOrNothing,
  observeSize,
} from '../utils/internal-utils';
import {
  Callback,
  Converter,
  FormControlStatus,
  Key,
  TreeItem,
} from '../utils/util.types';
import {
  SoundType,
  createWidgetKeySet,
  isTreeItemBasic,
  playSound,
} from '../utils/utilities';
 
import {
  AutoIdDirective,
  LabelContainerComponent,
} from '../internal/label-container/label-container.component';
import { OverlayContainerComponent } from '../internal/overlay-container/overlay-container.component';
 
import { TreeItemBasicAdvancedKeys } from '../tree/base-tree.component';
import { TreePickerPopupContentComponent } from './tree-picker-popup-content/tree-picker-popup-content.component';
 
const NO_VALUE_ITEM_SYMBOL: unique symbol = Symbol('no-value');
 
/**
 * A Tree Picker allowing the user to choose an item from a list of tree items.
 */
@Component({
  selector: 'gc-tree-picker',
  templateUrl: './tree-picker.component.html',
  styleUrls: ['./tree-picker.component.css'],
})
export class TreePickerComponent<T>
  implements OnChanges, OnDestroy, AfterViewInit
{
  /** The label that shows on the input. */
  @Input()
  public label = '';
 
  /** Marks the input field as required. true == required */
  @Input()
  public required = false;
 
  /** Marks the input field as disabled. true == disabled */
  @Input()
  public disabled = false;
 
  /** Marks the input field as readonly. true == readonly */
  @Input()
  public readonly = false;
 
  /**
   * Overrides the default text which is shown when the control is readonly and empty.
   */
  @Input()
  public readonlyEmptyValue = '';
 
  /** A hint message that will appear below the picker if set. */
  @Input()
  public hint = '';
 
  /**
   * Data that will be rendered as tree items/nodes.
   */
  @Input()
  public items: readonly (T | null)[] = [];
 
  /**
   * Enables resetting the value i.e. the selection of a no-value (null) item.
   */
  @Input()
  public resetEnabled = false;
 
  /**
   * Set of item keys that will be rendered as disabled items.
   */
  @Input()
  public disabledItems: ReadonlySet<Key> = new Set();
 
  /**
   * Adapter that manages the conversion of item types.
   */
  @Input()
  public itemAdapter?: Converter<T, TreeItem<T>>;
 
  /**
   * The value represents the selected values.
   */
  @Input()
  public value: T | null = null;
 
  /**
   * Shows full path to the selected item if set to true, else shows only the selected item.
   */
  @Input()
  public showSelectedPath = true;
 
  /**
   * If true, the component will be rendered in a slot-element mode.
   * @ignore
   */
  @Input()
  public _slotElementMode?: 'ext-search-single-field';
 
  /**
   * Error message id used when `_slotElementMode` is enabled.
   * @ignore
   */
  @Input()
  public _errorMessageId?: string;
 
  /**
   * Signals changes of the current (combined) status of the component, e.g. also reports errors triggered by internal
   * validation or input handling.
   */
  @Output()
  public readonly onStatusChange: EventEmitter<FormControlStatus> =
    new EventEmitter<FormControlStatus>(true);
 
  /** Fires if the picker has focus. */
  @Output()
  public readonly onFocusEntered: EventEmitter<void> = new EventEmitter<void>();
 
  /** Inform about the change of the selection state */
  @Output()
  public readonly valueChange: EventEmitter<T | null> =
    new EventEmitter<T | null>();
 
  /** Fires if the picker has lost focus. */
  @Output()
  public readonly onFocusLeft: EventEmitter<void> = new EventEmitter<void>();
 
  /** @ignore */
  @ViewChild('treePopup', { static: true })
  public tree?: TreePickerPopupContentComponent<T>;
 
  /** @ignore */
  @ViewChild(LabelContainerComponent)
  protected labelContainer?: LabelContainerComponent;
 
  /** @ignore */
  @ViewChild('drawerSlot')
  protected drawerSlot?: ElementRef;
 
  /** @ignore */
  @ViewChild(AutoIdDirective)
  protected autoId?: AutoIdDirective;
 
  /** @ignore */
  @ViewChild('comboboxElement')
  protected comboboxElement?: ElementRef<HTMLSpanElement>;
 
  /** @ignore */
  @ViewChild('popup')
  protected popup?: OverlayContainerComponent;
 
  /** @ignore */
  @ViewChild('itemArea')
  private itemArea?: ElementRef<HTMLSpanElement>;
 
  /** An error message that will appear below the picker if set. */
  @Input()
  public set errorMessage(message: string) {
    if (this._errorMessage !== message) {
      this._errorMessage = message;
      this.emitStatusChange();
    }
  }
 
  public get errorMessage(): string {
    return this._errorMessage;
  }
 
  /** @ignore */
  protected internalItems: readonly (T | null)[] = this.items;
 
  /** @ignore */
  protected _drawerOpen = false;
 
  /** @ignore */
  protected readonly treePopupListId: string;
 
  /** @ignore */
  protected noValueItem: TreeItemBasicAdvancedKeys<T> = {
    key: NO_VALUE_ITEM_SYMBOL,
    label: '\u2013',
  };
 
  /** @ignore */
  private _errorMessage = '';
 
  /** @ignore */
  private _resizeObserver?: Callback;
 
  /** @ignore */
  private hasFocus = false;
 
  public constructor(private zone: NgZone) {
    const widgetKeys = createWidgetKeySet('gc-tree-picker');
    this.treePopupListId = widgetKeys.baseKey + '-popup';
  }
 
  /** @ignore */
  public ngAfterViewInit(): void {
    if (this.itemArea) {
      this._resizeObserver = observeSize(
        this.itemArea,
        this.zone,
        this._resizeCallback.bind(this),
      );
    }
    this.initPopup();
  }
 
  /** @ignore */
  public ngOnChanges(changes: SimpleChanges): void {
    if ('readonly' in changes) {
      setTimeout(() => this.initPopup());
      if (this._resizeObserver) {
        this._resizeObserver();
      }
      if (this.itemArea) {
        this._resizeObserver = observeSize(
          this.itemArea,
          this.zone,
          this._resizeCallback.bind(this),
        );
      }
    }
    if ('resetEnabled' in changes || 'items' in changes) {
      this.updateInternalItems();
    }
  }
 
  /** @ignore */
  public ngOnDestroy(): void {
    if (this._resizeObserver) {
      this._resizeObserver();
    }
  }
 
  /** @ignore */
  protected _buttonOnKeydown(event: KeyboardEvent) {
    const key = event.key;
 
    switch (key) {
      case 'ArrowDown':
        if (isOnlyAltPressedOrNothing(event)) {
          this._drawerOpen = true;
        }
        break;
      case ' ':
        this._drawerOpen = true;
        event.preventDefault();
        break;
    }
  }
 
  /** @ignore */
  protected _onTreeKeyboardEvent(event: KeyboardEvent): void {
    const key = event.key;
    if (key === 'Escape') {
      this.closePopup();
    } else if (key === 'Tab') {
      // ensure focus move initiated via Tab starts at the component, so the "next" element is correct
      this.comboboxElement?.nativeElement.focus();
      this.closePopup();
      // focus scope directive won't report the intermediate focus on the component, need to trigger handling manually
      this.onFocusLeftHandler();
    }
  }
 
  /** @ignore */
  protected _computeReadonlyText(): string {
    if (this.showSelectedPath) {
      return this._generateLabelsOfSelectedPath().join(' \u276D ');
    }

    return this.tree?._getSelectedItemLabel() ?? '';
  }
 
  /** @ignore */
  protected _generateLabelsOfSelectedPath(): string[] {
    return this.tree ? this.tree._generateLabelsOfSelectedItemPath() : [];
  }
 
  /** @ignore */
  protected _onTreeSelection(value: T | null | undefined): void {
    this.value = value ?? null;
    this.valueChange.emit(value);
    this.closePopup();
  }
 
  /** @ignore */
  protected _onButtonClick(): void {
    if (this.disabled) {
      return;
    }
 
    if (this._drawerOpen) {
      this.closePopup();
    } else {
      this._drawerOpen = true;
    }
  }
 
  /** @ignore */
  protected _handlePopupVisible(): void {
    setTimeout(() => {
      this.tree?.focusChild();
    });
  }
 
  /** @ignore */
  protected _isButtonFocused(): boolean {
    return document.activeElement == this.comboboxElement?.nativeElement;
  }
 
  /** @ignore */
  protected _onLabelClick(): void {
    if (!this.disabled) {
      this.comboboxElement?.nativeElement.focus();
      this._onButtonClick();
    }
  }
 
  /** @ignore */
  protected closePopup(): void {
    this._drawerOpen = false;
    // if the popup is closed due to a click in a random area outside (e.g. not moving to another element via 'Tab'),
    // then move the focus back to the component; detectable as no specific (other) element is focused
    setTimeout(() => {
      if (
        document.activeElement === null ||
        document.activeElement === document.body
      ) {
        this.comboboxElement?.nativeElement.focus();
      } else if (
        document.activeElement !== this.comboboxElement?.nativeElement
      ) {
        this.onFocusLeftHandler();
      }
    });
  }
 
  /** @ignore */
  protected screenReaderValueText(): string {
    const value = this.tree?._getSelectedItemLabel();
    if (value) {
      const path = this._generateLabelsOfSelectedPath().slice(0, -1);
      if (path.length > 0) {
        const pathString = path.join(' \u276D ');
        return `${value} (${pathString})`;
      } else {
        return value;
      }
    } else {
      return '';
    }
  }
 
  /** @ignore */
  protected onFocusLeftHandler(): void {
    if (!this._drawerOpen) {
      this.onFocusLeft.emit();
      this.hasFocus = false;
 
      // We need to wait a tick so that the control is back
      // in a sync state
      setTimeout(() => {
        if (this.errorMessage.length > 0) {
          void playSound(SoundType.ERROR);
        }
      });
    }
  }
 
  /** @ignore */
  protected isBaseItem(x: unknown): x is TreeItemBasicAdvancedKeys<T> {
    return isTreeItemBasic(x);
  }
 
  /** @ignore */
  protected onFocusEnteredHandler(): void {
    if (!this.hasFocus) {
      this.hasFocus = true;
      this.onFocusEntered.emit();
    }
  }
 
  /** @ignore */
  protected readonly internalItemAdapter = (
    value: T | null,
  ): TreeItemBasicAdvancedKeys<T> => {
    if (value === null) {
      return this.noValueItem;
    } else if (this.itemAdapter === undefined && this.isBaseItem(value)) {
      return value;
    } else if (this.itemAdapter) {
      return this.itemAdapter(value);
    }
    console.error('Missing converter for ', value);
    throw new Error('missing converter');
  };
 
  /** @ignore */
  protected updateInternalItems(): void {
    if (this.resetEnabled) {
      this.internalItems = [null, ...this.items];
    } else {
      this.internalItems = this.items;
    }
  }
 
  /** @ignore */
  private initPopup(): void {
    if (!this.readonly && this.popup) {
      this.popup.anker = this.getAnker();
      this.popup.scrollTargetElement = this.labelContainer?.boxEl;
    }
  }
 
  private getAnker(): ElementRef {
    if (this.labelContainer) {
      return this.labelContainer.drawerSlot;
    } else if (this.drawerSlot) {
      return this.drawerSlot;
    }
    throw new Error('Unable to find a drawer slot');
  }
 
  /** @ignore */
  private emitStatusChange() {
    const status: FormControlStatus = {};
    if (this.errorMessage) {
      status.error = [this.errorMessage];
    }
 
    this.onStatusChange.emit(status);
  }
 
  /** @ignore */
  private _resizeCallback(): void {
    if (this._drawerOpen) {
      this.closePopup();
    }
  }
}