sprotty/src/features/bounds/vbox-layout.ts

A next-gen framework for graphical views

/********************************************************************************
 * Copyright (c) 2017-2024 TypeFox and others.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0 which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the Eclipse
 * Public License v. 2.0 are satisfied: GNU General Public License, version 2
 * with the GNU Classpath Exception which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 ********************************************************************************/

import { injectable } from 'inversify';
import { Bounds, Dimension, Point } from 'sprotty-protocol/lib/utils/geometry';
import { SParentElementImpl, SChildElementImpl } from "../../base/model/smodel";
import { AbstractLayout } from './abstract-layout';
import { AbstractLayoutOptions } from './layout-options';
import { BoundsData } from './hidden-bounds-updater';
import { InternalLayoutContainer, isLayoutableChild } from './model';
import { StatefulLayouter } from './layout';
import { HAlignment } from 'sprotty-protocol/lib/model';

export interface VBoxLayoutOptions extends AbstractLayoutOptions {
    vGap: number
    hAlign: HAlignment
}

/**
 * Layouts children of a container in vertical (top->bottom) direction.
 */
@injectable()
export class VBoxLayouter extends AbstractLayout<VBoxLayoutOptions> {

    static KIND = 'vbox';

    protected getChildrenSize(container: SParentElementImpl & InternalLayoutContainer,
                               containerOptions: VBoxLayoutOptions,
                               layouter: StatefulLayouter) {
        let maxWidth = -1;
        let maxHeight = 0;
        let isFirst = true;
        container.children.forEach(
            child => {
                if (isLayoutableChild(child)) {
                    const bounds = layouter.getBoundsData(child).bounds;
                    if (bounds !== undefined && Dimension.isValid(bounds)) {
                        maxHeight += bounds.height;
                        if (isFirst)
                            isFirst = false;
                        else
                            maxHeight += containerOptions.vGap;
                        maxWidth = Math.max(maxWidth, bounds.width);
                    }
                }
            }
        );
        return {
            width: maxWidth,
            height: maxHeight
        };
    }

    protected layoutChild(child: SChildElementImpl,
                        boundsData: BoundsData,
                        bounds: Bounds,
                        childOptions: VBoxLayoutOptions,
                        containerOptions: VBoxLayoutOptions,
                        currentOffset: Point,
                        maxWidth: number,
                        maxHeight: number) {
        const dx = this.getDx(childOptions.hAlign, bounds, maxWidth);
        boundsData.bounds = {
            x: containerOptions.paddingLeft + (child as any).bounds.x - bounds.x + dx,
            y: currentOffset.y + (child as any).bounds.y - bounds.y,
            width: bounds.width,
            height: bounds.height
        };
        boundsData.boundsChanged = true;
        return {
            x: currentOffset.x,
            y: currentOffset.y + bounds.height + containerOptions.vGap
        };
    }

    protected getDefaultLayoutOptions(): VBoxLayoutOptions {
        return {
            resizeContainer: true,
            paddingTop: 5,
            paddingBottom: 5,
            paddingLeft: 5,
            paddingRight: 5,
            paddingFactor: 1,
            vGap: 1,
            hAlign: 'center',
            minWidth: 0,
            minHeight: 0
        };
    }

    protected spread(a: VBoxLayoutOptions, b: VBoxLayoutOptions): VBoxLayoutOptions {
        return { ...a, ...b };
    }
}