-
Notifications
You must be signed in to change notification settings - Fork 1.7k
/
ViewExtensions.cs
523 lines (449 loc) · 23.2 KB
/
ViewExtensions.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
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Logging;
using Microsoft.Maui.Animations;
using Microsoft.Maui.Controls.Internals;
using Microsoft.Maui.Graphics;
namespace Microsoft.Maui.Controls
{
/// <summary>
/// Extension methods for <see cref="VisualElement" />s, providing animatable scaling, rotation, and layout functions.
/// </summary>
public static class ViewExtensions
{
/// <summary>
/// Aborts all animations (e.g. <c>LayoutTo</c>, <c>TranslateTo</c>, <c>ScaleTo</c>, etc.) on the <paramref name= "view" /> element.
/// </summary>
/// <param name="view">The view on which this method operates.</param>
/// <exception cref="ArgumentNullException">Thrown if <paramref name="view"/> is <see langword="null"/>.</exception>
public static void CancelAnimations(this VisualElement view)
{
if (view == null)
throw new ArgumentNullException(nameof(view));
view.AbortAnimation(nameof(LayoutTo));
view.AbortAnimation(nameof(TranslateTo));
view.AbortAnimation(nameof(RotateTo));
view.AbortAnimation(nameof(RotateYTo));
view.AbortAnimation(nameof(RotateXTo));
view.AbortAnimation(nameof(ScaleTo));
view.AbortAnimation(nameof(ScaleXTo));
view.AbortAnimation(nameof(ScaleYTo));
view.AbortAnimation(nameof(FadeTo));
}
static Task<bool> AnimateTo(this VisualElement view, double start, double end, string name,
Action<VisualElement, double> updateAction, uint length = 250, Easing? easing = null)
{
if (easing == null)
easing = Easing.Linear;
var tcs = new TaskCompletionSource<bool>();
var weakView = new WeakReference<VisualElement>(view);
void UpdateProperty(double f)
{
if (weakView.TryGetTarget(out VisualElement? v))
{
updateAction(v, f);
}
}
new Animation(UpdateProperty, start, end, easing).Commit(view, name, 16, length, finished: (f, a) => tcs.SetResult(a));
return tcs.Task;
}
/// <summary>
/// Returns a task that performs the fade that is described by the <paramref name="opacity" />, <paramref name = "length" />, and <paramref name="easing" /> parameters.
/// </summary>
/// <param name="view">The view on which this method operates.</param>
/// <param name="opacity">The opacity to fade to.</param>
/// <param name="length">The time, in milliseconds, over which to animate the transition. The default is 250.</param>
/// <param name="easing">The easing function to use for the animation.</param>
/// <returns>A <see cref="Task"/> containing a <see cref="bool"/> value which indicates whether the animation was canceled. <see langword="true"/> indicates that the animation was canceled. <see langword="false"/> indicates that the animation ran to completion.</returns>
/// <exception cref="ArgumentNullException">Thrown when <paramref name="view"/> is <see langword="null"/>.</exception>
public static Task<bool> FadeTo(this VisualElement view, double opacity, uint length = 250, Easing? easing = null)
{
if (view == null)
throw new ArgumentNullException(nameof(view));
return AnimateTo(view, view.Opacity, opacity, nameof(FadeTo), (v, value) => v.Opacity = value, length, easing);
}
/// <summary>
/// <summary>Returns a task that eases the bounds of the <see cref="VisualElement" /> that is specified by the <paramref name="view" />
/// to the rectangle that is specified by the <paramref name="bounds" /> parameter.</summary>
/// </summary>
/// <param name="view">The view on which this method operates.</param>
/// <param name="bounds">The layout bounds.</param>
/// <param name="length">The time, in milliseconds, over which to animate the transition. The default is 250.</param>
/// <param name="easing">The easing function to use for the animation.</param>
/// <returns>A <see cref="Task"/> containing a <see cref="bool"/> value which indicates whether the animation was canceled. <see langword="true"/> indicates that the animation was canceled. <see langword="false"/> indicates that the animation ran to completion.</returns>
/// <exception cref="ArgumentNullException">Thrown when <paramref name="view"/> is <see langword="null"/>.</exception>
public static Task<bool> LayoutTo(this VisualElement view, Rect bounds, uint length = 250, Easing? easing = null)
{
if (view == null)
throw new ArgumentNullException(nameof(view));
Rect start = view.Bounds;
Func<double, Rect> computeBounds = progress =>
{
double x = start.X + (bounds.X - start.X) * progress;
double y = start.Y + (bounds.Y - start.Y) * progress;
double w = start.Width + (bounds.Width - start.Width) * progress;
double h = start.Height + (bounds.Height - start.Height) * progress;
return new Rect(x, y, w, h);
};
return AnimateTo(view, 0, 1, nameof(LayoutTo), (v, value) => v.Layout(computeBounds(value)), length, easing);
}
/// <summary>
/// Rotates the <see cref="VisualElement" /> that is specified by <paramref name="view" /> from its current rotation by <paramref name="drotation" />.
/// </summary>
/// <param name="view">The view on which this method operates.</param>
/// <param name="drotation">The relative rotation.</param>
/// <param name="length">The time, in milliseconds, over which to animate the transition. The default is 250.</param>
/// <param name="easing">The easing function to use for the animation.</param>
/// <returns>A <see cref="Task"/> containing a <see cref="bool"/> value which indicates whether the animation was canceled. <see langword="true"/> indicates that the animation was canceled. <see langword="false"/> indicates that the animation ran to completion.</returns>
/// <exception cref="ArgumentNullException">Thrown when <paramref name="view"/> is <see langword="null"/>.</exception>
public static Task<bool> RelRotateTo(this VisualElement view, double drotation, uint length = 250, Easing? easing = null)
{
if (view == null)
throw new ArgumentNullException(nameof(view));
return view.RotateTo(view.Rotation + drotation, length, easing);
}
/// <summary>
/// Returns a task that scales the <see cref="VisualElement" /> that is specified by <paramref name="view" />
/// from its current scale to <paramref name="dscale" />.
/// </summary>
/// <param name="view">The view on which this method operates.</param>
/// <param name="dscale">The relative scale.</param>
/// <param name="length">The time, in milliseconds, over which to animate the transition. The default is 250.</param>
/// <param name="easing">The easing function to use for the animation.</param>
/// <returns>A <see cref="Task"/> containing a <see cref="bool"/> value which indicates whether the animation was canceled. <see langword="true"/> indicates that the animation was canceled. <see langword="false"/> indicates that the animation ran to completion.</returns>
/// <exception cref="ArgumentNullException">Thrown when <paramref name="view"/> is <see langword="null"/>.</exception>
public static Task<bool> RelScaleTo(this VisualElement view, double dscale, uint length = 250, Easing? easing = null)
{
if (view == null)
throw new ArgumentNullException(nameof(view));
return view.ScaleTo(view.Scale + dscale, length, easing);
}
/// <summary>
/// Returns a task that rotates the <see cref="VisualElement" /> that is specified by <paramref name="view" />
/// that is described by the <paramref name="rotation" />, <paramref name="length" />, and <paramref name="easing" /> parameters.
/// </summary>
/// <param name="view">The view on which this method operates.</param>
/// <param name="rotation">The final rotation value.</param>
/// <param name="length">The time, in milliseconds, over which to animate the transition. The default is 250.</param>
/// <param name="easing">The easing function to use for the animation.</param>
/// <returns>A <see cref="Task"/> containing a <see cref="bool"/> value which indicates whether the animation was canceled. <see langword="true"/> indicates that the animation was canceled. <see langword="false"/> indicates that the animation ran to completion.</returns>
/// <exception cref="ArgumentNullException">Thrown when <paramref name="view"/> is <see langword="null"/>.</exception>
public static Task<bool> RotateTo(this VisualElement view, double rotation, uint length = 250, Easing? easing = null)
{
if (view == null)
throw new ArgumentNullException(nameof(view));
return AnimateTo(view, view.Rotation, rotation, nameof(RotateTo), (v, value) => v.Rotation = value, length, easing);
}
/// <summary>
/// Returns a task that skews the X axis of the the <see cref="VisualElement" /> that is specified by <paramref name="view" />
/// by <paramref name="rotation" />, taking time <paramref name="length" /> and using <paramref name="easing" />.
/// </summary>
/// <param name="view">The view on which this method operates.</param>
/// <param name="rotation">The final rotation value.</param>
/// <param name="length">The time, in milliseconds, over which to animate the transition. The default is 250.</param>
/// <param name="easing">The easing function to use for the animation.</param>
/// <returns>A <see cref="Task"/> containing a <see cref="bool"/> value which indicates whether the animation was canceled. <see langword="true"/> indicates that the animation was canceled. <see langword="false"/> indicates that the animation ran to completion.</returns>
/// <exception cref="ArgumentNullException">Thrown when <paramref name="view"/> is <see langword="null"/>.</exception>
public static Task<bool> RotateXTo(this VisualElement view, double rotation, uint length = 250, Easing? easing = null)
{
if (view == null)
throw new ArgumentNullException(nameof(view));
return AnimateTo(view, view.RotationX, rotation, nameof(RotateXTo), (v, value) => v.RotationX = value, length, easing);
}
/// <summary>
/// Returns a task that skews the Y axis of the the <see cref="VisualElement" /> that is specified by <paramref name="view" />
/// by <paramref name="rotation" />, taking time <paramref name="length" /> and using <paramref name="easing" />.
/// </summary>
/// <param name="view">The view on which this method operates.</param>
/// <param name="rotation">The final rotation value.</param>
/// <param name="length">The time, in milliseconds, over which to animate the transition. The default is 250.</param>
/// <param name="easing">The easing function to use for the animation.</param>
/// <returns>A <see cref="Task"/> containing a <see cref="bool"/> value which indicates whether the animation was canceled. <see langword="true"/> indicates that the animation was canceled. <see langword="false"/> indicates that the animation ran to completion.</returns>
/// <exception cref="ArgumentNullException">Thrown when <paramref name="view"/> is <see langword="null"/>.</exception>
public static Task<bool> RotateYTo(this VisualElement view, double rotation, uint length = 250, Easing? easing = null)
{
if (view == null)
throw new ArgumentNullException(nameof(view));
return AnimateTo(view, view.RotationY, rotation, nameof(RotateYTo), (v, value) => v.RotationY = value, length, easing);
}
/// <summary>
/// Returns a task that scales the <see cref="VisualElement" /> that is specified by <paramref name="view" /> to the absolute scale factor <paramref name="scale" />.
/// </summary>
/// <param name="view">The view on which this method operates.</param>
/// <param name="scale">The final absolute scale.</param>
/// <param name="length">The time, in milliseconds, over which to animate the transition. The default is 250.</param>
/// <param name="easing">The easing function to use for the animation.</param>
/// <returns>A <see cref="Task"/> containing a <see cref="bool"/> value which indicates whether the animation was canceled. <see langword="true"/> indicates that the animation was canceled. <see langword="false"/> indicates that the animation ran to completion.</returns>
/// <exception cref="ArgumentNullException">Thrown when <paramref name="view"/> is <see langword="null"/>.</exception>
public static Task<bool> ScaleTo(this VisualElement view, double scale, uint length = 250, Easing? easing = null)
{
if (view == null)
throw new ArgumentNullException(nameof(view));
return AnimateTo(view, view.Scale, scale, nameof(ScaleTo), (v, value) => v.Scale = value, length, easing);
}
/// <summary>
/// Returns a task that scales the X axis of the the <see cref="VisualElement" /> that is specified by <paramref name="view" />
/// to the absolute scale factor <paramref name="scale" />.
/// </summary>
/// <param name="view">The view on which this method operates.</param>
/// <param name="scale">The final absolute scale.</param>
/// <param name="length">The time, in milliseconds, over which to animate the transition. The default is 250.</param>
/// <param name="easing">The easing function to use for the animation.</param>
/// <returns>A <see cref="Task"/> containing a <see cref="bool"/> value which indicates whether the animation was canceled. <see langword="true"/> indicates that the animation was canceled. <see langword="false"/> indicates that the animation ran to completion.</returns>
/// <exception cref="ArgumentNullException">Thrown when <paramref name="view"/> is <see langword="null"/>.</exception>
public static Task<bool> ScaleXTo(this VisualElement view, double scale, uint length = 250, Easing? easing = null)
{
if (view == null)
throw new ArgumentNullException(nameof(view));
return AnimateTo(view, view.ScaleX, scale, nameof(ScaleXTo), (v, value) => v.ScaleX = value, length, easing);
}
/// <summary>
/// Returns a task that scales the Y axis of the the <see cref="VisualElement" /> that is specified by <paramref name="view" />
/// to the absolute scale factor <paramref name="scale" />.
/// </summary>
/// <param name="view">The view on which this method operates.</param>
/// <param name="scale">The final absolute scale.</param>
/// <param name="length">The time, in milliseconds, over which to animate the transition. The default is 250.</param>
/// <param name="easing">The easing function to use for the animation.</param>
/// <returns>A <see cref="Task"/> containing a <see cref="bool"/> value which indicates whether the animation was canceled. <see langword="true"/> indicates that the animation was canceled. <see langword="false"/> indicates that the animation ran to completion.</returns>
/// <exception cref="ArgumentNullException">Thrown when <paramref name="view"/> is <see langword="null"/>.</exception>
public static Task<bool> ScaleYTo(this VisualElement view, double scale, uint length = 250, Easing? easing = null)
{
if (view == null)
throw new ArgumentNullException(nameof(view));
return AnimateTo(view, view.ScaleY, scale, nameof(ScaleYTo), (v, value) => v.ScaleY = value, length, easing);
}
/// <summary>
/// Animates an elements <see cref="VisualElement.TranslationX"/> and <see cref="VisualElement.TranslationY"/> properties
/// from their current values to the new values. This ensures that the input layout is in the same position as the visual layout.
/// </summary>
/// <param name="view">The view on which this method operates.</param>
/// <param name="x">The x component of the final translation vector.</param>
/// <param name="y">The y component of the final translation vector.</param>
/// <param name="length">The time, in milliseconds, over which to animate the transition. The default is 250.</param>
/// <param name="easing">The easing function to use for the animation.</param>
/// <returns>A <see cref="Task"/> containing a <see cref="bool"/> value which indicates whether the animation was canceled. <see langword="true"/> indicates that the animation was canceled. <see langword="false"/> indicates that the animation ran to completion.</returns>
/// <exception cref="ArgumentNullException">Thrown when <paramref name="view"/> is <see langword="null"/>.</exception>
public static Task<bool> TranslateTo(this VisualElement view, double x, double y, uint length = 250, Easing? easing = null)
{
if (view == null)
throw new ArgumentNullException(nameof(view));
easing ??= Easing.Linear;
var tcs = new TaskCompletionSource<bool>();
var weakView = new WeakReference<VisualElement>(view);
Action<double> translateX = f =>
{
if (weakView.TryGetTarget(out VisualElement? v))
v.TranslationX = f;
};
Action<double> translateY = f =>
{
if (weakView.TryGetTarget(out VisualElement? v))
v.TranslationY = f;
};
new Animation
{
{ 0, 1, new Animation(translateX, view.TranslationX, x, easing: easing) },
{ 0, 1, new Animation(translateY, view.TranslationY, y, easing: easing) }
}.Commit(view, nameof(TranslateTo), 16, length, null, (f, a) => tcs.SetResult(a));
return tcs.Task;
}
internal static IAnimationManager GetAnimationManager(this IAnimatable animatable)
{
if (animatable is Element element)
{
if (element.FindMauiContext() is IMauiContext viewMauiContext)
return viewMauiContext.GetAnimationManager();
if (Application.Current?.FindMauiContext() is IMauiContext applicationMauiContext)
return applicationMauiContext.GetAnimationManager();
}
throw new ArgumentException($"Unable to find {nameof(IAnimationManager)} for '{animatable.GetType().FullName}'.", nameof(animatable));
}
internal static IMauiContext RequireMauiContext(this Element element, bool fallbackToAppMauiContext = false)
=> element.FindMauiContext(fallbackToAppMauiContext) ?? throw new InvalidOperationException($"{nameof(IMauiContext)} not found.");
internal static IMauiContext? FindMauiContext(this Element element, bool fallbackToAppMauiContext = false)
{
if (element is Maui.IElement fe && fe.Handler?.MauiContext != null)
return fe.Handler.MauiContext;
foreach (var parent in element.GetParentsPath())
{
if (parent is Maui.IElement parentView && parentView.Handler?.MauiContext != null)
return parentView.Handler.MauiContext;
}
return fallbackToAppMauiContext ? Application.Current?.FindMauiContext() : default;
}
internal static ILogger<T>? CreateLogger<T>(this Element element, bool fallbackToAppMauiContext = true) =>
element.FindMauiContext(fallbackToAppMauiContext)?.CreateLogger<T>();
internal static IFontManager RequireFontManager(this Element element, bool fallbackToAppMauiContext = false)
=> element.RequireMauiContext(fallbackToAppMauiContext).Services.GetRequiredService<IFontManager>();
internal static double GetDefaultFontSize(this Element element)
=> element.FindMauiContext()?.Services?.GetService<IFontManager>()?.DefaultFontSize ?? 0d;
internal static Element? FindParentWith(this Element element, Func<Element, bool> withMatch, bool includeThis = false)
{
if (includeThis && withMatch(element))
return element;
foreach (var parent in element.GetParentsPath())
{
if (withMatch(parent))
return parent;
}
return default;
}
internal static T? FindParentOfType<T>(this Element element, bool includeThis = false)
where T : Maui.IElement
{
if (includeThis && element is T view)
return view;
foreach (var parent in element.GetParentsPath())
{
if (parent is T parentView)
return parentView;
}
return default;
}
internal static IList<IGestureRecognizer>? GetCompositeGestureRecognizers(this Element element)
{
if (element is IGestureController gc)
return gc.CompositeGestureRecognizers;
return null;
}
internal static IEnumerable<Element> GetParentsPath(this Element self)
{
Element current = self;
while (!Application.IsApplicationOrNull(current.RealParent))
{
current = current.RealParent;
yield return current;
}
}
internal static List<Page> GetParentPages(this Page target)
{
var result = new List<Page>();
var parent = target.RealParent as Page;
while (!Application.IsApplicationOrWindowOrNull(parent))
{
result.Add(parent!);
parent = parent!.RealParent as Page;
}
return result;
}
internal static string? GetStringValue(this IView element)
{
string? text = null;
if (element is ILabel label)
text = label.Text;
else if (element is IEntry entry)
text = entry.Text;
else if (element is IEditor editor)
text = editor.Text;
else if (element is ITimePicker tp)
text = tp.Time.ToString();
else if (element is IDatePicker dp)
text = dp.Date.ToString();
else if (element is ICheckBox cb)
text = cb.IsChecked.ToString();
else if (element is ISwitch sw)
text = sw.IsOn.ToString();
else if (element is IRadioButton rb)
text = rb.IsChecked.ToString();
return text;
}
internal static bool TrySetValue(this Element element, string text)
{
if (element is Label label)
{
label.Text = text;
return true;
}
else if (element is Entry entry)
{
entry.Text = text;
return true;
}
else if (element is Editor editor)
{
editor.Text = text;
return true;
}
else if (element is CheckBox cb && bool.TryParse(text, out bool result))
{
cb.IsChecked = result;
return true;
}
else if (element is Switch sw && bool.TryParse(text, out bool swResult))
{
sw.IsToggled = swResult;
return true;
}
else if (element is RadioButton rb && bool.TryParse(text, out bool rbResult))
{
rb.IsChecked = rbResult;
return true;
}
else if (element is TimePicker tp && TimeSpan.TryParse(text, out TimeSpan tpResult))
{
tp.Time = tpResult;
return true;
}
else if (element is DatePicker dp && DateTime.TryParse(text, out DateTime dpResult))
{
dp.Date = dpResult;
return true;
}
return false;
}
static internal bool RequestFocus(this VisualElement view)
{
// if there is an attached handler, we use that and we will end up in the MapFocus method below
if (view.Handler is IViewHandler handler)
return handler.InvokeWithResult(nameof(IView.Focus), new FocusRequest());
// if there is no handler, we need to still run some code
var focusRequest = new FocusRequest();
view.MapFocus(focusRequest);
return focusRequest.Result;
}
static internal void MapFocus(this VisualElement view, FocusRequest focusRequest, Action? baseMethod = null)
{
// the virtual view is already focused
if (view.IsFocused)
{
focusRequest.TrySetResult(true);
return;
}
// if there are legacy events, then use that
if (view.HasFocusChangeRequestedEvent)
{
var arg = new VisualElement.FocusRequestArgs { Focus = true };
view.InvokeFocusChangeRequested(arg);
focusRequest.TrySetResult(arg.Result);
return;
}
// otherwise, fall back to "base"
if (baseMethod is not null)
{
baseMethod.Invoke();
return;
}
// if there was nothing that handles this, then nothing changed
focusRequest.TrySetResult(false);
}
internal static IMauiContext? GetCurrentlyPresentedMauiContext(this Element element)
{
var window = (element as Window) ?? (element as IWindowController)?.Window;
if (window is null)
return null;
var modalStack = window.Navigation.ModalStack;
if (modalStack.Count > 0)
{
var currentPage = modalStack[modalStack.Count - 1];
if (currentPage.Handler?.MauiContext is IMauiContext mauiContext)
{
return mauiContext;
}
}
return window.Handler?.MauiContext;
}
}
}