@magic-xpa/angular 4.1200.0-dev4120.4 → 4.1200.0-dev4120.40

package/src/ui/directives/magic/checkbox-noformcontrol.magic.directive.d.ts

@@ -1,8 +1,14 @@
 import { MagicDirective } from "../magic.directive";
 import * as i0 from "@angular/core";
+/**
+ * Directive for checkboxes which should not have a form control
+ */
 export declare class CheckboxNoFormControlMagicDirective {
     protected magicDirective: MagicDirective;
     constructor(magicDirective: MagicDirective);
+    /**
+     * Handle the 'Checkbox' change event - pass it to the Magic engine
+     */
     onChange($event: any): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<CheckboxNoFormControlMagicDirective, never>;
     static ɵdir: i0.ɵɵDirectiveDeclaration<CheckboxNoFormControlMagicDirective, "    input[type=checkbox][magic]:([noFormControl])       ", never, {}, {}, never, never, false, never>;

package/src/ui/directives/magic/checkbox.magic.directive.d.ts

@@ -3,6 +3,9 @@ import { MagicDirective } from '../magic.directive';
 import { TaskMagicService } from "../../../services/task.magics.service";
 import { GuiCommand } from "@magic-xpa/gui";
 import * as i0 from "@angular/core";
+/**
+ * Directive for checkboxes, to handle the 'change' event
+ */
 export declare class CheckboxMagicDirective {
     protected magicDirective: MagicDirective;
     private el;
@@ -10,12 +13,21 @@ export declare class CheckboxMagicDirective {
     threeState: boolean;
     private subscribeRefreshDom;
     private isIndeterminate;
+    /**
+     * @ignore
+     */
     constructor(magicDirective: MagicDirective, el: ElementRef, task: TaskMagicService);
+    /**
+     * Handles the Checkbox 'change' event - pass it to the Magic engine
+     */
     onChange($event: any): void;
     ngOnInit(): void;
     private regUpdatesUI;
     handleCommand(command: GuiCommand): void;
     private handleThreeState;
+    /**
+     * Cleanup
+     */
     ngOnDestroy(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<CheckboxMagicDirective, never>;
     static ɵdir: i0.ɵɵDirectiveDeclaration<CheckboxMagicDirective, "    input[type=checkbox][magic]:not([noFormControl])", never, { "threeState": { "alias": "threeState"; "required": false; }; }, {}, never, never, false, never>;

package/src/ui/directives/magic/combobox.magic.directive.d.ts

@@ -1,9 +1,18 @@
 import { MagicDirective } from '../magic.directive';
 import * as i0 from "@angular/core";
+/**
+ * Directive for comboboxes, to handle the 'change' event
+ */
 export declare class ComboboxMagicDirective {
     protected magicDirective: MagicDirective;
     constructor(magicDirective: MagicDirective);
+    /**
+     * Handles the Combobox 'change' event - pass it to the Magic engine
+     */
     onChange($event: any): void;
+    /**
+     * To refresh Combobox selection as per selected property.
+     */
     onComboboxItemsListChanged(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<ComboboxMagicDirective, never>;
     static ɵdir: i0.ɵɵDirectiveDeclaration<ComboboxMagicDirective, "select[magic]:not([multiple])", never, {}, {}, never, never, false, never>;

package/src/ui/directives/magic/form-controls/control-value-accessors/checkbox.cva.directive.d.ts

@@ -1,6 +1,12 @@
 import { CheckboxControlValueAccessor } from '@angular/forms';
 import * as i0 from "@angular/core";
+/**
+ * @ignore
+ */
 export declare const CHECKBOX_VALUE_ACCESSOR: any;
+/**
+ * Value accessor for Checkbox without a FormControl
+ */
 export declare class MagicCheckboxControlValueAccessor extends CheckboxControlValueAccessor {
     static ɵfac: i0.ɵɵFactoryDeclaration<MagicCheckboxControlValueAccessor, never>;
     static ɵdir: i0.ɵɵDirectiveDeclaration<MagicCheckboxControlValueAccessor, "      input[type=checkbox][magic]:not([formControlName]):not([no-form-control]),      input[type=checkbox][magic]:not([formControl]),      input[type=checkbox][magic]:not([ngModel])    ", never, {}, {}, never, never, false, never>;

package/src/ui/directives/magic/form-controls/control-value-accessors/date.cva.directive.d.ts

@@ -4,6 +4,14 @@ import { MagicDirective } from "../../../magic.directive";
 import { TaskMagicService } from "../../../../../services/task.magics.service";
 import * as i0 from "@angular/core";
 export declare const DATE_VALUE_ACCESSOR: any;
+/**
+ * The accessor for writing a value and listening to changes on a date input element
+ *
+ *  ### Example
+ *  `<input type="date" name="birthday" ngModel dateInput>`
+ *  OR
+ *  `<input type="date" formControlName="birthday" dateInput>`
+ */
 export declare class DateValueAccessor implements ControlValueAccessor {
     private renderer;
     private elementRef;
@@ -13,10 +21,15 @@ export declare class DateValueAccessor implements ControlValueAccessor {
     onTouched: () => void;
     onBlurEvent(event: any): void;
     constructor(renderer: Renderer2, elementRef: ElementRef, magicDir: MagicDirective, _task: TaskMagicService);
+    /** Format year, if user enters 2 digits instead of 4 digits as per the century given in Magic.ini file */
     formatDateWithCentury(userInput: string, century: number, control: AbstractControl): void;
+    /** Writes a new value to the element (model -> view) */
     writeValue(value: Date): void;
+    /** Registers a callback function, called when value changes (view -> model) */
     registerOnChange(fn: (_: any) => void): void;
+    /** Registers a callback function, called when the control is blurred */
     registerOnTouched(fn: () => void): void;
+    /** Enables or disables the element when the control status changes */
     setDisabledState(isDisabled: boolean): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<DateValueAccessor, never>;
     static ɵdir: i0.ɵɵDirectiveDeclaration<DateValueAccessor, "[dateInput]", never, {}, {}, never, never, false, never>;

package/src/ui/directives/magic/form-controls/control-value-accessors/default.cva.directive.d.ts

@@ -1,6 +1,12 @@
 import { DefaultValueAccessor } from '@angular/forms';
 import * as i0 from "@angular/core";
+/**
+ * @ignore
+ */
 export declare const MAGIC_DEFAULT_VALUE_ACCESSOR: any;
+/**
+ * @ignore
+ */
 export declare class MagicDefaultValueAccessor extends DefaultValueAccessor {
     static ɵfac: i0.ɵɵFactoryDeclaration<MagicDefaultValueAccessor, never>;
     static ɵdir: i0.ɵɵDirectiveDeclaration<MagicDefaultValueAccessor, "    input[magic]:not([type=checkbox]):not([formControlName]):not([no-form-control]),    textarea[magic]:not([formControlName]):not([noFormControl]):not([no-form-control])  ", ["magic"], {}, {}, never, never, false, never>;

package/src/ui/directives/magic/input.noformcontrol.magic.directive.d.ts

@@ -1,8 +1,14 @@
 import { MagicDirective } from '../magic.directive';
 import * as i0 from "@angular/core";
+/**
+ * Directive for non-checkbox input controls which do not have a form control
+ */
 export declare class InputNoFormControlMagicDirective {
     protected magicDirective: MagicDirective;
     constructor(magicDirective: MagicDirective);
+    /**
+     * Handles the 'change' event - pass it to the Magic engine
+     */
     onChange($event: any): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<InputNoFormControlMagicDirective, never>;
     static ɵdir: i0.ɵɵDirectiveDeclaration<InputNoFormControlMagicDirective, "input[magic]:([noFormControl]):not([type=checkbox]),             textarea[magic]:([noFormControl]):not([type=checkbox])", never, {}, {}, never, never, false, never>;

package/src/ui/directives/magic/nocontrol.magic.directive.d.ts

@@ -5,6 +5,9 @@ import { TaskMagicService } from "../../../services/task.magics.service";
 import { RowMagicDirective } from "./row.magic.directive";
 import { Platform } from "@angular/cdk/platform";
 import * as i0 from "@angular/core";
+/**
+ * @ignore
+ */
 export declare class NoControlMagicDirective extends MagicDirective {
     set magic(val: any);
     constructor(_task: TaskMagicService, element: ElementRef, renderer: Renderer2, vcRef: ViewContainerRef, platform: Platform, magicRow: RowMagicDirective);

package/src/ui/directives/magic/row.magic.directive.d.ts

@@ -1,15 +1,30 @@
 import { ElementRef, OnDestroy, OnInit } from "@angular/core";
 import { TaskMagicService } from "../../../services/task.magics.service";
 import * as i0 from "@angular/core";
+/**
+ * @ignore
+ */
 export declare class RowMagicDirective implements OnInit, OnDestroy {
     protected _task: TaskMagicService;
     protected element: ElementRef;
     rowId: string;
+    /**
+     * The HTML element connected to this directive
+     */
     protected htmlElement: HTMLElement;
+    /**
+     * @ignore
+     */
     private rowChangedSubscriber;
     constructor(_task: TaskMagicService, element: ElementRef);
+    /**
+     * Initializes this object
+     */
     ngOnInit(): void;
     private isInView;
+    /**
+     * Cleanup
+     */
     ngOnDestroy(): void;
     onClick($event: any): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<RowMagicDirective, never>;

package/src/ui/directives/magic-focus.directive.d.ts

@@ -1,5 +1,8 @@
 import { ElementRef } from "@angular/core";
 import * as i0 from "@angular/core";
+/**
+ * Directive for setting focus on element
+ */
 export declare class MagicFocusDirective {
     private hostElement;
     constructor(hostElement: ElementRef);

package/src/ui/directives/magic.directive.d.ts

@@ -6,6 +6,9 @@ import { RowMagicDirective } from "./magic/row.magic.directive";
 import { Subscription } from "rxjs";
 import { Platform } from "@angular/cdk/platform";
 import * as i0 from "@angular/core";
+/**
+ * Connects HTML elements to the Magic Web Client engine
+ */
 export declare class MagicDirective implements OnInit, OnDestroy {
     protected _task: TaskMagicService;
     protected element: ElementRef;
@@ -14,31 +17,110 @@ export declare class MagicDirective implements OnInit, OnDestroy {
     platform: Platform;
     protected magicRow: RowMagicDirective;
     set magic(val: any);
+    /**
+     * This flag is used when we only want to register to events, but do not want to execute commands sent from server
+     */
     set eventsOnly(val: any);
+    /**
+     * pollTime: after which value will be sent to magic
+     */
     pollTime: number;
+    /**
+     * Row id of the control, for when it is on a table
+     */
     rowId: string;
+    /**
+     *
+     */
+    /**
+     * The HTML element connected to this directive
+     */
     protected htmlElement: HTMLElement;
+    /**
+     * Magic's component handling this control
+     */
     component: TaskBaseMagicComponent;
+    /**
+     * Collection of event handlers for this element
+     */
     private eventHandlers;
+    /**
+     * Id of this element
+     */
     id: string;
+    /**
+     * @ignore
+     */
     protected selector: string;
+    /**
+     * @ignore
+     */
     subscribeRefreshDom: Subscription;
     private focusUnlistener;
     eventsOnlyVal: boolean;
     static opened: boolean;
     static noOfAutoCompleteBoxesOpened: number;
     subscribeInteractiveCommands: Subscription;
+    /**
+     *
+     * @param _task The task service
+     * @param element The element for which the directive is applied
+     * @param renderer Renderer for the element
+     * @param vcRef
+     * @param platform
+     * @param magicRow
+     */
     constructor(_task: TaskMagicService, element: ElementRef, renderer: Renderer2, vcRef: ViewContainerRef, platform: Platform, magicRow: RowMagicDirective);
+    /**
+     * Get the task service
+     * @returns
+     */
     get task(): TaskMagicService;
+    /**
+     * Register to the events this element may need to handle
+     */
     protected regEvents(): void;
+    /**
+     * Handle focus event
+     */
     private OnFocus;
+    /**
+     * Is the command's element the same as this directive's element
+     * @param command
+     * @returns true/false
+     */
     IsSameElement(command: any): boolean;
+    /**
+     * Is the command's element the same as this directive's component
+     * @param command
+     * @returns true/false
+     */
     private IsSameComponent;
+    /**
+     * @ignore
+     */
     private regUpdatesUI;
+    /**
+     * Initializes this object
+     */
     ngOnInit(): void;
+    /**
+     * Handles the commands received from the Magic WebClient engine
+     * @param command
+     */
     handleCommand(command: GuiCommand): void;
+    /**
+     * handle the interactive commands like CallJS
+     */
     handleInteractiveCommands(command: GuiInteractive): void;
+    /**
+     * Handle the Magic set-property command
+     * @param command
+     */
     handleSetProperty(command: GuiCommand): void;
+    /**
+     * Cleanup
+     */
     ngOnDestroy(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<MagicDirective, [null, null, null, null, null, { optional: true; }]>;
     static ɵdir: i0.ɵɵDirectiveDeclaration<MagicDirective, "[magic]", never, { "magic": { "alias": "magic"; "required": false; }; "eventsOnly": { "alias": "eventsOnly"; "required": false; }; "pollTime": { "alias": "pollTime"; "required": false; }; "rowId": { "alias": "rowId"; "required": false; }; }, {}, never, never, false, never>;

package/src/ui/directives/magicViewContainerRef.directive.d.ts

@@ -1,5 +1,8 @@
 import { ViewContainerRef } from "@angular/core";
 import * as i0 from "@angular/core";
+/**
+ * Directive for setting  ViewContainerRef on element
+ */
 export declare class MagicViewContainerRef {
     private vcRef;
     constructor(vcRef: ViewContainerRef);

package/src/ui/directives/mgformat.magic.directive.d.ts

@@ -5,33 +5,77 @@ import { MagicDirective } from './magic.directive';
 import { AbstractControl } from '@angular/forms';
 import { PIC } from '@magic-xpa/gui';
 import * as i0 from "@angular/core";
+/**
+ * Perform Magic validation on input controls which hold alphanumeric strings
+ */
 export declare class MgformatMagicDirective {
     protected magicDir: MagicDirective;
     protected _task: TaskMagicService;
     datePasteFlag: boolean;
+    /**
+     * @ignore
+     */
     constructor(magicDir: MagicDirective, _task: TaskMagicService);
     ngAfterViewInit(): void;
+    /**
+     * @ignore
+     */
+    /**
+     * This can be used to set pattern
+     * On input, verifies the input matches the required mask
+     */
     onFocusEvent($event: any): void;
     onPaste(event: ClipboardEvent): void;
     onInputEvent(event: any): void;
     dateMasking(event: any): void;
+    /**
+     * @ignore
+     */
     onChangeEvent(event: any): void;
     onBlurEvent(event: any): void;
+    /** Format year, if user enters 2 digits instead of 4 digits as per the century given in Magic.ini file */
     formatDateWithCentury(userInput: string, century: number, control: AbstractControl): void;
     updateYear(day: number, month: string, year: number, separator: string, century: number, centuryVal: number, control: AbstractControl): void;
     getDateSegments1(dateArray: any): any[];
     getDateSegments2(dateArray: any): any[];
     getDateSegments3(dateArray: any): any[];
     getDateSegments4(dateArray: any): any[];
+    /**
+     * @ignore
+     */
     calculatePattern(): void;
     formatDate(pic: PIC): void;
+    /**
+     * @ignore
+     */
     formatAlphaUnicode(control: AbstractControl): void;
+    /**
+     * @ignore
+     */
     formatBoolean(control: AbstractControl): void;
+    /**
+     * @ignore
+     */
     generatePattern(attribute: StorageAttribute, pic: PIC): string;
+    /**
+     * @ignore
+     */
     generatePatternForNumber(pic: PIC): string;
+    /**
+     * @ignore
+     */
     isPatternGenerationNeeded(attr: StorageAttribute, pic: PIC): boolean;
+    /**
+     * @ignore
+     */
     generatePatternForAlpha(pic: PIC): string;
+    /**
+     * @ignore
+     */
     getDirectiveCount(mask: string, idx: number, pattern: string, changeInPattern: RefParam<boolean>): number;
+    /**
+     * @ignore
+     */
     IsPatternMatches(mask: string, pattern: string): boolean;
     static ɵfac: i0.ɵɵFactoryDeclaration<MgformatMagicDirective, never>;
     static ɵdir: i0.ɵɵDirectiveDeclaration<MgformatMagicDirective, "[mgFormat]", never, {}, {}, never, never, false, never>;

package/src/ui/directives/range-validator.magic.directive.d.ts

@@ -2,15 +2,31 @@ import { ViewContainerRef } from '@angular/core';
 import { FormControl, Validator } from '@angular/forms';
 import { TaskMagicService } from '../../services/task.magics.service';
 import * as i0 from "@angular/core";
+/**
+ * Validates the field range.
+ */
 export declare class RangeValidatorMagicDirective implements Validator {
     protected _task: TaskMagicService;
     protected vcRef: ViewContainerRef;
+    /**
+     *
+     * @param _task The task service
+     * @param vcRef
+     */
     constructor(_task: TaskMagicService, vcRef: ViewContainerRef);
+    /**
+     * Validation method
+     * @param c FormControl to validate
+     * @returns If validation fails, return error message, else returns null
+     */
     validate(c: FormControl): {
         rangevalidator: {
             errorMsg: string;
         };
     };
+    /**
+     * @ignore
+     */
     getControlName(c: FormControl): string | null;
     static ɵfac: i0.ɵɵFactoryDeclaration<RangeValidatorMagicDirective, never>;
     static ɵdir: i0.ɵɵDirectiveDeclaration<RangeValidatorMagicDirective, "[rangevalidator] ", never, {}, {}, never, never, false, never>;

package/src/ui/magic-confirmationBox.d.ts

@@ -1,6 +1,25 @@
 import { Styles } from "@magic-xpa/gui";
+/**
+ * Displays a message-box
+ */
 export declare class confirmationBox {
+    /**
+     * @ignore
+     */
     static isConfirmBox(style: Styles): Boolean;
+    /**
+     * Converts the result from the HTML window to the expected result type
+     * @param style Result received from HTML window
+     * @param okWasPressed Was the "OK" pressed
+     * @returns  MessageBox result type
+     */
     static convertToExcpectedResultBox(style: Styles, okWasPressed: Boolean): Styles;
+    /**
+     * Show a message box as an HTML window
+     * @param title Title of the message box
+     * @param message Message that will be display in the message box
+     * @param style Style that include buttons \ Icons
+     * @returns MessageBox result
+     */
     static showConfirmationBox(title: string, message: string, style: Styles): boolean;
 }

package/src/ui/magic-modal/base-magic-overlay-container.d.ts

@@ -1,5 +1,14 @@
 export declare abstract class BaseMagicOverlayContainer {
+    /**
+     *
+     */
     abstract ModalComp: any;
+    /**
+     *
+     */
     abstract ModalCompParameters: any;
+    /**
+     *
+     */
     abstract onClose: any;
 }

package/src/ui/magic-modal/magic-modal-form.d.ts

@@ -1,3 +1,6 @@
+/**
+ * @ignore
+ */
 export declare class ModalFormDefinition {
     taskId: string;
     comp: any;

package/src/ui/magic-modal/magic-modal-interface.d.ts

@@ -1,10 +1,37 @@
+/**
+ * Describes the behavior of a modal window
+ */
 export interface MagicModalInterface {
+    /**
+     * Returns the X coordinate of the modal window
+     */
     X(): any;
+    /**
+     * Returns the Y coordinate of the modal window
+     */
     Y(): any;
+    /**
+     * Returns the width of modal window
+     */
     Width(): string;
+    /**
+     * Returns the height of modal window
+     */
     Height(): string;
+    /**
+     * Is the modal window centered relatively to the main window
+     */
     IsCenteredToWindow(): any;
+    /**
+     * Returns the name of the form - title of the modal window
+     */
     FormName(): any;
+    /**
+     * Should the title bar be displayed
+     */
     ShowTitleBar(): any;
+    /**
+     * Should the modal window close when the user clicks on the background
+     */
     ShouldCloseOnBackgroundClick(): any;
 }

package/src/ui/magic-modal/magic-overlay-container-wrapper.d.ts

@@ -9,17 +9,37 @@ export declare class MagicOverlayContainerWrapper implements IMagicViewContainer
     private injector;
     private changeDetectorRef;
     private compiler;
+    /**
+     *
+     */
     Component: any;
+    /**
+     *
+     */
     Parameters: any;
     private OverlayTypeParam;
     private onClose;
+    /**
+     * HTML to be displayed in the modal window
+     */
     overlayContentViewContainerRef: ViewContainerRef;
     overlayContainerWrapperElementRef: ElementRef;
+    /**
+     * @ignore
+     * contais data of allowed base components to use
+     */
     static allowedBaseComps: Map<number, {
         comp: any;
         error: string;
     }>;
+    /**
+     *
+     * @param componentFactoryResolver
+     */
     constructor(componentListMagicService: ComponentListMagicService, magicLazyModuleLoader: MagicLazyLoaderService, injector: Injector, changeDetectorRef: ChangeDetectorRef, compiler: Compiler);
+    /**
+     *
+     */
     ngOnInit(): void;
     private loadComponent;
     setViewContainerRef(vcRef: ViewContainerRef): void;

package/src/ui/magic-modal/magic-overlay-container.d.ts

@@ -2,22 +2,73 @@ import { ElementRef, EventEmitter, OnInit, ViewContainerRef } from '@angular/cor
 import { BaseMagicOverlayContainer } from './base-magic-overlay-container';
 import { IMagicViewContainerRef } from '../../..';
 import * as i0 from "@angular/core";
+/**
+ * Creates a modal window for Magic modal window components
+ */
 export declare class MagicOverlayContainer extends BaseMagicOverlayContainer implements OnInit, IMagicViewContainerRef {
+    /**
+     * HTML to be displayed in the modal window
+     */
     modalbodyViewContainerRef: ViewContainerRef;
+    /**
+     * Header of the modal window
+     */
     headerElementRef: ElementRef;
+    /**
+     * Foreground of the modal window
+     */
     foregroundElementRef: ElementRef;
+    /**
+     *
+     */
     ModalComp: any;
+    /**
+     *
+     */
     ModalCompParameters: any;
     onClose: EventEmitter<void>;
+    /**
+     *
+     */
     private componentRef;
+    /**
+     *
+     * @param injector
+     * @param componentFactoryResolver
+     */
     constructor();
+    /**
+     *
+     */
     ngOnInit(): void;
     setViewContainerRef(vcRef: ViewContainerRef): void;
+    /**
+     * Returns the form name
+     * @returns
+     */
     getText(): any;
+    /**
+     * Returns CSS styles for the window
+     * @returns
+     */
     getStyle(): {};
+    /**
+     * Returns the CSS styles for the client area
+     * @returns
+     */
     getClientAreaStyles(): {};
+    /**
+     * Should the title bar be displayed
+     * @returns
+     */
     getShowTitleBar(): any;
+    /**
+     *
+     */
     OnClose(): void;
+    /**
+     * Handles click in the background window
+     */
     OnBackgroundClick(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<MagicOverlayContainer, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<MagicOverlayContainer, "app-magic-overlay-container", never, { "ModalComp": { "alias": "ModalComp"; "required": false; }; "ModalCompParameters": { "alias": "ModalCompParameters"; "required": false; }; }, { "onClose": "onClose"; }, never, never, false, never>;