ShrlAlgoToolkit/NeuWPF/NeoUI/Controls/Alert.xaml.cs

using System.Windows.Controls.Primitives;
using System.Windows.Markup;

namespace NeoUI.Controls;

/// <summary>
/// Alert component for feedback.
/// </summary>
[ContentProperty("Message")]
[TemplatePart(Name = PART_Close, Type = typeof(ButtonBase))]
public class Alert : Control
{
    #region Fields

    private const string PART_Close = "PART_Close";

    private ButtonBase? close;

    #endregion

    #region Events

    /// <summary>
    /// 当警告框即将关闭时触发的事件。
    /// </summary>
    public static readonly RoutedEvent ClosingEvent =
        EventManager.RegisterRoutedEvent("Closing", RoutingStrategy.Bubble, typeof(RoutedEventHandler), typeof(Alert));

    /// <summary>
    /// Occurs when closing the tag.
    /// </summary>
    public event RoutedEventHandler Closing
    {
        add => AddHandler(ClosingEvent, value);
        remove => RemoveHandler(ClosingEvent, value);
    }

    public static readonly RoutedEvent ClosedEvent =
        EventManager.RegisterRoutedEvent("Closed", RoutingStrategy.Bubble, typeof(RoutedEventHandler), typeof(Alert));

    /// <summary>
    /// Occurs when a Tag is closed and is no longer visible.
    /// </summary>
    public event RoutedEventHandler Closed
    {
        add => AddHandler(ClosedEvent, value);
        remove => RemoveHandler(ClosedEvent, value);
    }

    #endregion

    #region Properties

    /// <summary>
    /// 表示警报控件是否显示为横幅样式。
    /// </summary>
    public static readonly DependencyProperty BannerProperty =
        DependencyProperty.Register(nameof(Banner), typeof(bool), typeof(Alert), new PropertyMetadata(false));

    /// <summary>
    /// Gets/sets whether to show as banner.
    /// </summary>
    public bool Banner
    {
        get => (bool)GetValue(BannerProperty);
        set => SetValue(BannerProperty, value);
    }

    /// <summary>
    /// 表示警报是否可以关闭的依赖属性。
    /// 该属性允许设置或获取一个布尔值，用于控制警报组件是否显示关闭按钮。
    /// </summary>
    public static readonly DependencyProperty ClosableProperty =
        DependencyProperty.Register(nameof(Closable), typeof(bool?), typeof(Alert), new PropertyMetadata(null, OnClosableChanged));

    /// <summary>
    /// Gets/sets whether alert can be closed.
    /// </summary>
    public bool? Closable
    {
        get => (bool?)GetValue(ClosableProperty);
        set => SetValue(ClosableProperty, value);
    }

    private static void OnClosableChanged(DependencyObject d, DependencyPropertyChangedEventArgs e)
    {
        (d as Alert)?.SetCloseButtonVisibility();
    }

    private void SetCloseButtonVisibility()
    {
        if (close == null) return;
        var visible = Closable ?? CloseText != null;
        close.Visibility = visible ? Visibility.Visible : Visibility.Collapsed;
    }

    /// <summary>
    /// 用于获取或设置关闭按钮的文本内容。
    /// </summary>
    public static readonly DependencyProperty CloseTextProperty =
        DependencyProperty.Register(nameof(CloseText), typeof(object), typeof(Alert), new PropertyMetadata(null, OnCloseTextChanged));

    /// <summary>
    /// Gets/sets close text to show.
    /// </summary>
    public object CloseText
    {
        get => GetValue(CloseTextProperty);
        set => SetValue(CloseTextProperty, value);
    }

    private static void OnCloseTextChanged(DependencyObject d, DependencyPropertyChangedEventArgs e)
    {
        (d as Alert)?.SetCloseButton();
    }

    private void SetCloseButton()
    {
        if (close != null)
        {
            close.Content = CloseText != null ? CloseText : new IconElement() { Symbol = Assets.MaterialSymbol.Close };
        }

        SetCloseButtonVisibility();
    }

    /// <summary>
    /// 用于获取或设置警报的描述内容。
    /// </summary>
    public static readonly DependencyProperty DescriptionProperty =
        DependencyProperty.Register(nameof(Description), typeof(object), typeof(Alert), new PropertyMetadata(null));

