@magic-xpa/angular 4.1300.0-dev4130.303 → 4.1300.0-dev4130.306

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@magic-xpa/angular",
-  "version": "4.1300.0-dev4130.303",
+  "version": "4.1300.0-dev4130.306",
   "license": "SEE LICENSE IN EULA.pdf",
   "dependencies": {
-    "@magic-xpa/engine": "4.1300.0-dev4130.303",
-    "@magic-xpa/angular-material-core": "4.1300.0-dev4130.303",
+    "@magic-xpa/engine": "4.1300.0-dev4130.306",
+    "@magic-xpa/angular-material-core": "4.1300.0-dev4130.306",
     "ng-dynamic-component": "^11.0.0",
     "@maskito/angular": "^5.3.1",
     "@maskito/core": "^5.3.1",

package/types/magic-xpa-angular.d.ts

@@ -1784,6 +1784,39 @@ declare class MagicAlertComponent extends BaseMagicAlertComponent {
     static ɵcmp: i0.ɵɵComponentDeclaration<MagicAlertComponent, "sample-magic-alert-component", never, {}, {}, never, never, false, never>;
 }
 
+/**
+ * Sets of buttons that can be displayed in the confirmation box.
+ * Values match the button codes received from the server (Styles.MSGBOX_BUTTON_xxx)
+ */
+declare enum MagicConfirmationButtons {
+    Ok = 0,
+    OkCancel = 1,
+    AbortRetryIgnore = 2,
+    YesNoCancel = 3,
+    YesNo = 4,
+    RetryCancel = 5
+}
+/**
+ * Button pressed in the confirmation box.
+ * Values match the result codes returned to the server (Styles.MSGBOX_RESULT_xxx)
+ */
+declare enum MagicConfirmationResult {
+    Ok = 1,
+    Cancel = 2,
+    Abort = 3,
+    Retry = 4,
+    Ignore = 5,
+    Yes = 6,
+    No = 7
+}
+/**
+ * Buttons displayed for each set of buttons, in display order
+ */
+declare const ButtonSets: Record<MagicConfirmationButtons, MagicConfirmationResult[]>;
+/**
+ * Text of each button
+ */
+declare const ButtonTexts: Record<MagicConfirmationResult, string>;
 /**
  * This is a base class for the magic confirm components
  */
@@ -1796,25 +1829,40 @@ declare class BaseMagicConfirmComponent {
      * message of the component
      */
     message: string;
+    /**
+     * set of buttons to display
+     */
+    buttons: MagicConfirmationButtons;
     /**
      * onClose Event - to be raised when the component is closed
-     * should pass true when OK is pressed and false when cancel is pressed
+     * passes the button that was pressed
      */
-    onClose: EventEmitter<boolean>;
+    onClose: EventEmitter<MagicConfirmationResult>;
     /**
      * raises close Event
-     * @param result true when OK is pressed and false when cancel is pressed
-     *
+     * @param result the button that was pressed.
      */
-    OnClose(result: any): void;
+    OnClose(result: MagicConfirmationResult): 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>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<BaseMagicConfirmComponent, "mg-base-confirm", never, { "title": { "alias": "title"; "required": false; }; "message": { "alias": "message"; "required": false; }; "buttons": { "alias": "buttons"; "required": false; }; }, { "onClose": "onClose"; }, never, never, false, never>;
 }
 
 /***
- * This is sample component for the confirmation box
+ * This is the default confirmation box of Magic.
+ * It masks the application behind it until one of the buttons is pressed
  */
 declare class MagicConfirmationBoxComponent extends BaseMagicConfirmComponent {
+    protected readonly Result: typeof MagicConfirmationResult;
+    protected readonly buttonTexts: Record<MagicConfirmationResult, string>;
+    private buttonElements;
+    /**
+     * buttons to display for the current set of buttons
+     */
+    get buttonResults(): MagicConfirmationResult[];
+    /**
+     * focus the first button, so it can be pressed with Enter
+     */
+    ngAfterViewInit(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<MagicConfirmationBoxComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<MagicConfirmationBoxComponent, "sample-magic-confirmation-box", never, {}, {}, never, never, false, never>;
 }
@@ -2302,18 +2350,9 @@ declare class MagicModule {
  */
 declare class ConfirmationComponentsMagicProvider {
     /**
-     * Return true when use default javascript alert and confirmation or return false to provide custom components
-     *  @returns true is we want to use default javascript alert and confirmation
-     */
-    showDefaultConfirmations(): boolean;
-    /**
-     * Returns component that will replace javascript alert. The component will be used only if showDefaultConfirmations = false
-     *  @returns component that will replace javascript Alert
-     */
-    getAlertComponent(): any;
-    /**
-     * Returns component that will replace javascript confirmation box. The component will be used only if showDefaultConfirmations = false
-     *  @returns component that will replace javascript confirmation box
+     * Returns the component used to display the confirmation box, for all sets of buttons.
+     * Override it to provide a custom component that extends BaseMagicConfirmComponent
+     *  @returns component used to display the confirmation box
      */
     getConfirmtionComponent(): any;
     static ɵfac: i0.ɵɵFactoryDeclaration<ConfirmationComponentsMagicProvider, never>;
@@ -2551,6 +2590,11 @@ declare class OverlayWindowService {
      * @param result
      */
     finishConfirmation(style: Styles, result: boolean): void;
+    /**
+     * Sends the button pressed in the confirmation to the engine
+     * @param result the button pressed
+     */
+    private sendConfirmationResult;
     /**
      * creates a modal component. Can be used for overlay, message box or confirmation box
      * @param parameters component's parameters
@@ -2707,5 +2751,5 @@ declare class MagicModalProperties implements MagicModalInterface {
     IsMovable(): boolean;
 }
 
-export { AccessorMagicService, BaseMagicAlertComponent, BaseMagicConfirmComponent, BaseMagicOverlayContainer, CHECKBOX_VALUE_ACCESSOR, COLOR_FILE_NAME, CheckboxMagicDirective, CheckboxNoFormControlMagicDirective, ComboboxMagicDirective, CommandsCollectorMagicService, ComponentListMagicService, ConfirmationComponentsMagicProvider, Constants, ControlMetadata, ControlsMetadata, DATE_VALUE_ACCESSOR, DateMagicPipe, DateValueAccessor, EngineMagicService, ErrorMagicComponent, ExitMagicService, GuiInteractiveExecutor, HtmlClasses, InputNoFormControlMagicDirective, MAGIC_BG_COLOR, MAGIC_DEFAULT_VALUE_ACCESSOR, MAGIC_FG_COLOR, MG_FORMATS, MagicAlertComponent, MagicChangeDetectionService, MagicCheckboxControlValueAccessor, MagicColorService, MagicConfirmationBoxComponent, MagicDefaultValueAccessor, MagicDirective, MagicFocusDirective, MagicLazyLoaderService, MagicModalProperties, MagicModule, MagicOverlayContainer, MagicOverlayContainerWrapper, MagicServices, MagicShellComponent, MagicViewContainerRef, MgDateAdapter, MgDateFormatter, MgformatMagicDirective, ModalFormDefinition, NoControlMagicDirective, NonMagicControlDirective, OverlayContainerMagicProvider, OverlayWindowService, RangeValidatorMagicDirective, Records, RouteCommand, RouterCommandsMagicService, RouterContainerMagicComponent, RowMagicDirective, StylesMapManager, SubformMagicComponent, SubformMagicService, SubscriberService, TableMagicService, TaskBaseMagicComponent, TaskMagicService, Time24MagicPipe, TimeMagicPipe, TitleMagicService, basicMagicProviders, confirmationBox, magicProviders, matDateProviders, utils };
+export { AccessorMagicService, BaseMagicAlertComponent, BaseMagicConfirmComponent, BaseMagicOverlayContainer, ButtonSets, ButtonTexts, CHECKBOX_VALUE_ACCESSOR, COLOR_FILE_NAME, CheckboxMagicDirective, CheckboxNoFormControlMagicDirective, ComboboxMagicDirective, CommandsCollectorMagicService, ComponentListMagicService, ConfirmationComponentsMagicProvider, Constants, ControlMetadata, ControlsMetadata, DATE_VALUE_ACCESSOR, DateMagicPipe, DateValueAccessor, EngineMagicService, ErrorMagicComponent, ExitMagicService, GuiInteractiveExecutor, HtmlClasses, InputNoFormControlMagicDirective, MAGIC_BG_COLOR, MAGIC_DEFAULT_VALUE_ACCESSOR, MAGIC_FG_COLOR, MG_FORMATS, MagicAlertComponent, MagicChangeDetectionService, MagicCheckboxControlValueAccessor, MagicColorService, MagicConfirmationBoxComponent, MagicConfirmationButtons, MagicConfirmationResult, MagicDefaultValueAccessor, MagicDirective, MagicFocusDirective, MagicLazyLoaderService, MagicModalProperties, MagicModule, MagicOverlayContainer, MagicOverlayContainerWrapper, MagicServices, MagicShellComponent, MagicViewContainerRef, MgDateAdapter, MgDateFormatter, MgformatMagicDirective, ModalFormDefinition, NoControlMagicDirective, NonMagicControlDirective, OverlayContainerMagicProvider, OverlayWindowService, RangeValidatorMagicDirective, Records, RouteCommand, RouterCommandsMagicService, RouterContainerMagicComponent, RowMagicDirective, StylesMapManager, SubformMagicComponent, SubformMagicService, SubscriberService, TableMagicService, TaskBaseMagicComponent, TaskMagicService, Time24MagicPipe, TimeMagicPipe, TitleMagicService, basicMagicProviders, confirmationBox, magicProviders, matDateProviders, utils };
 export type { ComponentData, IMagicViewContainerRef, ISubformMagicService, MagicModalInterface, ModuleData, RouteDefinition, SubformDefinition };