Add automation support

wieslawsoltes · Mar 29, 2024 · b0ec12c · b0ec12c
1 parent c45d58d
commit b0ec12c
Show file tree

Hide file tree

Showing 10 changed files with 237 additions and 0 deletions.
diff --git a/src/DataBox/Automation/Peers/DataBoxAutomationPeer.cs b/src/DataBox/Automation/Peers/DataBoxAutomationPeer.cs
@@ -0,0 +1,54 @@
+using Avalonia.Automation.Peers;
+using Avalonia.Automation.Provider;
+using Avalonia.Controls;
+
+namespace DataBox.Automation.Peers;
+
+public class DataBoxAutomationPeer : ControlAutomationPeer, IScrollProvider
+{
+    private bool _searchedForScrollable;
+    private IScrollProvider? _scroller;
+
+    public DataBoxAutomationPeer(DataBox owner)
+        : base(owner)
+    {
+    }
+
+    public new DataBox Owner => (DataBox)base.Owner;
+    public bool HorizontallyScrollable => _scroller?.HorizontallyScrollable ?? false;
+    public double HorizontalScrollPercent => _scroller?.HorizontalScrollPercent ?? -1;
+    public double HorizontalViewSize => _scroller?.HorizontalViewSize ?? 0;
+    public bool VerticallyScrollable => _scroller?.VerticallyScrollable ?? false;
+    public double VerticalScrollPercent => _scroller?.VerticalScrollPercent ?? -1;
+    public double VerticalViewSize => _scroller?.VerticalViewSize ?? 0;
+
+    protected virtual IScrollProvider? Scroller
+    {
+        get
+        {
+            if (!_searchedForScrollable)
+            {
+                if (Owner.RowsPresenter?.GetValue(ListBox.ScrollProperty) is Control scrollable)
+                    _scroller = GetOrCreate(scrollable).GetProvider<IScrollProvider>();
+                _searchedForScrollable = true;
+            }
+
+            return _scroller;
+        }
+    }
+
+    protected override AutomationControlType GetAutomationControlTypeCore()
+    {
+        return AutomationControlType.DataGrid;
+    }
+
+    public void Scroll(ScrollAmount horizontalAmount, ScrollAmount verticalAmount)
+    {
+        _scroller?.Scroll(horizontalAmount, verticalAmount);
+    }
+
+    public void SetScrollPercent(double horizontalPercent, double verticalPercent)
+    {
+        _scroller?.SetScrollPercent(horizontalPercent, verticalPercent);
+    }
+}
diff --git a/src/DataBox/Automation/Peers/DataBoxCellAutomationPeer.cs b/src/DataBox/Automation/Peers/DataBoxCellAutomationPeer.cs
@@ -0,0 +1,22 @@
+using Avalonia.Automation.Peers;
+
+namespace DataBox.Automation.Peers;
+
+public class DataBoxCellAutomationPeer : ContentControlAutomationPeer
+{
+    public DataBoxCellAutomationPeer(DataBoxCell owner)
+        : base(owner)
+    {
+    }
+
+    public new DataBoxCell Owner => (DataBoxCell)base.Owner;
+
+    protected override AutomationControlType GetAutomationControlTypeCore()
+    {
+        return AutomationControlType.Custom;
+    }
+
+    protected override bool IsContentElementCore() => true;
+
+    protected override bool IsControlElementCore() => true;
+}
diff --git a/src/DataBox/Automation/Peers/DataBoxColumnHeaderAutomationPeer.cs b/src/DataBox/Automation/Peers/DataBoxColumnHeaderAutomationPeer.cs
@@ -0,0 +1,22 @@
+using Avalonia.Automation.Peers;
+
+namespace DataBox.Automation.Peers;
+
+public class DataBoxColumnHeaderAutomationPeer : ContentControlAutomationPeer
+{
+    public DataBoxColumnHeaderAutomationPeer(DataBoxColumnHeader owner)
+        : base(owner)
+    {
+    }
+
+    public new DataBoxColumnHeader Owner => (DataBoxColumnHeader)base.Owner;
+
+    protected override AutomationControlType GetAutomationControlTypeCore()
+    {
+        return AutomationControlType.HeaderItem;
+    }
+
+    protected override bool IsContentElementCore() => false;
+
+    protected override bool IsControlElementCore() => true;
+}
diff --git a/src/DataBox/Automation/Peers/DataBoxColumnHeadersPresenterAutomationPeer.cs b/src/DataBox/Automation/Peers/DataBoxColumnHeadersPresenterAutomationPeer.cs
@@ -0,0 +1,23 @@
+using Avalonia.Automation.Peers;
+using DataBox.Primitives;
+
+namespace DataBox.Automation.Peers;
+
+public class DataBoxColumnHeadersPresenterAutomationPeer : ControlAutomationPeer
+{
+    public DataBoxColumnHeadersPresenterAutomationPeer(DataBoxColumnHeadersPresenter owner)
+        : base(owner)
+    {
+    }
+
+    public new DataBoxColumnHeadersPresenter Owner => (DataBoxColumnHeadersPresenter)base.Owner;
+
+    protected override AutomationControlType GetAutomationControlTypeCore()
+    {
+        return AutomationControlType.Header;
+    }
+
+    protected override bool IsContentElementCore() => false;
+
+    protected override bool IsControlElementCore() => true;
+}
diff --git a/src/DataBox/Automation/Peers/DataBoxRowAutomationPeer.cs b/src/DataBox/Automation/Peers/DataBoxRowAutomationPeer.cs
@@ -0,0 +1,81 @@
+using Avalonia.Automation.Peers;
+using Avalonia.Automation.Provider;
+using Avalonia.Controls;
+
+namespace DataBox.Automation.Peers;
+
+public class DataBoxRowAutomationPeer : ContentControlAutomationPeer,
+    ISelectionItemProvider
+{
+    public DataBoxRowAutomationPeer(ContentControl owner)
+        : base(owner)
+    {
+    }
+
+    public bool IsSelected => Owner.GetValue(ListBoxItem.IsSelectedProperty);
+
+    public ISelectionProvider? SelectionContainer
+    {
+        get
+        {
+            if (Owner.Parent is DataBox parent)
+            {
+                var parentPeer = GetOrCreate(parent);
+                return parentPeer.GetProvider<ISelectionProvider>();
+            }
+
+            return null;
+        }
+    }
+
+    public void Select()
+    {
+        EnsureEnabled();
+
+        if (Owner.Parent is DataBox parent && parent.RowsPresenter is not null)
+        {
+            var index = parent.RowsPresenter.IndexFromContainer(Owner);
+
+            if (index != -1)
+                parent.RowsPresenter.SelectedIndex = index;
+        }
+    }
+
+    void ISelectionItemProvider.AddToSelection()
+    {
+        EnsureEnabled();
+
+        if (Owner.Parent is DataBox parent 
+            && parent.RowsPresenter is not null
+            && parent.RowsPresenter.GetValue(ListBox.SelectionProperty) is { } selectionModel)
+        {
+            var index = parent.RowsPresenter.IndexFromContainer(Owner);
+
+            if (index != -1)
+                selectionModel.Select(index);
+        }
+    }
+
+    void ISelectionItemProvider.RemoveFromSelection()
+    {
+        EnsureEnabled();
+
+        if (Owner.Parent is DataBox parent
+            && parent.RowsPresenter is not null
+            && parent.GetValue(ListBox.SelectionProperty) is { } selectionModel)
+        {
+            var index = parent.RowsPresenter.IndexFromContainer(Owner);
+
+            if (index != -1)
+                selectionModel.Deselect(index);
+        }
+    }
+
+    protected override AutomationControlType GetAutomationControlTypeCore()
+    {
+        return AutomationControlType.DataItem;
+    }
+
+    protected override bool IsContentElementCore() => true;
+    protected override bool IsControlElementCore() => true;
+}
diff --git a/src/DataBox/DataBox.cs b/src/DataBox/DataBox.cs
@@ -1,11 +1,13 @@
 using System.Collections;
 using Avalonia;
