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

package/controls/tooltip/tooltip.d.ts

@@ -35,7 +35,7 @@ export declare abstract class SacTooltipCommon implements OnInit, OnDestroy, Aft
      */
     IsTooltipContentVisible: boolean;
     /**
-     * Position des Tooltips links
+     * Position of the tooltip on the left
      */
     LeftPos: number;
     /**
@@ -77,8 +77,9 @@ export declare abstract class SacTooltipCommon implements OnInit, OnDestroy, Aft
      */
     tooltiptext: string;
     /**
-     * Konstruktor
-     * @param ref Element Referenz
+     * Constructor
+     * @param cdRef Change detector reference for updating component view
+     * @param ref Element reference
      */
     constructor(cdRef: ChangeDetectorRef, ref: ElementRef);
     /**
@@ -96,6 +97,7 @@ export declare abstract class SacTooltipCommon implements OnInit, OnDestroy, Aft
     get tooltop(): ElementRef;
     /**
      * Returns the position of the tooltip
+     * @returns TooltipPosition The calculated position for the tooltip
      */
     GetTooltipPosition(): TooltipPosition;
     /**
@@ -104,6 +106,7 @@ export declare abstract class SacTooltipCommon implements OnInit, OnDestroy, Aft
     HideTooltip(): void;
     /**
      * Defines whether the tooltip is present in the markup
+     * @returns Boolean indicating whether the tooltip is visible
      */
     IsTooltipVisible(): boolean;
     /**
@@ -112,18 +115,20 @@ export declare abstract class SacTooltipCommon implements OnInit, OnDestroy, Aft
     ShowTooltip(): void;
     /**
      * Calculates the height of the tooltip
+     * @returns The height of the tooltip in pixels
      */
     getToolTipHeight(): number;
     /**
      * Calculates the width of the tooltips
+     * @returns The width of the tooltip in pixels
      */
     getToolTipWidth(): number;
     /**
-     * Detect Changes after view checked. Prevent ExpressionChangedAfterItHasBeenCheckedError error
+     * Detect changes after view checked. Prevent ExpressionChangedAfterItHasBeenCheckedError error
      */
     ngAfterViewChecked(): void;
     /**
-     * Detect UI Changes to Calculate Tooltip correct
+     * Detect UI changes to calculate tooltip correctly
      */
     ngDoCheck(): void;
     /**

package/controls/treeview/treeview.d.ts

@@ -4,7 +4,7 @@ import { SacFormLayoutCommon } from '../layout/formlayout';
 import { EventEmitter, Injector, TemplateRef } from '@angular/core';
 import { AbstractControl, ValidationErrors } from '@angular/forms';
 /**
- * Basis Komponente für SacTreeView
+ * Base component for SacTreeView
  */
 export declare class SacTreeviewCommon extends SacBaseModelControl<any> {
     /**
@@ -52,7 +52,7 @@ export declare class SacTreeviewCommon extends SacBaseModelControl<any> {
      */
     data: any[];
     /**
-     * Activates the 'expand' and 'collabse' event even if a node has no children. This is helpful if node elements are to be reloaded at runtime.
+     * Activates the 'expand' and 'collapse' event even if a node has no children. This is helpful if node elements are to be reloaded at runtime.
      */
     enableasynchload: boolean | string;
     /**
@@ -100,21 +100,22 @@ export declare class SacTreeviewCommon extends SacBaseModelControl<any> {
      */
     templatelabel: TemplateRef<any>;
     /**
-     * Resource Key für Validation Message Required bei Control
+     * Resource key required for validation message at control
      */
     validationmessagerequired: string;
     /**
-     * Resource Key für Validation Message Required in Validation Summary
+     * Resource key required for validation message in the validation summary
      */
     validationmessagesummaryrequired: string;
     /**
      * Constructor
+     * @param formlayout Form layout directive for scoped layout settings
      * @param injector Service Injector
      */
     constructor(formlayout: SacFormLayoutCommon, injector: Injector);
     get iconAction(): string;
     /**
-     * CSS icon for folders in tree there are collabsed
+     * CSS icon for folders in tree that are collapsed
      * @returns css class with icon
      */
     get iconFolderCollabsed(): string;
@@ -134,12 +135,48 @@ export declare class SacTreeviewCommon extends SacBaseModelControl<any> {
      * @returns Array
      */
     count(size: number): Array<void>;
+    /**
+     * Get the child nodes of a node
+     * @param node Parent node
+     * @returns Array of child nodes
+     */
     getChildren(node: any): any[];
+    /**
+     * Get string field value from node
+     * @param node Node object
+     * @param fieldname Field name to retrieve
+     * @returns The field value as string or empty string
+     */
     getStringField(node: any, fieldname: string): any;
+    /**
+     * Check if node has children
+     * @param node Node to check
+     * @returns Boolean indicating if node has child nodes
+     */
     hasChildren(node: any): boolean;
+    /**
+     * Check if node is in disabled state
+     * @param node Node to check
+     * @returns Boolean indicating if node is disabled
+     */
     isDisabledState(node: any): boolean;
+    /**
+     * Check if node is in expanded state
+     * @param node Node to check
+     * @returns Boolean indicating if node is expanded
+     */
     isExpandedState(node: any): boolean;
+    /**
+     * Check if node is in hover state
+     * @param node Node to check
+     * @returns Boolean indicating if node is hovered
+     */
     isHoverState(node: any): boolean;
+    /**
+     * Check if node is in selected state
+     * @param node Node to check
+     * @returns Boolean indicating if node is selected
+     */
     isSelectedState(node: any): boolean;
     /**
      * Method is called by clicking an action
@@ -180,6 +217,14 @@ export declare class SacTreeviewCommon extends SacBaseModelControl<any> {
      * @returns Returns the node if it is found. If not, NULL is returned.
      */
     private findNodeById;
+    /**
+     * Inverts the expanded state of a tree node
+     * @param node The node whose expanded state should be inverted
+     */
     private invertExpandedState;
+    /**
+     * Recursively resets the selected state of a node and its children
+     * @param node The node whose selected state should be reset
+     */
     private resetSelectedState;
 }

package/controls/upload/dropzonemultiple.d.ts

@@ -3,66 +3,66 @@ import { OnInit } from '@angular/core';
 import { AbstractControl, ValidationErrors } from '@angular/forms';
 import { UploadState } from 'ngx-uploadx';
 /**
- * Upload Komponente für ein einzelnes File
+ * Upload component for multiple files
  */
 export declare class SacDropzoneMultipleCommon extends SacUploadBase<string[]> implements OnInit {
     /**
-     * Property wenn Drag Event aktiv ist (Maus über Zone)
+     * Property when drag event is active (mouse over zone)
      */
     active: boolean;
     /**
-     * Max. Anzahl Files die hochgeladen werden können
+     * Max. number of files that can be uploaded
      */
     maxfiles: number;
     /**
-     * Min. Anzahl Files die hochgeladen werden müssen
+     * Min. number of files that must be uploaded
      */
     minfiles: number;
     /**
-     * Höhe des Upload Controls
+     * Height of the upload control
      */
     uploadheight: string;
     /**
-     * Resource Key für Validation Message Required bei Control
+     * Resource Key for Validation Message Required at Control
      */
     validationmessageminfiles: string;
     /**
-     * Resource Key für Validation Message Required in Validation Summary
+     * Resource Key for Validation Message Required in Validation Summary
      */
     validationmessagesummaryminfiles: string;
     /**
-     * Prüft ob die max. Files in der Queue nicht überschritten werden
+     * Checks if the max. files in the queue are not exceeded
      *
-     * @param file File das hinzugefügt wurde
+     * @param file File that was added
      */
     CustomAddValidation(file: UploadState): boolean;
     /**
-     * Setzt die File ID's der hochgeladen Files in das Model
+     * Sets the file IDs of the uploaded files into the model
      *
-     * @param file ID des Files welches hochgeladen wurde.
+     * @param file ID of the file that was uploaded.
      */
     SetUploadValue(file: UploadState): void;
     /**
-     * Methode für Drag and Drop von Files
+     * Method for drag and drop of files
      * @param event Drag Event
      */
     dropHandler(event: DragEvent): void;
     /**
-     * Ervent wenn das Control initialisert wird
+     * Event when the control is initialized
      */
     ngOnInit(): void;
     /**
-     * Methode wenn Drag die Zone verlässt
+     * Method when drag leaves the zone
      * @param event DragLeave Event
      */
     onDragLeave(event: DragEvent): void;
     /**
-     * Methode wenn Drag in die Zone eintritt
+     * Method when drag enters the zone
      * @param event DragEnter Event
      */
     onDragOver(event: DragEvent): void;
     /**
-     * Validiert das Control
+     * Validates the control
      *
      * @param c Control
      */

package/controls/upload/dropzonesingle.d.ts

@@ -2,45 +2,45 @@ import { SacUploadBase } from '../../common/baseuploadcontrol';
 import { OnInit } from '@angular/core';
 import { UploadState } from 'ngx-uploadx';
 /**
- * Upload Komponente für ein einzelnes File
+ * Upload component for a single file
  */
 export declare class SacDropzoneSingleCommon extends SacUploadBase<string> implements OnInit {
     /**
-     * Property wenn Drag Event aktiv ist (Maus über Zone)
+     * Property when drag event is active (mouse over zone)
      */
     active: boolean;
     /**
-     * Höhe der Dropzone. Wert wird mit Einheit angegeben.
+     * Height of the dropzone. Value is given with unit.
      */
     uploadheight: string;
     /**
-     * Macht keine Validierung in diesem Control
+     * Does no validation in this control
      *
-     * @param file File das hinzugefügt wurde
+     * @param file File that was added
      */
     CustomAddValidation(file: UploadState): boolean;
     /**
-     * Setzt die File ID des hochgeladen Files in das Model
+     * Sets the file ID of the uploaded file into the model
      *
-     * @param file ID des Files
+     * @param file ID of the file
      */
     SetUploadValue(file: UploadState): void;
     /**
-     * Methode für Drag and Drop von Files
+     * Method for drag and drop of files
      * @param event Drag Event
      */
     dropHandler(event: DragEvent): void;
     /**
-     * Ervent wenn das Control initialisert wird
+     * Event when the control is initialized
      */
     ngOnInit(): void;
     /**
-     * Methode wenn Drag die Zone verlässt
+     * Method when drag leaves the zone
      * @param event DragLeave Event
      */
     onDragLeave(event: DragEvent): void;
     /**
-     * Methode wenn Drag in die Zone eintritt
+     * Method when drag enters the zone
      * @param event DragEnter Event
      */
     onDragOver(event: DragEvent): void;

package/controls/upload/uploadmultiple.d.ts

@@ -2,47 +2,47 @@ import { SacUploadBase } from '../../common/baseuploadcontrol';
 import { AbstractControl, ValidationErrors } from '@angular/forms';
 import { UploadState } from 'ngx-uploadx';
 /**
- * Upload Componente für mehrere Files
+ * Upload component for multiple files
  */
 export declare class SacUploadMultipleCommon extends SacUploadBase<string[]> {
     /**
-     * Label für Browse Button
+     * Label for Browse Button
      */
     buttonbrowse: string;
     /**
-     * Label für Upload Button
+     * Label for Upload Button
      */
     buttonupload: string;
     /**
-     * Max. Files die hochgeladen werden können. 0 deaktiviert das Limit
+     * Max. files that can be uploaded. 0 disables the limit
      */
     maxfiles: number;
     /**
-     * Min. Files die hochgeladen werden müssen. 0 deaktiviert das Limit
+     * Min. files that must be uploaded. 0 disables the limit
      */
     minfiles: number;
     /**
-     * Resource Key für Validation Message Required bei Control
+     * Resource Key for Validation Message Required at Control
      */
     validationmessageminfiles: string;
     /**
-     * Resource Key für Validation Message Required in Validation Summary
+     * Resource Key for Validation Message Required in Validation Summary
      */
     validationmessagesummaryminfiles: string;
     /**
-     * Prüft ob die max. Files in der Queue nicht überschritten werden
+     * Checks if the max. files in the queue are not exceeded
      *
-     * @param file File das hinzugefügt wurde
+     * @param file File that was added
      */
     CustomAddValidation(file: UploadState): boolean;
     /**
-     * Setzt die File ID's der hochgeladen Files in das Model
+     * Sets the file IDs of the uploaded files into the model
      *
-     * @param file ID des Files welches hochgeladen wurde.
+     * @param file ID of the file that was uploaded.
      */
     SetUploadValue(file: UploadState): void;
     /**
-     * Validiert das Control
+     * Validates the control
      *
      * @param c Control
      */

package/controls/upload/uploadsingle.d.ts

@@ -1,27 +1,27 @@
 import { SacUploadBase } from '../../common/baseuploadcontrol';
 import { UploadState } from 'ngx-uploadx';
 /**
- * Upload Komponente für ein einzelnes File
+ * Upload component for a single file
  */
 export declare class SacUploadSingleCommon extends SacUploadBase<string> {
     /**
-     * Label für Browse Button
+     * Label for Browse Button
      */
     buttonbrowse: string;
     /**
-     * Label für Upload Button
+     * Label for Upload Button
      */
     buttonupload: string;
     /**
-     * Macht keine Validierung in diesem Control
+     * Does no validation in this control
      *
-     * @param file File das hinzugefügt wurde
+     * @param file File that was added
      */
     CustomAddValidation(file: UploadState): boolean;
     /**
-     * Setzt die File ID des hochgeladen Files in das Model
+     * Sets the file ID of the uploaded file into the model
      *
-     * @param file ID des Files
+     * @param file ID of the file
      */
     SetUploadValue(file: UploadState): void;
     /**

package/controls/validation/validationsummary.d.ts

@@ -5,15 +5,15 @@ import { Injector } from '@angular/core';
 import { FormGroup } from '@angular/forms';
 import { Observable } from 'rxjs';
 /**
- * Basis Komponente für SacValidationSummary
+ * Base component for SacValidationSummary
  */
 export declare class SacValidationSummaryCommon {
     /**
-     * Service für Error Localisation
+     * Service for Error Localisation
      */
     protected lngResourceService: ISacLocalisationService;
     /**
-     * Parent Formular
+     * Parent Form
      */
     protected parent: SacFormCommon;
     /**
@@ -39,26 +39,27 @@ export declare class SacValidationSummaryCommon {
      */
     name: string;
     /**
-     * Konstruktor
-     * Inject des Formulars
+     * Constructor
+     * @param parent Parent form control component
+     * @param injector Service injector for dependency resolution
      */
     constructor(parent: SacFormCommon, injector: Injector);
     /**
-     * Validation Methode
+     * Validation method
      */
     get formErrors(): Observable<string>[];
     /**
-     * Getter wenn Errors entstehen
+     * Getter when errors occur
      */
     get hasErrors(): boolean;
     /**
-     * Fügt einen Validation Error in die Error Collection hinzu
-     * @param ctl Fehlerhaftes Control
-     * @param collection Collection aller Fehlermeldungen
+     * Adds a validation error to the error collection
+     * @param ctl Faulty control
+     * @param collection Collection of all error messages
      */
     private addErrorToCollection;
     /**
-     * Die Methode gibt Collection von Errors. Verlangt controls: Array<NgForm | FormArray> und  collection: Array<Observable<string>>
+     * The method returns collection of errors. Requires controls: Array<NgForm | FormArray> and collection: Array<Observable<string>>
      */
     private getErrorCollection;
 }

package/controls/wizard/wizard.d.ts

@@ -2,41 +2,41 @@ import { SacWizardItemCommon } from './wizarditem';
 import { AfterContentInit, EventEmitter, QueryList } from '@angular/core';
 import { ControlValueAccessor } from '@angular/forms';
 /**
- * Base Komponente für SacWizardCommon
+ * Base component for SacWizardCommon
  */
 export declare abstract class SacWizardCommon implements AfterContentInit, ControlValueAccessor {
     /**
-     * Aktueller Schritt im Wizard
+     * Current step in wizard
      */
     private _currentstep;
     /**
-     * Boolean Property prüft ob Navigation im Wizard disabled ist; default Wert - false
+     * Boolean property checks if navigation in wizard is disabled; default value - false
      */
     disablenavigation: boolean;
     /**
-     * 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 so that no error occurs
      */
     propagateChange: any;
     /**
-     * Leere Implementation von 'propagateTouch'. Muss gemacht werden, damit kein Fehler entsteht
+     * Empty implementation of 'propagateTouch'. Must be done so that no error occurs
      */
     propagateTouch: any;
     /**
-     * EventEmitter wenn der Schritt geändert wird
+     * EventEmitter when the step is changed
      */
     stepchanged: EventEmitter<string>;
     get currentstep(): string | null;
     /**
-     * Setter und Getter für aktueller Schritt
+     * Setter and getter for current step
      */
     set currentstep(v: string | null);
     /**
-     * Auf nächsten/vorherigen Schritt gehen
-     * @param step Step auf welchen gewechselt werden soll
+     * Go to next/previous step
+     * @param step Step to which should be switched
      */
     changeStep(step: string | null): void;
     /**
@@ -44,30 +44,37 @@ export declare abstract class SacWizardCommon implements AfterContentInit, Contr
      */
     ngAfterContentInit(): void;
     /**
-     * Methode, damit andere Controls änderungen im Control mitbekommen können
-     * Zur Änderungsinfo die Methode propagateChange aufrufen.
+     * Method so that other controls can get changes in the control
+     * To change info call the propagateChange method.
+     * @param fn Callback to invoke when the value changes.
      */
     registerOnChange(fn: any): void;
     /**
-     * Methode, damit andere Controls änderungen mitbekommen, wenn das Control aktiviert (Focus) wird.
+     * Method so that other controls get changes when the control is activated (Focus).
+     * @param fn Callback to invoke when the control is touched.
      */
     registerOnTouched(fn: any): void;
     /**
-     * Schritt selektieren
-     * @param step Step welcher selektiert werden soll
+     * Select step
+     * @param step Step which should be selected
      */
     selectStep(step: SacWizardItemCommon): void;
     /**
-     * Abstrakte QueryList von SacWizardItemCommon
+     * Abstract QueryList of SacWizardItemCommon
      */
     abstract wizardItems(): QueryList<SacWizardItemCommon>;
     /**
-     * Methode zum schreiben von Werten aus dem Model in das Control
+     * Method to write values from the model into the control
+     * @param value Step ID from the bound model.
      */
     writeValue(value: string | null): void;
     /**
-     * Ursprünglicher Schritt wird selektiert
+     * Original step is selected
      */
     private initSteps;
+    /**
+     * Sets the current step internally and notifies observers of the change
+     * @param step The step ID to set as current
+     */
     private setStepInternal;
 }

package/controls/wizard/wizarditem.d.ts

@@ -1,13 +1,13 @@
 /**
- * Basis Komponente für SacWizardItem
+ * Base component for SacWizardItem
  */
 export declare class SacWizardItemCommon {
     /**
-     * Prüft ob der aktuelle Schritt aktiv ist.
+     * Checks if the current step is active.
      */
     active: boolean;
     /**
-     * Prüft ob der Schritt disabled ist.
+     * Checks if the step is disabled.
      */
     disabled: boolean;
     /**
@@ -15,11 +15,11 @@ export declare class SacWizardItemCommon {
      */
     id: string;
     /**
-     * Prüft ob der Schritt abgeschlossen wurde.
+     * Checks if the step was completed.
      */
     iscomplete: boolean;
     /**
-     * Label-Property, das angezeigt wird
+     * Label property that is displayed
      */
     label: string;
 }

package/enums/ButtonRoleType.d.ts

@@ -1 +1,26 @@
-export declare type BUTTONROLETYPE = '' | 'primary' | 'default' | 'light' | 'dark' | 'link' | 'success' | 'secondary' | 'danger' | 'warning' | 'info';
+/**
+ * Available CSS role types for button styling. These values map to Bootstrap button style classes.
+ */
+export declare type BUTTONROLETYPE = 
+/** no specific role, uses default styling */
+''
+/** primary accent button */
+ | 'primary'
+/** default button */
+ | 'default'
+/** light variant */
+ | 'light'
+/** dark variant */
+ | 'dark'
+/** hyperlink-like variant */
+ | 'link'
+/** success indicator style */
+ | 'success'
+/** secondary button style */
+ | 'secondary'
+/** danger/(error) style */
+ | 'danger'
+/** warning style */
+ | 'warning'
+/** info style */
+ | 'info';

package/enums/ControlHeight.d.ts

@@ -3,7 +3,7 @@
  */
 export declare enum ControlHeight {
     /**
-     * Default Componnent Height
+     * Default Component Height
      */
     Default = 0,
     /**

package/enums/IconType.d.ts

@@ -1,5 +1,5 @@
 /**
- * Enum für Icon Types in Componenten
+ * Enum for Icon Types in Components
  */
 export declare enum IconType {
     Image = 1,