//TH-Header
//*****************************************************************************************
// Copyright (c)  2023 NEXT Software Kft.
// All rights reserved.
//
// $FileName    : SyncFusion\AppSrc\csfWebToast.pkg
// $ProjectName : SyncFusion Library
// $Authors     : András Michaletzky, Rudolf Norman Monik
// $Created     : 2023-12-20
//
// Contents:
// This is a web framework wrapper class for the Toast control.
// Documentation for the API is here:
// https://ej2.syncfusion.com/documentation/api/Toast
// and tips & tricks here:
// https://ej2.syncfusion.com/javascript/documentation/Toast/es5-getting-started/
// Syncfusion demo's:
// https://ej2.syncfusion.com/javascript/demos/#/material/Toast/default.html
//
//*****************************************************************************************
//TH-RevisionStart
// ********************
// MODIFICATION SUMMARY
// ********************
// ####### DD/MM/YYYY  WHO COMMENT
//TH-RevisionEnd
Use csfWebBaseControl.pkg

{ OverrideProperty=psLabel}
{ OverrideProperty=psValue}
{ OverrideProperty=psCSSClass}
{ OverrideProperty=pbShowLabel Visibility=Private InitialValue=False }
Class csfWebToast is a csfWebBaseControl
    
    Procedure Construct_Object
        Forward Send Construct_Object
        
        { WebProperty=Client }
        Property String psValue
        
        { WebProperty=Client }
        Property String psCaption
        
        { WebProperty=Client }
        Property String psLabel
        
        { EnumList="e-meeting, e-info toast-icons, e-success toast-icons, e-warning toast-icons, e-error toast-icons" }
        { InitialValue="e-meeting" }
        { WebProperty=Client }
        Property String psIcon                          "e-meeting"
        
        { EnumList="e-toast-info, e-toast-success, e-toast-warning, e-toast-danger" }
        { InitialValue="" }
        { WebProperty=Client }
        Property String psCSSClass
        
        { InitialValue=75 }  // only as a hint for the designer
        { WebProperty=Client }
        Property Integer piHeight                       C_WebDefault
        
        { WebProperty=Client }
        Property Integer piWidth                        C_WebDefault
        
        { WebProperty=Client }
        Property String  psItemTemplate                 '<div id="toast_default"></div>'
        
        { EnumList="Left, Right" }
        { InitialValue="Right" }
        { WebProperty=Client }
        Property String psPositionH                     "Right"
        
        { EnumList="Top, Bottom" }
        { InitialValue="Top" }
        { WebProperty=Client }
        Property String psPositionV                     "Top"
        
        { EnumList="SlideBottomIn, FadeIn, FadeZoomIn, FlipLeftDownIn, FlipLeftUpIn, FlipRightDownIn, FlipRightUpIn, SlideLeftIn, SlideRightIn, SlideTopIn, ZoomIn" }
        { InitialValue="FadeIn" }
        { WebProperty=Client }
        Property String psShowEffect                   "FadeIn"
        
        { EnumList="SlideBottomOut, FadeOut, FadeZoomOut, FlipLeftDownOut, FlipLeftUpOut, FlipRightDownOut, FlipRightUpOut, SlideLeftOut, SlideRightOut, SlideTopOut, ZoomOut" }
        { InitialValue="FadeOut" }
        { WebProperty=Client }
        Property String psHideEffect                   "FadeOut"
        
        { EnumList="ease, linear" }
        { InitialValue="ease" }
        { WebProperty=Client }
        Property String psShowEasing                   "ease"
        
        { EnumList="ease, linear" }
        { InitialValue="ease" }
        { WebProperty=Client }
        Property String psHideEasing                   "ease"
        
        { WebProperty=Client }
        Property Integer piShowDuration                 600
        
        { WebProperty=Client }
        Property Integer piHideDuration                 600
        
        { EnumList="Ltr, Rtl" }
        { InitialValue="Ltr" }
        { WebProperty=Client }
        Property String psProgressDirection             "Ltr"
        
        { WebProperty=Client }
        Property Boolean pbShowProgressBar              True
        
        { WebProperty=Client }
        Property Boolean pbShowCloseButton              False
        
        { WebProperty=Client }
        Property Boolean pbNewestOnTop                  True
       
        { WebProperty=Client }
        Property Integer piTimeout                      5000
        
        { WebProperty=Client }
        Property Integer piExtendedTimeout              600
        
        { WebProperty=Client }
        Property String  psTemplate                     ""
        
        { WebProperty=Client }
        Property Boolean pbServerOnClick                False
        
        { WebProperty=Client }
        Property Boolean pbServerOnBeforeOpen           False   
        
        { WebProperty=Client }
        Property Boolean pbServerOnBeforeClose          False     
        
        { WebProperty=Client }
        Property Boolean pbServerOnOpen                 False 
        
        { WebProperty=Client }
        Property Boolean pbServerOnClose                False
                
        { WebProperty=Client }
        Property Boolean pbServerOnCreated              False   
        
        { WebProperty=Client }
        Property Boolean pbServerOnBeforeSanitizeHtml   False
            
        Set psJSClass to "sf.WebToast"
    End_Procedure

    // RefreshToast
    //
    Procedure RefreshToast
        Send ClientAction "refreshToast"
    End_Procedure
    
    Procedure doRenderToast
        Send OnRender
        Send ClientAction "renderToast"
    End_Procedure
    
    
    { Visibility=Private }
    Procedure ConfigureWebToast
        String[] asParams
        tWebValueTree tVT
        Send doRenderToast
    End_Procedure
    
    // Executes before we ask the component to render itself.
    { MethodType=Event }
    Procedure OnRender
    End_Procedure
    
    // Triggers when the component has been clicked. (needs to be enabled)
    { MethodType=Event }
    Procedure OnClick  String sValue
    End_Procedure
    
    // Triggers before the component is opened. (needs to be enabled)
    { MethodType=Event }
    Procedure OnBeforeOpen String sValue
    End_Procedure
    
    // Triggers before the component is closed. (needs to be enabled)
    { MethodType=Event }
    Procedure OnBeforeClose String sValue
    End_Procedure
    
    // Triggers when the component is opened. (needs to be enabled)
    { MethodType=Event }
    Procedure OnOpen String sValue
    End_Procedure
    
    // Triggers when the component is closed. (needs to be enabled)
    { MethodType=Event }
    Procedure OnClose String sValue
    End_Procedure
    
    // Triggers when the component in the browser is created. (needs to be enabled)
    { MethodType=Event }
    Procedure OnCreated String sValue
    End_Procedure
    
    // Triggers before the component is sanitized in the browser. (needs to be enabled)
    { MethodType=Event }
    Procedure OnBeforeSanitizeHtml String sValue
    End_Procedure
    
    Procedure Show
        Handle hoFloatBy
        String sName
        Send doRenderToast
        WebSet pbVisible to True
    End_Procedure
    
    
    Procedure End_Construct_Object
        WebPublishProcedure ConfigureWebToast
        WebPublishProcedure OnClick
        WebPublishProcedure OnBeforeOpen
        WebPublishProcedure OnBeforeClose
        WebPublishProcedure OnOpen
        WebPublishProcedure OnClose
        WebPublishProcedure OnCreated
        WebPublishProcedure OnBeforeSanitizeHtml
        Forward Send End_Construct_Object
    End_Procedure
End_Class