angular-toolbox 1.2.2 → 1.3.0

package/lib/component/index.d.ts

@@ -6,3 +6,4 @@
  * found in the LICENSE file at https://pascalechemann.com/angular-toolbox/resources/license
  */
 export * from './angular-toolbox-logo/angular-toolbox-logo.component';
+export * from './layout';

package/lib/component/layout/border-layout/border-layout.component.d.ts

@@ -0,0 +1,79 @@
+/**
+ * @license
+ * Copyright Pascal ECHEMANN. All Rights Reserved.
+ *
+ * Use of this source code is governed by an MIT-style license that can be found in
+ * the LICENSE file at https://pascalechemann.com/angular-toolbox/resources/license
+ */
+import { AfterViewInit, OnDestroy, EventEmitter } from '@angular/core';
+import { LayoutDragEvent, LayoutRegion, LayoutRegionType, SubscriptionService } from '../../../model';
+import { BorderLayoutRenderer } from './util/border-layout-renderer';
+import { IdentifiableComponent } from '../../../core';
+import * as i0 from "@angular/core";
+/**
+ * A border layout lays out a container, arranging and resizing its components to fit in five regions: north, south, east, west, and center.
+ * Each region is defined by a `BorderLayoutContainer` instance, and is identified by a corresponding constant: `NORTH`, `SOUTH`, `EAST`, `WEST`, and `CENTER`.
+ */
+export declare class BorderLayout extends IdentifiableComponent implements AfterViewInit, OnDestroy {
+    private subscribeSvc;
+    /**
+     * Emits events each time the user starts dragging a region handle.
+     */
+    readonly dragStart: EventEmitter<LayoutDragEvent>;
+    /**
+     * Emits events each time the user stops dragging a region handle.
+     */
+    readonly dragStop: EventEmitter<LayoutDragEvent>;
+    /**
+     * Emits events each time the user is dragging a region handle.
+     */
+    readonly dragging: EventEmitter<LayoutDragEvent>;
+    /**
+     * @private
+     */
+    private onResize;
+    /**
+     * @private
+     */
+    private layoutContainer;
+    /**
+     * @private
+     */
+    private renderer;
+    /**
+     * @private
+     */
+    private set __containers__(value);
+    /**
+     * @private
+     */
+    constructor(subscribeSvc: SubscriptionService);
+    /**
+     * @private
+     * For test purpose only.
+     */
+    getRenderer(): BorderLayoutRenderer;
+    /**
+     * @private
+     */
+    ngOnDestroy(): void;
+    /**
+     * @private
+     */
+    ngAfterViewInit(): void;
+    /**
+     * Forces the container to be redrawn.
+     */
+    paint(): void;
+    /**
+     * Resizes the specified region.
+     *
+     * @param region The region to resize.
+     * @param size The new size of the region to resize.
+     *
+     * @returns `true` whether the specified region has been resized; `false` otherwise.
+     */
+    resizeRegion(region: LayoutRegion | LayoutRegionType, size: number): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<BorderLayout, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<BorderLayout, "atx-border-layout", never, {}, { "dragStart": "dragStart"; "dragStop": "dragStop"; "dragging": "dragging"; }, ["__containers__"], ["*"], true, never>;
+}

package/lib/component/layout/border-layout/util/border-layout-bounds-manager.d.ts

