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

package/common/baseuploadcontrol.d.ts

@@ -7,21 +7,21 @@ import { AbstractControl, ValidationErrors } from '@angular/forms';
 import { UploadState, UploadxService } from 'ngx-uploadx';
 import { Observable } from 'rxjs';
 /**
- * Base Klasse für Uploader Control
+ * Base class for uploader control
  */
 export declare abstract class SacUploadBase<VALUE> extends SacBaseModelControl<VALUE> implements OnInit, OnDestroy {
     private renderer;
     private ngZone;
     /**
-     * Erlaubte Dateitypen
+     * Allowed file types
      */
     private _allowedtypes;
     /**
-     * Files automatisch hochladen
+     * Automatically uploads files
      */
     private _autoupload;
     /**
-     * Pausieren von Uploads erlauben
+     * Allow pausing of uploads
      */
     private _enablepause;
     /**
@@ -45,15 +45,15 @@ export declare abstract class SacUploadBase<VALUE> extends SacBaseModelControl<V
      */
     protected uploadService: UploadxService;
     /**
-     * Handling von neuen Files im Input Control
+     * Handling of new files in the input control
      */
     fileListener: () => void;
     /**
-     * Definiert das Control als Required
+     * Defines the control as required
      */
     isrequired: boolean;
     /**
-     * Listener für Files
+     * Listener for files
      */
     listenerFn: () => void;
     /**
@@ -61,7 +61,7 @@ export declare abstract class SacUploadBase<VALUE> extends SacBaseModelControl<V
      */
     lngResourceService: ISacLocalisationService;
     /**
-     * Max. Dateigrösse für Files die hochgeladen werden können. 0 deaktiviert den Filter
+     * Max. file size for files that can be uploaded. 0 disables the filter
      */
     maxfilesize: number;
     /**
@@ -73,15 +73,15 @@ export declare abstract class SacUploadBase<VALUE> extends SacBaseModelControl<V
      */
     onuploadcomplete: EventEmitter<ISacUploadEventCompleteState>;
     /**
-     * Array von Uploads
+     * Array of uploads
      */
     uploads: SacUploadFile[];
     /**
-     * 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
      */
     validationmessagesummaryrequired: string;
     /**
@@ -114,78 +114,95 @@ export declare abstract class SacUploadBase<VALUE> extends SacBaseModelControl<V
     get IconUpload(): string;
     get allowedtypes(): string;
     /**
-     * Erlaubte Dateitypen für den Upload. Format: ".xxx,.yyy,.zzz"
+     * Allowed file types for upload. Format: ".xxx,.yyy,.zzz"
      */
     set allowedtypes(types: string);
+    /**
+     * Indicates whether files should be uploaded automatically after selection.
+     * @returns true when auto-upload is enabled.
+     */
     get autoupload(): boolean;
     /**
-     * Files nach der Auswahl automatisch hochladen
+     * Automatically uploads files after selection.
+     * @param v true to enable automatic upload.
      */
     set autoupload(v: boolean);
+    /**
+     * Indicates whether upload pause is allowed.
+     * @returns true when pause support is active.
+     */
     get enablepause(): boolean;
     /**
-     * Uploads können unterbrochen werden
+     * Uploads can be paused.
+     * @param v true to allow pausing uploads.
      */
     set enablepause(v: boolean);
+    /**
+     * API endpoint for upload registration.
+     * @returns configured endpoint URL.
+     */
     get endpoint(): string;
     /**
-     * Definiert den Registration Endpoint für Uploads.
+     * Defines the registration endpoint for uploads.
+     * @param v upload endpoint URL.
      */
     set endpoint(v: string);
     /**
-     * Token for Bearer Authentication
+     * Bearer authentication token used by upload service.
+     * @returns current auth token or null.
      */
     get token(): string | null;
     /**
-     * Token for Bearer Authentication
+     * Sets Bearer authentication token for service requests.
+     * @param v token string or null to clear token.
      */
     set token(v: string | null);
     /**
-     * Methode kann für Controls verwendet werden, zusätzliche Validierungen bei hinzufügen der Files zu machen
+     * Method can be used for controls to perform additional validations when adding files
      *
-     * @param file File das hinzugefügt wurde.
-     * @returns Valdierung ist erfolgreich
+     * @param file File that was added.
+     * @returns Validation is successful
      */
     abstract CustomAddValidation(file: UploadState): boolean;
     /**
-     * Name der Datei die Hochgeladen wird
-     * @returns Observable des Dateinamens.
+     * Name of the file being uploaded
+     * @returns Observable of the file name.
      */
     Filename(): Observable<string>;
     /**
-     * Gibt an ob Queue Elemente beinhaltet
-     * @returns Elemente in der Queue
+     * Indicates whether the queue contains elements
+     * @returns Elements in the queue
      */
     HasQueueItem(): boolean;
     /**
-     * Gibt an ob ein Upload abgeschlossen ist
-     * @returns Upload erfolgreich
+     * Indicates whether an upload is complete
+     * @returns Upload successful
      */
     HasSuccessUpload(): boolean;
     /**
-     * Prüft ob ein Upload pausiert
-     * @returns Pausierter Upload ist vorhanden
+     * Checks if an upload is paused
+     * @returns Paused upload is present
      */
     IsPaused(): boolean;
     /**
-     * Prüft ob in der Queue Elemente die zum Upload bereit sind vorhanden sind.
-     * @returns Elemente für Upload vorhanden
+     * Checks if there are elements in the queue ready for upload.
+     * @returns Elements available for upload
      */
     IsStateToUpload(): boolean;
     /**
-     * Prüft ob ein Upload eines Files am laufen ist
-     * @returns Upload ist am laufen
+     * Checks if a file upload is in progress
+     * @returns Upload is in progress
      */
     IsUploading(): boolean;
     /**
-     * Gibt den Uploadfortschritt zurück
-     * @returns Upload Fortschritt. Wert von 0-100
+     * Returns the upload progress
+     * @returns Upload progress. Value from 0-100
      */
     Progress(): number;
     /**
-     * Methode welche die Upload ID's in das Model setzt oder löscht
+     * Method that sets or deletes the upload IDs in the model
      *
-     * @param file Type von File ID's
+     * @param file Type of file IDs
      */
     abstract SetUploadValue(file: UploadState): void;
     /**
@@ -198,7 +215,7 @@ export declare abstract class SacUploadBase<VALUE> extends SacBaseModelControl<V
      */
     cancelAll(): void;
     /**
-     * Destroy des Controls
+     * Destroy the control
      */
     ngOnDestroy(): void;
     /**
@@ -206,18 +223,18 @@ export declare abstract class SacUploadBase<VALUE> extends SacBaseModelControl<V
      */
     ngOnInit(): void;
     /**
-     * Upload Event
+     * Upload event
      *
-     * @param uploadsOutStream Upload Item
+     * @param uploadsOutStream Upload item
      */
     onUpload(ufile: UploadState): void;
     /**
-     * Cancel Single File
-     * @param uploadId ID of File to Cancel
+     * Cancel single file
+     * @param uploadId ID of file to cancel
      */
     pause(uploadId: any): void;
     /**
-     * Pause all Uploads
+     * Pause all uploads
      */
     pauseAll(): void;
     /**
@@ -235,45 +252,48 @@ export declare abstract class SacUploadBase<VALUE> extends SacBaseModelControl<V
      */
     uploadAll(): void;
     /**
-     * Validiert das Upload Control
-     * @param c Control das validiert werden soll
+     * Validates the upload control
+     * @param c Control to be validated
      */
     validateData(c: AbstractControl): ValidationErrors | null;
     /**
      * get max. files that can be uploaded
      */
     protected abstract GetMaxFiles(): number;
+    /**
+     * Updates the file count on the form control
+     */
     private UpdateFileCount;
     /**
      * Returns the number of uploaded files
      */
     private UploadedFileCount;
     /**
-     * Prüft ob die Dateierweiterung gültig ist
+     * Checks whether the file extension is valid
      *
-     * @param filename Dateiname
+     * @param filename File name
      */
     private isExtensionValid;
     /**
-     * Prüft ob das File nicht zu gross ist.
+     * Checks if the file is not too large.
      *
-     * @param filesize Max File Size in Bytes
+     * @param filesize Max file size in bytes
      */
     private isFileSizeValid;
     /**
-     * Setzt die erlaubten Datentypen für den Upload
+     * Sets the allowed data types for upload
      *
-     * @param types Erlaubte File Extensions
+     * @param types Allowed file extensions
      */
     private setAllowedTypes;
     /**
-     * Setzt den Upload Endpoit
+     * Sets the upload endpoint
      * @param url Register URI
      */
     private setEndpoint;
 }
 /**
- * Klasse für den Upload einer Datei in der Upload Component
+ * Class for uploading a file in the upload component
  */
 export declare class SacUploadFile {
     /**
@@ -281,15 +301,15 @@ export declare class SacUploadFile {
      */
     documentid: string;
     /**
-     * Dateiname
+     * File name
      */
     name: string;
     /**
-     * Upload Fortschritt
+     * Upload progress
      */
     progress: number;
     /**
-     * Upload Status
+     * Upload status
      */
     status: string;
     /**
@@ -297,8 +317,8 @@ export declare class SacUploadFile {
      */
     uploadId: string;
     /**
-     * Konstruktor
-     * @param ufile Upload Status
+     * Constructor
+     * @param ufile Upload state
      */
     constructor(ufile: UploadState);
 }

