Files
maui-linux/Views/SkiaBorder.cs

573 lines
18 KiB
C#
Raw Normal View History

// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
using System;
2026-01-16 05:49:20 +00:00
using System.Collections.Generic;
using Microsoft.Maui.Controls;
2026-01-16 05:49:20 +00:00
using Microsoft.Maui.Controls.Shapes;
2026-01-16 05:30:52 +00:00
using Microsoft.Maui.Graphics;
using Microsoft.Maui.Platform.Linux.Handlers;
using SkiaSharp;
namespace Microsoft.Maui.Platform;
/// <summary>
/// Skia-rendered border/frame container control with full XAML styling support.
2026-01-16 05:30:52 +00:00
/// Implements MAUI IBorderView interface patterns.
/// </summary>
public class SkiaBorder : SkiaLayoutView
{
#region BindableProperties
public static readonly BindableProperty StrokeThicknessProperty =
2026-01-16 05:30:52 +00:00
BindableProperty.Create(nameof(StrokeThickness), typeof(double), typeof(SkiaBorder), 1.0,
BindingMode.TwoWay, propertyChanged: (b, o, n) => ((SkiaBorder)b).Invalidate());
public static readonly BindableProperty CornerRadiusProperty =
2026-01-16 05:30:52 +00:00
BindableProperty.Create(nameof(CornerRadius), typeof(double), typeof(SkiaBorder), 0.0,
BindingMode.TwoWay, propertyChanged: (b, o, n) => ((SkiaBorder)b).Invalidate());
public static readonly BindableProperty StrokeProperty =
2026-01-16 05:30:52 +00:00
BindableProperty.Create(nameof(Stroke), typeof(Color), typeof(SkiaBorder), Colors.Black,
BindingMode.TwoWay, propertyChanged: (b, o, n) => ((SkiaBorder)b).Invalidate());
2026-01-16 05:30:52 +00:00
public static readonly BindableProperty BorderPaddingProperty =
BindableProperty.Create(nameof(BorderPadding), typeof(Thickness), typeof(SkiaBorder), new Thickness(0),
BindingMode.TwoWay, propertyChanged: (b, o, n) => ((SkiaBorder)b).InvalidateMeasure());
public static readonly BindableProperty HasShadowProperty =
BindableProperty.Create(nameof(HasShadow), typeof(bool), typeof(SkiaBorder), false,
BindingMode.TwoWay, propertyChanged: (b, o, n) => ((SkiaBorder)b).Invalidate());
public static readonly BindableProperty ShadowColorProperty =
2026-01-16 05:30:52 +00:00
BindableProperty.Create(nameof(ShadowColor), typeof(Color), typeof(SkiaBorder), Color.FromRgba(0, 0, 0, 40),
BindingMode.TwoWay, propertyChanged: (b, o, n) => ((SkiaBorder)b).Invalidate());
public static readonly BindableProperty ShadowBlurRadiusProperty =
2026-01-16 05:30:52 +00:00
BindableProperty.Create(nameof(ShadowBlurRadius), typeof(double), typeof(SkiaBorder), 4.0,
BindingMode.TwoWay, propertyChanged: (b, o, n) => ((SkiaBorder)b).Invalidate());
public static readonly BindableProperty ShadowOffsetXProperty =
2026-01-16 05:30:52 +00:00
BindableProperty.Create(nameof(ShadowOffsetX), typeof(double), typeof(SkiaBorder), 2.0,
BindingMode.TwoWay, propertyChanged: (b, o, n) => ((SkiaBorder)b).Invalidate());
public static readonly BindableProperty ShadowOffsetYProperty =
2026-01-16 05:30:52 +00:00
BindableProperty.Create(nameof(ShadowOffsetY), typeof(double), typeof(SkiaBorder), 2.0,
BindingMode.TwoWay, propertyChanged: (b, o, n) => ((SkiaBorder)b).Invalidate());
2026-01-16 05:49:20 +00:00
public static readonly BindableProperty StrokeShapeProperty =
BindableProperty.Create(nameof(StrokeShape), typeof(IShape), typeof(SkiaBorder), null,
BindingMode.TwoWay, propertyChanged: (b, o, n) => ((SkiaBorder)b).Invalidate());
public static readonly BindableProperty StrokeDashArrayProperty =
BindableProperty.Create(nameof(StrokeDashArray), typeof(DoubleCollection), typeof(SkiaBorder), null,
BindingMode.TwoWay, propertyChanged: (b, o, n) => ((SkiaBorder)b).Invalidate());
public static readonly BindableProperty StrokeDashOffsetProperty =
BindableProperty.Create(nameof(StrokeDashOffset), typeof(double), typeof(SkiaBorder), 0.0,
BindingMode.TwoWay, propertyChanged: (b, o, n) => ((SkiaBorder)b).Invalidate());
public static readonly BindableProperty StrokeLineCapProperty =
BindableProperty.Create(nameof(StrokeLineCap), typeof(LineCap), typeof(SkiaBorder), LineCap.Butt,
BindingMode.TwoWay, propertyChanged: (b, o, n) => ((SkiaBorder)b).Invalidate());
public static readonly BindableProperty StrokeLineJoinProperty =
BindableProperty.Create(nameof(StrokeLineJoin), typeof(LineJoin), typeof(SkiaBorder), LineJoin.Miter,
BindingMode.TwoWay, propertyChanged: (b, o, n) => ((SkiaBorder)b).Invalidate());
public static readonly BindableProperty StrokeMiterLimitProperty =
BindableProperty.Create(nameof(StrokeMiterLimit), typeof(double), typeof(SkiaBorder), 10.0,
BindingMode.TwoWay, propertyChanged: (b, o, n) => ((SkiaBorder)b).Invalidate());
#endregion
private bool _isPressed;
#region Properties
2026-01-16 05:30:52 +00:00
public double StrokeThickness
{
2026-01-16 05:30:52 +00:00
get => (double)GetValue(StrokeThicknessProperty);
set => SetValue(StrokeThicknessProperty, value);
}
2026-01-16 05:30:52 +00:00
public double CornerRadius
{
2026-01-16 05:30:52 +00:00
get => (double)GetValue(CornerRadiusProperty);
set => SetValue(CornerRadiusProperty, value);
}
2026-01-16 05:30:52 +00:00
public Color Stroke
{
2026-01-16 05:30:52 +00:00
get => (Color)GetValue(StrokeProperty);
set => SetValue(StrokeProperty, value);
}
2026-01-16 05:30:52 +00:00
public Thickness BorderPadding
{
2026-01-16 05:30:52 +00:00
get => (Thickness)GetValue(BorderPaddingProperty);
set => SetValue(BorderPaddingProperty, value);
}
2026-01-16 05:30:52 +00:00
// Convenience properties for backward compatibility
public double PaddingLeft
{
2026-01-16 05:30:52 +00:00
get => BorderPadding.Left;
set => BorderPadding = new Thickness(value, BorderPadding.Top, BorderPadding.Right, BorderPadding.Bottom);
}
2026-01-16 05:30:52 +00:00
public double PaddingTop
{
2026-01-16 05:30:52 +00:00
get => BorderPadding.Top;
set => BorderPadding = new Thickness(BorderPadding.Left, value, BorderPadding.Right, BorderPadding.Bottom);
}
2026-01-16 05:30:52 +00:00
public double PaddingRight
{
2026-01-16 05:30:52 +00:00
get => BorderPadding.Right;
set => BorderPadding = new Thickness(BorderPadding.Left, BorderPadding.Top, value, BorderPadding.Bottom);
}
public double PaddingBottom
{
get => BorderPadding.Bottom;
set => BorderPadding = new Thickness(BorderPadding.Left, BorderPadding.Top, BorderPadding.Right, value);
}
public bool HasShadow
{
get => (bool)GetValue(HasShadowProperty);
set => SetValue(HasShadowProperty, value);
}
2026-01-16 05:30:52 +00:00
public Color ShadowColor
{
2026-01-16 05:30:52 +00:00
get => (Color)GetValue(ShadowColorProperty);
set => SetValue(ShadowColorProperty, value);
}
2026-01-16 05:30:52 +00:00
public double ShadowBlurRadius
{
2026-01-16 05:30:52 +00:00
get => (double)GetValue(ShadowBlurRadiusProperty);
set => SetValue(ShadowBlurRadiusProperty, value);
}
2026-01-16 05:30:52 +00:00
public double ShadowOffsetX
{
2026-01-16 05:30:52 +00:00
get => (double)GetValue(ShadowOffsetXProperty);
set => SetValue(ShadowOffsetXProperty, value);
}
2026-01-16 05:30:52 +00:00
public double ShadowOffsetY
{
2026-01-16 05:30:52 +00:00
get => (double)GetValue(ShadowOffsetYProperty);
set => SetValue(ShadowOffsetYProperty, value);
}
2026-01-16 05:49:20 +00:00
/// <summary>
/// Gets or sets the shape of the border stroke (Rectangle, RoundRectangle, Ellipse, etc.).
/// </summary>
public IShape? StrokeShape
{
get => (IShape?)GetValue(StrokeShapeProperty);
set => SetValue(StrokeShapeProperty, value);
}
/// <summary>
/// Gets or sets the dash pattern for the stroke.
/// </summary>
public DoubleCollection? StrokeDashArray
{
get => (DoubleCollection?)GetValue(StrokeDashArrayProperty);
set => SetValue(StrokeDashArrayProperty, value);
}
/// <summary>
/// Gets or sets the offset into the dash pattern.
/// </summary>
public double StrokeDashOffset
{
get => (double)GetValue(StrokeDashOffsetProperty);
set => SetValue(StrokeDashOffsetProperty, value);
}
/// <summary>
/// Gets or sets the cap style for the stroke line ends.
/// </summary>
public LineCap StrokeLineCap
{
get => (LineCap)GetValue(StrokeLineCapProperty);
set => SetValue(StrokeLineCapProperty, value);
}
/// <summary>
/// Gets or sets the join style for stroke corners.
/// </summary>
public LineJoin StrokeLineJoin
{
get => (LineJoin)GetValue(StrokeLineJoinProperty);
set => SetValue(StrokeLineJoinProperty, value);
}
/// <summary>
/// Gets or sets the miter limit for stroke joins.
/// </summary>
public double StrokeMiterLimit
{
get => (double)GetValue(StrokeMiterLimitProperty);
set => SetValue(StrokeMiterLimitProperty, value);
}
#endregion
#region Events
public event EventHandler? Tapped;
#endregion
2026-01-16 05:30:52 +00:00
#region Helper Methods
/// <summary>
/// Converts a MAUI Color to SkiaSharp SKColor.
/// </summary>
private static SKColor ToSKColor(Color? color)
{
if (color == null) return SKColors.Transparent;
2026-01-17 03:36:37 +00:00
return color.ToSKColor();
2026-01-16 05:30:52 +00:00
}
#endregion
#region SetPadding Methods
/// <summary>
/// Sets uniform padding on all sides.
/// </summary>
2026-01-16 05:30:52 +00:00
public void SetPadding(double all)
{
2026-01-16 05:30:52 +00:00
BorderPadding = new Thickness(all);
}
/// <summary>
/// Sets padding with horizontal and vertical values.
/// </summary>
2026-01-16 05:30:52 +00:00
public void SetPadding(double horizontal, double vertical)
{
2026-01-16 05:30:52 +00:00
BorderPadding = new Thickness(horizontal, vertical);
}
/// <summary>
/// Sets padding with individual values for each side.
/// </summary>
2026-01-16 05:30:52 +00:00
public void SetPadding(double left, double top, double right, double bottom)
{
2026-01-16 05:30:52 +00:00
BorderPadding = new Thickness(left, top, right, bottom);
}
#endregion
2026-01-16 05:30:52 +00:00
#region Drawing
2026-01-16 05:49:20 +00:00
/// <summary>
/// Converts LineCap to SKStrokeCap.
/// </summary>
private static SKStrokeCap ToSKStrokeCap(LineCap lineCap)
{
return lineCap switch
{
LineCap.Round => SKStrokeCap.Round,
LineCap.Square => SKStrokeCap.Square,
_ => SKStrokeCap.Butt
};
}
/// <summary>
/// Converts LineJoin to SKStrokeJoin.
/// </summary>
private static SKStrokeJoin ToSKStrokeJoin(LineJoin lineJoin)
{
return lineJoin switch
{
LineJoin.Round => SKStrokeJoin.Round,
LineJoin.Bevel => SKStrokeJoin.Bevel,
_ => SKStrokeJoin.Miter
};
}
/// <summary>
/// Creates an SKPath for the border based on StrokeShape.
/// </summary>
private SKPath CreateShapePath(SKRect rect, float defaultCornerRadius)
{
var path = new SKPath();
if (StrokeShape is RoundRectangle roundRect)
{
// Use RoundRectangle's corner radii
var cr = roundRect.CornerRadius;
var radii = new SKPoint[]
{
new SKPoint((float)cr.TopLeft, (float)cr.TopLeft),
new SKPoint((float)cr.TopRight, (float)cr.TopRight),
new SKPoint((float)cr.BottomRight, (float)cr.BottomRight),
new SKPoint((float)cr.BottomLeft, (float)cr.BottomLeft)
};
var skRoundRect = new SKRoundRect();
skRoundRect.SetRectRadii(rect, radii);
path.AddRoundRect(skRoundRect);
}
else if (StrokeShape is Ellipse)
{
path.AddOval(rect);
}
else if (StrokeShape is Rectangle)
{
path.AddRect(rect);
}
else
{
// Default: use CornerRadius property
if (defaultCornerRadius > 0)
{
path.AddRoundRect(rect, defaultCornerRadius, defaultCornerRadius);
}
else
{
path.AddRect(rect);
}
}
return path;
}
protected override void OnDraw(SKCanvas canvas, SKRect bounds)
{
2026-01-16 05:30:52 +00:00
float strokeThickness = (float)StrokeThickness;
float cornerRadius = (float)CornerRadius;
var borderRect = new SKRect(
bounds.Left + strokeThickness / 2f,
bounds.Top + strokeThickness / 2f,
bounds.Right - strokeThickness / 2f,
bounds.Bottom - strokeThickness / 2f);
2026-01-16 05:49:20 +00:00
// Create the shape path
using var shapePath = CreateShapePath(borderRect, cornerRadius);
// Draw shadow if enabled
if (HasShadow)
{
using var shadowPaint = new SKPaint
{
2026-01-16 05:30:52 +00:00
Color = ToSKColor(ShadowColor),
MaskFilter = SKMaskFilter.CreateBlur(SKBlurStyle.Normal, (float)ShadowBlurRadius),
Style = SKPaintStyle.Fill
};
2026-01-16 05:49:20 +00:00
canvas.Save();
canvas.Translate((float)ShadowOffsetX, (float)ShadowOffsetY);
canvas.DrawPath(shapePath, shadowPaint);
canvas.Restore();
}
// Draw background
using var bgPaint = new SKPaint
{
2026-01-17 03:10:29 +00:00
Color = GetEffectiveBackgroundColor(),
Style = SKPaintStyle.Fill,
IsAntialias = true
};
2026-01-16 05:49:20 +00:00
canvas.DrawPath(shapePath, bgPaint);
// Draw border
if (strokeThickness > 0f)
{
using var borderPaint = new SKPaint
{
2026-01-16 05:30:52 +00:00
Color = ToSKColor(Stroke),
Style = SKPaintStyle.Stroke,
StrokeWidth = strokeThickness,
2026-01-16 05:49:20 +00:00
IsAntialias = true,
StrokeCap = ToSKStrokeCap(StrokeLineCap),
StrokeJoin = ToSKStrokeJoin(StrokeLineJoin),
StrokeMiter = (float)StrokeMiterLimit
};
2026-01-16 05:49:20 +00:00
// Apply dash pattern if specified
if (StrokeDashArray != null && StrokeDashArray.Count > 0)
{
var dashArray = new float[StrokeDashArray.Count];
for (int i = 0; i < StrokeDashArray.Count; i++)
{
dashArray[i] = (float)(StrokeDashArray[i] * strokeThickness);
}
borderPaint.PathEffect = SKPathEffect.CreateDash(dashArray, (float)(StrokeDashOffset * strokeThickness));
}
canvas.DrawPath(shapePath, borderPaint);
}
// Draw children
foreach (var child in Children)
{
if (child.IsVisible)
{
child.Draw(canvas);
}
}
}
2026-01-16 05:30:52 +00:00
#endregion
#region Layout
protected override SKRect GetContentBounds()
{
return GetContentBounds(Bounds);
}
protected new SKRect GetContentBounds(SKRect bounds)
{
2026-01-16 05:30:52 +00:00
float strokeThickness = (float)StrokeThickness;
var padding = BorderPadding;
return new SKRect(
2026-01-16 05:30:52 +00:00
bounds.Left + (float)padding.Left + strokeThickness,
bounds.Top + (float)padding.Top + strokeThickness,
bounds.Right - (float)padding.Right - strokeThickness,
bounds.Bottom - (float)padding.Bottom - strokeThickness);
}
protected override SKSize MeasureOverride(SKSize availableSize)
{
2026-01-16 05:30:52 +00:00
float strokeThickness = (float)StrokeThickness;
var padding = BorderPadding;
float paddingWidth = (float)(padding.Left + padding.Right) + strokeThickness * 2f;
float paddingHeight = (float)(padding.Top + padding.Bottom) + strokeThickness * 2f;
// Respect explicit size requests
var requestedWidth = WidthRequest >= 0.0 ? (float)WidthRequest : availableSize.Width;
var requestedHeight = HeightRequest >= 0.0 ? (float)HeightRequest : availableSize.Height;
var childAvailable = new SKSize(
Math.Max(0f, requestedWidth - paddingWidth),
Math.Max(0f, requestedHeight - paddingHeight));
var maxChildSize = SKSize.Empty;
foreach (var child in Children)
{
var childSize = child.Measure(childAvailable);
maxChildSize = new SKSize(
Math.Max(maxChildSize.Width, childSize.Width),
Math.Max(maxChildSize.Height, childSize.Height));
}
// Use requested size if set, otherwise use child size + padding
var width = WidthRequest >= 0.0 ? (float)WidthRequest : maxChildSize.Width + paddingWidth;
var height = HeightRequest >= 0.0 ? (float)HeightRequest : maxChildSize.Height + paddingHeight;
return new SKSize(width, height);
}
protected override SKRect ArrangeOverride(SKRect bounds)
{
var contentBounds = GetContentBounds(bounds);
foreach (var child in Children)
{
// Apply child's margin
var margin = child.Margin;
var marginedBounds = new SKRect(
contentBounds.Left + (float)margin.Left,
contentBounds.Top + (float)margin.Top,
contentBounds.Right - (float)margin.Right,
contentBounds.Bottom - (float)margin.Bottom);
child.Arrange(marginedBounds);
}
return bounds;
}
2026-01-16 05:30:52 +00:00
#endregion
#region Input Handling
private bool HasTapGestureRecognizers()
{
if (MauiView?.GestureRecognizers == null)
{
return false;
}
foreach (var gestureRecognizer in MauiView.GestureRecognizers)
{
if (gestureRecognizer is TapGestureRecognizer)
{
return true;
}
}
return false;
}
public override SkiaView? HitTest(float x, float y)
{
if (IsVisible && IsEnabled)
{
var bounds = Bounds;
if (bounds.Contains(new SKPoint(x, y)))
{
if (HasTapGestureRecognizers())
{
return this;
}
return base.HitTest(x, y);
}
}
return null;
}
public override void OnPointerPressed(PointerEventArgs e)
{
if (HasTapGestureRecognizers())
{
_isPressed = true;
e.Handled = true;
if (MauiView != null)
{
GestureManager.ProcessPointerDown(MauiView, e.X, e.Y);
}
}
else
{
base.OnPointerPressed(e);
}
}
public override void OnPointerReleased(PointerEventArgs e)
{
if (_isPressed)
{
_isPressed = false;
e.Handled = true;
if (MauiView != null)
{
GestureManager.ProcessPointerUp(MauiView, e.X, e.Y);
}
Tapped?.Invoke(this, EventArgs.Empty);
}
else
{
base.OnPointerReleased(e);
}
}
public override void OnPointerExited(PointerEventArgs e)
{
base.OnPointerExited(e);
_isPressed = false;
}
2026-01-16 05:30:52 +00:00
#endregion
}