@eclipse-scout/core/src/tooltip/WidgetTooltip.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 {FocusRule, keys, KeyStrokeContext, ObjectOrChildModel, scout, ScoutKeyboardEvent, Tooltip, Widget, WidgetTooltipEventMap, WidgetTooltipModel} from '../index';

export class WidgetTooltip extends Tooltip implements WidgetTooltipModel {
  declare model: WidgetTooltipModel;
  declare eventMap: WidgetTooltipEventMap;
  declare self: WidgetTooltip;

  keyStrokeStopPropagationInterceptor: (event: ScoutKeyboardEvent) => void;
  withFocusContext: boolean;
  initialFocus: () => FocusRule;
  focusableContainer: boolean;
  content: Widget;
  $widgetContainer: JQuery;

  constructor() {
    super();

    this.$widgetContainer = null;
    this.content = null;
    this._addWidgetProperties(['content']);
    this.keyStrokeStopPropagationInterceptor = event => {
      if (scout.isOneOf(event.which, keys.ESC, keys.ENTER)) {
        return;
      }
      event.stopPropagation();
    };
    this.withFocusContext = true;
    this.initialFocus = () => FocusRule.AUTO;
    this.focusableContainer = false;
  }

  protected override _createKeyStrokeContext(): KeyStrokeContext {
    return new KeyStrokeContext();
  }

  protected override _initKeyStrokeContext() {
    super._initKeyStrokeContext();
    if (this.keyStrokeStopPropagationInterceptor) {
      this.keyStrokeContext.registerStopPropagationInterceptor(this.keyStrokeStopPropagationInterceptor);
    }
  }

  protected override _render() {
    super._render();
    this.$container.addClass('widget-tooltip');
    this.$widgetContainer = this.$container.appendDiv('tooltip-widget-container');
  }

  protected override _renderProperties() {
    super._renderProperties();
    this._renderContent();
  }

  protected override _remove() {
    this._removeContent();
    super._remove();
  }

  setContent(content: ObjectOrChildModel<Widget>) {
    this.setProperty('content', content);
  }

  protected _renderContent() {
    if (this.content) {
      this.content.render(this.$widgetContainer);
      this.content.$container.addClass('widget');
      this.content.pack();
    }
    this.$widgetContainer.setVisible(!!this.content);
    if (!this.rendering) {
      this.position();
    }

    // Focus the widget
    // It is important that this happens after layouting and positioning, otherwise we'd focus an element
    // that is currently not on the screen. Which would cause the whole desktop to
    // be shifted for a few pixels.
    if (this.withFocusContext && this.content) {
      this.session.focusManager.installFocusContext(this.$widgetContainer, this.initialFocus());
    }
  }

  protected _removeContent() {
    if (this.content) {
      this.session.focusManager.uninstallFocusContext(this.$widgetContainer);
      this.content.remove();
    }
  }
}