feat: ensure TinyPagination invokes command.

This commit is contained in:
rabbitism
2024-08-10 13:45:38 +08:00
parent 378c5b0200
commit d5fc912a5d
2 changed files with 162 additions and 178 deletions

View File

@@ -52,6 +52,7 @@
</ControlTheme> </ControlTheme>
<ControlTheme x:Key="TinyPagination" TargetType="{x:Type u:Pagination}"> <ControlTheme x:Key="TinyPagination" TargetType="{x:Type u:Pagination}">
<Setter Property="DisplayCurrentPageInQuickJumper" Value="True"></Setter>
<Setter Property="Template"> <Setter Property="Template">
<ControlTemplate TargetType="u:Pagination"> <ControlTemplate TargetType="u:Pagination">
<StackPanel Orientation="Horizontal"> <StackPanel Orientation="Horizontal">
@@ -64,7 +65,7 @@
</u:PaginationButton> </u:PaginationButton>
<Grid ColumnDefinitions="*, Auto, *"> <Grid ColumnDefinitions="*, Auto, *">
<u:NumericIntUpDown <u:NumericIntUpDown
Name="PART_PageInput" Name="{x:Static u:Pagination.PART_QuickJumpInput}"
Grid.Column="0" Grid.Column="0"
MinWidth="{Binding $self.Bounds.Height}" MinWidth="{Binding $self.Bounds.Height}"
VerticalAlignment="Center" VerticalAlignment="Center"
@@ -102,7 +103,7 @@
<Style Selector="^.ReadOnly /template/ TextBlock#PART_PageTextBlock"> <Style Selector="^.ReadOnly /template/ TextBlock#PART_PageTextBlock">
<Setter Property="IsVisible" Value="True" /> <Setter Property="IsVisible" Value="True" />
</Style> </Style>
<Style Selector="^.ReadOnly /template/ u|NumericUpDown#PART_PageInput"> <Style Selector="^.ReadOnly /template/ u|NumericUpDown#PART_QuickJumpInput">
<Setter Property="IsVisible" Value="False" /> <Setter Property="IsVisible" Value="False" />
</Style> </Style>
</ControlTheme> </ControlTheme>

View File

