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

package/common/basedatetimecontrol.d.ts

@@ -1,22 +1,22 @@
 import { SacFormLayoutCommon } from '../controls/layout/formlayout';
 import { TooltipPosition } from '../utilities/enums';
 import { SacBaseModelControl } from './basemodelcontrol';
-import { ChangeDetectorRef, DoCheck, ElementRef, Injector, OnDestroy, OnInit } from '@angular/core';
+import { ChangeDetectorRef, ElementRef, Injector, OnDestroy, OnInit } from '@angular/core';
 import { AbstractControl, ValidationErrors } from '@angular/forms';
 import { IMaskDirective } from 'angular-imask';
 import * as moment_ from 'moment';
 /**
- * Base Klasse für Date/Time Controls
+ * Base class for Date/Time controls
  */
-export declare abstract class SacBaseDateTimeControl extends SacBaseModelControl<Date> implements OnInit, OnDestroy, DoCheck {
+export declare abstract class SacBaseDateTimeControl extends SacBaseModelControl<Date> implements OnInit, OnDestroy {
     protected elementRef: ElementRef;
     private readonly cdRef;
     /**
-     * Helper class to display tooltip on correct position
+     * Helper class to display tooltips in the correct position
      */
     private readonly popupHelper;
     /**
-     * das property enthielt das Value als string. Default ist ''
+     * This property contains the value as a string. Default is ''
      */
     protected _valueAsString: string;
     /**
@@ -28,7 +28,7 @@ export declare abstract class SacBaseDateTimeControl extends SacBaseModelControl
      */
     TooltipPosition: typeof TooltipPosition;
     /**
-     * Definiert ob der Date Selector angezeigt wird
+     * Defines whether the date selector is displayed
      */
     _showselector: boolean;
     /**
@@ -36,7 +36,7 @@ export declare abstract class SacBaseDateTimeControl extends SacBaseModelControl
      */
     iMask: IMaskDirective<any>;
     /**
-     * Definiert das Control als Required
+     * Defines the control as required
      */
     isrequired: boolean;
     /**
@@ -47,6 +47,9 @@ export declare abstract class SacBaseDateTimeControl extends SacBaseModelControl
      * Arrow Item of Picker Element. Required to set the position of arrow correctly
      */
     pickerPosition: typeof TooltipPosition;
+    /**
+     * Reference to the picker arrow element used for calculating tooltip arrow position.
+     */
     pickerarrow: ElementRef<HTMLElement> | null;
     /**
      * Name of the container for content (e.g. icon) on which the tooltip is displayed.
@@ -79,43 +82,44 @@ export declare abstract class SacBaseDateTimeControl extends SacBaseModelControl
      */
     position: string;
     /**
-     * Resource Key für Validation Message DateTimeFormat bei Control
+     * Resource Key for Validation Message DateTimeFormat at Control
      */
     validationmessagedatetimeformat: string;
     /**
-     * Resource Key für Validation Message DateTimeFormat in Validation Summary
+     * Resource Key for Validation Message DateTimeFormat in Validation Summary
      */
     validationmessagedatetimeformatsummary: 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 Required in Validation Summary
+     * Resource Key for Validation Message Required in Validation Summary
      */
     validationmessagerequiredsummary: 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);
     /**
-     * Setter for the name of the container for the tooltip. Is required as the tooltip can be hidden via ngIf.
+     * Setter for the name of the container for the tooltip. Required because the tooltip can be hidden via ngIf.
      */
     set picker(picker: ElementRef);
     get tooltop(): ElementRef;
     /**
-     * getter für valuestring
+     * Getter for valuestring
      */
     get valuestring(): string;
     /**
-     * Das Input bekommt das value von typ string
+     * The input receives the value of type string
      */
     set valuestring(v: string);
     /**
-     * Die methode returns dateTime in string
+     * The method returns dateTime as a string
      */
     abstract GetDateTimeFormatString(): string;
     /**
@@ -123,11 +127,13 @@ export declare abstract class SacBaseDateTimeControl extends SacBaseModelControl
      */
     GetPickerPosition(): TooltipPosition;
     /**
-     * Die methode modifiziert das eingegebene Value von typ Moment
+     * The method modifies the entered value of type Moment
      */
     abstract ModifyParsedDateTimeValue(v: moment_.Moment): moment_.Moment;
     /**
-     * JSON Date String in ein UTC DateTime Object konvertieren, welches vom Control verwendete werden kann
+     * Converts a JSON date string into a UTC DateTime object that can be used by the control
+     * @param timestamp Date timestamp to convert
+     * @returns Moment object in UTC
      */
     getDate(timestamp: any): moment.Moment;
     /**
@@ -138,25 +144,42 @@ export declare abstract class SacBaseDateTimeControl extends SacBaseModelControl
      * Calculates the width of the picker
      */
     getPickerWidth(): number;
-    ngDoCheck(): void;
+    /**
+     * Clean up resources when the control is destroyed.
+     *
+     * Removes the picker element from the DOM if visible and unregisters global resize/scroll listeners.
+     */
     ngOnDestroy(): void;
     /**
      * Init Event
      */
     ngOnInit(): void;
     /**
-     * setzt das value von typ string zu property valuestring
+     * Sets the value of type string to the property valuestring
+     * @param v String value to set
      */
     setValueString(v: string): void;
     /**
-     * Validator
+     * Validates the datetime control value format and required status.
+     *
+     * @param c AbstractControl instance to validate.
+     * @returns ValidationErrors if invalid, otherwise null.
      */
     validateData(c: AbstractControl): ValidationErrors | null;
     /**
      * Overwrite WriteValue to Set correct Date Object
+     * @param value Date or string value to write to the control
      */
     writeValue(value: Date | string): void;
+    /**
+     * Gets the height of the arrow element
+     * @returns The height in pixels of the arrow element, or 0 if not present
+     */
     protected getArrowHeight(): number;
+    /**
+     * Gets the width of the arrow element
+     * @returns The width in pixels of the arrow element, or 0 if not present
+     */
     protected getArrowWidth(): number;
     /**
      * Calculates the position of the tooltip from links
@@ -170,5 +193,8 @@ export declare abstract class SacBaseDateTimeControl extends SacBaseModelControl
      * method if content has changed and proportions need to be reset in the UI.
      */
     private readonly onContentChange;
+    /**
+     * Sets the date-time format string from the configured format property
+     */
     private setDateTimeFormat;
 }

