Merge pull request #253 from w-ahmad/feat/conditional_styling

feat: Implemented Conditional Cell Styling

Author: w-ahmad

src/Collections/DependencyObjectCollection.cs

@@ -0,0 +1,114 @@
+#if WINDOWS
+using Microsoft.UI.Xaml;
+using Microsoft.UI.Xaml.Markup;
+using System;
+using System.Collections.Generic;
+using System.ComponentModel;
+using Windows.Foundation.Collections;
+
+namespace WinUI.TableView.Collections;
+
+/// <summary>
+/// Provides a strongly-typed wrapper around <see cref="DependencyObjectCollection"/>
+/// for collections containing <typeparamref name="T"/> items.
+/// </summary>
+/// <typeparam name="T">The type of items in the collection.</typeparam>
+[ContentProperty(Name = nameof(Items))]
+[EditorBrowsable(EditorBrowsableState.Never)]
+public partial class DependencyObjectCollection<T> : DependencyObjectCollection, IList<T> where T : DependencyObject
+{
+    /// <summary>
+    /// Initializes a new instance of the <see cref="DependencyObjectCollection{T}"/> class.
+    /// </summary>
+    public DependencyObjectCollection()
+    {
+        VectorChanged += OnVectorChanged;
+    }
+
+    /// <summary>
+    /// Handles changes to the underlying vector of <see cref="DependencyObject"/> items.
+    /// </summary>
+    private void OnVectorChanged(IObservableVector<DependencyObject> sender, IVectorChangedEventArgs args)
+    {
+        if (args.CollectionChange is CollectionChange.ItemInserted)
+        {
+            if (this[(int)args.Index] is not T)
+            {
+                throw new InvalidOperationException($"Only items of type {typeof(T).FullName} can be added to this collection.");
+            }
+        }
+    }
+
+    /// <summary>
+    /// Gets an <see cref="IList{T}"/> view over this collection.
+    /// This provides strongly-typed access to the underlying items.
+    /// </summary>
+    public IList<T> Items => this;
+
+    T IList<T>.this[int index]
+    {
+        get => (T)base[index];
+        set => base[index] = value;
+    }
+
+    int ICollection<T>.Count => Count;
+
+    bool ICollection<T>.IsReadOnly => IsReadOnly;
+
+    void ICollection<T>.Add(T item)
+    {
+        Add(item);
+    }
+
+    void ICollection<T>.Clear()
+    {
+        Clear();
+    }
+
+    bool ICollection<T>.Contains(T item)
+    {
+        return Contains(item);
+    }
+
+    void ICollection<T>.CopyTo(T[] array, int arrayIndex)
+    {
+        CopyTo(array as DependencyObject[], arrayIndex);
+    }
+
+    IEnumerator<T> IEnumerable<T>.GetEnumerator()
+    {
+        foreach (var item in this)
+        {
+            yield return (T)item;
+        }
+    }
+
+    int IList<T>.IndexOf(T item)
+    {
+        return IndexOf(item);
+    }
+
+    void IList<T>.Insert(int index, T item)
+    {
+        Insert(index, item);
+    }
+
+    bool ICollection<T>.Remove(T item)
+    {
+        var index = IndexOf(item);
+
+        if (index >= 0)
+        {
+            RemoveAt(index);
+            return true;
+        }
+
+        return false;
+    }
+
+    void IList<T>.RemoveAt(int index)
+    {
+        RemoveAt(index);
+    }
+}
+#endif

src/Columns/TableViewColumn.cs

@@ -1,6 +1,7 @@
 using Microsoft.UI.Xaml;
 using Microsoft.UI.Xaml.Data;
 using System;
+using System.Collections.Generic;
 using WinUI.TableView.Extensions;
 using SD = WinUI.TableView.SortDirection;
 
@@ -20,6 +21,14 @@ public abstract partial class TableViewColumn : DependencyObject
     private bool _isFrozen;
     private Func<object, object?>? _funcCompiledPropertyPath;
 
+    /// <summary>
+    /// Initializes a new instance of the <see cref="TableViewColumn"/> class with default conditional cell styles.
+    /// </summary>
+    public TableViewColumn()
+    {
+        SetValue(ConditionalCellStylesProperty, new TableViewConditionalCellStylesCollection());
+    }
+
     /// <summary>
     /// Generates a display element for the cell.
     /// </summary>
@@ -277,6 +286,15 @@ public bool CanReorder
         set => SetValue(CanReorderProperty, value);
     }
 
