namespace OSS.Application.WebServices
{

#nullable disable

    /// <summary>
    /// The BreadcrumbItem data-model supports Breadcrumb and TreeView type web components. 
    /// </summary>
    public class BreadcrumbItem
    {
        //--- unique to Telerik Components: TreeView and Breadcrumb ----------

        /// <summary>
        /// The text shown for the breadcrumb (or treeview item).<br/>
        /// Defines the Text DataField of the Datasource.
        /// </summary>
        public string Text
        {
            get
            {
                return _text;
            }
            set
            {
                _text = value;
                _originalText = value;
            }
        }
        protected string _text;
        protected string _originalText;


        //*** Graphics ***
        //       NOTE: only one value will be used in the following order of precedence:  ImageUrl, Icon, IconClass
        /// <summary>
        /// Defines the ImageUrl DataField of the Datasource.
        /// </summary>
        public string ImageUrl { get; set; } // <-- not sure about this one
        /// <summary>
        /// Defines the Icon DataField of the Datasource. 
        /// A CSS selector to a font-image to display along side Text. 
        /// Its value is taken with priority over the 'ImageUrl' property-field.
        /// </summary>
        public string Icon { get; set; }
        /// <summary>
        /// Defines the IconClass DataField of the Datasource. 
        /// To display along side Text. 
        /// Its value is taken with priority over the 'Icon' and 'ImageUrl' property-fields. 
        /// </summary>
        public string IconClass { get; set; }

        //*** Navigation ***
        /**
       <summary>
        Defines the Url DataField of the Datasource.
       <para>
       <b>How To disable the auto-click Url navigation in the TelerikTreeView component:</b><br/>
       Assign the Telerik 'URLField' attribute-parameter a value that does not match a property name in the model assigned to the 'Data' attribute-parameter:<br/> 
       Example: add the following attribute-parameter: 
       &lt;TreeViewBinding UrlField="UrlDummy"&gt;&lt;/TreeViewBinding&gt;<br/>
       Now use NavigationManager.NavigateTo() in your on-click custom code-behind.
       </para>
       </summary>
        */
        public string Url         // <-- CAUTION: if the target model uses the same name (ie 'Url') the Telerik TreeView may auto-attempt navigation
        {
            get
            {
                if (Disabled) return null;
                return _url;
            }
            set
            {
                _url = value;
            }
        }
        private string _url;


        //--- unique to telerik Breadcrumb -----------------------------------

        /// <summary>
        /// Typically shown as tooltip type text.<br/>
        /// Title supports a defacto standard HTML Tag attribute (eg title="over-over tooltip here").
        /// </summary>
        public string Title { get; set; }
        /// <summary>
        /// 'true' = not clickable.
        /// </summary>
        public bool Disabled { get; set; }
        /// <summary>
        /// The CSS class that will be rendered on the main wrapping container of the item.
        /// </summary>
        public string Class { get; set; }


        //--- Not Telerik Properties: the following are related and used along with the URL Property ---

        /// <summary>
        /// Hide (emove) the Item.<br/>
        /// if also a 'TreeItem' then the items removed from the list for items with HasChildren = false.
        /// </summary>
        public bool Hidden { get; set; }
        /// <summary>
        /// The Blazor Component name to be shown as the page content area (ie @Body in MainLayout.razor).<br/>
        /// Reccommended using the name of the actual blazor .net component ( ie <see langword="nameof"/>(SystemUserGrid) ). 
        /// </summary>
        public string PageComponent { get; set; }
        /// <summary>
        /// An optional route segment value to further qualify to a single TreeItem unique route.<br/>
        /// Leave this value as <see langword="null"/> if used in the PageComponent to programatically modify the visual UI appearance of the page content.
        /// </summary>
        public string SegmentAction1 { get; set; }
        /// <summary>
        /// An optional route segment value to further qualify to a single TreeItem unique route.<br/>
        /// Leave this value as <see langword="null"/> if used in the PageComponent to programatically modify the visual UI appearance of the page content.
        /// </summary>
        public string SegmentAction2 { get; set; }

        // public IDictionary<string, object> ComponentParameters { get; set; }  // <-- if a match, then can include extra parameters 


        /// <summary>
        /// The query string portion of the Url.<br/>
        /// Does not include the question mark ('?').
        /// </summary>
        public string Query { get; set; }
        /// <summary>
        /// Use this to navigate to an on-page HTML "Anchor".<br/>
        /// The fragment portion of the Url (eg #myfragment).<br/>
        /// Does not include the pound sign ('#').
        /// </summary>
        public string Fragment { get; set; }    // <-- use this to navigate to an on-page HTML "Anchor"
        /// <summary>
        /// An enum specifying the intent of the link type related properties (eg Url, Query, Fragment and ComponentType).
        /// </summary>
        public LinkIntent Intent { get; set; }


        public object PageState { get; set; }
        //public int PageNumber { get; set; } = 1;
        //public int? PageSize { get; set; }

    }

}



/*   TELERIK BREADCRUMB

    Telerik Page:  https://docs.telerik.com/blazor-ui/components/breadcrumb/data-binding

Breadcrumb Item Features: 

    *** Displayed Text ***
TextField         => Text          ###
TitleField        => Title

    *** Functional & Additional Rendering *** 
DisabledField     => Disabled
ClassField        => Class

    *** Graphics *** 
ImageUrlField     => ImageUrl      ###
IconField         => Icon          ###
IconClassField    => IconClass     ###

    *** Naviation *** 
UrlField          => Url           ###


     NOTE:   '###' denotes are also properties of the Telerik TreeView component too

 */


/*   TELERIK TREEVIEW

    Telerik Page:  https://docs.telerik.com/blazor-ui/components/treeview/data-binding/overview

Treeview Item Features: 

    *** Unique Id and Displayed Text ***
IdField           => Id
TextField         => Text          ###

    *** Item Relations *** 
HasChildrenField  => HasChildren
ParentIdField     => ParentId
ItemsField        => Items
Level             -

    *** Graphics *** 
ImageUrlField     => ImageUrl      ###
IconField         => Icon          ###
IconClassField    => IconClass     ###

    *** Naviation *** 
UrlField          => Url           ###


     NOTE:   '###' denotes are also properties of the Telerik BreadCrumb component too

     Level: Used for defining different bindings for different levels. 
            If no level is set, the bindings are taken as default for any level that does not have explicit settings. 
            You should have one TelerikTreeViewBinding without a level.
 */