TileListView.xaml.cs

using Microsoft.UI.Xaml;
using Microsoft.UI.Xaml.Controls;
using Microsoft.UI.Xaml.Controls.Primitives;
using Microsoft.UI.Xaml.Data;
using Microsoft.UI.Xaml.Input;
using Microsoft.UI.Xaml.Media;
using Microsoft.UI.Xaml.Media.Animation;
using Microsoft.UI.Xaml.Navigation;
using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Runtime.InteropServices.WindowsRuntime;
using Trivial.Data;
using Windows.Foundation;
using Windows.Foundation.Collections;
using Windows.UI.Text;

namespace Trivial.UI;
using DependencyObjectProxy = DependencyObjectProxy<TileListView>;

/// <summary>
/// The horizontal tile collection control.
/// </summary>
public sealed partial class TileListView : UserControl
{
    /// <summary>
    /// The dependency property of item style.
    /// </summary>
    public static readonly DependencyProperty ItemStyleProperty = DependencyObjectProxy.RegisterProperty<Style>(nameof(ItemStyle), OnItemStyleChanged);

    /// <summary>
    /// The dependency property of list view item style.
    /// </summary>
    public static readonly DependencyProperty ItemContainerStyleProperty = DependencyObjectProxy.RegisterProperty<Style>(nameof(ItemContainerStyle), (c, e, p) => c.ItemContainerStyle = e.NewValue);

    /// <summary>
    /// The dependency property of selection mode.
    /// </summary>
    public static readonly DependencyProperty SelectionModeProperty = DependencyObjectProxy.RegisterProperty(nameof(SelectionMode), ListViewSelectionMode.None);

    /// <summary>
    /// The dependency property of header height.
    /// </summary>
    public static readonly DependencyProperty HeaderHeightProperty = DependencyObjectProxy.RegisterDoubleProperty(nameof(HeaderHeight), (c, e, p) => c.HeaderHeight = e.NewValue);

    /// <summary>
    /// The dependency property of header font size.
    /// </summary>
    public static readonly DependencyProperty HeaderFontSizeProperty = DependencyObjectProxy.RegisterDoubleProperty(nameof(HeaderFontSize), (c, e, p) => c.HeaderFontSize = e.NewValue, 12);

    /// <summary>
    /// The dependency property of header font weight.
    /// </summary>
    public static readonly DependencyProperty HeaderFontWeightProperty = DependencyObjectProxy.RegisterFontWeightProperty(nameof(HeaderFontWeight), (c, e, p) => c.HeaderFontWeight = e.NewValue);

    /// <summary>
    /// The dependency property of header font style.
    /// </summary>
    public static readonly DependencyProperty HeaderFontStyleProperty = DependencyObjectProxy.RegisterProperty<FontStyle>(nameof(HeaderFontStyle), (c, e, p) => c.HeaderFontStyle = e.NewValue);

    /// <summary>
    /// The dependency property of header foreground.
    /// </summary>
    public static readonly DependencyProperty HeaderForegroundProperty = DependencyObjectProxy.RegisterProperty<Brush>(nameof(HeaderForeground), (c, e, p) => c.HeaderForeground = e.NewValue);

    /// <summary>
    /// The dependency property of header background.
    /// </summary>
    public static readonly DependencyProperty HeaderBackgroundProperty = DependencyObjectProxy.RegisterProperty<Brush>(nameof(HeaderBackground), (c, e, p) => c.HeaderBackground = e.NewValue);

    /// <summary>
    /// The dependency property of header background sizing.
    /// </summary>
    public static readonly DependencyProperty HeaderBackgroundSizingProperty = DependencyObjectProxy.RegisterProperty<BackgroundSizing>(nameof(HeaderBackgroundSizing), (c, e, p) => c.HeaderBackgroundSizing = e.NewValue);

    /// <summary>
    /// The dependency property of header padding.
    /// </summary>
    public static readonly DependencyProperty HeaderPaddingProperty = DependencyObjectProxy.RegisterProperty<Thickness>(nameof(HeaderPadding), (c, e, p) => c.HeaderPadding = e.NewValue);