@@ -0,0 +1,131 @@
+/**
+ * @license
+ * Copyright Pascal ECHEMANN. All Rights Reserved.
+ *
+ * Use of this source code is governed by an MIT-style license that can be found in
+ * the LICENSE file at https://pascalechemann.com/angular-toolbox/resources/license
+ */
+import { BorderLayoutContainer } from '../../border-layout-container/border-layout-container.component';
+import { Destroyable, LayoutRegion } from '../../../../model';
+import { ResizeMethod } from './resize-method';
+/**
+ * @private
+ * A utility class that computes the size of all border layout containers.
+ */
+export declare class BorderLayoutBoundsManager implements Destroyable {
+    /**
+     * @private
+     * The container top position when the user starts to drag the handle.
+     */
+    private topPos;
+    /**
+     * @private
+     * The container left position when the user starts to drag the handle.
+     */
+    private leftPos;
+    /**
+     * @private
+     * The bounds of the center container.
+     */
+    private bounds;
+    /**
+     * Makes this object elligible for garbage collection.
+     */
+    destroy(): void;
+    /**
+     * Returns a rectangle that represents the bounds currently computed by this object.
+     *
+     * @returns The bounds currently computed by this object.
+     */
+    getBounds(): DOMRect;
+    /**
+     * Sets the top-left hand corner position before each bounds computaion.
+     *
+     * @param x The x position of the main container, in pixels, before computaion.
+     * @param y The y position of the main container, in pixels, before computaion.
+     */
+    setOrigin(x: number, y: number): void;
+    /**
+     * @private
+     * For test purpose only.
+     */
+    getOrigin(): any;
+    /**
+     * Computes the size of a "north" container.
+     *
+     * @param event The mouse event that triggered the computation of the container size.
+     * @param width The width of the main container.
+     * @param height The height of the main container.
+     * @param minSize The minimum size of the container for which to compute the size.
+     * @param maxSize The maximum size of the container for which to compute the size.
+     *
+     * @returns The size of a "north" container.
+     */
+    northResize(event: MouseEvent, width: number, height: number, minSize: number | undefined, maxSize: number | undefined): number;
+    /**
+     * @private
+     */
+    private setY;
+    /**
+     * Computes the size of a "south" container.
+     *
+     * @param event The mouse event that triggered the computation of the container size.
+     * @param width The width of the main container.
+     * @param height The height of the main container.
+     * @param minSize The minimum size of the container for which to compute the size.
+     * @param maxSize The maximum size of the container for which to compute the size.
+     *
+     * @returns The size of a "south" container.
+     */
+    southResize(event: MouseEvent, width: number, height: number, minSize: number | undefined, maxSize: number | undefined): number;
+    /**
+     * @private
+     */
+    private setHeight;
+    /**
+     * Computes the size of a "west" container.
+     *
+     * @param event The mouse event that triggered the computation of the container size.
+     * @param width The width of the main container.
+     * @param height The height of the main container.
+     * @param minSize The minimum size of the container for which to compute the size.
+     * @param maxSize The maximum size of the container for which to compute the size.
+     *
+     * @returns The size of a "west" container.
+     */
+    westResize(event: MouseEvent, width: number, height: number, minSize: number | undefined, maxSize: number | undefined): number;
+    /**
+     * @private
+     */
+    private setX;
+    /**
+     * Computes the size of a "east" container.
+     *
+     * @param event The mouse event that triggered the computation of the container size.
+     * @param width The width of the main container.
+     * @param height The height of the main container.
+     * @param minSize The minimum size of the container for which to compute the size.
+     * @param maxSize The maximum size of the container for which to compute the size.
+     *
+     * @returns The size of a "east" container.
+     */
+    eastResize(event: MouseEvent, width: number, height: number, minSize: number | undefined, maxSize: number | undefined): number;
+    /**
+     * @private
+     */
+    private setWidth;
+    /**
+     * Invoked after each `BorderLayoutContainer` registration to initialize the center container bounds.
+     *
+     * @param container A `BorderLayoutContainer` instance added to the main container.
+     */
+    initBounds(container: BorderLayoutContainer): void;
+    /**
+     * Returns the method used to compute the size of a container, depending on the specified region.
+     *
+     * @param region The region associated with the container for which to compute the size.
+     *
+     * @returns The method used to compute the size of a container.
+     */
+    getResizeMethod(region: LayoutRegion): ResizeMethod;
+}

package/lib/component/layout/border-layout/util/border-layout-renderer.d.ts