+using Avalonia.Automation.Peers;
 using Avalonia.Collections;
 using Avalonia.Controls;
 using Avalonia.Controls.Primitives;
 using Avalonia.Data;
 using Avalonia.Media;
 using Avalonia.Metadata;
+using DataBox.Automation.Peers;
 using DataBox.Primitives;
 
 namespace DataBox;
@@ -127,6 +129,11 @@ public DataBox()
         _columns = new AvaloniaList<DataBoxColumn>();
     }
 
+    protected override AutomationPeer OnCreateAutomationPeer()
+    {
+        return new DataBoxAutomationPeer(this);
+    }
+
     protected override void OnApplyTemplate(TemplateAppliedEventArgs e)
     {
         base.OnApplyTemplate(e);

diff --git a/src/DataBox/DataBoxCell.cs b/src/DataBox/DataBoxCell.cs
@@ -1,8 +1,10 @@
 using System;
 using Avalonia;
+using Avalonia.Automation.Peers;
 using Avalonia.Controls;
 using Avalonia.Controls.Primitives;
 using Avalonia.Controls.Shapes;
+using DataBox.Automation.Peers;
 
 namespace DataBox;
 
@@ -16,6 +18,11 @@ public class DataBoxCell : ContentControl
 
     protected override Type StyleKeyOverride => typeof(DataBoxCell);
 
+    protected override AutomationPeer OnCreateAutomationPeer()
+    {
+        return new DataBoxCellAutomationPeer(this);
+    }
+
     protected override void OnApplyTemplate(TemplateAppliedEventArgs e)
     {
         base.OnApplyTemplate(e);

diff --git a/src/DataBox/DataBoxColumnHeader.cs b/src/DataBox/DataBoxColumnHeader.cs
@@ -3,12 +3,14 @@
 using System.ComponentModel;
 using System.Linq;
 using Avalonia;
+using Avalonia.Automation.Peers;
 using Avalonia.Controls;
 using Avalonia.Controls.Metadata;
 using Avalonia.Controls.Primitives;
 using Avalonia.Input;
 using Avalonia.Media;
 using Avalonia.VisualTree;
+using DataBox.Automation.Peers;
 
 namespace DataBox;
 
@@ -57,6 +59,11 @@ internal bool IsPressed
 
     internal IReadOnlyList<DataBoxColumnHeader>? ColumnHeaders { get; set; }
 
+    protected override AutomationPeer OnCreateAutomationPeer()
+    {
+        return new DataBoxColumnHeaderAutomationPeer(this);
+    }
+
     protected override void OnApplyTemplate(TemplateAppliedEventArgs e)
     {
         base.OnApplyTemplate(e);

diff --git a/src/DataBox/DataBoxRow.cs b/src/DataBox/DataBoxRow.cs
@@ -1,7 +1,9 @@
 using System;
+using Avalonia.Automation.Peers;
 using Avalonia.Controls;
 using Avalonia.Controls.Primitives;
 using Avalonia.Controls.Shapes;
+using DataBox.Automation.Peers;
 using DataBox.Primitives;
 
 namespace DataBox;
@@ -16,6 +18,11 @@ public class DataBoxRow : ListBoxItem
 
     protected override Type StyleKeyOverride => typeof(DataBoxRow);
 
+    protected override AutomationPeer OnCreateAutomationPeer()
+    {
+        return new DataBoxRowAutomationPeer(this);
+    }
+
     protected override void OnApplyTemplate(TemplateAppliedEventArgs e)
     {
         base.OnApplyTemplate(e);

diff --git a/src/DataBox/Primitives/DataBoxColumnHeadersPresenter.cs b/src/DataBox/Primitives/DataBoxColumnHeadersPresenter.cs
@@ -1,8 +1,10 @@
 using System;
 using System.Collections.Generic;
 using Avalonia;
+using Avalonia.Automation.Peers;
 using Avalonia.Controls;
 using Avalonia.Layout;
+using DataBox.Automation.Peers;
 using DataBox.Primitives.Layout;
 
 namespace DataBox.Primitives;
@@ -16,6 +18,11 @@ public class DataBoxColumnHeadersPresenter : Panel
 
     protected override Type StyleKeyOverride => typeof(DataBoxColumnHeadersPresenter);
 
+    protected override AutomationPeer OnCreateAutomationPeer()
+    {
+        return new DataBoxColumnHeadersPresenterAutomationPeer(this);
+    }
+
     protected override void OnDetachedFromVisualTree(VisualTreeAttachmentEventArgs e)
     {
         base.OnDetachedFromVisualTree(e);