package/components/browser/browser.d.ts

@@ -1,16 +1,16 @@
-import { HttpClient } from '@angular/common/http';
-import { EventEmitter, Injector, OnInit } from '@angular/core';
-import { Observable } from 'rxjs';
 import { ISacLocalisationService } from '../../interfaces/ISacLocalisationService';
 import { ISacValidationKeyService } from '../../interfaces/ISacValidationKeyService';
 import { IBrowserFile } from './models/browserfile';
 import { IBrowserNode } from './models/browsernode';
+import { HttpClient } from '@angular/common/http';
+import { EventEmitter, Injector, OnInit } from '@angular/core';
+import { Observable } from 'rxjs';
 /**
- * Base Component für File Browser
+ * Base component for file browser
  */
 export declare abstract class SacFileBrowserCommon implements OnInit {
     /**
-     * Service für File Browser Zugriff (Backend)
+     * Service for file browser access (backend)
      */
     private browserService;
     /**
@@ -18,52 +18,51 @@ export declare abstract class SacFileBrowserCommon implements OnInit {
      */
     private iconService;
     /**
-     * File welches beim starten des Browsers bereits selektiert ist
+     * File that is already selected when the browser starts
      */
     private preselecedfile;
     /**
-     * Erlaubte Dateierweiterungen für Fileauswahl und Upload. Dateierweiterung mit Punkt und
-     * getrennt durch Komma für mehr als eine Erweiterung (Example: ".jpg,.gif")
+     * Allowed file extensions for file selection and upload. Use dot notation, separated by commas for multiple extensions (Example: ".jpg,.gif")
      */
     allowedtypes: string;
     /**
-     * Erlaubt das löschen einer Datei
+     * Allows deleting a file
      */
     allowfiledelete: boolean;
     /**
-     * Erlaubt das umbenennen einer Datei
+     * Allows renaming a file
      */
     allowfilerename: boolean;
     /**
-     * Erlaubt den Upload von Dateien
+     * Allows uploading files
      */
     allowfileupload: boolean;
     /**
-     * Erlaubt das erstellen eines neuen Ordners
+     * Allows creating a new folder
      */
     allowfoldercreate: boolean;
     /**
-     * Erlaubt das löschen eines Ordners
+     * Allows deleting a folder
      */
     allowfolderdelete: boolean;
     /**
-     * Erlaubt das Umbenennen eines Ordners
+     * Allows renaming a folder
      */
     allowfolderrename: boolean;
     /**
-     * URL für Backend API
+     * URL for the backend API
      */
     apiurl: string;
     /**
-     * Output Emitter wenn File selektiert wird.
+     * Output emitter when a file is selected.
      */
     file: EventEmitter<string>;
     /**
-     * Service für Error Localisation
+     * Service for error localisation
      */
     lngResourceService: ISacLocalisationService;
     /**
-     * Root Node Item für Tree
+     * Root node item for the tree
      */
     rootNode: IBrowserNode;
     /**
@@ -87,15 +86,11 @@ export declare abstract class SacFileBrowserCommon implements OnInit {
      */
     validationKeyService: ISacValidationKeyService;
     /**
-     * Konstruktor
+     * Constructor
      * @param httpclient Angular HTTP Client
      * @param injector Service Injector
      */
     constructor(httpclient: HttpClient, injector: Injector);
-    /**
-     * Setzt den Seleced Node über den Pfad
-     */
-    set selectedfile(v: string | null);
     /**
      * CSS icon class for delete icon
      * @returns css class with icon
@@ -107,7 +102,7 @@ export declare abstract class SacFileBrowserCommon implements OnInit {
      */
     get iconEdit(): 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;
@@ -132,136 +127,138 @@ export declare abstract class SacFileBrowserCommon implements OnInit {
      */
     get iconRefresh(): string;
     /**
-     * Getter für Selected File. Ist an Input Property gebunden
+     * Getter for selected file. Bound to an input property
      */
     get selectedfile(): string | null;
     /**
-     * HostListener welcher den Edit Mode bei allen Files und Nodes beendet.
+     * Sets the selected node by the path
      */
-    exitEditMode(targetElement: any): void;
+    set selectedfile(v: string | null);
+    /**
+     * Abstract confirm method that must be implemented. Called when a file should be deleted.
+     * @param file File for which a delete confirmation should be requested
+     */
+    abstract confirmDeleteFile(file: IBrowserFile): Observable<boolean>;
+    /**
+     * Abstract confirm method that must be implemented. Called when a folder should be deleted.
+     * @param folder Folder for which a delete confirmation should be requested.
+     */
+    abstract confirmDeleteNode(folder: IBrowserNode): Observable<boolean>;
     /**
-     * Löscht ein File
-     * @param file File welches gelöscht werden soll
+     * Deletes a file
+     * @param file File to be deleted
      */
     deleteFile(file: IBrowserFile): void;
     /**
-     * Löscht einen Node
-     * @param node Node welcher gelöscht werden soll
+     * Deletes a node
+     * @param node Node to be deleted
      */
     deleteNode(node: IBrowserNode): void;
     /**
-     * Setzt ein File in den Edit Mode
-     * @param file File welches in den Edit Mode gesetzt werden soll
+     * Sets a file into edit mode
+     * @param file File that should be placed into edit mode
      */
     editFile(file: IBrowserFile): void;
     /**
-     * Setzt einen Node in den Edit Mode
-     * @param node Node welcher bearbeitet werden soll
+     * Sets a node into edit mode
+     * @param node Node to be edited
      */
     editNode(node: IBrowserNode): void;
     /**
-     * Erzeugt einen neuen Node im Tree
-     * @param node Node unter welchem ein neuer Node erstellt werden soll
+     * HostListener that ends edit mode for all files and nodes.
+     */
+    exitEditMode(targetElement: any): void;
+    /**
+     * Creates a new node in the tree
+     * @param node Node under which a new node should be created
      */
     newNode(node: IBrowserNode): void;
     /**
-     * Init Event der Komponente
+     * Init event of the component
      */
     ngOnInit(): void;
     /**
-     * Aktualisiert den Node
+     * Updates the node
      */
     refreshNode(node: IBrowserNode): void;
     /**
-     * Methode wenn eine Datei umbenannt werden soll
-     * @param file File welches umbenannt werden soll
-     * @param newFilename Neuer Dateiname
+     * Method called when a file should be renamed
+     * @param file File to be renamed
+     * @param newFilename New filename
      */
     renameFile(file: IBrowserFile, newFilename: string): void;
     /**
-     * Methode wenn ein Node umbenannt werden soll
-     * @param node Node welcher umbenannt werden soll
-     * @param newFoldername Neuer Ordnername
+     * Method called when a node should be renamed
+     * @param node Node to be renamed
+     * @param newFoldername New folder name
      */
     renameNode(node: IBrowserNode, newFoldername: string): void;
     /**
-     * Methode wenn ein File selektiert wird
-     * @param file File welches selektiert wird
+     * Method called when a file is selected
+     * @param file File that is selected
      */
     selectFile(file: IBrowserFile): void;
     /**
-     * Methode wenn ein Node selektiert wird
-     * @param node Node welcher selektiert werden soll
+     * Method called when a node is selected
+     * @param node Node that should be selected
      */
     selectNode(node: IBrowserNode): void;
     /**
-     * Expand/Collabse Methode für Nodes
-     * @param node Node welcher geöffnet oder geschlossen werden soll
+     * Expand/collapse method for nodes
+     * @param node Node that should be opened or closed
      */
     switchExpandNode(node: IBrowserNode): void;
     /**
-     * Methode die Aufgerufen werden muss, wenn ein Upload beendet ist.
-     * @param param Parameter des hochgeladenen Files
+     * Method that must be called when an upload is completed.
+     * @param node Node where uploaded files should be attached.
+     * @param uploadIdList List of upload IDs that finished uploading.
      */
     uploadComplete(node: IBrowserNode, uploadIdList: string[]): void;
     /**
-     * Abstrakte Confirm Methode welche implementiert werden muss. Methode wird aufgerufen, wenn eine
-     * Datei gelöscht werden soll.
-     * @param file File für welches ein Delete Confirm eingefordert werden soll
-     */
-    abstract confirmDeleteFile(file: IBrowserFile): Observable<boolean>;
-    /**
-     * Abstrakte Confirm Methode welche implementiert werden muss. Methode wird aufgerufen, wenn ein
-     * Ordner gelöscht werden soll.
-     * @param folder Ordern für welchen ein Delete Confirm eingefordert werden soll.
-     */
-    abstract confirmDeleteNode(folder: IBrowserNode): Observable<boolean>;
-    /**
-     * Abstrakte Methode die Aufgerufen wird, wenn das Hochgeladene File aus dem Temp Folder in die
-     * Struktur verschoben wurde.
-     * @param uploadid ID des Uploads
+     * Abstract method invoked when the uploaded file has been moved from the temp folder into the structure.
+     * @param uploadid Upload ID
      */
     abstract uploadedFileMoved(uploadid: string): void;
     /**
-     * Rekursive Methode welche beim Node und all seinen Childs neue Nodes entfernt
-     * @param node Node bei welchem alle neuen Nodes entfernt werden soll.
+     * Recursive method that removes new nodes from the given node and all its children
+     * @param node Node from which all new nodes should be removed.
      */
     private clearNewChildNodes;
     /**
-     * Methode welche den Pfad für einen Node erzeugt
-     * @param node Node für welchen der Pfad erzeugt werden soll
-     * @param parentPath Übergeordneter Pfad
+     * Method that generates the path for a node
+     * @param node Node for which the path should be generated
+     * @param parentPath Parent path
      */
     private fillPath;
     /**
-     * Sucht den übergeordneten Node im Tree
-     * @param node Aktueller Node
-     * @param nodeToFind Node welcher gefunden werden soll
-     * @returns Node wenn er gefunden wurde, ansonsten wird NULL zurückgegeben
+     * Finds the parent node in the tree
+     * @param node Current node
+     * @param nodeToFind Node to find
+     * @returns The node if found, otherwise NULL
      */
     private findParentNode;
     /**
-     * Sucht einen Node gem. einem URL Pfad
-     * @param node Node in welchem gesucht werden soll
-     * @param path Pfad nach welchem gesucht wird
-     * @returns Node welcher zum gesuchten Pfad passt. Wenn kein Node gefunden wird, wird NULL zurückgegeben
+     * Finds a node according to a URL path
+     * @param node Node in which to search
+     * @param path Path to search for
+     * @returns Node matching the path. Returns NULL if not found
      */
     private findSelectedNodeByPath;
     /**
-     * Sucht einen Node gem. einem Array von Node Namen
-     * @param node Node in welchem gesucht werden soll
-     * @param path Array von Node Namen, welche die Hirarchy des Pfades abbilden
-     * @param index Aktueller Index im PATH Array
-     * @returns Node wenn einer gefunden wurde, ansonsten NULL
+     * Finds a node based on an array of node names
+     * @param node Node in which to search
+     * @param path Array of node names representing the hierarchy of the path
+     * @param index Current index in the path array
+     * @returns Node if found, otherwise NULL
      */
     private findSelectedNodeByPathArray;
     /**
-     * Rekursive Methode welche beim Node und all seinen Childs den Edit Mode beendet.
-     * @param node Node bei welchem der Edit Mode beendet werden soll
+     * Recursive method that ends edit mode for the node and all its children.
+     * @param node Node for which edit mode should be ended
      */
     private resetNodeEditMode;
     /**
-     * Setzt den Pfad in allen Nodes
+     * Sets the path in all nodes
      */
     private setPathToAllNodes;
 }

package/components/browser/models/browserfile.d.ts

@@ -1,17 +1,17 @@
 /**
- * Interface für Datei Items in File Browser Component
+ * Interface for file items in the file browser component
  */
 export interface IBrowserFile {
     /**
-     * Dateiname
+     * File name
      */
     Filename: string;
     /**
-     * Grösse der Datei
+     * Item is being edited
      */
-    Size: number;
+    IsEditMode: boolean;
     /**
-     * Item wird bearbeitet
+     * File size
      */
-    IsEditMode: boolean;
+    Size: number;
 }