generated from unoplatform/template
-
Notifications
You must be signed in to change notification settings - Fork 27
/
VisualTreeHelperEx.cs
327 lines (298 loc) · 12 KB
/
VisualTreeHelperEx.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Text.RegularExpressions;
using System.Threading.Tasks;
#if IS_WINUI
using Microsoft.UI.Xaml;
using Microsoft.UI.Xaml.Media;
using Microsoft.UI.Xaml.Controls;
using Microsoft.UI.Xaml.Shapes;
#else
using Windows.UI.Xaml;
using Windows.UI.Xaml.Media;
using Windows.UI.Xaml.Controls;
using Windows.UI.Xaml.Shapes;
#endif
#if __IOS__
using UIKit;
using _View = UIKit.UIView;
#elif __MACOS__
using AppKit;
using _View = AppKit.NSView;
#elif __ANDROID__
using _View = Android.Views.View;
#else
#if IS_WINUI
using _View = Microsoft.UI.Xaml.DependencyObject;
#else
using _View = Windows.UI.Xaml.DependencyObject;
#endif
#endif
using static System.Reflection.BindingFlags;
using static Uno.Toolkit.UI.PrettyPrint;
namespace Uno.Toolkit.UI
{
/// <summary>
/// Utility class to traverse the visual tree.
/// </summary>
/// <remarks>
/// This class is implemented with <see cref="VisualTreeHelper.GetChild(DependencyObject, int)"/> which doesn't cross uwp/native barrier.
/// Use the <see cref="Native"/> counterpart if the uwp/native barrier needs to be crossed.
/// </remarks>
internal static partial class VisualTreeHelperEx
{
/// <summary>
/// Produces a text representation of the visual tree.
/// </summary>
/// <param name="reference">Any node of the visual tree</param>
public static string TreeGraph(this DependencyObject reference) => TreeGraph(reference, DebugVTNode);
/// <summary>
/// Produces a text representation of the visual tree, using the provided method of description.
/// </summary>
/// <param name="reference">Any node of the visual tree</param>
/// <param name="describe">A function to describe a visual tree node in a single line.</param>
/// <returns></returns>
public static string TreeGraph(this DependencyObject reference, Func<DependencyObject, string> describe)
{
var buffer = new StringBuilder();
Walk(reference);
return buffer.ToString();
void Walk(DependencyObject o, int depth = 0)
{
Print(o, depth);
foreach (var child in o.GetChildren())
{
Walk(child, depth + 1);
}
}
void Print(DependencyObject o, int depth)
{
buffer
.Append(new string(' ', depth * 4))
.Append(describe(o))
.AppendLine();
}
}
/// <summary>
/// Returns the first ancestor of a specified type.
/// </summary>
/// <typeparam name="T">The type of ancestor to find.</typeparam>
/// <param name="reference">Any node of the visual tree</param>
/// <remarks>First Counting from the <paramref name="reference"/> and not from the root of tree.</remarks>
public static T? GetFirstAncestor<T>(this DependencyObject reference) => GetAncestors(reference)
.OfType<T>()
.FirstOrDefault();
/// <summary>
/// Returns the first ancestor of a specified type that satisfies the <paramref name="predicate"/>.
/// </summary>
/// <typeparam name="T">The type of ancestor to find.</typeparam>
/// <param name="reference">Any node of the visual tree</param>
/// <param name="predicate">A function to test each node for a condition.</param>
/// <remarks>First Counting from the <paramref name="reference"/> and not from the root of tree.</remarks>
public static T? GetFirstAncestor<T>(this DependencyObject reference, Func<T, bool> predicate) => GetAncestors(reference)
.OfType<T>()
.FirstOrDefault(predicate);
/// <summary>
/// Returns the first ancestor of a specified type that satisfies the <paramref name="predicate"/>.
/// </summary>
/// <typeparam name="T">The type of ancestor to find.</typeparam>
/// <param name="reference">Any node of the visual tree</param>
/// <param name="hierarchyPredicate">A function to test each ancestor for a condition.</param>
/// <param name="predicate">A function to test each node for a condition.</param>
/// <remarks>First Counting from the <paramref name="reference"/> and not from the root of tree.</remarks>
public static T? GetFirstAncestor<T>(this DependencyObject reference, Func<DependencyObject, bool> hierarchyPredicate, Func<T, bool> predicate) => GetAncestors(reference, hierarchyPredicate)
.OfType<T>()
.FirstOrDefault(predicate);
/// <summary>
/// Returns the first descendant of a specified type.
/// </summary>
/// <typeparam name="T">The type of descendant to find.</typeparam>
/// <param name="reference">Any node of the visual tree</param>
/// <remarks>The crawling is done depth first.</remarks>
public static T? GetFirstDescendant<T>(this DependencyObject reference) => GetDescendants(reference)
.OfType<T>()
.FirstOrDefault();
/// <summary>
/// Returns the first descendant of a specified type that satisfies the <paramref name="predicate"/>.
/// </summary>
/// <typeparam name="T">The type of descendant to find.</typeparam>
/// <param name="reference">Any node of the visual tree</param>
/// <param name="predicate">A function to test each node for a condition.</param>
/// <remarks>The crawling is done depth first.</remarks>
public static T? GetFirstDescendant<T>(this DependencyObject reference, Func<T, bool> predicate) => GetDescendants(reference)
.OfType<T>()
.FirstOrDefault(predicate);
/// <summary>
/// Returns the first descendant of a specified type that satisfies the <paramref name="predicate"/> whose ancestors (up to <paramref name="reference"/>) satisfy the <paramref name="hierarchyPredicate"/>.
/// </summary>
/// <typeparam name="T">The type of descendant to find.</typeparam>
/// <param name="reference">Any node of the visual tree</param>
/// <param name="hierarchyPredicate">A function to test each ancestor for a condition.</param>
/// <param name="predicate">A function to test each descendant for a condition.</param>
/// <remarks>The crawling is done depth first.</remarks>
public static T? GetFirstDescendant<T>(this DependencyObject reference, Func<DependencyObject, bool> hierarchyPredicate, Func<T, bool> predicate) => GetDescendants(reference, hierarchyPredicate)
.OfType<T>()
.FirstOrDefault(predicate);
public static IEnumerable<DependencyObject> GetAncestors(this DependencyObject o) => GetAncestors(o, x => true);
public static IEnumerable<DependencyObject> GetAncestors(this DependencyObject o, Func<DependencyObject, bool> hierarchyPredicate)
{
if (o is null) yield break;
while (VisualTreeHelper.GetParent(o) is { } parent && hierarchyPredicate(parent))
{
yield return o = parent;
}
}
public static IEnumerable<DependencyObject> GetDescendants(this DependencyObject reference) => GetDescendants(reference, x => true);
public static IEnumerable<DependencyObject> GetDescendants(this DependencyObject reference, Func<DependencyObject, bool> hierarchyPredicate)
{
foreach (var child in reference.GetChildren().Where(hierarchyPredicate))
{
yield return child;
foreach (var grandchild in child.GetDescendants(hierarchyPredicate))
{
yield return grandchild;
}
}
}
public static IEnumerable<DependencyObject> GetChildren(this DependencyObject reference)
{
return Enumerable
.Range(0, VisualTreeHelper.GetChildrenCount(reference))
.Select(x => VisualTreeHelper.GetChild(reference, x));
}
public static DependencyObject? GetTemplateRoot(this DependencyObject o) => o?.GetChildren().FirstOrDefault();
}
internal static partial class VisualTreeHelperEx // TreeGraph helper methods
{
private static string DebugVTNode(object x)
{
return new StringBuilder()
.Append(x.GetType().Name)
.Append((x as FrameworkElement)?.Name is string { Length: > 0 } xname ? $"#{xname}" : string.Empty)
.Append($" // {string.Join(", ", GetDetails())}")
.ToString();
IEnumerable<string> GetDetails()
{
#if __IOS__
if (x is _View view)
{
var abs = view.Superview.ConvertPointToView(view.Frame.Location, toView: null);
yield return $"Abs=[Rect {view.Frame.Width:0.#}x{view.Frame.Height:0.#}@{abs.X:0.#},{abs.Y:0.#}]";
}
#elif __ANDROID__
if (x is _View view)
{
yield return $"Rect={FormatViewRect(view)}";
}
#endif
if (x is FrameworkElement fe)
{
yield return $"Actual={fe.ActualWidth}x{fe.ActualHeight}";
// yield return $"Constraints=[{fe.MinWidth},{fe.Width},{fe.MaxWidth}]x[{fe.MinHeight},{fe.Height},{fe.MaxHeight}]";
yield return $"HV={fe.HorizontalAlignment}/{fe.VerticalAlignment}";
}
if (x is UIElement uie)
{
//yield return $"Desired={FormatSize(uie.DesiredSize)}";
//yield return $"LAS={FormatSize(uie.LastAvailableSize)}";
}
if (x is ScrollViewer sv)
{
yield return $"Offset={sv.HorizontalOffset:0.#},{sv.VerticalOffset:0.#}";
yield return $"Viewport={sv.ViewportWidth:0.#}x{sv.ViewportHeight:0.#}";
yield return $"Extent={sv.ExtentWidth:0.#}x{sv.ExtentHeight:0.#}";
}
if (x is ListViewItem lvi)
{
yield return $"Index={ItemsControl.ItemsControlFromItemContainer(lvi)?.IndexFromContainer(lvi) ?? -1}";
}
if (x is TextBlock txt && !string.IsNullOrEmpty(txt.Text))
{
yield return $"Text=\"{Regex.Escape(txt.Text)}\"";
}
if (x is Shape shape)
{
if (shape.Fill is not null) yield return $"Fill={FormatBrush(shape.Fill)}";
if (shape.Stroke is not null) yield return $"Stroke={FormatBrush(shape.Stroke)}*{shape.StrokeThickness}px";
}
if (TryGetDpValue<CornerRadius>(x, "CornerRadius", out var cr)) yield return $"CornerRadius={FormatCornerRadius(cr)}";
if (TryGetDpValue<Thickness>(x, "Margin", out var margin)) yield return $"Margin={FormatThickness(margin)}";
if (TryGetDpValue<Thickness>(x, "Padding", out var padding)) yield return $"Padding={FormatThickness(padding)}";
if (TryGetDpValue<double>(x, "Opacity", out var opacity)) yield return $"Opacity={opacity}";
if (TryGetDpValue<Visibility>(x, "Visibility", out var visibility)) yield return $"Visibility={visibility}";
if (GetActiveVisualStates(x as Control) is { } states) yield return $"VisualStates={states}";
}
}
internal static bool TryGetDpValue<T>(object owner, string property, out T? value)
{
if (owner is DependencyObject @do &&
owner.GetType().GetProperty($"{property}Property", Public | Static | FlattenHierarchy)
?.GetValue(null, null) is DependencyProperty dp)
{
value = (T)@do.GetValue(dp);
return true;
}
value = default;
return false;
}
internal static string? GetActiveVisualStates(Control? control)
{
if (control?.GetTemplateRoot() is FrameworkElement root)
{
if (VisualStateManager.GetVisualStateGroups(root) is { Count: > 0 } vsgs)
{
return string.Join("|", vsgs.Select(x => x.CurrentState?.Name));
}
}
return null;
}
}
internal static partial class VisualTreeHelperEx // Native view impl
{
#if __IOS__ || __ANDROID__
internal static class Native
{
public static T? GetFirstDescendant<T>(_View reference) => GetDescendants(reference)
.OfType<T>()
.FirstOrDefault();
public static T? GetFirstDescendant<T>(_View reference, Func<T, bool> predicate) => GetDescendants(reference)
.OfType<T>()
.FirstOrDefault(predicate);
public static T? GetFirstDescendant<T>(_View reference, Func<_View, bool> hierarchyPredicate, Func<T, bool> predicate) => GetDescendants(reference, hierarchyPredicate)
.OfType<T>()
.FirstOrDefault(predicate);
public static IEnumerable<_View> GetDescendants(_View reference) => GetDescendants(reference, x => true);
public static IEnumerable<_View> GetDescendants(_View reference, Func<_View, bool> hierarchyPredicate)
{
foreach (var child in GetChildren(reference).Where(hierarchyPredicate))
{
yield return child;
foreach (var grandchild in GetDescendants(child, hierarchyPredicate))
{
yield return grandchild;
}
}
}
#if __IOS__
private static IEnumerable<_View> GetChildren(_View reference)
{
return reference.Subviews;
}
#elif __ANDROID__
private static IEnumerable<_View> GetChildren(_View reference)
{
if (reference is Android.Views.ViewGroup vg)
{
return Enumerable
.Range(0, vg.ChildCount)
.Select(vg.GetChildAt)!;
}
return Enumerable.Empty<_View>();
}
#endif
}
#endif
}
}