    /// <summary>
    /// The dependency property of header margin.
    /// </summary>
    public static readonly DependencyProperty HeaderMarginProperty = DependencyObjectProxy.RegisterProperty<Thickness>(nameof(HeaderMargin), (c, e, p) => c.HeaderMargin = e.NewValue);

    /// <summary>
    /// The dependency property of header border thickness.
    /// </summary>
    public static readonly DependencyProperty HeaderBorderThicknessProperty = DependencyObjectProxy.RegisterProperty<Thickness>(nameof(HeaderBorderThickness), (c, e, p) => c.HeaderBorderThickness = e.NewValue);

    /// <summary>
    /// The dependency property of header border brush.
    /// </summary>
    public static readonly DependencyProperty HeaderBorderBrushProperty = DependencyObjectProxy.RegisterProperty<Brush>(nameof(HeaderBorderBrush), (c, e, p) => c.HeaderBorderBrush = e.NewValue);

    /// <summary>
    /// The dependency property of header corner radius.
    /// </summary>
    public static readonly DependencyProperty HeaderCornerRadiusProperty = DependencyObjectProxy.RegisterProperty<CornerRadius>(nameof(HeaderCornerRadius), (c, e, p) => c.HeaderCornerRadius = e.NewValue);

    /// <summary>
    /// The dependency property of header left margin.
    /// </summary>
    public static readonly DependencyProperty HeaderLeftMarginProperty = DependencyObjectProxy.RegisterProperty<Thickness>(nameof(HeaderLeftMargin), (c, e, p) => c.HeaderLeftMargin = e.NewValue);

    /// <summary>
    /// The dependency property of header right margin.
    /// </summary>
    public static readonly DependencyProperty HeaderRightMarginProperty = DependencyObjectProxy.RegisterProperty<Thickness>(nameof(HeaderRightMargin), (c, e, p) => c.HeaderRightMargin = e.NewValue);

    /// <summary>
    /// The dependency property of title.
    /// </summary>
    public static readonly DependencyProperty TitleProperty = DependencyObjectProxy.RegisterProperty<string>(nameof(Title), (c, e, p) => c.Title = e.NewValue);

    /// <summary>
    /// The dependency property of title font size.
    /// </summary>
    public static readonly DependencyProperty TitleFontSizeProperty = DependencyObjectProxy.RegisterDoubleProperty(nameof(TitleFontSize), (c, e, p) => c.TitleFontSize = e.NewValue, 18);

    /// <summary>
    /// The dependency property of title font weight.
    /// </summary>
    public static readonly DependencyProperty TitleFontWeightProperty = DependencyObjectProxy.RegisterFontWeightProperty(nameof(TitleFontWeight), (c, e, p) => c.TitleFontWeight = e.NewValue);

    /// <summary>
    /// The dependency property of title font style.
    /// </summary>
    public static readonly DependencyProperty TitleFontStyleProperty = DependencyObjectProxy.RegisterProperty<FontStyle>(nameof(TitleFontStyle), (c, e, p) => c.TitleFontStyle = e.NewValue);

    /// <summary>
    /// The dependency property of title line height.
    /// </summary>
    public static readonly DependencyProperty TitleLineHeightProperty = DependencyObjectProxy.RegisterDoubleProperty(nameof(TitleLineHeight), (c, e, p) => c.TitleLineHeight = e.NewValue);

    /// <summary>
    /// The dependency property of title foreground.
    /// </summary>
    public static readonly DependencyProperty TitleForegroundProperty = DependencyObjectProxy.RegisterProperty<Brush>(nameof(TitleForeground), (c, e, p) => c.TitleForeground = e.NewValue);

    /// <summary>
    /// The dependency property of icon stretch.
    /// </summary>
    public static readonly DependencyProperty IconStretchProperty = DependencyObjectProxy.RegisterProperty<Stretch>(nameof(IconStretch), (c, e, p) => c.IconStretch = e.NewValue);