+    /// <summary>
+    /// Gets or sets the collection of conditional cell styles for the column.
+    /// </summary>
+    public IList<TableViewConditionalCellStyle> ConditionalCellStyles
+    {
+        get => (IList<TableViewConditionalCellStyle>)GetValue(ConditionalCellStylesProperty);
+        set => SetValue(ConditionalCellStylesProperty, value);
+    }
+
     internal TableViewColumnsCollection? OwningCollection { get; set; }
 
     /// <summary>
@@ -511,4 +529,9 @@ private static void OnHeaderStyleChanged(DependencyObject d, DependencyPropertyC
     /// Identifies the CanReorder dependency property.
     /// </summary>
     public static readonly DependencyProperty CanReorderProperty = DependencyProperty.Register(nameof(CanReorder), typeof(bool), typeof(TableViewColumn), new PropertyMetadata(true));
+
+    /// <summary>
+    /// Identifies the <see cref="ConditionalCellStyles"/> dependency property.
+    /// </summary>
+    public static readonly DependencyProperty ConditionalCellStylesProperty = DependencyProperty.Register(nameof(ConditionalCellStyles), typeof(IList<TableViewConditionalCellStyle>), typeof(TableViewColumn), new PropertyMetadata(default));
 }

src/ItemsSource/CollectionView.Events.cs

@@ -83,4 +83,9 @@ private void OnPropertyChanged([CallerMemberName] string propertyName = null!)
     /// Occurs when a property value changes.
     /// </summary>
     public event PropertyChangedEventHandler? PropertyChanged;
+
+    /// <summary>
+    /// Occurs when an item's property value changes.
+    /// </summary>
+    public event PropertyChangedEventHandler? ItemPropertyChanged;
 }

src/ItemsSource/CollectionView.cs

@@ -141,6 +141,8 @@ private void OnSourceCollectionChanged(object? arg1, NotifyCollectionChangedEven
     /// </summary>
     private void OnItemPropertyChanged(object? item, PropertyChangedEventArgs e)
     {
+        ItemPropertyChanged?.Invoke(item, e);
+
         if (!AllowLiveShaping || item is null || string.IsNullOrEmpty(e.PropertyName))
         {
             return;

src/TableView.Properties.cs

@@ -254,6 +254,12 @@ public partial class TableView
     /// Identifies the CanReorderColumns dependency property.
     /// </summary>
     public static readonly DependencyProperty CanReorderColumnsProperty = DependencyProperty.Register(nameof(CanReorderColumns), typeof(bool), typeof(TableView), new PropertyMetadata(true));
+
+    /// <summary>
+    /// Identifies the <see cref="ConditionalCellStyles"/> dependency property.
+    /// </summary>
+    public static readonly DependencyProperty ConditionalCellStylesProperty = DependencyProperty.Register(nameof(ConditionalCellStyles), typeof(IList<TableViewConditionalCellStyle>), typeof(TableView), new PropertyMetadata(default));
+
     /// <summary>
     /// Gets or sets a value indicating whether opening the column filter over header right-click is enabled.
     /// </summary>
@@ -301,6 +307,15 @@ public TableViewCellSlot? CurrentCellSlot
         set => SetValue(CurrentCellSlotProperty, value);
     }
 
+    /// <summary>
+    /// Gets or sets the collection of conditional cell styles.
+    /// </summary>
+    public IList<TableViewConditionalCellStyle> ConditionalCellStyles
+    {
+        get => (IList<TableViewConditionalCellStyle>)GetValue(ConditionalCellStylesProperty);
+        set => SetValue(ConditionalCellStylesProperty, value);
+    }
+
     /// <summary>
     /// Gets or sets the selection start cell slot.
     /// </summary>

src/TableView.cs

@@ -1,5 +1,4 @@
 using CommunityToolkit.WinUI;
-using Microsoft.UI;
 using Microsoft.UI.Xaml;
 using Microsoft.UI.Xaml.Controls;
 using Microsoft.UI.Xaml.Controls.Primitives;
@@ -8,6 +7,7 @@
 using System;
 using System.Collections;
 using System.Collections.Generic;
+using System.ComponentModel;
 using System.ComponentModel.DataAnnotations;
 using System.IO;
 using System.Linq;
@@ -19,7 +19,6 @@
 using Windows.Storage;
 using Windows.Storage.Pickers;
 using Windows.System;
-using WinRT.Interop;
 using WinUI.TableView.Extensions;
 using WinUI.TableView.Helpers;
 
@@ -49,12 +48,17 @@ public TableView()
 
         Columns = new TableViewColumnsCollection(this);
         FilterHandler = new ColumnFilterHandler(this);
+
         base.ItemsSource = _collectionView;
         base.SelectionMode = SelectionMode;
+
+        SetValue(ConditionalCellStylesProperty, new TableViewConditionalCellStylesCollection());
         RegisterPropertyChangedCallback(ItemsControl.ItemsSourceProperty, OnBaseItemsSourceChanged);
         RegisterPropertyChangedCallback(ListViewBase.SelectionModeProperty, OnBaseSelectionModeChanged);
+
         Loaded += OnLoaded;
         SelectionChanged += TableView_SelectionChanged;
+        _collectionView.ItemPropertyChanged += OnItemPropertyChanged;
     }
 
     /// <summary>
@@ -84,6 +88,16 @@ private void TableView_SelectionChanged(object sender, SelectionChangedEventArgs
         }
     }
 