package/common/baseinputcontrol.d.ts

@@ -1,18 +1,18 @@
 import { SacBaseModelControl } from './basemodelcontrol';
 /**
- * Abstract Klasse für SacInputBase. Extendes SacBaseModelControl
+ * Abstract class for SacInputBase. Extends SacBaseModelControl
  */
 export declare abstract class SacInputBase<VALUE> extends SacBaseModelControl<VALUE> {
     /**
-     * Erlaubte Zeichen bei der Eingabe
+     * Allowed characters for input
      */
     allowedchars: string;
     /**
-     * Autofill aktivieren oder deaktivieren
+     * Enable or disable autofill
      */
     disableautocomplete: boolean;
     /**
-     * Definiert das Control als Required
+     * Defines the control as required
      */
     isrequired: boolean;
     /**
@@ -20,19 +20,21 @@ export declare abstract class SacInputBase<VALUE> extends SacBaseModelControl<VA
      */
     placeholder: string;
     /**
-     * Macht das Input readonly
+     * Makes the input readonly
      */
     readonly: boolean;
     /**
-     * Definiert das Feld als valid/invalid von eingegebenen regex-pattern
+     * Defines the field as valid/invalid by entered regex pattern
      */
     regexvalidation: string;
     /**
-     * Methode validiert Input wenn KeyPress-Event passiert
+     * Method validates input when keypress event occurs
+     * @param event Keyboard event object
+     * @returns Boolean indicating whether the event should propagate
      */
     onKeyPress(event: KeyboardEvent): Boolean;
     /**
-     * Methode validiert wenn ein Drück-Event passiert
+     * Method validates when a keypress event occurs
      */
     protected OnKeyPressValidation(position: number, character: string): boolean;
 }

