@eclipse-scout/core/src/form/FormLayout.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 {AbstractLayout, Dimension, FileChooser, Form, graphics, HtmlComponent, HtmlCompPrefSizeOptions} from '../index';
import $ from 'jquery';

export class FormLayout extends AbstractLayout {
  form: Form | FileChooser;

  constructor(form: Form | FileChooser) {
    super();
    this.form = form;
  }

  override layout($container: JQuery) {
    this.form.validateLogicalGrid();
    let htmlRootGb = this._htmlRootGroupBox();
    if (!htmlRootGb) {
      return;
    }
    let htmlContainer = HtmlComponent.get($container);
    let rootGbSize = htmlContainer.availableSize()
      .subtract(htmlContainer.insets())
      .subtract(htmlRootGb.margins());

    rootGbSize.height -= this._headerHeight();

    $.log.isTraceEnabled() && $.log.trace('(FormLayout#layout) rootGbSize=' + rootGbSize);
    htmlRootGb.setSize(rootGbSize);
  }

  override preferredLayoutSize($container: JQuery, options?: HtmlCompPrefSizeOptions): Dimension {
    options = options || {};
    this.form.validateLogicalGrid();

    let titleHeight = this._headerHeight();
    if (options.heightHint) {
      options.heightHint -= titleHeight;
    }
    let htmlContainer = HtmlComponent.get($container);
    let prefSize;
    let htmlRootGb = this._htmlRootGroupBox();
    if (htmlRootGb) {
      prefSize = htmlRootGb.prefSize(options)
        .add(htmlContainer.insets())
        .add(htmlRootGb.margins());
    } else {
      prefSize = new Dimension().add(htmlContainer.insets());
    }
    prefSize.height += titleHeight;

    return prefSize;
  }

  protected _htmlRootGroupBox(): HtmlComponent {
    let $rootGroupBox = this.form.$container.children('.root-group-box');
    return HtmlComponent.optGet($rootGroupBox);
  }

  protected _headerHeight(): number {
    let $header = (this.form as Form).$header;
    if ($header && $header.css('position') !== 'absolute') {
      return graphics.prefSize($header, true).height;
    }
    return 0;
  }
}