@@ -0,0 +1,87 @@
+/**
+ * @license
+ * Copyright Pascal ECHEMANN. All Rights Reserved.
+ *
+ * Use of this source code is governed by an MIT-style license that can be found in
+ * the LICENSE file at https://pascalechemann.com/angular-toolbox/resources/license
+ */
+import { EventEmitter, QueryList } from '@angular/core';
+import { BorderLayoutContainer } from '../../border-layout-container/border-layout-container.component';
+import { Destroyable, LayoutDragEvent, LayoutRegion, SubscriptionService } from '../../../../model';
+import { IdentifiableComponent } from '../../../../core';
+import { BorderLayoutBoundsManager } from './border-layout-bounds-manager';
+/**
+ * @private
+ * A controller object responsible for handling user actions on a `BorderLayout` container.
+ */
+export declare class BorderLayoutRenderer extends IdentifiableComponent implements Destroyable {
+    private subscribeSvc;
+    /**
+     * Emits events each time the user starts, or stops dragging handle.
+     */
+    readonly userAction: EventEmitter<LayoutDragEvent>;
+    /**
+     * @private
+     */
+    private lytContainerElm;
+    /**
+     * @private
+     */
+    private containerList;
+    /**
+     * @private
+     */
+    private boundsManager;
+    /**
+     * @private
+     */
+    constructor(subscribeSvc: SubscriptionService);
+    /**
+     * Add the list `BorderLayoutContainer` objects associated with the main container to this controller.
+     *
+     * @param containers the list `BorderLayoutContainer` objects associated with the main container.
+     */
+    addContainers(containers: QueryList<BorderLayoutContainer>): void;
+    /**
+     * Sets the reference to the HTML container associated with the main container.
+     *
+     * @param lytContainer The reference to the HTML container associated with the main container.
+     */
+    setLayoutContainer(lytContainer: HTMLDivElement): void;
+    /**
+     * @private
+     * For test purpose only.
+     * Returns the reference to the internal `BorderLayoutBoundsManager` instance.
+     */
+    getBoundsManager(): BorderLayoutBoundsManager;
+    /**
+     * Makes this object elligible for garbage collection.
+     */
+    destroy(): void;
+    /**
+     * Forces the layout of all `BorderLayoutContainer` objects associated with the main container.
+     */
+    paint(): void;
+    /**
+     * Resizes the specified region of the associated container.
+     *
+     * @param region The region to resize.
+     * @param size The new size of the region to resize.
+     *
+     * @returns `true` whether the specified region has been resized; `false` otherwise.
+     */
+    resizeRegion(region: LayoutRegion, size: number): boolean;
+    /**
+     * @private
+     */
+    private resizeEnter;
+    /**
+     * @private
+     */
+    private fireEvent;
+    /**
+     * @private
+     */
+    private render;
+    private checkLytContainer;
+}

package/lib/component/layout/border-layout/util/resize-method.d.ts

@@ -0,0 +1,13 @@
+/**
+ * @license
+ * Copyright Pascal ECHEMANN. All Rights Reserved.
+ *
+ * Use of this source code is governed by an MIT-style license that can be found in
+ * the LICENSE file at https://pascalechemann.com/angular-toolbox/resources/license
+ */
+/**
+ * @private
+ * A convenient type that describes methods used to compute the size of a `BorderlayoutContainer` object,
+ * depending on its region.
+ */
+export type ResizeMethod = (event: MouseEvent, width: number, height: number, minSize: number | undefined, maxSize: number | undefined) => number;

package/lib/component/layout/border-layout-container/border-layout-container.component.d.ts

@@ -0,0 +1,104 @@
+/**
+ * @license
+ * Copyright Pascal ECHEMANN. All Rights Reserved.
+ *
+ * Use of this source code is governed by an MIT-style license that can be found in
+ * the LICENSE file at https://pascalechemann.com/angular-toolbox/resources/license
+ */
+import { ElementRef, EventEmitter } from '@angular/core';
+import { LayoutConstraints, LayoutRegion } from '../../../model';
+import * as i0 from "@angular/core";
+/**
+ * A container that defines the region of a `BorderLayout` component instance.
+ */
+export declare class BorderLayoutContainer {
+    private elRef;
+    /**
+     * @private
+     * Indicates to the parent `BorderLayout` instance that the user starts to resize this container.
+     */
+    readonly resizeStart: EventEmitter<BorderLayoutContainer>;
+    /**
+     * @private
+     */
+    selected: Boolean;
+    /**
+     * Gets the CSS class associated with the region constraint of the `BorderLayoutContainer` object.
+     */
+    get class(): string;
+    /**
+     * @private
+     */
+    protected region: LayoutRegion;
+    /**
+     * @private
+     */
+    protected resizable: boolean;
+    /**
+     * @private
+     */
+    private atxConstraints;
+    /**
+     * @private
+     */
+    private size;
+    /**
+     * @private
+     */
+    private readonly style;
+    /**
+     * Gets or sets the constraints for this `BorderLayoutContainer` object.
+     */
+    get constraints(): LayoutConstraints;
+    set constraints(constraints: LayoutConstraints);
+    /**
+     * @private
+     */
+    constructor(elRef: ElementRef);
+    /**
+     * Sets the size of this container depending on the specified region.
+     *
+     * @param size The new size for this container, in pixels.
+     */
+    setSize(size: number | undefined): void;
+    /**
+     * Returns the size of the container, in pixels.
+     *
+     * @returns The size of the container.
+     */
+    getSize(): number;
+    /**
+     * Sets the left-hand side position of this container.
+     *
+     * @param position The left-hand side position of this container, in pixels.
+     */
+    setLeftPos(position: number): void;
+    /**
+     * Sets the right-hand side position of this container.
+     *
+     * @param position The right-hand side position of this container, in pixels.
+     */
+    setRightPos(position: number): void;
+    /**
+     * Sets the top position of this container.
+     *
+     * @param position The top position of this container, in pixels.
+     */
+    setTopPos(position: number): void;
+    /**
+     * Sets the bottom position of this container.
+     *
+     * @param position The bottom position of this container, in pixels.
+     */
+    setBottomPos(position: number): void;
+    /**
+     * @private
+     */
+    protected resizetart(): void;
+    /**
+     * @private
+     */
+    private initHandle;
+    static ɵfac: i0.ɵɵFactoryDeclaration<BorderLayoutContainer, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<BorderLayoutContainer, "atx-border-layout-container", never, { "constraints": { "alias": "constraints"; "required": false; }; }, {}, never, ["*"], true, never>;
+}