package/common/baselistcontrol.d.ts

@@ -1,7 +1,7 @@
-import { TemplateRef } from '@angular/core';
 import { SacBaseModelControl } from './basemodelcontrol';
+import { TemplateRef } from '@angular/core';
 /**
- * Abstract Klasse für SacBaseListControl. Extendes SacBaseModelControl
+ * Abstract class for SacBaseListControl. Extends SacBaseModelControl
  */
 export declare abstract class SacBaseListControl<VALUE> extends SacBaseModelControl<VALUE> {
     /**
@@ -9,35 +9,35 @@ export declare abstract class SacBaseListControl<VALUE> extends SacBaseModelCont
      */
     _options: any[];
     /**
-     * Template für Value Element
+     * Defines the control as required
      */
-    optionlabeltemplate: TemplateRef<any>;
+    isrequired: boolean;
     /**
-     * Definiert das Label für das Option Element
+     * Defines whether the option element is active
      */
-    optionlabel: string;
+    optionenabled: string;
     /**
-     * Definiert den Wert für das Option Element
+     * Defines the label for the option element
      */
-    optionvalue: string;
+    optionlabel: string;
     /**
-     * Definiert, ob das Option Element aktiv ist
+     * Template for value element
      */
-    optionenabled: string;
+    optionlabeltemplate: TemplateRef<any>;
     /**
-     * Definiert das Control als Required
+     * Defines the value for the option element
      */
-    isrequired: boolean;
+    optionvalue: string;
     /**
-     * Style Breite für List Control Element
+     * Style width for list control element
      */
     width: string;
     /**
-     * Input property für options
+     * Input property for options
      */
     get options(): any[];
     /**
-     * setter für options
+     * Setter for options
      */
     set options(val: any[]);
 }

package/common/basemodelcontrol.d.ts

