@eclipse-scout/core/src/layout/logicalgrid/LogicalGridData.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 {CompositeField, FormField, FormFieldLabelPosition, graphics, GridData, LayoutData, Rectangle, Widget} from '../../index';

export interface LogicalGridWidget extends Widget {
  _setGridData(gridData: GridData);

  gridData: GridData;
  gridDataHints?: GridData;
  label?: string;
  labelVisible?: boolean;
  $label?: JQuery;
  labelPosition?: FormFieldLabelPosition;
}

function isLogicalGridWidget(widget): widget is LogicalGridWidget {
  return widget instanceof Widget;
}

/**
 * JavaScript port of org.eclipse.scout.rt.ui.swing.form.fields.SwingScoutFormFieldGridData.
 * Merged with the base class LogicalGridData (for the default values). We don't need the base
 * class standalone, since we only used LGL for the group-box body in Html UI.
 */
export class LogicalGridData implements LayoutData {
  fillHorizontal: boolean;
  fillVertical: boolean;
  gridh: number;
  gridw: number;
  gridx: number;
  gridy: number;
  heightHint: number;
  maxHeight: number;
  horizontalAlignment: number;
  logicalRowHeightAddition: number;
  useUiHeight: boolean;
  useUiWidth: boolean;
  verticalAlignment: number;
  weightx: number;
  weighty: number;
  widget: LogicalGridWidget;
  widthHint: number;
  maxWidth: number;

  constructor(vararg?: Partial<LogicalGridData> | Widget) {
    this.gridx = 0;
    this.gridy = 0;
    this.gridw = 1;
    this.gridh = 1;
    this.weightx = 0.0;
    this.weighty = 0.0;
    this.useUiWidth = false;
    this.useUiHeight = false;
    this.widthHint = 0;
    this.maxWidth = 10240;
    this.heightHint = 0;
    this.maxHeight = 10240;
    this.horizontalAlignment = -1;
    this.verticalAlignment = -1;
    this.fillHorizontal = true;
    this.fillVertical = true;

    if (isLogicalGridWidget(vararg)) {
      // work with widget / validate
      this.widget = vararg;
    } else {
      $.extend(this, vararg);
    }
  }

  validate() {
    if (!this.widget) {
      return;
    }

    let data = this.widget.gridData;
    // setup constraints
    this.gridx = data.x;
    this.gridy = data.y;
    this.gridw = data.w;
    this.gridh = data.h;
    this.weightx = data.weightX;
    this.weighty = data.weightY;
    if (this.weightx < 0) {
      // inherit
      this.weightx = Math.max(1.0, this.gridw);
    }
    if (this.weighty < 0) {
      // inherit
      this.weighty = this._inheritWeightY();
    }
    this.useUiWidth = data.useUiWidth;
    this.useUiHeight = data.useUiHeight;
    this.horizontalAlignment = data.horizontalAlignment;
    this.verticalAlignment = data.verticalAlignment;
    this.fillHorizontal = data.fillHorizontal;
    this.fillVertical = data.fillVertical;
    this.widthHint = data.widthInPixel;
    this.maxWidth = data.maxWidthInPixel > 0 ? data.maxWidthInPixel : 10240;
    this.heightHint = data.heightInPixel;
    this.maxHeight = data.maxHeightInPixel > 0 ? data.maxHeightInPixel : 10240;

    // when having the label on top, the row height has to be increased
    if (this.widget.labelVisible && this.widget.$label && this.widget.labelPosition === FormField.LabelPosition.TOP) {
      this.logicalRowHeightAddition = graphics.prefSize(this.widget.$label, true).height;
    } else {
      this.logicalRowHeightAddition = 0;
    }
  }

  protected _inheritWeightY(): number {
    let d = this._inheritWeightYRec(this.widget);
    if (d === null) {
      let data = this.widget.gridData;
      if (data.weightY >= 0) {
        d = data.weightY;
      } else {
        d = data.h >= 2 ? data.h : 0;
      }
    }
    return d;
  }

  protected _inheritWeightYRec(widget: LogicalGridWidget): number {
    let found = false,
      sumWy = 0;

    // The children may have a dirty grid -> make sure the grid is valid before reading any grid data properties
    widget.validateLogicalGrid();

    if (widget instanceof CompositeField) {
      let i, inheritWeightY, child, children = widget.getFields();
      for (i = 0; i < children.length; i++) {
        child = children[i];
        if (child.visible) {
          let data = child.gridData;
          if (data.weightY < 0) {
            inheritWeightY = this._inheritWeightYRec(child);
            if (inheritWeightY !== null) {
              found = true;
              sumWy += inheritWeightY;
            }
          } else {
            found = true;
            sumWy += data.weightY;
          }
        }
      }
    } else {
      sumWy = (widget.gridData.h >= 2 ? widget.gridData.h : 0);
      found = true;
    }
    if (found) {
      return sumWy;
    }
    return null;
  }

  isValidateRoot(): boolean {
    return !this.useUiHeight && !this.useUiWidth && this.fillVertical && this.fillHorizontal;
  }

  toRectangle(): Rectangle {
    return new Rectangle(this.gridx, this.gridy, this.gridw, this.gridh);
  }
}