@@ -1,3 +1,4 @@
using System.Windows.Input;
using Avalonia; using Avalonia;
using Avalonia.Collections; using Avalonia.Collections;
using Avalonia.Controls; using Avalonia.Controls;
@@ -7,165 +8,75 @@ using Avalonia.Input;
using Avalonia.Interactivity; using Avalonia.Interactivity;
using Avalonia.Styling; using Avalonia.Styling;
using Irihi.Avalonia.Shared.Helpers; using Irihi.Avalonia.Shared.Helpers;
using System.Windows.Input;
namespace Ursa.Controls; namespace Ursa.Controls;
/// <summary> /// <summary>
/// Pagination is a control that displays a series of buttons that can be used to navigate to pages. /// Pagination is a control that displays a series of buttons that can be used to navigate to pages.
/// CurrentPage starts from 1. /// CurrentPage starts from 1.
/// Pagination only stores an approximate index internally. /// Pagination only stores an approximate index internally.
/// </summary> /// </summary>
[TemplatePart(PART_PreviousButton, typeof(PaginationButton))] [TemplatePart(PART_PreviousButton, typeof(PaginationButton))]
[TemplatePart(PART_NextButton, typeof(PaginationButton))] [TemplatePart(PART_NextButton, typeof(PaginationButton))]
[TemplatePart(PART_ButtonPanel, typeof(StackPanel))] [TemplatePart(PART_ButtonPanel, typeof(StackPanel))]
[TemplatePart(PART_QuickJumpInput, typeof(NumericIntUpDown))] [TemplatePart(PART_QuickJumpInput, typeof(NumericIntUpDown))]
public class Pagination: TemplatedControl public class Pagination : TemplatedControl
{ {
public const string PART_PreviousButton = "PART_PreviousButton"; public const string PART_PreviousButton = "PART_PreviousButton";
public const string PART_NextButton = "PART_NextButton"; public const string PART_NextButton = "PART_NextButton";
public const string PART_ButtonPanel = "PART_ButtonPanel"; public const string PART_ButtonPanel = "PART_ButtonPanel";
public const string PART_QuickJumpInput = "PART_QuickJumpInput"; public const string PART_QuickJumpInput = "PART_QuickJumpInput";
private PaginationButton? _previousButton;
private PaginationButton? _nextButton;
private StackPanel? _buttonPanel;
private readonly PaginationButton[] _buttons = new PaginationButton[7];
private NumericIntUpDown? _quickJumpInput;
public static readonly StyledProperty<int?> CurrentPageProperty = AvaloniaProperty.Register<Pagination, int?>( public static readonly StyledProperty<int?> CurrentPageProperty = AvaloniaProperty.Register<Pagination, int?>(
nameof(CurrentPage) , coerce: CoerceCurrentPage); nameof(CurrentPage), coerce: CoerceCurrentPage);
public int? CurrentPage
{
get => GetValue(CurrentPageProperty);
set => SetValue(CurrentPageProperty, value);
}
private static int? CoerceCurrentPage(AvaloniaObject arg1, int? arg2)
{
if (arg2 is null) return null;
if (arg1 is Pagination p)
{
arg2 = MathHelpers.SafeClamp(arg2.Value, 1, p.PageCount);
}
return arg2;
}
private void OnCurrentPageChanged(AvaloniaPropertyChangedEventArgs<int?> args)
{
int? oldValue = args.GetOldValue<int?>();
int? newValue = args.GetNewValue<int?>();
var e = new ValueChangedEventArgs<int>(CurrentPageChangedEvent, oldValue, newValue);
RaiseEvent(e);
}
public static readonly RoutedEvent<ValueChangedEventArgs<int>> CurrentPageChangedEvent = public static readonly RoutedEvent<ValueChangedEventArgs<int>> CurrentPageChangedEvent =
RoutedEvent.Register<Pagination, ValueChangedEventArgs<int>>(nameof(CurrentPageChanged), RoutingStrategies.Bubble); RoutedEvent.Register<Pagination, ValueChangedEventArgs<int>>(nameof(CurrentPageChanged),
RoutingStrategies.Bubble);
/// <summary>
/// Raised when the <see cref="CurrentPage"/> changes.
/// </summary>
public event EventHandler<ValueChangedEventArgs<int>>? CurrentPageChanged
{
add => AddHandler(CurrentPageChangedEvent, value);
remove => RemoveHandler(CurrentPageChangedEvent, value);
}
public static readonly StyledProperty<ICommand?> CommandProperty = AvaloniaProperty.Register<Pagination, ICommand?>( public static readonly StyledProperty<ICommand?> CommandProperty = AvaloniaProperty.Register<Pagination, ICommand?>(
nameof(Command)); nameof(Command));
public ICommand? Command public static readonly StyledProperty<object?> CommandParameterProperty =
{ AvaloniaProperty.Register<Pagination, object?>(nameof(CommandParameter));
get => GetValue(CommandProperty);
set => SetValue(CommandProperty, value);
}
public static readonly StyledProperty<object?> CommandParameterProperty = AvaloniaProperty.Register<Pagination, object?>(nameof(CommandParameter));
public object? CommandParameter
{
get => this.GetValue(CommandParameterProperty);
set => this.SetValue(CommandParameterProperty, value);
}
public static readonly StyledProperty<int> TotalCountProperty = AvaloniaProperty.Register<Pagination, int>( public static readonly StyledProperty<int> TotalCountProperty = AvaloniaProperty.Register<Pagination, int>(
nameof(TotalCount)); nameof(TotalCount));
/// <summary>
/// Total count of items.
/// </summary>
public int TotalCount
{
get => GetValue(TotalCountProperty);
set => SetValue(TotalCountProperty, value);
}
public static readonly StyledProperty<int> PageSizeProperty = AvaloniaProperty.Register<Pagination, int>( public static readonly StyledProperty<int> PageSizeProperty = AvaloniaProperty.Register<Pagination, int>(
nameof(PageSize), defaultValue: 10); nameof(PageSize), 10);
/// <summary>
/// Page size.
/// </summary>
public int PageSize
{
get => GetValue(PageSizeProperty);
set => SetValue(PageSizeProperty, value);
}
private int _pageCount;
public static readonly DirectProperty<Pagination, int> PageCountProperty = public static readonly DirectProperty<Pagination, int> PageCountProperty =
AvaloniaProperty.RegisterDirect<Pagination, int>( AvaloniaProperty.RegisterDirect<Pagination, int>(
nameof(PageCount), o => o.PageCount, (o, e) => o.PageCount = e); nameof(PageCount), o => o.PageCount, (o, e) => o.PageCount = e);
/// <summary> public static readonly StyledProperty<AvaloniaList<int>> PageSizeOptionsProperty =
/// Page count. AvaloniaProperty.Register<Pagination, AvaloniaList<int>>(
/// </summary> nameof(PageSizeOptions));
public int PageCount
{
get => _pageCount;
private set => SetAndRaise(PageCountProperty, ref _pageCount, value);
}
public static readonly StyledProperty<AvaloniaList<int>> PageSizeOptionsProperty = AvaloniaProperty.Register<Pagination, AvaloniaList<int>>( public static readonly StyledProperty<ControlTheme> PageButtonThemeProperty =
nameof(PageSizeOptions)); AvaloniaProperty.Register<Pagination, ControlTheme>(
nameof(PageButtonTheme));
public AvaloniaList<int> PageSizeOptions public static readonly StyledProperty<bool> ShowPageSizeSelectorProperty =
{ AvaloniaProperty.Register<Pagination, bool>(
get => GetValue(PageSizeOptionsProperty); nameof(ShowPageSizeSelector));
set => SetValue(PageSizeOptionsProperty, value);
}
public static readonly StyledProperty<ControlTheme> PageButtonThemeProperty = AvaloniaProperty.Register<Pagination, ControlTheme>(
nameof(PageButtonTheme));
public ControlTheme PageButtonTheme
{
get => GetValue(PageButtonThemeProperty);
set => SetValue(PageButtonThemeProperty, value);
}
public static readonly StyledProperty<bool> ShowPageSizeSelectorProperty = AvaloniaProperty.Register<Pagination, bool>(
nameof(ShowPageSizeSelector));
public bool ShowPageSizeSelector
{
get => GetValue(ShowPageSizeSelectorProperty);
set => SetValue(ShowPageSizeSelectorProperty, value);
}
public static readonly StyledProperty<bool> ShowQuickJumpProperty = AvaloniaProperty.Register<Pagination, bool>( public static readonly StyledProperty<bool> ShowQuickJumpProperty = AvaloniaProperty.Register<Pagination, bool>(
nameof(ShowQuickJump)); nameof(ShowQuickJump));
public bool ShowQuickJump private readonly PaginationButton[] _buttons = new PaginationButton[7];
{ private StackPanel? _buttonPanel;
get => GetValue(ShowQuickJumpProperty); private PaginationButton? _nextButton;
set => SetValue(ShowQuickJumpProperty, value);
} private int _pageCount;
private PaginationButton? _previousButton;
private NumericIntUpDown? _quickJumpInput;
static Pagination() static Pagination()
{ {
PageSizeProperty.Changed.AddClassHandler<Pagination, int>((pagination, args) => pagination.OnPageSizeChanged(args)); PageSizeProperty.Changed.AddClassHandler<Pagination, int>((pagination, args) =>
pagination.OnPageSizeChanged(args));
CurrentPageProperty.Changed.AddClassHandler<Pagination, int?>((pagination, args) => CurrentPageProperty.Changed.AddClassHandler<Pagination, int?>((pagination, args) =>
pagination.UpdateButtonsByCurrentPage(args.NewValue.Value)); pagination.UpdateButtonsByCurrentPage(args.NewValue.Value));
CurrentPageProperty.Changed.AddClassHandler<Pagination, int?>((pagination, args) => CurrentPageProperty.Changed.AddClassHandler<Pagination, int?>((pagination, args) =>
@@ -174,19 +85,119 @@ public class Pagination: TemplatedControl
pagination.UpdateButtonsByCurrentPage(pagination.CurrentPage)); pagination.UpdateButtonsByCurrentPage(pagination.CurrentPage));
} }
public int? CurrentPage
{
get => GetValue(CurrentPageProperty);
set => SetValue(CurrentPageProperty, value);
}
public ICommand? Command
{
get => GetValue(CommandProperty);
set => SetValue(CommandProperty, value);
}
public object? CommandParameter
{
get => GetValue(CommandParameterProperty);
set => SetValue(CommandParameterProperty, value);
}
/// <summary>
/// Total count of items.
/// </summary>
public int TotalCount
{
get => GetValue(TotalCountProperty);
set => SetValue(TotalCountProperty, value);
}
/// <summary>
/// Page size.
/// </summary>
public int PageSize
{
get => GetValue(PageSizeProperty);
set => SetValue(PageSizeProperty, value);
}
/// <summary>
/// Page count.
/// </summary>
public int PageCount
{
get => _pageCount;
private set => SetAndRaise(PageCountProperty, ref _pageCount, value);
}
public AvaloniaList<int> PageSizeOptions
{
get => GetValue(PageSizeOptionsProperty);
set => SetValue(PageSizeOptionsProperty, value);
}
public ControlTheme PageButtonTheme
{
get => GetValue(PageButtonThemeProperty);
set => SetValue(PageButtonThemeProperty, value);
}
public bool ShowPageSizeSelector
{
get => GetValue(ShowPageSizeSelectorProperty);
set => SetValue(ShowPageSizeSelectorProperty, value);
}
public bool ShowQuickJump
{
get => GetValue(ShowQuickJumpProperty);
set => SetValue(ShowQuickJumpProperty, value);
}
public static readonly StyledProperty<bool> DisplayCurrentPageInQuickJumperProperty = AvaloniaProperty.Register<Pagination, bool>(
nameof(DisplayCurrentPageInQuickJumper));
public bool DisplayCurrentPageInQuickJumper
{
get => GetValue(DisplayCurrentPageInQuickJumperProperty);
set => SetValue(DisplayCurrentPageInQuickJumperProperty, value);
}
private static int? CoerceCurrentPage(AvaloniaObject arg1, int? arg2)
{
if (arg2 is null) return null;
if (arg1 is Pagination p) arg2 = MathHelpers.SafeClamp(arg2.Value, 1, p.PageCount);
return arg2;
}
private void OnCurrentPageChanged(AvaloniaPropertyChangedEventArgs<int?> args)
{
var oldValue = args.GetOldValue<int?>();
var newValue = args.GetNewValue<int?>();
var e = new ValueChangedEventArgs<int>(CurrentPageChangedEvent, oldValue, newValue);
if (DisplayCurrentPageInQuickJumper)
{
_quickJumpInput?.SetCurrentValue(NumericIntUpDown.ValueProperty, newValue);
}
RaiseEvent(e);
}
/// <summary>
/// Raised when the <see cref="CurrentPage" /> changes.
/// </summary>
public event EventHandler<ValueChangedEventArgs<int>>? CurrentPageChanged
{
add => AddHandler(CurrentPageChangedEvent, value);
remove => RemoveHandler(CurrentPageChangedEvent, value);
}
private void OnPageSizeChanged(AvaloniaPropertyChangedEventArgs<int> args) private void OnPageSizeChanged(AvaloniaPropertyChangedEventArgs<int> args)
{ {
int pageCount = TotalCount / args.NewValue.Value; var pageCount = TotalCount / args.NewValue.Value;
int residue = TotalCount % args.NewValue.Value; var residue = TotalCount % args.NewValue.Value;
if (residue > 0) if (residue > 0) pageCount++;
{
pageCount++;
}
PageCount = pageCount; PageCount = pageCount;
if (CurrentPage > PageCount) if (CurrentPage > PageCount) CurrentPage = null;
{
CurrentPage = null;
}
UpdateButtonsByCurrentPage(CurrentPage); UpdateButtonsByCurrentPage(CurrentPage);
} }
@@ -212,10 +223,7 @@ public class Pagination: TemplatedControl
private void OnQuickJumpInputKeyDown(object? sender, KeyEventArgs e) private void OnQuickJumpInputKeyDown(object? sender, KeyEventArgs e)
{ {
if (e.Key is Key.Enter or Key.Return) if (e.Key is Key.Enter or Key.Return) SyncQuickJumperValue();
{
SyncQuickJumperValue();
}
} }
private void OnQuickJumpInputLostFocus(object? sender, RoutedEventArgs e) private void OnQuickJumpInputLostFocus(object? sender, RoutedEventArgs e)
@@ -230,7 +238,10 @@ public class Pagination: TemplatedControl
if (value is null) return; if (value is null) return;
value = Clamp(value.Value, 1, PageCount); value = Clamp(value.Value, 1, PageCount);
SetCurrentValue(CurrentPageProperty, value); SetCurrentValue(CurrentPageProperty, value);
_quickJumpInput?.SetCurrentValue(NumericIntUpDown.ValueProperty, null); if (!DisplayCurrentPageInQuickJumper)
{
_quickJumpInput?.SetCurrentValue(NumericIntUpDown.ValueProperty, null);
}
InvokeCommand(); InvokeCommand();
} }
@@ -245,9 +256,9 @@ public class Pagination: TemplatedControl
{ {
if (_buttonPanel is null) return; if (_buttonPanel is null) return;
_buttonPanel.Children.Clear(); _buttonPanel.Children.Clear();
for (int i = 1; i <= 7; i++) for (var i = 1; i <= 7; i++)
{ {
var button = new PaginationButton() { Page = i, IsVisible = true }; var button = new PaginationButton { Page = i, IsVisible = true };
_buttonPanel.Children.Add(button); _buttonPanel.Children.Add(button);
_buttons[i - 1] = button; _buttons[i - 1] = button;
Button.ClickEvent.AddHandler(OnPageButtonClick, button); Button.ClickEvent.AddHandler(OnPageButtonClick, button);
@@ -259,24 +270,19 @@ public class Pagination: TemplatedControl
if (sender is PaginationButton pageButton) if (sender is PaginationButton pageButton)
{ {
if (pageButton.IsFastForward) if (pageButton.IsFastForward)
{
AddCurrentPage(-5); AddCurrentPage(-5);
}
else if (pageButton.IsFastBackward) else if (pageButton.IsFastBackward)
{
AddCurrentPage(5); AddCurrentPage(5);
}
else else
{
CurrentPage = pageButton.Page; CurrentPage = pageButton.Page;
}
} }
InvokeCommand(); InvokeCommand();
} }
private void AddCurrentPage(int pageChange) private void AddCurrentPage(int pageChange)
{ {
int newValue = (CurrentPage ?? 0) + pageChange; var newValue = (CurrentPage ?? 0) + pageChange;
newValue = Clamp(newValue, 1, PageCount); newValue = Clamp(newValue, 1, PageCount);
SetCurrentValue(CurrentPageProperty, newValue); SetCurrentValue(CurrentPageProperty, newValue);
} }
@@ -287,29 +293,26 @@ public class Pagination: TemplatedControl
} }
/// <summary> /// <summary>
/// Update Button Content and Visibility by current page. /// Update Button Content and Visibility by current page.
/// </summary> /// </summary>
/// <param name="page"></param> /// <param name="page"></param>
private void UpdateButtonsByCurrentPage(int? page) private void UpdateButtonsByCurrentPage(int? page)
{ {
if (PageSize == 0) return; if (PageSize == 0) return;
int pageCount = TotalCount / PageSize; var pageCount = TotalCount / PageSize;
if (_buttonPanel is null) if (_buttonPanel is null)
{ {
SetCurrentValue(PageCountProperty, pageCount); SetCurrentValue(PageCountProperty, pageCount);
return; return;
} }
int? currentPage = CurrentPage;
int residue = TotalCount % PageSize; var currentPage = CurrentPage;
if (residue > 0) var residue = TotalCount % PageSize;
{ if (residue > 0) pageCount++;
pageCount++;
}
if (pageCount <= 7) if (pageCount <= 7)
{ {
for (int i = 0; i < 7; i++) for (var i = 0; i < 7; i++)
{
if (i < pageCount) if (i < pageCount)
{ {
_buttons[i].IsVisible = true; _buttons[i].IsVisible = true;
@@ -319,15 +322,11 @@ public class Pagination: TemplatedControl
{ {
_buttons[i].IsVisible = false; _buttons[i].IsVisible = false;
} }
}
} }
else else
{ {
for (int i = 0; i < 7; i++) for (var i = 0; i < 7; i++) _buttons[i].IsVisible = true;
{ var mid = currentPage ?? 0;
_buttons[i].IsVisible = true;
}
int mid = currentPage ?? 0;
mid = Clamp(mid, 4, pageCount - 3); mid = Clamp(mid, 4, pageCount - 3);
_buttons[3].Page = mid; _buttons[3].Page = mid;
_buttons[2].Page = mid - 1; _buttons[2].Page = mid - 1;
@@ -335,33 +334,19 @@ public class Pagination: TemplatedControl
_buttons[0].Page = 1; _buttons[0].Page = 1;
_buttons[6].Page = pageCount; _buttons[6].Page = pageCount;
if (mid > 4) if (mid > 4)
{
_buttons[1].SetStatus(-1, false, true, false); _buttons[1].SetStatus(-1, false, true, false);
}
else else
{
_buttons[1].SetStatus(mid - 2, false, false, false); _buttons[1].SetStatus(mid - 2, false, false, false);
}
if (mid < pageCount - 3) if (mid < pageCount - 3)
{
_buttons[5].SetStatus(-1, false, false, true); _buttons[5].SetStatus(-1, false, false, true);
}
else else
{
_buttons[5].SetStatus(mid + 2, false, false, false); _buttons[5].SetStatus(mid + 2, false, false, false);
}
foreach (var button in _buttons) foreach (var button in _buttons)
{
if (button.Page == currentPage) if (button.Page == currentPage)
{
button.SetSelected(true); button.SetSelected(true);
}
else else
{
button.SetSelected(false); button.SetSelected(false);
}
}
} }
SetCurrentValue(PageCountProperty, pageCount); SetCurrentValue(PageCountProperty, pageCount);
@@ -369,11 +354,9 @@ public class Pagination: TemplatedControl
if (_previousButton != null) _previousButton.IsEnabled = (CurrentPage ?? int.MaxValue) > 1; if (_previousButton != null) _previousButton.IsEnabled = (CurrentPage ?? int.MaxValue) > 1;
if (_nextButton != null) _nextButton.IsEnabled = (CurrentPage ?? 0) < PageCount; if (_nextButton != null) _nextButton.IsEnabled = (CurrentPage ?? 0) < PageCount;
} }
private void InvokeCommand() private void InvokeCommand()
{ {
if (this.Command != null && this.Command.CanExecute(this.CommandParameter)) if (Command != null && Command.CanExecute(CommandParameter)) Command.Execute(CommandParameter);
{
this.Command.Execute(this.CommandParameter);
}
} }
} }