@@ -9,12 +9,12 @@ import { Injector, OnInit } from '@angular/core';
 import { AbstractControl, ControlValueAccessor, FormControl, ValidationErrors, Validator } from '@angular/forms';
 import { Observable } from 'rxjs';
 /**
- * Abstract Klasse für SacBaseModelControl. Implements ControlValueAccessor, Validator, OnInit
+ * Abstract class for SacBaseModelControl. Implements ControlValueAccessor, Validator, OnInit
  */
 export declare abstract class SacBaseModelControl<VALUE> implements ControlValueAccessor, Validator, OnInit {
     private readonly injector;
     /**
-     * Inline Errors für das Control
+     * Inline errors for the control
      */
     private _inlineerrorenabled;
     /**
@@ -26,11 +26,11 @@ export declare abstract class SacBaseModelControl<VALUE> implements ControlValue
      */
     protected readonly configurationService: ISacConfigurationService;
     /**
-     * Boolean Property dirty; default Wert - false
+     * Boolean property dirty; default value - false
      */
     protected _dirty: boolean;
     /**
-     * SacModel Form ist disabled
+     * SacModel form is disabled
      */
     protected _disabledForm: boolean;
     /**
@@ -38,11 +38,11 @@ export declare abstract class SacBaseModelControl<VALUE> implements ControlValue
      */
     protected _onChange: () => void;
     /**
-     * Boolean Property touched; default Wert - false
+     * Boolean property touched; default value - false
      */
     protected _touched: boolean;
     /**
-     * Interne Variable, die den Wert des Controls hält
+     * Internal variable that holds the value of the control
      */
     protected _value: VALUE;
     /**
@@ -54,7 +54,7 @@ export declare abstract class SacBaseModelControl<VALUE> implements ControlValue
      */
     protected iconService: ISacIconService;
     /**
-     * Service für Error Localisation
+     * Service for error localisation
      */
     protected lngResourceService: ISacLocalisationService;
     /**
@@ -70,11 +70,11 @@ export declare abstract class SacBaseModelControl<VALUE> implements ControlValue
      */
     componentHeight: ControlHeight | null;
     /**
-     * Deaktiviert das Input Control
+     * Disables the input control
      */
     disabled: boolean;
     /**
-     * Deaktiviert das Label im Template
+     * Disables the label in the template
      */
     disablelabel: boolean;
     /**
@@ -94,9 +94,9 @@ export declare abstract class SacBaseModelControl<VALUE> implements ControlValue
      */
     inlineError: boolean;
     /**
-     * defines that the labels are displayed as adaptive labels
+     * Label Mode 'standard' | 'floating' or null (null = use global configuration)
      */
-    isAdaptiveLabel: boolean;
+    labelMode: 'standard' | 'floating' | null;
     /**
      * default labe size for large devices
      */
@@ -122,15 +122,15 @@ export declare abstract class SacBaseModelControl<VALUE> implements ControlValue
      */
     labelSizeXxl: number | null;
     /**
-     * Name des Controls
+     * Name of the control
      */
     name: string;
     /**
-     * Leere Implementation von "propagateChange". Muss gemacht werden, damit kein Fehler entsteht
+     * Empty implementation of "propagateChange". Must be done to avoid errors
      */
     propagateChange: any;
     /**
-     * Leere Implementation von "propagateTouch". Muss gemacht werden, damit kein Fehler entsteht
+     * Empty implementation of "propagateTouch". Must be done to avoid errors
      */
     propagateTouch: any;
     /**
@@ -152,7 +152,7 @@ export declare abstract class SacBaseModelControl<VALUE> implements ControlValue
      */
     get HelptextTooltipIcon(): string;
     /**
-     * Methode ergibt Boolean Wert für dirty
+     * Method returns boolean value for dirty
      */
     get dirty(): boolean;
     /**
@@ -160,15 +160,15 @@ export declare abstract class SacBaseModelControl<VALUE> implements ControlValue
      */
     get inlineerrorenabled(): boolean | null;
     /**
-     * Aktiviert oder Deaktiviert die Inline Errors für das Control
+     * Enables or disables the inline errors for the control
      */
     set inlineerrorenabled(value: boolean | null);
     /**
-     * Methode ergibt boolean Wert wenn Form invalid oder nicht invalid ist
+     * Method returns a boolean value indicating whether the form is invalid
      */
     get invalid(): boolean;
     /**
-     * Definiert ob das Control disabled ist
+     * Defines whether the control is disabled
      */
     get isdisabled(): boolean;
     /**
@@ -176,32 +176,32 @@ export declare abstract class SacBaseModelControl<VALUE> implements ControlValue
      */
     get isinlineerrorenabled(): boolean;
     /**
-     * Definiert den Label Text
+     * Defines the label text
      */
     get label(): string;
     /**
-     * Definiert den Label Text
+     * Sets the label text
      */
     set label(v: string);
     /**
-     * returns an object with all label sizes. These values can then be transferred to corresponding CSS classes using a pipe
+     * Returns an object with all label sizes. These values can then be transferred to corresponding CSS classes using a pipe
      */
     get labelSizes(): ISacLabelSizes;
     /**
-     * Methode ergibt Boolean Wert für touched
+     * Method returns boolean value for touched
      */
     get touched(): boolean;
     /**
-     * Get Methode für NgModel Binding in Html Markup
+     * Get method for NgModel binding in HTML markup
      */
     get value(): VALUE;
     /**
-     * Set Methode für NgModel Binding in Html Markup
-     * Input wird benötigt, damit der Wert auch über das Markup gesetzt werden kann.
+     * Set method for NgModel binding in HTML markup
+     * Input is required so that the value can also be set via the markup.
      */
     set value(v: VALUE);
     /**
-     * Methode ergibt Error anhand von gegebenen Kriterien
+     * Method returns error based on given criteria
      */
     GetErrorMessage(): Observable<string>;
     /**
@@ -209,50 +209,63 @@ export declare abstract class SacBaseModelControl<VALUE> implements ControlValue
      */
     ngOnInit(): void;
     /**
-     * Methode ergibt boolean touched = true
+     * Method sets touched = true
      */
     onTouch(): void;
     /**
-     * Methode, damit andere Controls änderungen im Control mitbekommen können
-     * Zur Änderungsinfo die Methode propagateChange aufrufen.
+     * Method so that other controls can be notified of changes in the control
+     * For change notification, call the propagateChange method.
+     * @param fn Callback function for change notification
      */
     registerOnChange(fn: any): void;
     /**
-     * Methode, damit andere Controls änderungen mitbekommen, wenn das Control aktiviert (Focus) wird.
+     * Method so that other controls can be notified of changes when the control is activated (focus).
+     * @param fn Callback function for touch notification
      */
     registerOnTouched(fn: any): void;
     /**
-     * Methode registriert Änderungen bei der Validierung
+     * Method registers changes in validation
+     * @param fn Callback function for validator change notification
      */
     registerOnValidatorChange(fn: () => void): void;
     /**
-     * Setzt das Control auf Disabled
+     * Sets the control to disabled
+     * @param isDisabled True to disable the control, false to enable it
      */
     setDisabledState(isDisabled: boolean): void;
     /**
-     * Methode die den Wert des Inputs setzt
+     * Method that sets the value of the input
+     * @param v The value to set
      */
     setValue(v: VALUE): void;
     /**
-     * Validator Methode
+     * Validator method
+     * @param c Form control to validate
+     * @returns Validation errors or null if valid
      */
     validate(c: AbstractControl): ValidationErrors | null;
     /**
-     * Abstrakte Validator Methode
+     * Abstract validator method for form control value.
+     *
+     * Derived classes should check control value and return validation errors or null.
+     *
+     * @param c Form control being validated
+     * @returns ValidationErrors if invalid, otherwise null
      */
     abstract validateData(c: AbstractControl): ValidationErrors | null;
     /**
-     * Methode zum schreiben von Werten aus dem Model in das Control
+     * Method for writing values from the model into the control
+     * @param value The value to write to the control
      */
     writeValue(value: VALUE): void;
     /**
-     * Method can Overwriten in Parent Classes
-     * @param value Wert welcher in den korrekten Typ konvertiert werden soll
-     * @returns Wert im korrekten Typ
+     * Method can be overridden in parent classes
+     * @param value Value that should be converted to the correct type
+     * @returns Value in the correct type
      */
     protected ConvertInputValue(value: VALUE): VALUE;
     /**
-     * Methode ergibt Decimal Symbol
+     * Method returns the decimal symbol
      */
     protected GetDecimalSymbol(): string;
     /**
@@ -260,7 +273,7 @@ export declare abstract class SacBaseModelControl<VALUE> implements ControlValue
      */
     protected OnClassInit(): void;
     /**
-     * Aktualisiert den NgModel Wert und die Gültigkeit des Validators des Controls
+     * Updates the NgModel value and the validity of the control's validator
      */
     protected UpdateValueAndValidity(): void;
     private UpdateLabelToControl;
@@ -273,12 +286,15 @@ export declare abstract class SacBaseModelControl<VALUE> implements ControlValue
      */
     private setHelpTextMode;
     /**
-     * Set adaptive label property from parent layout control
+     * Sets the label display mode from property or parent layout control
      */
-    private setIsAdaptiveLabel;
+    private setLabelMode;
     /**
      * Set label sizes from property or parent layout control
      */
     private setLabelSizes;
+    /**
+     * Sets the label split mode from property or parent layout control\n
+     **/
     private setLabelSplitMode;
 }

package/common/baseselectcontrol.d.ts

@@ -1,14 +1,14 @@
 import { SacBaseListControl } from './baselistcontrol';
 /**
- * Abstract Klasse für SacBaseSelectControl. Extendes SacBaseListControl
+ * Abstract class for SacBaseSelectControl. Extends SacBaseListControl
  */
 export declare abstract class SacBaseSelectControl<VALUE> extends SacBaseListControl<VALUE> {
     /**
-     * Definiert das Label für das Group Element
+     * Defines the collection of items in the group element
      */
-    grouplabel: string;
+    groupitems: string;
     /**
-     * Definiert die Collection der Items im Group Element
+     * Defines the label for the group element
      */
-    groupitems: string;
+    grouplabel: string;
 }