    /// <summary>
    /// The dependency property of icon URI.
    /// </summary>
    public static readonly DependencyProperty IconUriProperty = DependencyObjectProxy.RegisterProperty<Uri>(nameof(IconUri), (c, e, p) => c.IconUri = e.NewValue);

    /// <summary>
    /// The dependency property of icon width.
    /// </summary>
    public static readonly DependencyProperty IconWidthProperty = DependencyObjectProxy.RegisterDoubleProperty(nameof(IconWidth), (c, e, p) => c.IconWidth = e.NewValue);

    /// <summary>
    /// The dependency property of icon height.
    /// </summary>
    public static readonly DependencyProperty IconHeightProperty = DependencyObjectProxy.RegisterDoubleProperty(nameof(IconHeight), (c, e, p) => c.IconHeight = e.NewValue);

    /// <summary>
    /// The dependency property of icon margin.
    /// </summary>
    public static readonly DependencyProperty IconMarginProperty = DependencyObjectProxy.RegisterProperty<Thickness>(nameof(IconMargin), (c, e, p) => c.IconMargin = e.NewValue);

    /// <summary>
    /// The dependency property of icon corner radius.
    /// </summary>
    public static readonly DependencyProperty IconCornerRadiusProperty = DependencyObjectProxy.RegisterProperty<CornerRadius>(nameof(IconCornerRadius), (c, e, p) => c.IconCornerRadius = e.NewValue);

    /// <summary>
    /// The dependency property of the item space in list.
    /// </summary>
    public static readonly DependencyProperty ListItemSpacingProperty = DependencyObjectProxy.RegisterProperty(nameof(ListItemSpacing), 0d);

    /// <summary>
    /// Initializes a new instance of the TileListView class.
    /// </summary>
    public TileListView()
    {
        InitializeComponent();
    }

    /// <summary>
    /// Occurs when the currently selected item changes.
    /// </summary>
    public event SelectionChangedEventHandler SelectionChanged;

    /// <summary>
    /// Gets the children.
    /// </summary>
    public ItemCollection Items => ListPanel.Items;

    /// <summary>
    /// Gets or sets the style of tile item.
    /// </summary>
    public Style ItemStyle
    {
        get => (Style)GetValue(ItemStyleProperty);
        set => SetValue(ItemStyleProperty, value);
    }

    /// <summary>
    /// Gets or sets the style of internal list view.
    /// </summary>
    public Style ItemContainerStyle
    {
        get => ListPanel.ItemContainerStyle;
        set => ListPanel.ItemContainerStyle = value;
    }

    /// <summary>
    /// Gets or sets the selection mode.
    /// </summary>
    public ListViewSelectionMode SelectionMode
    {
        get => (ListViewSelectionMode)GetValue(SelectionModeProperty);
        set => SetValue(SelectionModeProperty, value);
    }

    /// <summary>
    /// Gets or sets the selected index.
    /// </summary>
    public int SelectedIndex
    {
        get => ListPanel.SelectedIndex;
        set => ListPanel.SelectedIndex = value;
    }

    /// <summary>
    /// Gets or sets the selected item.
    /// </summary>
    public TileItem SelectedItem
    {
        get => ListPanel.SelectedItem as TileItem;
        set => ListPanel.SelectedItem = value;
    }

    /// <summary>
    /// Gets or sets the template of internal list view.
    /// </summary>
    public ControlTemplate ListViewDataTemplate
    {
        get => ListPanel.Template;
        set => ListPanel.Template = value;
    }

    /// <summary>
    /// Gets or sets the font size of header.
    /// </summary>
    public double HeaderFontSize
    {
        get => HeaderElement.FontSize;
        set => HeaderElement.FontSize = value;
    }

    /// <summary>
    /// Gets or sets the font weight of header.
    /// </summary>
    public FontWeight HeaderFontWeight
    {
        get => HeaderElement.FontWeight;
        set => HeaderElement.FontWeight = value;
    }

