@magic-xpa/angular 4.1200.0-dev4120.5 → 4.1200.0-dev4120.51

package/src/services/subform.magic.service.d.ts

@@ -10,6 +10,9 @@ import { ISubformMagicService } from './ISubformMagicService';
 import { RouterContainerMagicComponent } from '../ui/router-container.magic.component';
 import { MagicLazyLoaderService } from './magic.lazy.loader.service';
 import * as i0 from "@angular/core";
+/**
+ * Service for managing subforms and routing
+ */
 export declare class SubformMagicService implements ISubformMagicService {
     private task;
     protected activatedRoute: ActivatedRoute;
@@ -29,13 +32,38 @@ export declare class SubformMagicService implements ISubformMagicService {
     static currentCallerMgSubformServiceRef: any;
     static routerContainers: Array<RouterContainerMagicComponent>;
     constructor(task: TaskMagicService, activatedRoute: ActivatedRoute, componentList: ComponentListMagicService, pendingCommandsCollector: CommandsCollectorMagicService, router: Router, routerCommandsMagicService: RouterCommandsMagicService, componentListMagicService: ComponentListMagicService, loader: MagicLazyLoaderService, injector: Injector, compiler: Compiler);
+    /**
+     * Finds and returns the component according to the subform name
+     * @param subformName
+     * @returns
+     */
     mgGetComp(subformName: string): Component;
+    /**
+     * Returns the parameters of the subform
+     * @param subformName
+     * @returns
+     */
     mgGetParameters(subformName: string): any;
+    /**
+     * @ignore
+     */
     deleteSubformComp(subformControlName: string, formName: string): void;
+    /**
+     * @ignore
+     */
     addSubformComp(subformControlName: string, formName: string, taskId: string, taskDescription: any, routerPath: string, params: List<any>, inDefaultOutlet: boolean): void;
+    /**
+     * Open the subform using a route command
+     */
     ExecuteRouteCommand(routeCommand: RouteCommand): void;
     private PerformRouterNavigate;
+    /**
+     * @ignore
+     */
     init(): void;
+    /**
+     * @ignore
+     */
     refreshView(): void;
     static getRelativeRoute(sendActivatedRoute: ActivatedRoute): ActivatedRoute;
     static ɵfac: i0.ɵɵFactoryDeclaration<SubformMagicService, never>;

package/src/services/table.magic.service.d.ts

@@ -1,29 +1,85 @@
 import { TaskMagicService } from "./task.magics.service";
 import { ComponentListMagicService } from "./component-list.magic.service";
 import * as i0 from "@angular/core";
+/**
+ * Implements various table-related functionalities
+ */
 export declare class TableMagicService {
     protected componentList: ComponentListMagicService;
     protected task: TaskMagicService;
     selectedItem: any;
     private chunkSize;
+    /**
+     *
+     * @param componentList Component-mapping service
+     * @param task Magic task service
+     */
     constructor(componentList: ComponentListMagicService, task: TaskMagicService);
     shouldOpenFieldTextEditor: boolean;
+    /**
+     * Refreshes the DataSource
+     */
     refreshDataSource(): void;
+    /**
+     * Returns the table page size
+     * chunkSize as default value for non-paginated tables.
+     */
     getPageSize(): number;
     setChunkSize(size: number): void;
+    /**
+     * Returns max no of rows in the table.
+     */
     getMaxRowsInTable(): number;
+    /**
+     * Selects the specified row
+     * @param rowId The row to select
+     */
     selectRow(rowId: string): void;
     getSelectedRow(): any;
+    /**
+     * Returns the selected row
+     */
     selectedRow(): any;
+    /**
+     * Selects the specified page
+     * @param  pageId The page to select
+     */
     selectPage(pageId: number): void;
+    /**
+     * Returns whether a dialog should be opened for the HTML element
+     * @param  element The HTML element for which a dialog may be needed
+     * @returns
+     */
     OpenDialogForControl(element: HTMLElement): boolean;
+    /**
+     * Returns the dialog used to edit values
+     */
     getDialog(): any;
+    /**
+     * Handles the table "scrolled" event
+     */
     onScrollDown(): void;
+    /**
+     * To be overwitten in specific implelemtations
+     */
     sortData(e: any): void;
+    /**
+     * To be overwitten in specific implelemtations
+     */
     mgOnPaginateChange(e: any, changeSelectedRow?: boolean): void;
     mgOptionChanged(e: any): void;
+    /**
+     * Change the number of lines in a table
+     * @param  size New number of lines in table
+     */
     updateTableSize(size: number): void;
+    /**
+     * @ignore
+     */
     setTableTopIndex(value: number): void;
+    /**
+     * @ignore
+     */
     getTableTopIndex(): number;
     static ɵfac: i0.ɵɵFactoryDeclaration<TableMagicService, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<TableMagicService>;

package/src/services/task.magics.service.d.ts

@@ -9,91 +9,391 @@ import { TitleMagicService } from './title.magic.service';
 import { AccessorMagicService } from './accessor.magic.service';
 import { OverlayWindowService } from './OverlayWindowService';
 import * as i0 from "@angular/core";
+/**
+ * Main service to connect the UI with the Magic WebCLient
+ */
 export declare class TaskMagicService {
     protected magic: EngineMagicService;
     private overlayWindowService;
+    /**
+     * Service to provide table-related functionalities
+     */
     tableService: any;
+    /**
+     * Collection of data for all controls
+     */
     Records: any;
+    /**
+     * FormGroup collection for line mode
+     */
     formGroups: Array<FormGroup>;
+    /**
+     * FormGroup for all controls in screen mode
+     */
     ScreenModeControls: FormGroup;
+    /**
+     * @ignore
+     */
     refreshDom: Subject<GuiCommand>;
+    /**
+     * @ignore
+     */
     subscribeRefreshDom: Subscription;
+    /**
+     * @ignore
+     */
     detectChanges: Subject<any>;
+    /**
+     * @ignore
+     */
     subscribeInteractiveCommands: Subscription;
+    /**
+     * @ignore
+     */
     interactiveCommands: Subject<GuiInteractive>;
+    /**
+     * @ignore
+     * This event is emitted when the selected row in a table changes.
+     */
     OnSelectedRowChanged: EventEmitter<string>;
+    /**
+     * @ignore
+     */
     customPropertiesSubject: Subject<any>;
+    /**
+     * @ignore
+     */
     recordsCountChangeSubject: Subject<any>;
     mgLoadSubject: Subject<any>;
+    /**
+     * @ignore
+     */
     template: {
         [id: string]: string;
     };
+    /**
+     * Service to provide subform-related functionalities
+     */
     mgSubformService: SubformMagicService;
+    /**
+     * Service to provide the title-change functionality
+     */
     mgTitleService: TitleMagicService;
+    /**
+     * Service which enables getting/setting values from/to the Magic WebClient engine
+     */
     mgAccessorService: AccessorMagicService;
     mgInputDateFormat: any;
+    /**
+     * @ignore
+     */
     oldPageSize: number;
+    /**
+     *
+     * @param  magic
+     */
     constructor(magic: EngineMagicService, overlayWindowService: OverlayWindowService);
+    /**
+    * returns true if used is logged in
+    * @returns
+    */
     getIsLoggenIn(): boolean;
+    /**
+     * Id of task to which this service refers
+     */
     _taskId: string;
+    /**
+     * returns the task Id
+     * @returns
+     */
     get taskId(): string;
+    /**
+     * Sets the task Id
+     * @param value the task id to set
+     */
     set taskId(value: string);
+    /**
+     * Returns the task's data in Screen mode
+     * @returns
+     */
     get ScreenControlsData(): any;
+    /**
+     * @ignore
+     */
     settemplate(value: any): void;
+    /**
+     * Builds the FormControl for each and every control
+     */
     buildScreenModeControls(): void;
+    /**
+     * Is the control a table control
+     * @param id Id of the control
+     * @returns
+     */
     isTableControl(id: string): boolean;
     getMgInputDateFormat(): string;
+    /**
+     * Returns the FormControl of a control
+     * @param guiRowid Id of the requested row
+     * @param id Id of the control
+     * @returns
+     */
     getFormControl(guiRowid: string, id: string): AbstractControl;
+    /**
+     * handle the change of text for input control inside table
+     * @param  guiRowId Id of the row for which the FormControls are built
+     * set the new value of the formcontrol
+     */
     setInputTextValue(controlId: string, guiRowid: string, val: any): void;
+    /**
+     * Build the FormControls for a table row
+     * @param  guiRowId Id of the row for which the FormControls are built
+     */
     buildTableRowControls(guiRowId: number): void;
+    /**
+     *
+     * @ignore
+     */
     updateRecordsBeforeCurrentView(value: number): void;
+    /**
+     * @ignore
+     */
     setIncludesFirst(value: boolean): void;
+    /**
+     * @ignore
+     */
     setIncludesLast(value: boolean): void;
+    /**
+     * @ignore
+     */
     markRowAsCreated(guiRowId: number): void;
+    /**
+     * @ignore
+     */
     markRowAsNotCreated(guiRowId: number): void;
+    /**
+     * @ignore
+     */
     startRowEditing(guiRowId: number): void;
+    /**
+     * @ignore
+     */
     stopRowEditing(guiRowId: number): void;
+    /**
+     * @ignore
+     */
     isRowInRowEditing(guiRowId: string): boolean;
+    /**
+     * @ignore
+     */
     setIsEmptyDataView(isEmpty: boolean): void;
+    /**
+     * Initialize the service to work with the task
+     * @param taskId Id of the task
+     * @param taskDescription
+     */
     initTask(taskId: any, taskDescription: any): void;
+    /**
+     * @ignore
+     */
     refreshView(): void;
+    /**
+     * Insert an event to the Magic WebClient event queue
+     * @param guiEvent The event to insert
+     */
     insertEvent(guiEvent: IGuiEvent): void;
+    /**
+     * @ignore
+     */
     GetControlPictureMask(controlName: string): any;
+    /**
+     * Validates the control value, using the Magic WebClient
+     * @param controlName Id of validated control
+     * @param value value to be validated
+     * @returns If validation fails, returns error message, else returns null
+     */
     ValidateControlValue(controlName: string, value: any): string;
+    /**
+     * @ignore
+     */
     GetRangedValue(controlName: string, value: string): string;
+    /**
+     * @ignore
+     */
     GetFldRanges(controlName: string): string;
+    /**
+     * returns the value of a property of the control
+     * @param controlId Id of control
+     * @param prop Property
+     * @param guiRowId Row Id, if applicable
+     * @returns Property value
+     */
     getProperty(controlId: string, prop: HtmlProperties, guiRowId?: string): any;
+    /**
+     * @ignore
+     */
     getPropertyStub(ControlsProperties: any, controlId: any, prop: any): any;
+    /**
+     * @ignore
+     */
     getStyleStub(ControlsProperties: any, controlId: any, styleName: string): any;
+    /**
+     * Return the CSS classes used for this control
+     * @param controlId Id of control
+     * @param guiRowId Row Id, if applicable
+     * @returns String containing the classes currently defined for this control
+     */
     getClasses(controlId: string, guiRowId?: string): string;
+    /**
+     * Return the value of a style used for a control
+     * @param controlId Id of control
+     * @param styleName Name of style
+     * @param guiRowId Row Id, if applicable
+     * @returns value of style of the control
+     */
     getStyle(controlId: string, styleName: string, guiRowId?: string): string;
+    /**
+     * Return the value of a control
+     * @param controlId Id of control
+     * @param guiRowId Row Id, if applicable
+     * @returns value of the control
+     */
     getValue(controlId: string, guiRowId?: string): any;
+    /**
+     * Return the formatted value of a control
+     * @param controlId Id of control
+     * @param guiRowId Row Id, if applicable
+     * @returns value of the control
+     */
     getFormattedValue(controlName: string, val: any, rowId?: string): string;
+    /**
+     * Sets the value of a control
+     * @param controlId Id of control
+     * @param guiRowId Row Id, if applicable
+     * @param value Value to set
+     */
     setValue(controlId: string, guiRowId: string, value: any): void;
+    /**
+     * @ignore
+     */
     protected executeInteractiveCommand(guiInteractiveCommand: GuiInteractive): void;
+    /**
+     * @ignore
+     */
     handleSetProperty(command: GuiCommand, isTableChild: boolean): void;
     executeCommand(command: GuiCommand): void;
+    /**
+    custom validator
+    */
     customValidator(rowid: string, id: string): ValidatorFn;
+    /**
+     * COnvert a value from Magic format to native format
+     * @param controlId Id of control
+     * @param  rowId Row Id, if applicable
+     * @param val Value to convert
+     * @returns Converted value
+     */
     ConvertValToNative(controlId: string, rowId: number, val: any): any;
+    /**
+     * Convert a value from native to Magic format
+     * @param controlId Id of control
+     * @param  rowId Row Id, if applicable
+     * @param val Value to convert
+     * @returns Converted value
+     */
     ConvertValFromNative(controlId: string, rowId: number, val: any): any;
+    /**
+     * Handle resize and also fetch chunk of records if having an empty view.
+     * @ignore
+     * @param pageSize : PageSize
+     * @param topGuiRowId : GuiRowId of first record in view.
+     */
     resize(pageSize: number, topGuiRowId: number): void;
+    /**
+     * Fetches data for new table rows when scrolling done
+     */
     onScrollDown(): void;
+    /**
+     * Sets the new browser window title
+     * @param newTitle New window title
+     */
     setTitle(newTitle: string): void;
+    /**
+     * @ignore
+     */
     getGuiRowId(dvRowId: number, isTableControl: boolean): number;
+    /**
+     *
+     * @ignore
+     */
     getDvRowId(guiRowId: number): number;
+    /**
+     * Clean up the service when it is no longer needed
+     */
     dispose(): void;
+    /**
+     * Handle the Combobox "change" event
+     * @param event  The event received from the UI
+     * @param idx Id of the control raising the event
+     * @param line Row Id, if applicable
+     */
     onComboboxSelectionChanged(event: Event, idx: string, line: number): void;
+    /**
+     * Handle the Listbox "change" event
+     * @param  event The event received from the UI
+     * @param idx Id of the control raising the event
+     */
     onListBoxSelectionChanged(event: Event, idx: string): void;
+    /**
+     * Handle the Checkbox "change" event
+     * @param  event The event received from the UI
+     * @param idx Id of the control raising the event
+     * @param  rowId Row Id, if applicable
+     */
     onCheckChanged(event: Event, idx: string, rowId: number): void;
+    /**
+     * Handle tab selection change, caused by UI events
+     * @param idx Id of the control raising the event
+     * @param  layer Id of selected tabpage
+     */
     mgOnTabSelectionChanged(idx: string, layer: number): void;
+    /**
+     * Handle the Radio button "change" event
+     * @param  event The event received from the UI
+     * @param idx Id of the control raising the event
+     */
     mgOnRadioSelectionChanged(idx: string): void;
+    /**
+     * Inserts the "close" event to the magic WebClient event queue
+     */
     close(): void;
+    /**
+     * @ignore
+     */
     IsStub(): boolean;
+    /**
+     * @ignore
+     */
     jsonData: string;
+    /**
+     * @ignore
+     */
     saveData(data: string): void;
+    /**
+     * @ignore
+     */
     createData(): void;
+    /**
+     * @ignore
+     */
     loadStubData(stubData: any): void;
+    /**
+     * @ignore
+     */
     loadData(): void;
+    /**
+     * @ignore
+     */
     setStubValue(guiRowId: number, fc: FormControl, name: string): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<TaskMagicService, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<TaskMagicService>;

package/src/services/title.magic.service.d.ts

@@ -1,8 +1,19 @@
 import { Title } from "@angular/platform-browser";
 import * as i0 from "@angular/core";
+/**
+ * Enables changing the browser title using Magic expression (SetTitle)
+ */
 export declare class TitleMagicService {
     protected titleService: Title;
+    /**
+     *
+     * @param titleService Angular's title-changing class
+     */
     constructor(titleService: Title);
+    /**
+     * Set the new title of the window
+      * @param newTitle New title of the window
+     */
     setTitle(newTitle: string): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<TitleMagicService, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<TitleMagicService>;

package/src/ui/GuiInteractiveExecutor.d.ts

@@ -2,6 +2,9 @@ import { GuiInteractive } from '@magic-xpa/gui';
 import { TaskBaseMagicComponent } from './task-base.magic.component';
 import { TaskMagicService } from '../services/task.magics.service';
 import { OverlayWindowService } from '../services/OverlayWindowService';
+/**
+ * @ignore
+ */
 export declare class GuiInteractiveExecutor {
     command: GuiInteractive;
     component: TaskBaseMagicComponent;

package/src/ui/components/base-magic-alert.component.d.ts

@@ -1,9 +1,25 @@
 import { EventEmitter } from "@angular/core";
 import * as i0 from "@angular/core";
+/**
+ * This is a base class for the magic alert components
+ */
 export declare class BaseMagicAlertComponent {
+    /**
+     * title of the component
+     */
     title: string;
+    /**
+     * message of the component
+     */
     message: string;
+    /**
+     * onClose Event - to be raised when the component is closed
+  
+     */
     onClose: EventEmitter<void>;
+    /**
+     * close magic alert
+     */
     OnClose(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<BaseMagicAlertComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<BaseMagicAlertComponent, "mg-base-alert", never, { "title": { "alias": "title"; "required": false; }; "message": { "alias": "message"; "required": false; }; }, { "onClose": "onClose"; }, never, never, false, never>;

package/src/ui/components/base-magic-confirm.component.d.ts

@@ -1,9 +1,27 @@
 import { EventEmitter } from '@angular/core';
 import * as i0 from "@angular/core";
+/**
+ * This is a base class for the magic confirm components
+ */
 export declare class BaseMagicConfirmComponent {
+    /**
+     * title of the component
+     */
     title: string;
+    /**
+     * message of the component
+     */
     message: string;
+    /**
+     * onClose Event - to be raised when the component is closed
+     * should pass true when OK is pressed and false when cancel is pressed
+     */
     onClose: EventEmitter<boolean>;
+    /**
+     * raises close Event
+     * @param result true when OK is pressed and false when cancel is pressed
+     *
+     */
     OnClose(result: any): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<BaseMagicConfirmComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<BaseMagicConfirmComponent, "mg-base-confirm", never, { "title": { "alias": "title"; "required": false; }; "message": { "alias": "message"; "required": false; }; }, { "onClose": "onClose"; }, never, never, false, never>;

package/src/ui/components/magic-alert.component.d.ts

@@ -1,5 +1,8 @@
 import { BaseMagicAlertComponent } from './base-magic-alert.component';
 import * as i0 from "@angular/core";
+/***
+ * This is sample component for the alert message
+ */
 export declare class MagicAlertComponent extends BaseMagicAlertComponent {
     static ɵfac: i0.ɵɵFactoryDeclaration<MagicAlertComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<MagicAlertComponent, "sample-magic-alert-component", never, {}, {}, never, never, false, never>;

package/src/ui/components/magic-confirmation-box.component.d.ts

@@ -1,5 +1,8 @@
 import { BaseMagicConfirmComponent } from './base-magic-confirm.component';
 import * as i0 from "@angular/core";
+/***
+ * This is sample component for the confirmation box
+ */
 export declare class MagicConfirmationBoxComponent extends BaseMagicConfirmComponent {
     static ɵfac: i0.ɵɵFactoryDeclaration<MagicConfirmationBoxComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<MagicConfirmationBoxComponent, "sample-magic-confirmation-box", never, {}, {}, never, never, false, never>;

package/src/ui/directives/NonMagicControlDirective.d.ts

@@ -3,23 +3,64 @@ import { TaskBaseMagicComponent } from '../task-base.magic.component';
 import { TaskMagicService } from '../../services/task.magics.service';
 import { Subscription } from 'rxjs';
 import * as i0 from "@angular/core";
+/**
+ * Responsible for connecting HTML elements to the Magic WebClient engine showing it is not Magic Control but a Dummy control which is used to notify only receeive focus event for now
+ */
 export declare class NonMagicControlDirective implements OnInit {
     protected _task: TaskMagicService;
     protected element: ElementRef;
     protected renderer: Renderer2;
     protected vcRef: ViewContainerRef;
     set magic(val: any);
+    /**
+     * 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;
     eventsOnlyVal: boolean;
+    /**
+     *
+     * @param _task The task service
+     * @param element The element for which the directive is applied
+     * @param renderer Renderer for the element
+     * @param vcRef
+     */
     constructor(_task: TaskMagicService, element: ElementRef, renderer: Renderer2, vcRef: ViewContainerRef);
+    /**
+     * 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;
+    /**
+     * Initialize this object
+     */
     ngOnInit(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<NonMagicControlDirective, never>;
     static ɵdir: i0.ɵɵDirectiveDeclaration<NonMagicControlDirective, "[NonMagicControl]", never, { "magic": { "alias": "NonMagicControl"; "required": false; }; }, {}, never, never, false, never>;