package/lib/component/layout/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./border-layout/border-layout.component";
+export * from "./border-layout-container/border-layout-container.component";

package/lib/model/business/ui/index.d.ts

@@ -3,3 +3,4 @@ export * from './dark-mode.constant';
 export * from './dark-mode-config.provider';
 export * from './scroll-behavior.type';
 export * from './window';
+export * from './layout';

package/lib/model/business/ui/layout/index.d.ts

@@ -0,0 +1,4 @@
+export * from './layout-constraints';
+export * from './layout-region';
+export * from './layout-drag.event';
+export * from './layout-drag-event-type.enum';

package/lib/model/business/ui/layout/layout-constraints.d.ts

@@ -0,0 +1,33 @@
+/**
+ * @license
+ * Copyright Pascal ECHEMANN. All Rights Reserved.
+ *
+ * Use of this source code is governed by an MIT-style license that can be found in
+ * the LICENSE file at https://pascalechemann.com/angular-toolbox/resources/license
+ */
+import { LayoutRegion, LayoutRegionType } from "./layout-region";
+/**
+ * Defines the layout constraints of a `BorderLayoutContainer` object.
+ */
+export interface LayoutConstraints {
+    /**
+     * Specifies the region of the `BorderLayoutContainer` object.
+     */
+    region: LayoutRegion | LayoutRegionType;
+    /**
+     * Indicates whether the `BorderLayoutContainer` object is resizable (`true`), or not (`false`).
+     */
+    resizable?: boolean;
+    /**
+     * Defines the default size of the `BorderLayoutContainer` object.
+     */
+    size?: number;
+    /**
+     * Defines the minimum size of the `BorderLayoutContainer` object.
+     */
+    minSize?: number;
+    /**
+     * Defines the maximum size of the `BorderLayoutContainer` object.
+     */
+    maxSize?: number;
+}

package/lib/model/business/ui/layout/layout-drag-event-type.enum.d.ts

@@ -0,0 +1,24 @@
+/**
+ * @license
+ * Copyright Pascal ECHEMANN. All Rights Reserved.
+ *
+ * Use of this source code is governed by an MIT-style license that can be found in
+ * the LICENSE file at https://pascalechemann.com/angular-toolbox/resources/license
+ */
+/**
+ * Defines the type of a `LayoutDragEvent` instance.
+ */
+export declare enum LayoutDragEventType {
+    /**
+     * Indicates that the dragging process is starting.
+     */
+    DRAG_START = "dragstart",
+    /**
+     * Indicates that the dragging process stopped.
+     */
+    DRAG_STOP = "dragstop",
+    /**
+     * Indicates that the user is dragging the container handle.
+     */
+    DRAGGING = "dragging"
+}

package/lib/model/business/ui/layout/layout-drag.event.d.ts