    /// <summary>
    /// Gets or sets the font style of header.
    /// </summary>
    public FontStyle HeaderFontStyle
    {
        get => HeaderElement.FontStyle;
        set => HeaderElement.FontStyle = value;
    }

    /// <summary>
    /// Gets or sets the height of header.
    /// </summary>
    public double HeaderHeight
    {
        get => HeaderElement.Height;
        set => HeaderElement.Height = value;
    }

    /// <summary>
    /// Gets or sets the foreground of header.
    /// </summary>
    public Brush HeaderForeground
    {
        get => HeaderElement.Foreground;
        set => HeaderElement.Foreground = value;
    }

    /// <summary>
    /// Gets or sets the background of header.
    /// </summary>
    public Brush HeaderBackground
    {
        get => HeaderElement.Background;
        set => HeaderElement.Background = value;
    }

    /// <summary>
    /// Gets or sets the background sizing of header.
    /// </summary>
    public BackgroundSizing HeaderBackgroundSizing
    {
        get => HeaderElement.BackgroundSizing;
        set => HeaderElement.BackgroundSizing = value;
    }

    /// <summary>
    /// Gets or sets the padding of header.
    /// </summary>
    public Thickness HeaderPadding
    {
        get => HeaderElement.Padding;
        set => HeaderElement.Padding = value;
    }

    /// <summary>
    /// Gets or sets the margin of header.
    /// </summary>
    public Thickness HeaderMargin
    {
        get => HeaderElement.Margin;
        set => HeaderElement.Margin = value;
    }

    /// <summary>
    /// Gets or sets the border thickness of header.
    /// </summary>
    public Thickness HeaderBorderThickness
    {
        get => HeaderElement.BorderThickness;
        set => HeaderElement.BorderThickness = value;
    }

    /// <summary>
    /// Gets or sets the border brush of header.
    /// </summary>
    public Brush HeaderBorderBrush
    {
        get => HeaderElement.BorderBrush;
        set => HeaderElement.BorderBrush = value;
    }

    /// <summary>
    /// Gets or sets the corner radius of header.
    /// </summary>
    public CornerRadius HeaderCornerRadius
    {
        get => HeaderElement.CornerRadius;
        set => HeaderElement.CornerRadius = value;
    }

    /// <summary>
    /// Gets or sets the margin of header left zone.
    /// </summary>
    public Thickness HeaderLeftMargin
    {
        get => HeaderElement.LeftMargin;
        set => HeaderElement.LeftMargin = value;
    }

    /// <summary>
    /// Gets or sets the margin of header right zone.
    /// </summary>
    public Thickness HeaderRightMargin
    {
        get => HeaderElement.RightMargin;
        set => HeaderElement.RightMargin = value;
    }

    /// <summary>
    /// Gets or sets the title.
    /// </summary>
    public string Title
    {
        get => HeaderElement.Title;
        set => HeaderElement.Title = value;
    }

    /// <summary>
    /// Gets or sets the font size of title.
    /// </summary>
    public double TitleFontSize
    {
        get => HeaderElement.TitleFontSize;
        set => HeaderElement.TitleFontSize = value;
    }

    /// <summary>
    /// Gets or sets the font weight of title.
    /// </summary>
    public FontWeight TitleFontWeight
    {
        get => HeaderElement.TitleFontWeight;
        set => HeaderElement.TitleFontWeight = value;
    }

    /// <summary>
    /// Gets or sets the font style of title.
    /// </summary>
    public FontStyle TitleFontStyle
    {
        get => HeaderElement.TitleFontStyle;
        set => HeaderElement.TitleFontStyle = value;
    }

    /// <summary>
    /// Gets or sets the line height of title.
    /// </summary>
    public double TitleLineHeight
    {
        get => HeaderElement.TitleLineHeight;
        set => HeaderElement.TitleLineHeight = value;
    }

    /// <summary>
    /// Gets or sets the foreground of title.
    /// </summary>
    public Brush TitleForeground
    {
        get => HeaderElement.TitleForeground;
        set => HeaderElement.TitleForeground = value;
    }

