@simpleangularcontrols/sac-common 10.0.0-rc.29 → 10.0.0-rc.30

package/controls/datetime/datetime.d.ts

@@ -5,16 +5,16 @@ import { AbstractControl, ValidationErrors } from '@angular/forms';
 import * as IMask from 'imask';
 import * as moment_ from 'moment';
 /**
- * Komponente für SacDateTimeCommon. Extends SacBaseDateTimeControl
+ * Component for SacDateTimeCommon. Extends SacBaseDateTimeControl
  */
 export declare abstract class SacDateTimeCommon extends SacBaseDateTimeControl {
     protected elementRef: ElementRef;
     /**
-     * Format des Datums
+     * Date format
      */
     readonly DATEFORMAT: string;
     /**
-     * Maske
+     * Mask
      */
     readonly imaskDate: {
         mask: string;
@@ -55,11 +55,11 @@ export declare abstract class SacDateTimeCommon extends SacBaseDateTimeControl {
         overwrite: boolean;
     };
     /**
-     * Maximaler Wert des Datums
+     * Maximum value of the date
      */
     _maxdate: Date;
     /**
-     * Minimaler Wert des Datums
+     * Minimum value of the date
      */
     _mindate: Date;
     /**
@@ -67,26 +67,27 @@ export declare abstract class SacDateTimeCommon extends SacBaseDateTimeControl {
      */
     moment: any;
     /**
-     * Resource Key für Validation Message MaxDate bei Control
+     * Resource key for validation message MaxDate at control
      */
     validationmessagemaxdate: string;
     /**
-     * Resource Key für Validation Message MinDate bei Control
+     * Resource key for validation message MinDate at control
      */
     validationmessagemindate: string;
     /**
-     * Resource Key für Validation Message MaxDate in Validation Summary
+     * Resource key for validation message MaxDate in validation summary
      */
     validationmessagesummarymaxdate: string;
     /**
-     * Resource Key für Validation Message MinDate in Validation Summary
+     * Resource key for validation message MinDate in validation summary
      */
     validationmessagesummarymindate: string;
     /**
      * Constructor
      * @param formlayout SacFormLayoutCommon to define scoped layout settings
      * @param injector Injector for injecting services
-     * @param elementRef reference to html element
+     * @param elementRef Reference to html element
+     * @param cdRef Change detector reference for updating component view
      */
     constructor(formlayout: SacFormLayoutCommon, injector: Injector, elementRef: ElementRef, cdRef: ChangeDetectorRef);
     /**
@@ -102,15 +103,15 @@ export declare abstract class SacDateTimeCommon extends SacBaseDateTimeControl {
      */
     set mindate(v: string | Date | null);
     /**
-     * Methode ergibt Datum-Format vom String
+     * Method returns date format from string
      */
     GetDateTimeFormatString(): string;
     /**
-     * Methode modifiziert den parsed Wert des Datums
+     * Method modifies the parsed value of the date
      */
     ModifyParsedDateTimeValue(v: moment_.Moment): moment_.Moment;
     /**
-     * Methode ergibt das selektierte Datum
+     * Method returns the selected date
      */
     dateselect(v: any): void;
     /**
@@ -118,7 +119,7 @@ export declare abstract class SacDateTimeCommon extends SacBaseDateTimeControl {
      */
     onClick(targetElement: any): void;
     /**
-     * DateSelector wird beim Click-Event angezeigt
+     * DateSelector is shown on click event
      */
     showDateSelector(): void;
     /**

package/controls/datetime/time.d.ts

@@ -5,16 +5,16 @@ import { AbstractControl, ValidationErrors } from '@angular/forms';
 import * as IMask from 'imask';
 import * as moment_ from 'moment';
 /**
- * Komponente für SacTimeCommon. Extends SacBaseDateTimeControl
+ * Component for SacTimeCommon. Extends SacBaseDateTimeControl
  */
 export declare class SacTimeCommon extends SacBaseDateTimeControl {
     protected elementRef: ElementRef;
     /**
-     * Format des Datums
+     * Date format
      */
     readonly TIMEFORMAT: string;
     /**
-     * Maske
+     * Mask
      */
     readonly imaskDate: {
         mask: string;
@@ -50,26 +50,27 @@ export declare class SacTimeCommon extends SacBaseDateTimeControl {
      */
     moment: any;
     /**
-     * Resource Key für Validation Message MinTime bei Control
+     * Resource Key for Validation Message MinTime at Control
      */
     validationmessagemaxtime: string;
     /**
-     * Resource Key für Validation Message MinTime bei Control
+     * Resource Key for Validation Message MinTime at Control
      */
     validationmessagemintime: string;
     /**
-     * Resource Key für Validation Message MinTime in Validation Summary
+     * Resource Key for Validation Message MinTime in Validation Summary
      */
     validationmessagesummarymaxtime: string;
     /**
-     * Resource Key für Validation Message MinTime in Validation Summary
+     * Resource Key for Validation Message MinTime in Validation Summary
      */
     validationmessagesummarymintime: string;
     /**
      * Constructor
      * @param formlayout SacFormLayoutCommon to define scoped layout settings
      * @param injector Injector for injecting services
-     * @param elementRef reference to html element
+     * @param elementRef Reference to html element
+     * @param cdRef Change detector reference for updating component view
      */
     constructor(formlayout: SacFormLayoutCommon, injector: Injector, elementRef: ElementRef, cdRef: ChangeDetectorRef);
     /**
@@ -85,11 +86,14 @@ export declare class SacTimeCommon extends SacBaseDateTimeControl {
      */
     set mintime(v: string | Date | null);
     /**
-     * Methode ergibt Datum-Format vom String
+     * Method returns date format from string
      */
     GetDateTimeFormatString(): string;
     /**
-     * Methode ergibt Datum - Moment
+     * Normalizes a parsed moment date to a base timeline context (year 1900, month January, day 1).
+     *
+     * @param v Parsed moment object.
+     * @returns Normalized moment object for internal comparison and validation.
      */
     ModifyParsedDateTimeValue(v: moment_.Moment): moment_.Moment;
     /**
@@ -97,15 +101,21 @@ export declare class SacTimeCommon extends SacBaseDateTimeControl {
      */
     onClick(targetElement: any): void;
     /**
-     * Zeigt Date Selector an
+     * Shows time selector
      */
     showTimeSelector(): void;
     /**
      * Time Selector
+     * @param v Selected time value object
      */
     timeselect(v: any): void;
     /**
-     * Validator
+     * Validates the input control value against min/max time constraints.
+     *
+     * Delegates to base validation and applies minTime/maxTime validations when applicable.
+     *
+     * @param c AbstractControl instance to validate.
+     * @returns ValidationErrors object when invalid, otherwise null.
      */
     validateData(c: AbstractControl): ValidationErrors | null;
 }

package/controls/dialog/dialog.d.ts

@@ -1,33 +1,33 @@
 import { ChangeDetectorRef, ElementRef, EventEmitter, OnDestroy } from '@angular/core';
 /**
- * Base Komponente für Dialog
+ * Base component for Dialog
  */
 export declare class SacDialogCommon implements OnDestroy {
     private cdRef;
     private hasSetBodyTag;
     /**
-     * Boolean Property definiert ob das Dialog angezeigt wird
+     * Boolean property defines whether the dialog is shown
      */
     _show: boolean;
     /**
-     * Das property enthielt (wenn überhaupt gesetzt) entweder keywords für sizing oder custom css Klassen.
-     * Die akzeptabel keywordssind: 'small', 'large', 'extralarge', 'medium', ''.
+     * This property contains (if set) either keywords for sizing or custom CSS classes.
+     * The acceptable keywords are: 'small', 'large', 'extralarge', 'medium', ''.
      */
     _size: 'small' | 'large' | 'extralarge' | 'medium' | '';
     /**
-     * Das input property akzeptiert boolen Wert. Definiert ob das Dialog darf durch ESC geschlossen werden. Default ist true.
+     * The input property accepts a boolean value. Defines whether the dialog can be closed by ESC. Default is true.
      */
     allowesc: boolean;
     /**
-     * Das input property akzeptiert boolen Wert. Definiert ob das Dialog darf durch click außerhalb des Dialog-Fenster geschlossen werden. Default ist true.
+     * The input property accepts a boolean value. Defines whether the dialog can be closed by clicking outside the dialog window. Default is true.
      */
     backdrop: boolean;
     /**
-     * Steuert ob im Header des Dialogs ein Button angezeigt wird.
+     * Controls whether a button is displayed in the header of the dialog.
      */
     closebutton: boolean;
     /**
-     * Name des Containers für den Dialog
+     * Name of the container for the dialog
      */
     dialogElement: ElementRef;
     /**
@@ -35,7 +35,11 @@ export declare class SacDialogCommon implements OnDestroy {
      */
     e2eidentifier: string | null;
     /**
-     * Output Emitter. Wird aufgerufen, wenn das Wert des _show property geändert ist - damait das Dialog geöfnet/geschlossen wird.
+     * If enabled dialog is closed if user click outside of the dialog
+     */
+    hideoutofdialog: boolean;
+    /**
+     * Output emitter. Called when the value of the _show property changes - so the dialog is opened/closed.
      */
     isvisibleChange: EventEmitter<boolean>;
     /**
@@ -43,31 +47,31 @@ export declare class SacDialogCommon implements OnDestroy {
      */
     name: string;
     /**
-     * Input Property. Erhält den Title des Dialog. Default Value: 'Dialog'.
+     * Input property. Receives the title of the dialog. Default value: 'Dialog'.
      */
     title: string;
     /**
-     * Konstruktor
-     * Inject des Formulars
+     * Creates the dialog control.
+     * @param cdRef Change detector used to trigger updates.
      */
     constructor(cdRef: ChangeDetectorRef);
     /**
-     * Implementation als Setter, da mit ngIf das Element bei Unsichtbarkeit UNDEFINED ist.
+     * Implementation as setter, because with ngIf the element is UNDEFINED when invisible.
      */
     set dialogElementSetter(content: ElementRef);
     /**
-     * Getter. Ergibt das boolen Wert des _show property
+     * Getter. Returns the boolean value of the _show property
      */
     get isvisible(): boolean;
     /**
-     * Setter. Erhält das boolen Wert des _show property
+     * Setter. Receives the boolean value of the _show property
      */
     set isvisible(v: boolean);
     /**
-     * Das Input akzeptiert sowohl default size-css-Klassen als auch custom Klassen.
-     * case insensitive.
-     * Die akzeptabel default-size-Klassen sind: 'small', 'large', 'extralarge', 'medium', ''.
-     * Wenn size ist NICHT gesetzt (oder 'medium' oder ''), default ist in medium size: max-width 500px.
+     * The input accepts both default size CSS classes and custom classes.
+     * Case insensitive.
+     * The acceptable default size classes are: 'small', 'large', 'extralarge', 'medium', ''.
+     * If size is NOT set (or 'medium' or ''), default is medium size: max-width 500px.
      */
     set size(v: 'small' | 'large' | 'extralarge' | 'medium' | '');
     /**
@@ -75,23 +79,25 @@ export declare class SacDialogCommon implements OnDestroy {
      */
     protected get ChangeDetector(): ChangeDetectorRef;
     /**
-     * Die Methode setz den Wert des _show property auf false
+     * The method sets the value of the _show property to false
      */
     hide(): void;
     /**
-     * Methode wenn Componente entfernt wird
+     * Method called when the component is destroyed
      */
     ngOnDestroy(): void;
     /**
      * Allow Close by Click outside Dialog
+     * @param event Click event object
      */
     onClick(event: any): void;
     /**
      * Allow Close by ESC
+     * @param event Keyboard event object
      */
     onKeydownHandler(event: KeyboardEvent): void;
     /**
-     * Die Methode setz den Wert des _show property auf true
+     * The method sets the value of the _show property to true
      */
     show(): void;
 }

package/controls/form/form.d.ts

@@ -1,43 +1,48 @@
 import { NgForm } from '@angular/forms';
 /**
- * Base Komponente für SacFormular
+ * Base component for SacForm
  */
 export declare class SacFormCommon {
     private form;
     /**
-     * Standardwert wann die Werte via NgModel aktualisiert werden
+     * Default value for when values are updated via NgModel
      */
     private _updateon;
     /**
-     * Konstruktor
-     * @param form Instanz von NgForm
+     * Constructor
+     * @param form Instance of NgForm
      */
     constructor(form: NgForm);
+    /**
+     * Returns the update strategy used by the form.
+     */
     get updateon(): FormHooks;
     /**
-     * Definiert, wenn das Model geupdatet wird
+     * Defines when the model is updated
      */
     set updateon(v: FormHooks);
     /**
-     * Gibt die NgForm Instanz zurück
+     * Returns the NgForm instance
+     * @returns The NgForm instance
      */
     getForm(): NgForm;
     /**
-     * Markiert alle Controls innerhalb des Formulares als Touched
+     * Marks all controls within the form as touched
      */
     markAsTouched(): void;
     /**
-     * Aktualisiert die Werte und den Gültigkeitsstatus des Formulars
+     * Updates the values and validity status of the form
+     * @param markAsTouched If true, all controls are marked as touched after validation update.
      */
     updateValueAndValidity(markAsTouched?: boolean): void;
     /**
-     * Markiert alle Controls inkl. dem Tree als Touched
-     * @param controls Controls Collection
+     * Marks all controls including the tree as touched
+     * @param controls Controls collection
      */
     private markAsTouchedInternal;
     /**
-     * Aktualisiert die Werte und die gültigkeit des Formulars
-     * @param controls Controls Collection
+     * Updates the values and validity of the form
+     * @param controls Controls collection
      */
     private updateValueAndValidityInternal;
 }

package/controls/grid/grid.d.ts

@@ -117,6 +117,7 @@ export declare abstract class SacGridCommon {
     RegisterColumn(): void;
     /**
      * Method for sorting the data.
+      * @param command Column key used to toggle sorting.
      */
     SortBy(command: any): void;
     /**

package/controls/grid/gridbutton.d.ts

@@ -47,6 +47,7 @@ export declare class SacGridButtonCommon {
     callaction(): void;
     /**
      * Defines the CSS class for the icon on the button
+     * @returns The CSS class name for the icon
      */
     getIconClass(): string;
 }

package/controls/grid/gridcolumn.d.ts

@@ -6,11 +6,14 @@ import { ElementRef, Injector } from '@angular/core';
  */
 export declare class SacGridColumnCommon extends SacGridColumnBaseCommon {
     /**
-     *  Defines whether the CSS class ellipsis is set.
+     * Defines whether the CSS class ellipsis is set.
      */
     private _ellipsis;
     /**
      * Constructor
+     * @param grid Reference to parent grid component
+     * @param injector Service injector for dependency resolution
+     * @param el Reference to host element
      */
     constructor(grid: SacGridCommon, injector: Injector, el: ElementRef);
     /**
@@ -23,6 +26,7 @@ export declare class SacGridColumnCommon extends SacGridColumnBaseCommon {
     set ellipsis(v: string | boolean);
     /**
      * Checks whether ellipsis is set
+     * @returns Boolean indicating whether ellipsis is set
      */
     IsEllipsis(): boolean;
 }

package/controls/grid/gridcolumnaction.d.ts

@@ -8,7 +8,7 @@ export declare class SacGridColumnActionCommon extends SacGridColumnBaseCommon {
     /**
      * Constructor
      * @param el Element reference
-     * @param injector di inector to resolve icon service
+     * @param injector DI injector to resolve icon service
      * @param grid SacGridCommon
      */
     constructor(grid: SacGridCommon, injector: Injector, el: ElementRef);

package/controls/grid/gridcolumnbase.d.ts

@@ -58,9 +58,9 @@ export declare class SacGridColumnBaseCommon implements OnInit, OnDestroy {
     width: string;
     /**
      * Constructor
-     * @param grid  reference to grid component
-     * @param injector di injector to resolve icon service
-     * @param el reference to html element
+     * @param grid Reference to grid component
+     * @param injector DI injector to resolve icon service
+     * @param el Reference to HTML element
      */
     constructor(grid: SacGridCommon, injector: Injector, el: ElementRef);
     /**
@@ -77,22 +77,27 @@ export declare class SacGridColumnBaseCommon implements OnInit, OnDestroy {
     ColumnClick(): void;
     /**
      * Indicates the direction of sorting. The possible values are `none`,`asc`,`desc`
+     * @returns The sort direction as string (none, asc, or desc)
      */
     GetSortDirection(): string;
     /**
      * Defines whether the element is a cell in the table.
+     * @returns Boolean indicating if element is in table body
      */
     IsBody(): boolean;
     /**
      * Defines whether the element is a cell in the footer of the table
+     * @returns Boolean indicating if element is in table footer
      */
     IsFooter(): boolean;
     /**
      * Defines whether the element is a cell in the table header
+     * @returns Boolean indicating if element is in table header
      */
     IsHeader(): boolean;
     /**
      * Defines whether this column is sorted.
+     * @returns Boolean indicating if column is sorted
      */
     IsSortedColumn(): boolean;
     /**

package/controls/grid/model.d.ts

@@ -18,13 +18,16 @@ export declare enum SortOrder {
      */
     Descending = 2
 }
+/**
+ * Carries grid data payload along with total record count for pagination.
+ */
 export declare class GridResponse<T> {
     /**
-     * Data
+     * Data array for the current page.
      */
     Data: T[];
     /**
-     * Total number of data records
+     * Total number of records available from the data source.
      */
     TotalRowCount: number;
 }

package/controls/grid/paging.d.ts

@@ -74,8 +74,7 @@ export declare abstract class SacPagingCommon {
     pagingtext: string;
     /**
      * Constructor
-     * @parent SacFormCommon
-     * @injector Injector
+     * @param injector Service injector for dependency resolution
      */
     constructor(injector: Injector);
     /**
@@ -105,7 +104,7 @@ export declare abstract class SacPagingCommon {
      */
     changePageSize(newSize: number): void;
     /**
-     *Switch to 1st page
+     * Switch to 1st page
      */
     firstPage(): void;
     /**

package/controls/input/input.d.ts

@@ -1,11 +1,11 @@
 import { SacInputBase } from '../../common/baseinputcontrol';
 import { AbstractControl, ValidationErrors } from '@angular/forms';
 /**
- * Basis Komponente für SacInput
+ * Base component for SacInput
  */
 export declare class SacInputCommon extends SacInputBase<string> {
     /**
-     * Fix breite für das Control definieren.
+     * Define fixed width for the control.
      */
     controlwidth: string;
     /**
@@ -13,23 +13,23 @@ export declare class SacInputCommon extends SacInputBase<string> {
      */
     maxtextlength: number;
     /**
-     * Resource Key für Validation Message Pattern bei Control
+     * Resource key for validation message pattern at control
      */
     validationmessagepattern: string;
     /**
-     * Resource Key für Validation Message Required bei Control
+     * Resource key for validation message required at control
      */
     validationmessagerequired: string;
     /**
-     * Resource Key für Validation Message Pattern in Validation Summary
+     * Resource key for validation message pattern in validation summary
      */
     validationmessagesummarypattern: string;
     /**
-     * Resource Key für Validation Message Required in Validation Summary
+     * Resource key for validation message required in validation summary
      */
     validationmessagesummaryrequired: string;
     /**
-     * Methode validiert, ob der Wert den gegebenen Kriterien entspricht
+     * Method validates whether the value meets the given criteria
      */
     validateData(c: AbstractControl): ValidationErrors | null;
 }

package/controls/input/inputarea.d.ts

@@ -1,26 +1,28 @@
 import { SacInputCommon } from './input';
 /**
- * Basis Komponente für SacInputArea
+ * Base component for SacInputArea
  */
 export declare class SacInputAreaCommon extends SacInputCommon {
     /**
-     * Property mit dem Custom CSS Klassen auf dem Form-Control definiert werden können.
+     * Property where custom CSS classes can be defined on the form control.
      */
     customcssclass: string;
     /**
-     * Definiert die Höhe der TextArea Box. Ist normalfall leer, da Höhe auch über Rows gesetzt werden kann.
+     * Defines the height of the textarea box. Normally empty, as height can also be set via rows.
      */
     height: string;
     /**
-     * Definiert die Höhe der TextArea Box.
+     * Defines the number of rows for the textarea box.
      */
     rows: number;
     /**
-     * Getter für die Länge des Inputs
+     * Getter for the length of the input
      */
     get _currentLength(): number;
     /**
-     * Methode wird 'true' ergeben wenn ein Key gedrückt wird und maxtextlength ist nicht definiert
+     * Method returns 'true' when a key is pressed and maxtextlength is not defined
+     * @param event The keyboard event
+     * @returns Boolean indicating whether the key press is allowed (undefined if maxtextlength is not defined)
      */
     onKeyPress(event: KeyboardEvent): Boolean;
 }

package/controls/input/inputcurrency.d.ts

@@ -1,8 +1,11 @@
 import { SacInputDecimalCommon } from './inputdecimal';
 /**
- * Basis Komponente für SacInputCurrency
+ * Base component for SacInputCurrency
  */
 export declare class SacInputCurrencyCommon extends SacInputDecimalCommon {
+    /**
+     * Currency symbol or code used by the input control. If empty, it falls back to configured default.
+     */
     currency: string;
     /**
      * Set currency during initialization if no value is defined.