tsai
/
Avalonia
mirror of https://github.com/AvaloniaUI/Avalonia.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

Merge pull request #7451 from robloo/robloo-button 

Button Refactoring
pull/7455/head
Max Katz 5 years ago
committed by GitHub
parent
c0ec9d634b a0331c6007
commit
9dcb061cdb
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 92 additions and 105 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 197
      src/Avalonia.Controls/Button.cs

197
src/Avalonia.Controls/Button.cs
View File

@ -59,13 +59,13 @@ namespace Avalonia.Controls
AvaloniaProperty.Register<Button, object>(nameof(CommandParameter)); AvaloniaProperty.Register<Button, object>(nameof(CommandParameter));
/// <summary> /// <summary>
/// Defines the <see cref="IsDefaultProperty"/> property. /// Defines the <see cref="IsDefault"/> property.
/// </summary> /// </summary>
public static readonly StyledProperty<bool> IsDefaultProperty = public static readonly StyledProperty<bool> IsDefaultProperty =
AvaloniaProperty.Register<Button, bool>(nameof(IsDefault)); AvaloniaProperty.Register<Button, bool>(nameof(IsDefault));
/// <summary> /// <summary>
/// Defines the <see cref="IsCancelProperty"/> property. /// Defines the <see cref="IsCancel"/> property.
/// </summary> /// </summary>
public static readonly StyledProperty<bool> IsCancelProperty = public static readonly StyledProperty<bool> IsCancelProperty =
AvaloniaProperty.Register<Button, bool>(nameof(IsCancel)); AvaloniaProperty.Register<Button, bool>(nameof(IsCancel));
@ -76,6 +76,9 @@ namespace Avalonia.Controls
public static readonly RoutedEvent<RoutedEventArgs> ClickEvent = public static readonly RoutedEvent<RoutedEventArgs> ClickEvent =
RoutedEvent.Register<Button, RoutedEventArgs>(nameof(Click), RoutingStrategies.Bubble); RoutedEvent.Register<Button, RoutedEventArgs>(nameof(Click), RoutingStrategies.Bubble);
/// <summary>
/// Defines the <see cref="IsPressed"/> property.
/// </summary>
public static readonly StyledProperty<bool> IsPressedProperty = public static readonly StyledProperty<bool> IsPressedProperty =
AvaloniaProperty.Register<Button, bool>(nameof(IsPressed)); AvaloniaProperty.Register<Button, bool>(nameof(IsPressed));
@ -95,13 +98,12 @@ namespace Avalonia.Controls
static Button() static Button()
{ {
FocusableProperty.OverrideDefaultValue(typeof(Button), true); FocusableProperty.OverrideDefaultValue(typeof(Button), true);
CommandProperty.Changed.Subscribe(CommandChanged);
CommandParameterProperty.Changed.Subscribe(CommandParameterChanged);
IsDefaultProperty.Changed.Subscribe(IsDefaultChanged);
IsCancelProperty.Changed.Subscribe(IsCancelChanged);
AccessKeyHandler.AccessKeyPressedEvent.AddClassHandler<Button>((lbl, args) => lbl.OnAccessKey(args)); AccessKeyHandler.AccessKeyPressedEvent.AddClassHandler<Button>((lbl, args) => lbl.OnAccessKey(args));
} }
/// <summary>
/// Initializes a new instance of the <see cref="Button"/> class.
/// </summary>
public Button() public Button()
{ {
UpdatePseudoClasses(IsPressed); UpdatePseudoClasses(IsPressed);
@ -112,8 +114,8 @@ namespace Avalonia.Controls
/// </summary> /// </summary>
public event EventHandler<RoutedEventArgs> Click public event EventHandler<RoutedEventArgs> Click
{ {
add { AddHandler(ClickEvent, value); } add => AddHandler(ClickEvent, value);
remove { RemoveHandler(ClickEvent, value); } remove => RemoveHandler(ClickEvent, value);
} }
/// <summary> /// <summary>
@ -121,8 +123,8 @@ namespace Avalonia.Controls
/// </summary> /// </summary>
public ClickMode ClickMode public ClickMode ClickMode
{ {
get { return GetValue(ClickModeProperty); } get => GetValue(ClickModeProperty);
set { SetValue(ClickModeProperty, value); } set => SetValue(ClickModeProperty, value);
} }
/// <summary> /// <summary>
@ -130,8 +132,8 @@ namespace Avalonia.Controls
/// </summary> /// </summary>
public ICommand Command public ICommand Command
{ {
get { return _command; } get => _command;
set { SetAndRaise(CommandProperty, ref _command, value); } set => SetAndRaise(CommandProperty, ref _command, value);
} }
/// <summary> /// <summary>
@ -139,8 +141,8 @@ namespace Avalonia.Controls
/// </summary> /// </summary>
public KeyGesture HotKey public KeyGesture HotKey
{ {
get { return GetValue(HotKeyProperty); } get => GetValue(HotKeyProperty);
set { SetValue(HotKeyProperty, value); } set => SetValue(HotKeyProperty, value);
} }
/// <summary> /// <summary>
@ -148,8 +150,8 @@ namespace Avalonia.Controls
/// </summary> /// </summary>
public object CommandParameter public object CommandParameter
{ {
get { return GetValue(CommandParameterProperty); } get => GetValue(CommandParameterProperty);
set { SetValue(CommandParameterProperty, value); } set => SetValue(CommandParameterProperty, value);
} }
/// <summary> /// <summary>
@ -158,8 +160,8 @@ namespace Avalonia.Controls
/// </summary> /// </summary>
public bool IsDefault public bool IsDefault
{ {
get { return GetValue(IsDefaultProperty); } get => GetValue(IsDefaultProperty);
set { SetValue(IsDefaultProperty, value); } set => SetValue(IsDefaultProperty, value);
} }
/// <summary> /// <summary>
@ -168,18 +170,21 @@ namespace Avalonia.Controls
/// </summary> /// </summary>
public bool IsCancel public bool IsCancel
{ {
get { return GetValue(IsCancelProperty); } get => GetValue(IsCancelProperty);
set { SetValue(IsCancelProperty, value); } set => SetValue(IsCancelProperty, value);
} }
/// <summary>
/// Gets or sets a value indicating whether the button is currently pressed.
/// </summary>
public bool IsPressed public bool IsPressed
{ {
get { return GetValue(IsPressedProperty); } get => GetValue(IsPressedProperty);
private set { SetValue(IsPressedProperty, value); } private set => SetValue(IsPressedProperty, value);
} }
/// <summary> /// <summary>
/// Gets or sets the Flyout that should be shown with this button /// Gets or sets the Flyout that should be shown with this button.
/// </summary> /// </summary>
public FlyoutBase Flyout public FlyoutBase Flyout
{ {
@ -187,7 +192,8 @@ namespace Avalonia.Controls
set => SetValue(FlyoutProperty, value); set => SetValue(FlyoutProperty, value);
} }
protected override bool IsEnabledCore => base.IsEnabledCore && _commandCanExecute; /// <inheritdoc/>
protected override bool IsEnabledCore => base.IsEnabledCore && _commandCanExecute;
/// <inheritdoc/> /// <inheritdoc/>
protected override void OnAttachedToVisualTree(VisualTreeAttachmentEventArgs e) protected override void OnAttachedToVisualTree(VisualTreeAttachmentEventArgs e)
@ -224,6 +230,7 @@ namespace Avalonia.Controls
} }
} }
/// <inheritdoc/>
protected override void OnAttachedToLogicalTree(LogicalTreeAttachmentEventArgs e) protected override void OnAttachedToLogicalTree(LogicalTreeAttachmentEventArgs e)
{ {
if (_hotkey != null) // Control attached again, set Hotkey to create a hotkey manager for this control if (_hotkey != null) // Control attached again, set Hotkey to create a hotkey manager for this control
@ -240,6 +247,7 @@ namespace Avalonia.Controls
} }
} }
/// <inheritdoc/>
protected override void OnDetachedFromLogicalTree(LogicalTreeAttachmentEventArgs e) protected override void OnDetachedFromLogicalTree(LogicalTreeAttachmentEventArgs e)
{ {
// This will cause the hotkey manager to dispose the observer and the reference to this control // This will cause the hotkey manager to dispose the observer and the reference to this control
@ -358,12 +366,14 @@ namespace Avalonia.Controls
} }
} }
} }
/// <inheritdoc/>
protected override void OnPointerCaptureLost(PointerCaptureLostEventArgs e) protected override void OnPointerCaptureLost(PointerCaptureLostEventArgs e)
{ {
IsPressed = false; IsPressed = false;
} }
/// <inheritdoc/>
protected override void OnLostFocus(RoutedEventArgs e) protected override void OnLostFocus(RoutedEventArgs e)
{ {
base.OnLostFocus(e); base.OnLostFocus(e);
@ -371,119 +381,93 @@ namespace Avalonia.Controls
IsPressed = false; IsPressed = false;
} }
/// <inheritdoc/>
protected override void OnPropertyChanged<T>(AvaloniaPropertyChangedEventArgs<T> change) protected override void OnPropertyChanged<T>(AvaloniaPropertyChangedEventArgs<T> change)
{ {
base.OnPropertyChanged(change); base.OnPropertyChanged(change);
if (change.Property == IsPressedProperty) if (change.Property == CommandProperty)
{
UpdatePseudoClasses(change.NewValue.GetValueOrDefault<bool>());
}
else if (change.Property == FlyoutProperty)
{ {
// If flyout is changed while one is already open, make sure we if (((ILogical)this).IsAttachedToLogicalTree)
// close the old one first
if (change.OldValue.GetValueOrDefault() is FlyoutBase oldFlyout &&
oldFlyout.IsOpen)
{ {
oldFlyout.Hide(); if (change.OldValue.GetValueOrDefault() is ICommand oldCommand)
{
oldCommand.CanExecuteChanged -= CanExecuteChanged;
}
if (change.NewValue.GetValueOrDefault() is ICommand newCommand)
{
newCommand.CanExecuteChanged += CanExecuteChanged;
}
} }
}
}
protected override void UpdateDataValidation<T>(AvaloniaProperty<T> property, BindingValue<T> value) CanExecuteChanged(this, EventArgs.Empty);
{ }
base.UpdateDataValidation(property, value); else if (change.Property == CommandParameterProperty)
if (property == CommandProperty)
{ {
if (value.Type == BindingValueType.BindingError) CanExecuteChanged(this, EventArgs.Empty);
}
else if (change.Property == IsCancelProperty)
{
var isCancel = change.NewValue.GetValueOrDefault<bool>();
if (VisualRoot is IInputElement inputRoot)
{ {
if (_commandCanExecute) if (isCancel)
{ {
_commandCanExecute = false; ListenForCancel(inputRoot);
UpdateIsEffectivelyEnabled(); }
else
{
StopListeningForCancel(inputRoot);
} }
} }
} }
} else if (change.Property == IsDefaultProperty)
/// <summary>
/// Called when the <see cref="Command"/> property changes.
/// </summary>
/// <param name="e">The event args.</param>
private static void CommandChanged(AvaloniaPropertyChangedEventArgs e)
{
if (e.Sender is Button button)
{ {
if (((ILogical)button).IsAttachedToLogicalTree) var isDefault = change.NewValue.GetValueOrDefault<bool>();
if (VisualRoot is IInputElement inputRoot)
{ {
if (e.OldValue is ICommand oldCommand) if (isDefault)
{ {
oldCommand.CanExecuteChanged -= button.CanExecuteChanged; ListenForDefault(inputRoot);
} }
else
if (e.NewValue is ICommand newCommand)
{ {
newCommand.CanExecuteChanged += button.CanExecuteChanged; StopListeningForDefault(inputRoot);
} }
} }
button.CanExecuteChanged(button, EventArgs.Empty);
} }
} else if (change.Property == IsPressedProperty)
/// <summary>
/// Called when the <see cref="CommandParameter"/> property changes.
/// </summary>
/// <param name="e">The event args.</param>
private static void CommandParameterChanged(AvaloniaPropertyChangedEventArgs e)
{
if (e.Sender is Button button)
{ {
button.CanExecuteChanged(button, EventArgs.Empty); UpdatePseudoClasses(change.NewValue.GetValueOrDefault<bool>());
} }
} else if (change.Property == FlyoutProperty)
/// <summary>
/// Called when the <see cref="IsDefault"/> property changes.
/// </summary>
/// <param name="e">The event args.</param>
private static void IsDefaultChanged(AvaloniaPropertyChangedEventArgs e)
{
var button = e.Sender as Button;
var isDefault = (bool)e.NewValue;
if (button?.VisualRoot is IInputElement inputRoot)
{ {
if (isDefault) // If flyout is changed while one is already open, make sure we
{ // close the old one first
button.ListenForDefault(inputRoot); if (change.OldValue.GetValueOrDefault() is FlyoutBase oldFlyout &&
} oldFlyout.IsOpen)
else
{ {
button.StopListeningForDefault(inputRoot); oldFlyout.Hide();
} }
} }
} }
/// <summary> /// <inheritdoc/>
/// Called when the <see cref="IsCancel"/> property changes. protected override void UpdateDataValidation<T>(AvaloniaProperty<T> property, BindingValue<T> value)
/// </summary>
/// <param name="e">The event args.</param>
private static void IsCancelChanged(AvaloniaPropertyChangedEventArgs e)
{ {
var button = e.Sender as Button; base.UpdateDataValidation(property, value);
var isCancel = (bool)e.NewValue; if (property == CommandProperty)
if (button?.VisualRoot is IInputElement inputRoot)
{ {
if (isCancel) if (value.Type == BindingValueType.BindingError)
{
button.ListenForCancel(inputRoot);
}
else
{ {
button.StopListeningForCancel(inputRoot); if (_commandCanExecute)
{
_commandCanExecute = false;
UpdateIsEffectivelyEnabled();
}
} }
} }
} }
@ -566,6 +550,9 @@ namespace Avalonia.Controls
} }
} }
/// <summary>
/// Updates the visual state of the control by applying latest PseudoClasses.
/// </summary>
private void UpdatePseudoClasses(bool isPressed) private void UpdatePseudoClasses(bool isPressed)
{ {
PseudoClasses.Set(":pressed", isPressed); PseudoClasses.Set(":pressed", isPressed);

Write Preview
Loading…
Cancel
Save