    /// <summary>
    /// Gets or sets the icon URI.
    /// </summary>
    public Uri IconUri
    {
        get => HeaderElement.IconUri;
        set => HeaderElement.IconUri = value;
    }

    /// <summary>
    /// Gets or sets the stretch of icon.
    /// </summary>
    public Stretch IconStretch
    {
        get => HeaderElement.IconStretch;
        set => HeaderElement.IconStretch = value;
    }

    /// <summary>
    /// Gets or sets the width of icon.
    /// </summary>
    public double IconWidth
    {
        get => HeaderElement.IconWidth;
        set => HeaderElement.IconWidth = value;
    }

    /// <summary>
    /// Gets or sets the height of icon.
    /// </summary>
    public double IconHeight
    {
        get => HeaderElement.IconHeight;
        set => HeaderElement.IconHeight = value;
    }

    /// <summary>
    /// Gets or sets the height of icon.
    /// </summary>
    public double ListItemSpacing
    {
        get => (double)GetValue(ListItemSpacingProperty);
        set => SetValue(ListItemSpacingProperty, value);
    }

    /// <summary>
    /// Gets or sets the margin of icon.
    /// </summary>
    public Thickness IconMargin
    {
        get => HeaderElement.IconMargin;
        set => HeaderElement.IconMargin = value;
    }

    /// <summary>
    /// Gets or sets the corner radius of icon.
    /// </summary>
    public CornerRadius IconCornerRadius
    {
        get => HeaderElement.IconCornerRadius;
        set => HeaderElement.IconCornerRadius = value;
    }

    /// <summary>
    /// Gets or sets the content of top customized zone.
    /// </summary>
    public UIElement TopContent
    {
        get => Top.Child;
        set => Top.Child = value;
    }

    /// <summary>
    /// Gets or sets the content of middle customized zone.
    /// </summary>
    public UIElement MiddleContent
    {
        get => Middle.Child;
        set => Middle.Child = value;
    }

    /// <summary>
    /// Gets or sets the content of bottom customized zone.
    /// </summary>
    public UIElement BottomContent
    {
        get => Bottom.Child;
        set => Bottom.Child = value;
    }

    /// <summary>
    /// Gets or sets the content of header cover zone.
    /// </summary>
    public UIElement HeaderCoverContent
    {
        get => HeaderElement.CoverContent;
        set => HeaderElement.CoverContent = value;
    }

    /// <summary>
    /// Gets or sets the content of header background zone.
    /// </summary>
    public UIElement HeaderBackgroundContent
    {
        get => HeaderElement.BackgroundContent;
        set => HeaderElement.BackgroundContent = value;
    }

    /// <summary>
    /// Gets or sets the content of customized zone before title in header.
    /// </summary>
    public UIElement BeforeTitleContent
    {
        get => HeaderElement.BeforeContent;
        set => HeaderElement.BeforeContent = value;
    }

    /// <summary>
    /// Gets or sets the content of customized zone after title in header.
    /// </summary>
    public UIElement AfterTitleContent
    {
        get => HeaderElement.AfterContent;
        set => HeaderElement.AfterContent = value;
    }

    /// <summary>
    /// Gets or sets the children of customized zone in header right side.
    /// </summary>
    public UIElementCollection TitleRightSideChildren => HeaderElement.RightChildren;

    /// <summary>
    /// Adds a new tile item.
    /// </summary>
    /// <returns>The tile item created to add.</returns>
    public TileItem AddItem()
    {
        var item = new TileItem
        {
            Style = ItemStyle
        };
        ListPanel.Items.Add(item);
        return item;
    }

    /// <summary>
    /// Adds a new tile item.
    /// </summary>
    /// <param name="fillProperties">The callback to fill properties.</param>
    /// <returns>The tile item created to add.</returns>
    public TileItem AddItem(Action<TileItem> fillProperties)
    {
        var item = new TileItem
        {
            Style = ItemStyle
        };
        fillProperties?.Invoke(item);
        ListPanel.Items.Add(item);
        return item;
    }