+    /// <summary>
+    /// Handles the PropertyChanged event of an item in the TableView.
+    /// </summary>
+    private void OnItemPropertyChanged(object? sender, PropertyChangedEventArgs e)
+    {
+        var row = ContainerFromItem(sender) as TableViewRow;
+
+        row?.EnsureCellsStyle(default, sender);
+    }
+
     /// <inheritdoc/>
     protected override void PrepareContainerForItemOverride(DependencyObject element, object item)
     {
@@ -93,6 +107,7 @@ protected override void PrepareContainerForItemOverride(DependencyObject element
         {
             if (element is TableViewRow row)
             {
+                row.EnsureCellsStyle(default, item);
                 row.ApplyCellsSelectionState();
 
                 if (CurrentCellSlot.HasValue)
@@ -739,8 +754,8 @@ private async Task<StorageFile> GetStorageFile()
         var savePicker = new FileSavePicker();
         savePicker.FileTypeChoices.Add("CSV (Comma delimited)", [".csv"]);
 #if WINDOWS
-        var hWnd = Win32Interop.GetWindowFromWindowId(XamlRoot.ContentIslandEnvironment.AppWindowId);
-        InitializeWithWindow.Initialize(savePicker, hWnd);
+        var hWnd = Microsoft.UI.Win32Interop.GetWindowFromWindowId(XamlRoot.ContentIslandEnvironment.AppWindowId);
+        WinRT.Interop.InitializeWithWindow.Initialize(savePicker, hWnd);
 #endif
 
         return await savePicker.PickSaveFileAsync();

src/TableViewCell.cs

@@ -6,10 +6,10 @@
 using Microsoft.UI.Xaml.Media;
 using Microsoft.UI.Xaml.Shapes;
 using System;
+using System.Collections.Generic;
 using System.Linq;
 using System.Threading.Tasks;
 using Windows.Foundation;
-using WinUI.TableView.Extensions;
 using WinUI.TableView.Helpers;
 
 namespace WinUI.TableView;
@@ -32,6 +32,7 @@ public partial class TableViewCell : ContentControl
     private Rectangle? _v_gridLine;
     private object? _uneditedValue;
     private RoutedEventArgs? _editingArgs;
+    private IList<TableViewConditionalCellStyle>? _cellStyles;
 
     /// <summary>
     /// Initializes a new instance of the TableViewCell class.
@@ -84,6 +85,7 @@ protected override void OnApplyTemplate()
         _v_gridLine = GetTemplateChild("VerticalGridLine") as Rectangle;
 
         EnsureGridLines();
+        EnsureStyle(Row?.Content);
     }
 
     /// <inheritdoc/>
@@ -111,7 +113,7 @@ protected override Size MeasureOverride(Size availableSize)
             if (Column is TableViewTemplateColumn)
             {
 #if WINDOWS
-                if (element is ContentControl { ContentTemplateRoot: FrameworkElement root }) 
+                if (element is ContentControl { ContentTemplateRoot: FrameworkElement root })
 #else
                 if (element.FindDescendant<ContentPresenter>() is { ContentTemplateRoot: FrameworkElement root })
 #endif
@@ -368,7 +370,6 @@ internal async Task<bool> BeginCellEditing(RoutedEventArgs editingArgs)
         return false;
     }
 
-
     /// <summary>
     /// Prepares the cell for editing.
     /// </summary>
@@ -531,6 +532,20 @@ internal void EnsureGridLines()
         }
     }
 
+    /// <summary>
+    /// Ensures the correct style is applied to the cell.
+    /// </summary>
+    /// <param name="item">The data item associated with the cell.</param>
+    internal void EnsureStyle(object? item)
+    {
+        _cellStyles ??= [
+            .. Column?.ConditionalCellStyles ?? [], // Column styles have first priority
+            .. TableView?.ConditionalCellStyles ?? []]; // TableView styles have second priority
+
+        Style = _cellStyles.FirstOrDefault(c => c.Predicate?.Invoke(new(Column!, item)) is true)?
+                          .Style ?? Column?.CellStyle ?? TableView?.CellStyle;
+    }
+
     /// <summary>
     /// Gets a value indicating whether the cell is read-only.
     /// </summary>