@@ -0,0 +1,32 @@
+/**
+ * @license
+ * Copyright Pascal ECHEMANN. All Rights Reserved.
+ *
+ * Use of this source code is governed by an MIT-style license that can be found in
+ * the LICENSE file at https://pascalechemann.com/angular-toolbox/resources/license
+ */
+import { BorderLayout, BorderLayoutContainer, LayoutDragEventType } from "projects/angular-toolbox/src/public-api";
+/**
+ * The `LayoutDragEvent` class is an event that represents a drag interaction with a `BorderLayoutContainer`.
+ */
+export declare class LayoutDragEvent {
+    /**
+     * The reference to the container that triggered this event.
+     */
+    readonly target: BorderLayoutContainer;
+    /**
+     * The reference to the layout that contains the target container.
+     */
+    layout: BorderLayout;
+    /**
+     * The type of this event; a `LayoutDragEventType` constant.
+     */
+    readonly type: LayoutDragEventType;
+    /**
+     * Creates a new `LayoutDragEvent` instance.
+     *
+     * @param target The container that triggered this event.
+     * @param type The type of this event.
+     */
+    constructor(target: BorderLayoutContainer, type: LayoutDragEventType);
+}

package/lib/model/business/ui/layout/layout-region.d.ts

@@ -0,0 +1,36 @@
+/**
+ * @license
+ * Copyright Pascal ECHEMANN. All Rights Reserved.
+ *
+ * Use of this source code is governed by an MIT-style license that can be found in
+ * the LICENSE file at https://pascalechemann.com/angular-toolbox/resources/license
+ */
+/**
+ * @private
+ */
+export type LayoutRegionType = "north" | "south" | "west" | "west" | "east" | "center";
+/**
+ * The list of layout constraints that defines the regions of a `BorderLayout` container.
+ */
+export declare enum LayoutRegion {
+    /**
+     * The north layout constraint (top of container).
+     */
+    NORTH = "north",
+    /**
+     * The south layout constraint (bottom of container).
+     */
+    SOUTH = "south",
+    /**
+     * The west layout constraint (left side of container).
+     */
+    WEST = "west",
+    /**
+     * The east layout constraint (right side of container).
+     */
+    EAST = "east",
+    /**
+     * The center layout constraint (middle of container).
+     */
+    CENTER = "center"
+}

package/lib/model/business/ui/window/window-init.d.ts

@@ -67,4 +67,9 @@ export interface WindowInit {
      * Specifies whether the menu bar is activated (`WindowFeatureState.YES`), or not (`WindowFeatureState.NO`).
      */
     menubar?: WindowFeatureState;
+    /**
+     * Indicates whether the winbdow is centered (`true`), or not (`false`).
+     * If `true`, the `top` and `left` properties are ignored.
+     */
+    center?: boolean;
 }

package/lib/util/index.d.ts

@@ -2,3 +2,4 @@ export * from './empty-string.const';
 export * from './aria-role.constant';
 export * from './uuid';
 export * from './js-type';
+export * from './version.util';

package/lib/util/version.util.d.ts

@@ -0,0 +1,30 @@
+/**
+ * @license
+ * Copyright Pascal ECHEMANN. All Rights Reserved.
+ *
+ * Use of this source code is governed by an MIT-style license that can be found in
+ * the LICENSE file at https://pascalechemann.com/angular-toolbox/resources/license
+ */
+import { Version } from "../model";
+/**
+ * A convenient utility class for working with `Version` objects.
+ */
+export declare class VersionUtil {
+    /**
+     * Returns a string that represents the specified `Version` object.
+     *
+     * @param version The `Version` object for which to get a string representation.
+     *
+     * @returns A string that represents the specified `Version` object.
+     */
+    static stringify(version: Version): string;
+    /**
+     * Compares the given `Version` objects.
+     *
+     * @param v1 The first object to compare.
+     * @param v2 The second object to compare.
+     *
+     * @returns `true` whether both `Version` objects are equal; `false` otherwise.
+     */
+    static equal(v1: Version, v2: Version): boolean;
+}

package/lib/util/window/window-features-builder.d.ts

@@ -19,6 +19,10 @@ export declare class BrowserWindowFeaturesBuilder {
      * @returns A string that represents the features parameter of the `Window.open()` method.
      */
     static build(init?: WindowInit): string;
+    /**
+     * @private
+     */
+    static setCenterPos(init: WindowInit): void;
     /**
      * @private
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "angular-toolbox",
-  "version": "1.2.2",
+  "version": "1.3.0",
   "license": "SEE LICENSE IN LICENSE",
   "peerDependencies": {
     "@angular/common": "^18.0.0",