feat: add templatecolumn

src/DynamicTreeDataGrid/DynamicTreeDataGrid.csproj

@@ -16,8 +16,4 @@
       <PackageVersion Update="DynamicData" Version="8.4.1" />
     </ItemGroup>
 
-    <ItemGroup>
-      <Folder Include="Models\Columns\" />
-    </ItemGroup>
-
 </Project>

src/DynamicTreeDataGrid/Models/Columns/FilterableTemplateColumn.cs

@@ -0,0 +1,123 @@
+using System.ComponentModel;
+
+using Avalonia.Controls;
+using Avalonia.Controls.Models.TreeDataGrid;
+using Avalonia.Controls.Templates;
+
+namespace DynamicTreeDataGrid.Models.Columns;
+
+/// <summary>
+/// A column in an <see cref="ITreeDataGridSource"/> which displays its values using a data
+/// template.
+/// </summary>
+/// <typeparam name="TModel">The model type.</typeparam>
+/// <typeparam name="TValue">The column data type.</typeparam>
+public class FilterableTemplateColumn<TModel> : FilterableColumnBase<TModel>, ITextSearchableColumn<TModel> {
+    private readonly Func<Control, IDataTemplate> _getCellTemplate;
+    private readonly Func<Control, IDataTemplate>? _getEditingCellTemplate;
+    private IDataTemplate? _cellTemplate;
+    private IDataTemplate? _cellEditingTemplate;
+    private object? _cellTemplateResourceKey;
+    private object? _cellEditingTemplateResourceKey;
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="FilterableTemplateColumn{TModel}"/> class.
+    /// </summary>
+    /// <param name="header">The column header.</param>
+    /// <param name="cellTemplate">The template to use for the cell when <b>not editing the cell.</b></param>
+    /// <param name="cellEditingTemplate">The template to use for the cell when <b>we are editing the cell.</b></param>
+    /// <param name="width">The column width. If null defaults to <see cref="GridLength.Auto"/>.</param>
+    /// <param name="options">Additional column options.</param>
+    public FilterableTemplateColumn(object? header,
+                                    IDataTemplate cellTemplate,
+                                    IDataTemplate? cellEditingTemplate = null,
+                                    GridLength? width = null,
+                                    TemplateColumnOptions<TModel>? options = null) : base(header, width,
+        options ?? new()) {
+        _getCellTemplate = GetCellTemplate;
+        _cellTemplate = cellTemplate;
+        _cellEditingTemplate = cellEditingTemplate;
+        _getEditingCellTemplate = cellEditingTemplate is not null ? GetCellEditingTemplate : null;
+    }
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="FilterableTemplateColumn{TModel}"/> class.
+    /// </summary>
+    /// <param name="header">The column header.</param>
+    /// <param name="cellTemplateResourceKey">
+    /// The key of the template to use for the cell when <b>not editing the cell.</b>
+    /// </param>
+    /// <param name="cellEditingTemplateResourceKey">
+    /// The  key of the template to use for the cell when <b>we are editing the cell.</b>
+    /// </param>
+    /// <param name="width">The column width. If null defaults to <see cref="GridLength.Auto"/>.</param>
+    /// <param name="options">Additional column options.</param>
+    public FilterableTemplateColumn(object? header,
+                                    object cellTemplateResourceKey,
+                                    object? cellEditingTemplateResourceKey = null,
+                                    GridLength? width = null,
+                                    TemplateColumnOptions<TModel>? options = null) : base(header, width,
+        options ?? new()) {
+        _cellTemplateResourceKey = cellTemplateResourceKey ??
+            throw new ArgumentNullException(nameof(cellTemplateResourceKey));
+        _cellEditingTemplateResourceKey = cellEditingTemplateResourceKey;
+        _getCellTemplate = GetCellTemplate;
+        _getEditingCellTemplate = cellEditingTemplateResourceKey is not null ? GetCellEditingTemplate : null;
+    }
+
+    public new TemplateColumnOptions<TModel> Options => (TemplateColumnOptions<TModel>)base.Options;
+
+    bool ITextSearchableColumn<TModel>.IsTextSearchEnabled => Options.IsTextSearchEnabled;
+
+    /// <summary>
+    /// Gets the template to use to display the contents of a cell that is not in editing mode.
+    /// </summary>
+    public IDataTemplate GetCellTemplate(Control anchor) {
+        if (_cellTemplate is not null)
+            return _cellTemplate;
+
+        _cellTemplate = anchor.FindResource(_cellTemplateResourceKey!) as IDataTemplate;
+
+        if (_cellTemplate is null)
+            throw new KeyNotFoundException($"No data template resource with the key of '{_cellTemplateResourceKey}' " +
+                $"could be found for the template column '{Header}'.");
+
+        return _cellTemplate;
+    }
+
+    /// <summary>
+    /// Gets the template to use to display the contents of a cell that is in editing mode.
+    /// </summary>
+    public IDataTemplate GetCellEditingTemplate(Control anchor) {
+        if (_cellEditingTemplate is not null)
+            return _cellEditingTemplate;
+
+        _cellEditingTemplate = anchor.FindResource(_cellEditingTemplateResourceKey!) as IDataTemplate;
+
+        if (_cellEditingTemplate is null)
+            throw new KeyNotFoundException(
+                $"No data template resource with the key of '{_cellEditingTemplateResourceKey}' " +
+                "could be found for the template column '{Header}'.");
+
+        return _cellEditingTemplate;
+    }
+
+    /// <summary>
+    /// Creates a cell for this column on the specified row.
+    /// </summary>
+    /// <param name="row">The row.</param>
+    /// <returns>The cell.</returns>
+    public override ICell CreateCell(IRow<TModel> row) {
+        return new TemplateCell(row.Model, _getCellTemplate, _getEditingCellTemplate, Options);
+    }
+
+    public override Comparison<TModel?>? GetComparison(ListSortDirection direction) {
+        return direction switch {
+            ListSortDirection.Ascending  => Options.CompareAscending,
+            ListSortDirection.Descending => Options.CompareDescending,
+            _                            => null,
+        };
+    }
+
+    public string? SelectValue(TModel model) => Options.TextSearchValueSelector?.Invoke(model);
+}

