@simpleangularcontrols/sac-common 10.0.0-rc.7 → 10.0.0-rc.8

package/common/baseinputcontrol.d.ts

@@ -27,10 +27,6 @@ export declare abstract class SacInputBase<VALUE> extends SacBaseModelControl<VA
      * Definiert das Feld als valid/invalid von eingegebenen regex-pattern
      */
     regexvalidation: string;
-    /**
-     * Text welcher als Tooltip angezeigt wird.
-     */
-    tooltiptext: string;
     /**
      * Methode validiert Input wenn KeyPress-Event passiert
      */

package/common/basemodelcontrol.d.ts

@@ -4,6 +4,7 @@ import { Observable } from 'rxjs';
 import { SacFormLayoutCommon } from '../controls/layout/formlayout';
 import { ControlHeight } from '../enums/ControlHeight';
 import { ISacConfigurationService } from '../interfaces/ISacConfigurationService';
+import { ISacIconService } from '../interfaces/ISacIconService';
 import { ISacLabelSizes } from '../interfaces/ISacLabelSizes';
 import { ISacLocalisationService } from '../interfaces/ISacLocalisationService';
 import { ISacValidationKeyService } from '../interfaces/ISacValidationKeyService';
@@ -11,7 +12,7 @@ import { ISacValidationKeyService } from '../interfaces/ISacValidationKeyService
  * Abstract Klasse für SacBaseModelControl. Implements ControlValueAccessor, Validator, OnInit
  */
 export declare abstract class SacBaseModelControl<VALUE> implements ControlValueAccessor, Validator, OnInit, AfterViewInit {
-    private injector;
+    private readonly injector;
     /**
      * Inline Errors für das Control
      */
@@ -45,6 +46,10 @@ export declare abstract class SacBaseModelControl<VALUE> implements ControlValue
      * Form layout instance if exists
      */
     protected formlayout: SacFormLayoutCommon;
+    /**
+     * icon service
+     */
+    protected iconService: ISacIconService;
     /**
      * Service für Error Localisation
      */
@@ -65,6 +70,14 @@ export declare abstract class SacBaseModelControl<VALUE> implements ControlValue
      * Deaktiviert das Label im Template
      */
     disablelabel: boolean;
+    /**
+     * Text to support the user during input.
+     */
+    helptext: string;
+    /**
+     * Mode for display helptext
+     */
+    helptextmode: 'tooltip' | 'text' | null;
     /**
      * defines that error messages are displayed under the controls
      */
@@ -136,10 +149,17 @@ export declare abstract class SacBaseModelControl<VALUE> implements ControlValue
      * Input wird benötigt, damit der Wert auch über das Markup gesetzt werden kann.
      */
     set value(v: VALUE);
+    /**
+     * Get Icon for Helptext Tooltip
+     */
+    get HelptextTooltipIcon(): string;
     /**
      * Methode ergibt Boolean Wert für dirty
      */
     get dirty(): boolean;
+    /**
+     * Show error messages inline
+     */
     get inlineerrorenabled(): boolean | null;
     /**
      * Methode ergibt boolean Wert wenn Form invalid oder nicht invalid ist
@@ -241,6 +261,10 @@ export declare abstract class SacBaseModelControl<VALUE> implements ControlValue
      * Set component height from property or parent layout control
      */
     private setComponentHeight;
+    /**
+     * Set mode for helptext. Can be tooltip or text
+     */
+    private setHelpTextMode;
     /**
      * Set adaptive label property from parent layout control
      */

package/common/baseuploadcontrol.d.ts

@@ -3,7 +3,6 @@ import { AbstractControl, ValidationErrors } from '@angular/forms';
 import { UploadState, UploadxService } from 'ngx-uploadx';
 import { Observable } from 'rxjs';
 import { SacFormLayoutCommon } from '../controls/layout/formlayout';
-import { ISacIconService } from '../interfaces/ISacIconService';
 import { ISacLocalisationService } from '../interfaces/ISacLocalisationService';
 import { SacBaseModelControl } from './basemodelcontrol';
 /**
@@ -36,10 +35,6 @@ export declare abstract class SacUploadBase<VALUE> extends SacBaseModelControl<V
      * Upload Settings
      */
     private options;
-    /**
-     * icon service to receive icons for uploader
-     */
-    protected iconService: ISacIconService;
     /**
      * Upload Service
      */

package/controls/checkbox/checkbox.d.ts

@@ -4,10 +4,6 @@ import { SacBaseModelControl } from '../../common/basemodelcontrol';
  * Basis Komponente für SacCheckboxCommon. Extends SacBaseModelControl
  */
 export declare class SacCheckboxCommon extends SacBaseModelControl<boolean> {
-    /**
-     * Text welcher als Tooltip angezeigt wird.
-     */
-    tooltiptext: string;
     /**
      * Text vom Checkbox-Control. Der Text wird rechts von der Checkbox angezeigt.
      */

package/controls/datetime/date.d.ts

@@ -9,10 +9,6 @@ import { SacFormLayoutCommon } from '../layout/formlayout';
  */
 export declare class SacDateCommon extends SacBaseDateTimeControl {
     protected elementRef: ElementRef;
-    /**
-     * icon service
-     */
-    private iconService;
     /**
      * Format des Datums
      */

package/controls/datetime/datetime.d.ts

@@ -9,10 +9,6 @@ import { SacFormLayoutCommon } from '../layout/formlayout';
  */
 export declare class SacDateTimeCommon extends SacBaseDateTimeControl {
     protected elementRef: ElementRef;
-    /**
-     * icon service
-     */
-    private iconService;
     /**
      * Format des Datums
      */

package/controls/datetime/time.d.ts

@@ -9,10 +9,6 @@ import { SacFormLayoutCommon } from '../layout/formlayout';
  */
 export declare class SacTimeCommon extends SacBaseDateTimeControl {
     protected elementRef: ElementRef;
-    /**
-     * icon service
-     */
-    private iconService;
     /**
      * Format des Datums
      */

package/controls/grid/grid.d.ts

@@ -2,124 +2,126 @@ import { ChangeDetectorRef, EventEmitter, Injector, TemplateRef } from '@angular
 import { ISacValidationKeyService } from '../../interfaces/ISacValidationKeyService';
 import { PagerData, PagerRequest, SortDescriptor, SortOrder } from './model';
 /**
- * Basis Komponente für SacGrid
+ * Basic component for SacGrid
  */
 export declare abstract class SacGridCommon {
     private cd;
     /**
-     * Protected Property. Enthielt die Nummer der aktiven Seite. Type: number. Default ist 1
+     * Page number of the active page.
      */
     protected activePage: number;
     /**
-     * Protected Property. Enthielt die Nummer der ersten angezeigtenen Seite in Pager. Type: number. Default ist 1
+     * Contains the number of the first page displayed in Pager.
      */
     protected firstPageNumber: number;
     /**
-     * Protected Property. Enthielt die Nummer der letzen Seite in Pager. Type: number. Default ist undefined/null
+     * Contains the number of the last page in Pager. The value is calculated automatically.
      */
     protected lastPageNumber: number;
     /**
-     * Protected Property. Enthielt Array of Pages. Default value: empty array []
+     * Contains Array of Pages.
      */
     protected paginators: Array<any>;
     /**
-     * Input property für body. Type: TemplateRef<any>.
+     * Input property for Body.
      */
     body: TemplateRef<any>;
     /**
-     * Text welcher angezeigt wird, wenn keine Rows verfügbar sind.
+     * Text which is displayed if no rows are available.
      */
     emptytext: string;
     /**
-     * Input property für headers. Type: TemplateRef<any>.
+     * Property for headers.
      */
     headers: TemplateRef<any>;
     /**
-     * Input property für die maximalle Seiten die sichtbar sind. Type: number.
+     * Property for the maximum pages that are visible.
      */
     maxvisiblepagenumbers: number;
     /**
-     * Input property für Name.
+     * Control Name. Used to generate the ID and names.
      */
     name: string;
     /**
-     * Pager Settings
-     *
-     * Pager kann ausgeschaltet werden, in dem PagerData auf NULL gesetzt wird.
+     * Pager configuration. Pager can be switched off by setting PagerData to `null`.
      */
     pagerdata: PagerData;
     /**
-     * Deaktiviert die Auswahl der PageSize im Pager
+     * Deactivates the selection of the PageSize in the pager
      */
     pagesizedisabled: boolean;
     /**
-     * Definiert die Anzahl der Elemente pro Seite die ausgewählt werden können
+     * Defines the number of elements per page that can be selected. The default is 20, 50 and 100. The values must be separated with a `|`.
      */
     pagesizes: string;
     /**
-     * Text in Page für Anzahl Seitenelemente pro Seite
-     * Folgende Interpolation Texte sind vorhanden:
-     * {{PAGESIZE}}: Anzahl Elemente pro Seite
+     * Text in Page for number of page elements per page. The following interpolation texts are available:
+     *
+     * {{PAGESIZE}}: Number of elements per page
      */
     pagesizetext: string;
     /**
-     * Text in Pager für 'Seite x von y'.
-     * Folgende Interpolation Texte sind vorhanden:
-     * {{CURRENTPAGE}}: Aktuelle Seite
-     * {{TOTALPAGES}}: Anzahl Seiten
+     * Text in pager for 'Page x of y'. The following interpolation texts are available:
+     *
+     * {{CURRENTPAGE}}: Current page
+     *
+     * {{TOTALPAGES}}: Number of pages
      */
     pagingtext: string;
     /**
-     * Grid Daten
+     * Grid data
      */
     value: any;
     /**
-     * Output EventEmitter. Wird aufgerufen wenn das Pager geklickt ist.
+     * Event when the pager is clicked.
      */
     paging: EventEmitter<PagerRequest>;
     /**
-     * Output EventEmitter. Wird aufgerufen wenn ein Header geklickt ist, damit das Column soritert wird.
+     * Event when a header is clicked so that the grid is sorted.
      */
     sorting: EventEmitter<SortDescriptor>;
     /**
-     * Private Property. Enthielt die Column Menge. Type: number. Default ist 0
+     * Number of columns in the grid
      */
     ColumnCount: number;
     /**
-     * Aktuell Sortierte Spalte
+     * Column by which currently sorted.
      */
     sortColumn: string;
     /**
-     * Aktuelle Sortierung
+     * Current direction of sorting
      */
     sortDirection: SortOrder;
+    /**
+     * Service with the validation keys. Is required to load the default texts for the pager etc.
+     */
     validationKeyService: ISacValidationKeyService;
     /**
-     * Konstruktor
+     * Constructor
      * @param cd Change Detection Service
      * @param injector DI Injector
      */
     constructor(cd: ChangeDetectorRef, injector: Injector);
     /**
-     * Model für Sortierung
-     * @param sortDescription Settings für aktuelle sortierung
+     * Model for sorting
+     * @param sortDescription Settings for current sorting
      */
     set sortdata(sortDescription: SortDescriptor);
     /**
-     * Die Methode erhöht die Column-Stücke um eins
+     * The method increases the column elements by one
      */
     RegisterColumn(): void;
     /**
-     * Die Methode deffiniert das Sortierung Flow
+     * Method for sorting the data.
      */
     SortBy(command: any): void;
     /**
-     * Die Methode verringert die Column-Stücke um eins
+     * The method reduces the column elements by one
      */
     UnregisterColumn(): void;
     /**
-     * Setzt die neue Seite
-     * @param newStartIndex Neuer Seiten Index (Zero-Based)
+     * Method if Grid is to switch to a new page.
+     * @param newStartIndex New Page Index (Zero-Based)
      */
     pageChange(newStartIndex: any): void;
 }

package/controls/grid/gridbutton.d.ts

@@ -4,30 +4,30 @@ import { EventEmitter } from '@angular/core';
  */
 export declare class SacGridButtonCommon {
     /**
-     * Input Property für Styling des Buttons. Deffiniert die Css Klassen des Buttons
+     * Button is deactivated
      */
-    iconstyle: string;
+    protected _isdisabledvalue: boolean;
     /**
-     * Icon Name aus Sprite
+     * Icon name from sprite
      */
     icon: string;
     /**
-     * Button ist deaktiviert
+     * Input property for styling the button. Defines the CSS classes of the button
      */
-    protected _isdisabledvalue: boolean;
+    iconstyle: string;
     /**
-     * Deaktivieren von Buttons
-     * @param v Deaktiviert den Button
-     * @return Definiert ob der Button deaktiviert ist
+     * Event when the button is clicked
      */
-    set isdisabled(v: boolean | string);
-    get isdisabled(): boolean | string;
+    clicked: EventEmitter<any>;
     /**
-     * Event wenn auf den Button geklickt wird
+     * Deactivating buttons
+     * @param v Deactivates the button. Can be a Boolean or the strings `true` or `false`.
+     * @return Defines whether the button is deactivated. Is always a Boolean type
      */
-    clicked: EventEmitter<any>;
+    set isdisabled(v: boolean | string);
+    get isdisabled(): boolean | string;
     /**
-     * Die Methode wird das cklickaction Emitter aktivieren
+     * Triggers the clicked event if the button is not deactivated.
      */
     callaction(): void;
 }

package/controls/grid/gridcolumn.d.ts

@@ -2,27 +2,27 @@ import { ElementRef, Injector } from '@angular/core';
 import { SacGridCommon } from './grid';
 import { SacGridColumnBaseCommon } from './gridcolumnbase';
 /**
- * Komponente für SacGridColumnCommon. Extends SacGridColumnBaseCommon
+ * Component for SacGridColumnCommon. Extends SacGridColumnBaseCommon
  */
 export declare class SacGridColumnCommon extends SacGridColumnBaseCommon {
     /**
-     * Konstruktor
+     *  Defines whether the CSS class ellipsis is set.
      */
-    constructor(grid: SacGridCommon, injector: Injector, el: ElementRef);
+    private _ellipsis;
     /**
-     * Das Property enthielt boolean Wert für die CSS Klasse ellipsis. Default is false.
+     * Constructor
      */
-    private _ellipsis;
+    constructor(grid: SacGridCommon, injector: Injector, el: ElementRef);
     /**
-     * Input Parameter für das css Class ellipsis. Das Setter setzt das boolean Wert auf das private property _ellipsis
+     * Sets the ellipsis property. Can be a Boolean or the strings `true` or `false`.
      */
     set ellipsis(v: string | boolean);
     /**
-     * Getter für das private property _ellipsis. Ergibt das boolean Wert des Property
+     * Getter for the ellipsis property. Always returns a boolean type.
      */
     get ellipsis(): string | boolean;
     /**
-     * Die Methode returns das Wert des Property _ellipsis
+     * Checks whether ellipsis is set
      */
     IsEllipsis(): boolean;
 }

package/controls/grid/gridcolumnaction.d.ts

@@ -2,12 +2,12 @@ import { ElementRef, Injector } from '@angular/core';
 import { SacGridCommon } from './grid';
 import { SacGridColumnBaseCommon } from './gridcolumnbase';
 /**
- * Komponente für SacGridColumnActionCommon. Extends SacGridColumnBaseCommon
+ * Component for SacGridColumnActionCommon. Extends SacGridColumnBaseCommon
  */
 export declare class SacGridColumnActionCommon extends SacGridColumnBaseCommon {
     /**
-     * Konstruktor
-     * @param el Element Referenz
+     * Constructor
+     * @param el Element reference
      * @param injector di inector to resolve icon service
      * @param grid SacGridCommon
      */

package/controls/grid/gridcolumnbase.d.ts

@@ -1,86 +1,86 @@
 import { ElementRef, Injector, OnDestroy, OnInit } from '@angular/core';
-import { SacGridCommon } from './grid';
 import { ISacIconService } from '../../interfaces/ISacIconService';
+import { SacGridCommon } from './grid';
 /**
- * Base Komponente für GridColumn
+ * Base component for GridColumn
  */
 export declare class SacGridColumnBaseCommon implements OnInit, OnDestroy {
     private grid;
     protected injector: Injector;
     private el;
     /**
-     * Konstruktor
-     * @param grid  reference to grid component
-     * @param injector di injector to resolve icon service
-     * @param el reference to html element
+     * icon service for reading the icons
      */
-    constructor(grid: SacGridCommon, injector: Injector, el: ElementRef);
+    protected iconService: ISacIconService;
     /**
-     * icon service
+     * Value of the cell if the type is `header`.
      */
-    protected iconService: ISacIconService;
+    header: string;
     /**
-     * Das Input property erhält den Namen des Column
+     * Name of the column
      */
     name: any;
     /**
-     * Das Input property erhält das Value des Column
+     * Key for sorting the column
      */
-    value: any;
+    sortkey: string;
     /**
-     * Das Input property erhält das Header des Column
+     * Type of column. Can contain the values `header`,`footer` and `body`.
      */
-    header: string;
+    type: string;
     /**
-     * Das Input property erhält die Breite des Column
+     * Value of the cell if the type is `body`
      */
-    width: string;
+    value: any;
     /**
-     * Das Input property erhält das Type des Column
+     * Column width
      */
-    type: string;
+    width: string;
     /**
-     * Das Input property erhält das Column- Key-Word, damit das Column sortiert werden kann.
+     * Constructor
+     * @param grid  reference to grid component
+     * @param injector di injector to resolve icon service
+     * @param el reference to html element
      */
-    sortkey: string;
+    constructor(grid: SacGridCommon, injector: Injector, el: ElementRef);
     /**
-     * lifecycle hook - OnInit. Wird aufgeruren sobald das Komponent initialisiert ist.
+     * sort down icon for grid header
      */
-    ngOnInit(): void;
+    get IconSortDown(): string;
     /**
-     * lifecycle hook - ngOnDestroy. Wird aufgeruren wenn das Component zerstört wird.
+     * sort up icon for grid header
      */
-    ngOnDestroy(): void;
+    get IconSortUp(): string;
     /**
-     * die Methode ergibt boolean Wert, ob das Element Header ist.
+     * Indicates the direction of sorting. The possible values are `none`,`asc`,`desc`
      */
-    IsHeader(): boolean;
+    GetSortDirection(): string;
     /**
-     * die Methode ergibt boolean Wert, ob das Element Body ist.
+     * Defines whether the element is a cell in the table.
      */
     IsBody(): boolean;
     /**
-     * die Methode ergibt boolean Wert, ob das Element Footer ist.
+     * Defines whether the element is a cell in the footer of the table
      */
     IsFooter(): boolean;
     /**
-     * sort up icon for grid header
+     * Defines whether the element is a cell in the table header
      */
-    get IconSortUp(): string;
+    IsHeader(): boolean;
     /**
-     * sort down icon for grid header
+     * Defines whether this column is sorted.
      */
-    get IconSortDown(): string;
+    IsSortedColumn(): boolean;
     /**
-     * Die Methode deffiniert wie das Grid sortiert wird, abhängig von gekligte Column
+     * Triggers the events so that the table is sorted according to this column.
      */
     SortByColumn(): void;
     /**
-     * die Methode ergibt boolean Wert und definiert, ob das Column für Sortierung aktiviert ist, gemäß eingegebene sortKey
+     * Called when the component is destroyed.
      */
-    IsSortedColumn(): boolean;
+    ngOnDestroy(): void;
     /**
-     * Die methode definiert die Dortirung Richtung. Die Werte sind: none, asc, desc.
+     * Is called when the component is initialized.
      */
-    GetSortDirection(): string;
+    ngOnInit(): void;
 }

package/controls/grid/gridimage.d.ts

@@ -1,9 +1,9 @@
 /**
- * Basis Komponente für SacGridImage
+ * Basic component for SacGridImage
  */
 export declare class SacGridImageCommon {
     /**
-     * das Input property akypetiert string value für style des Icon
+     * Style of the icon
      */
     iconstyle: string;
 }