    /// <summary>
    /// Adds a new tile item.
    /// </summary>
    /// <param name="model">The model.</param>
    /// <param name="click">The event handler on item click.</param>
    /// <returns>The tile item created to add.</returns>
    public TileItem AddItem(BaseItemModel model, RoutedEventHandler click = null)
    {
        var item = model == null ? new TileItem() : TileItem.Create(model);
        if (click != null) item.Click += click;
        item.Style = ItemStyle;
        ListPanel.Items.Add(item);
        return item;
    }

    /// <summary>
    /// Adds a new tile item.
    /// </summary>
    /// <param name="title">The title.</param>
    /// <param name="image">The image URI.</param>
    /// <param name="description">The description</param>
    /// <param name="click">The event handler on item click.</param>
    /// <returns>The tile item created to add.</returns>
    public TileItem AddItem(string title, Uri image, string description = null, RoutedEventHandler click = null)
    {
        var item = new TileItem
        {
            Title = title,
            ImageUri = image,
            Description = description,
            DataContext = new BaseItemModel
            {
                Name = title,
                ImageUri = image,
                Description = description
            }
        };
        if (click != null) item.Click += click;
        item.Style = ItemStyle;
        ListPanel.Items.Add(item);
        return item;
    }

    /// <summary>
    /// Adds a new tile item.
    /// </summary>
    /// <param name="title">The title.</param>
    /// <param name="image">The image URI.</param>
    /// <param name="imagePrepareOnly">true if the image URI is only for preparing to set but not take effect immediately; otherwise, false.</param>
    /// <param name="description">The description</param>
    /// <param name="click">The event handler on item click.</param>
    /// <returns>The tile item created to add.</returns>
    public TileItem AddItem(string title, Uri image, bool imagePrepareOnly, string description = null, RoutedEventHandler click = null)
    {
        var item = new TileItem
        {
            Title = title,
            Description = description,
            DataContext = new BaseItemModel
            {
                Name = title,
                ImageUri = image,
                Description = description
            }
        };
        if (click != null) item.Click += click;
        item.Style = ItemStyle;
        item.SetImage(image, imagePrepareOnly);
        ListPanel.Items.Add(item);
        return item;
    }

    /// <summary>
    /// Lists all tile items.
    /// </summary>
    /// <returns>A collection of tile items.</returns>
    public IEnumerable<TileItem> GetAllTiles()
    {
        foreach (var item in ListPanel.Items)
        {
            if (item is TileItem t) yield return t;
        }
    }

    /// <summary>
    /// Uses prepare image URI if available.
    /// </summary>
    public void UsePrepareImageUri()
    {
        foreach (var item in ListPanel.Items)
        {
            if (item is TileItem t) t.UseImageUriPrepared();
        }
    }

    /// <summary>
    /// Scrolls the list to bring the specified item into view.
    /// </summary>
    /// <param name="item">The item to scroll into view.</param>
    /// <param name="aligment">The alignment.</param>
    public void ScrollIntoView(TileItem item, ScrollIntoViewAlignment aligment = ScrollIntoViewAlignment.Default)
        => ListPanel.ScrollIntoView(item, aligment);

    private static void OnItemStyleChanged(TileListView c, ChangeEventArgs<Style> e, DependencyProperty p)
    {
        foreach (var item in c.ListPanel.Items)
        {
            if (item is not TileItem ti) continue;
            ti.Style = e.NewValue;
        }
    }

    /// <summary>
    /// Occurs on container content changing.
    /// </summary>
    /// <param name="sender">The sender.</param>
    /// <param name="args">The event arguments.</param>
    public static void OnContainerContentChanging(object sender, ContainerContentChangingEventArgs args)
    {
        if (args?.Item is TileListView c) c.UsePrepareImageUri();
    }

    private void ListPanel_SelectionChanged(object sender, SelectionChangedEventArgs e)
        => SelectionChanged?.Invoke(this, e);
}