    /// <summary>
    /// Gets/sets additional content of alert.
    /// </summary>
    public object Description
    {
        get => GetValue(DescriptionProperty);
        set => SetValue(DescriptionProperty, value);
    }

    /// <summary>
    /// 用于获取或设置警报图标名称的依赖属性。此属性允许自定义警报中显示的图标，通常用来表示警报的不同类型或状态。
    /// </summary>
    public static readonly DependencyProperty IconProperty =
        DependencyProperty.Register(nameof(Icon), typeof(string), typeof(Alert), new PropertyMetadata(string.Empty));

    /// <summary>
    /// 获取或设置警报的图标。
    /// </summary>
    public string Icon
    {
        get => (string)GetValue(IconProperty);
        set => SetValue(IconProperty, value);
    }

    /// <summary>
    /// 用于获取或设置警告控件中显示的消息内容。
    /// </summary>
    public static readonly DependencyProperty MessageProperty =
        DependencyProperty.Register(nameof(Message), typeof(object), typeof(Alert), new PropertyMetadata(null));

    /// <summary>
    /// Gets/sets content of alert.
    /// </summary>
    public object Message
    {
        get => GetValue(MessageProperty);
        set => SetValue(MessageProperty, value);
    }

    /// <summary>
    /// 用于控制是否显示图标的依赖属性。
    /// </summary>
    public static readonly DependencyProperty ShowIconProperty =
        DependencyProperty.Register(nameof(ShowIcon), typeof(bool), typeof(Alert), new PropertyMetadata(true));

    /// <summary>
    /// Gets/sets whether to show icon.
    /// </summary>
    public bool ShowIcon
    {
        get => (bool)GetValue(ShowIconProperty);
        set => SetValue(ShowIconProperty, value);
    }

    /// <summary>
    /// 获取或设置警报的外观类型。
    /// </summary>
    public static readonly DependencyProperty TypeProperty =
        DependencyProperty.Register(nameof(Type), typeof(AppearanceType), typeof(Alert), new PropertyMetadata(AppearanceType.Info));

    /// <summary>
    /// Gets/sets the type of alert.
    /// </summary>
    public AppearanceType Type
    {
        get => (AppearanceType)GetValue(TypeProperty);
        set => SetValue(TypeProperty, value);
    }

    /// <summary>
    /// 用于设置或获取图标颜色的画刷属性。
    /// </summary>
    public static readonly DependencyProperty IconBrushProperty =
        DependencyProperty.Register(nameof(IconBrush), typeof(Brush), typeof(Alert), new PropertyMetadata(null));

    /// <summary>
    /// Gets/sets the alert icon brush.
    /// </summary>
    public Brush IconBrush
    {
        get => (Brush)GetValue(IconBrushProperty);
        set => SetValue(IconBrushProperty, value);
    }

    #endregion

    #region Constructors

    static Alert()
    {
        DefaultStyleKeyProperty.OverrideMetadata(typeof(Alert), new FrameworkPropertyMetadata(typeof(Alert)));
    }

    #endregion

    #region Overrides

    /// <inheritdoc />
    public override void OnApplyTemplate()
    {
        base.OnApplyTemplate();

        close = GetTemplateChild(PART_Close) as ButtonBase;

        if (close != null)
        {
            Loaded -= OnLoaded;
            Loaded += OnLoaded;

            close.Click -= OnRaiseClosingEvent;
            close.Click += OnRaiseClosingEvent;
        }

        SetCloseButton();
    }

    private void OnLoaded(object sender, RoutedEventArgs e)
    {
        Closing -= OnClosing;
        Closing += OnClosing;
    }

    private void OnRaiseClosingEvent(object sender, RoutedEventArgs e)
    {
        e.Handled = true;
        RaiseEvent(new RoutedEventArgs(ClosingEvent, this));
    }

    private void OnClosing(object sender, RoutedEventArgs e)
    {
        SetCurrentValue(VisibilityProperty, Visibility.Collapsed);
        RaiseEvent(new RoutedEventArgs(ClosedEvent, this));
    }

    #endregion
}