src/DynamicTreeDataGrid/Models/FilterableTextColumn.cs → src/DynamicTreeDataGrid/Models/Columns/FilterableTextColumn.cs

@@ -4,13 +4,15 @@
 using Avalonia.Controls.Models.TreeDataGrid;
 using Avalonia.Experimental.Data;
 
-namespace DynamicTreeDataGrid.Models;
+namespace DynamicTreeDataGrid.Models.Columns;
 
+/// <summary>
+/// A column in an <see cref="ITreeDataGridSource"/> which displays its values as text.
+/// </summary>
+/// <typeparam name="TModel">The model type.</typeparam>
+/// <typeparam name="TValue">The column data type.</typeparam>
 public class FilterableTextColumn<TModel, TValue> : FilterableColumnBase<TModel, TValue>, ITextSearchableColumn<TModel>
     where TModel : class {
-    private ITextSearchableColumn<TModel> _textSearchableColumnImplementation;
-
-    // TODO: Look into using <inheritdoc>?
     /// <summary>
     /// Initializes a new instance of the <see cref="TextColumn{TModel, TValue}"/> class.
     /// </summary>
@@ -54,13 +56,9 @@ public FilterableTextColumn(object? header,
 
     bool ITextSearchableColumn<TModel>.IsTextSearchEnabled => Options?.IsTextSearchEnabled ?? false;
 
-    public override ICell CreateCell(IRow<TModel> row)
-    {
+    public override ICell CreateCell(IRow<TModel> row) {
         return new TextCell<TValue?>(CreateBindingExpression(row.Model), Binding.Write is null, Options);
     }
 
-    string? ITextSearchableColumn<TModel>.SelectValue(TModel model)
-    {
-        return ValueSelector(model)?.ToString();
-    }
+    public string? SelectValue(TModel model) { return ValueSelector(model)?.ToString(); }
 }

src/DynamicTreeDataGrid/Models/FilterableColumnBase`2cs.cs

@@ -8,12 +8,14 @@ namespace DynamicTreeDataGrid.Models;
 
 public abstract class FilterableColumnBase<TModel, TValue> : ColumnBase<TModel, TValue>, IFilterableColumn<TModel>
     where TModel : class {
+    /// <inheritdoc />
     protected FilterableColumnBase(object? header,
                                    Expression<Func<TModel, TValue?>> getter,
                                    Action<TModel, TValue?>? setter,
                                    GridLength? width,
                                    ColumnOptions<TModel> options) : base(header, getter, setter, width, options) { }
 
+    /// <inheritdoc />
     protected FilterableColumnBase(object? header,
                                    Func<TModel, TValue?> valueSelector,
                                    TypedBinding<TModel, TValue?> binding,