Add HasCustomContextMenu to NodifyEditor and ItemContainer (#165)

miroiu · web-flow · commit 7f6768e613a1 · 2024-12-02T20:50:52.000+02:00
* Add HasCustomContextMenu to NodifyEditor and ItemContainer
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -15,7 +15,8 @@
 >	- Added UpdateCuttingLine to NodifyEditor
 >	- Added BeginSelecting, UpdateSelection, EndSelecting, CancelSelecting and AllowSelectionCancellation to NodifyEditor
 >	- Added IsDragging, BeginDragging, UpdateDragging, EndDragging and CancelDragging to NodifyEditor
->	- Added AlignSelection and AlignContainers to NodifyEditor
+>	- Added AlignSelection and AlignContainers methods to NodifyEditor
+>	- Added HasCustomContextMenu dependency property to NodifyEditor and ItemContainer
 >	- Added Select, BeginDragging, UpdateDragging, EndDragging and CancelDragging to ItemContainer
 >	- Added PreserveSelectionOnRightClick configuration field to ItemContainer
 > - Bugfixes:
diff --git a/Examples/Nodify.Calculator/EditorView.xaml b/Examples/Nodify.Calculator/EditorView.xaml
@@ -135,6 +135,7 @@
                              ConnectionTemplate="{StaticResource ConnectionTemplate}"
                              Background="{StaticResource SmallGridLinesDrawingBrush}"
                              ItemContainerStyle="{StaticResource ItemContainerStyle}"
+                             HasCustomContextMenu="True"
                              GridCellSize="15"
                              AllowDrop="True"
                              Drop="OnDropNode"
diff --git a/Examples/Nodify.Calculator/EditorView.xaml.cs b/Examples/Nodify.Calculator/EditorView.xaml.cs
@@ -16,7 +16,7 @@ public EditorView()
 
         private void OpenOperationsMenu(object sender, MouseButtonEventArgs e)
         {
-            if (!e.Handled && e.OriginalSource is NodifyEditor editor && !editor.IsPanning && editor.DataContext is CalculatorViewModel calculator)
+            if (!e.Handled && e.OriginalSource is NodifyEditor editor && editor.DataContext is CalculatorViewModel calculator)
             {
                 e.Handled = true;
                 calculator.OperationsMenu.OpenAt(editor.MouseLocation);
diff --git a/Nodify/EditorStates/ContainerDefaultState.cs b/Nodify/EditorStates/ContainerDefaultState.cs
@@ -69,7 +69,7 @@ public override void HandleMouseUp(MouseButtonEventArgs e)
                 // explicit context menu or is configured to preserve the selection on right-click, the selection 
                 // remains unchanged. This ensures that the context menu applies to the entire selection rather 
                 // than only the clicked item.
-                bool hasContextMenu = Container.ContextMenu != null || ItemContainer.PreserveSelectionOnRightClick;
+                bool hasContextMenu = Container.HasContextMenu || ItemContainer.PreserveSelectionOnRightClick;
                 bool allowContextMenu = e.ChangedButton == MouseButton.Right && Container.IsSelected && hasContextMenu;
                 if (!(_selectionType == SelectionType.Replace && allowContextMenu))
                 {
diff --git a/Nodify/EditorStates/ContainerDraggingState.cs b/Nodify/EditorStates/ContainerDraggingState.cs
@@ -56,7 +56,7 @@ public override void HandleMouseUp(MouseButtonEventArgs e)
             if (gestures.Drag.Matches(e.Source, e))
             {
                 // Suppress the context menu if the mouse moved beyond the defined drag threshold
-                if (e.ChangedButton == MouseButton.Right && Editor.ContextMenu != null)
+                if (e.ChangedButton == MouseButton.Right && (Container.HasContextMenu || Editor.HasContextMenu))
                 {
                     double dragThreshold = NodifyEditor.MouseActionSuppressionThreshold * NodifyEditor.MouseActionSuppressionThreshold;
                     double dragDistance = (Editor.MouseLocation - _initialMousePosition).LengthSquared;
diff --git a/Nodify/EditorStates/EditorCuttingState.cs b/Nodify/EditorStates/EditorCuttingState.cs
@@ -39,7 +39,7 @@ public override void HandleMouseUp(MouseButtonEventArgs e)
             if (gestures.Cutting.Matches(e.Source, e))
             {
                 // Suppress the context menu if the mouse moved beyond the defined drag threshold
-                if (e.ChangedButton == MouseButton.Right && Editor.ContextMenu != null)
+                if (e.ChangedButton == MouseButton.Right && Editor.HasContextMenu)
                 {
                     double dragThreshold = NodifyEditor.MouseActionSuppressionThreshold * NodifyEditor.MouseActionSuppressionThreshold;
                     double dragDistance = (Editor.MouseLocation - _initialPosition).LengthSquared;
diff --git a/Nodify/EditorStates/EditorPanningState.cs b/Nodify/EditorStates/EditorPanningState.cs
@@ -59,7 +59,7 @@ public override void HandleMouseUp(MouseButtonEventArgs e)
             if (gestures.Pan.Matches(e.Source, e))
             {
                 // Suppress the context menu if the mouse moved beyond the defined drag threshold or the editor is selecting
-                if (e.ChangedButton == MouseButton.Right && Editor.ContextMenu != null)
+                if (e.ChangedButton == MouseButton.Right && Editor.HasContextMenu)
                 {
                     double dragThreshold = NodifyEditor.MouseActionSuppressionThreshold * NodifyEditor.MouseActionSuppressionThreshold;
                     double dragDistance = (_currentMousePosition - _initialMousePosition).LengthSquared;
diff --git a/Nodify/EditorStates/EditorPushingItemsState.cs b/Nodify/EditorStates/EditorPushingItemsState.cs
@@ -63,7 +63,7 @@ public override void HandleMouseUp(MouseButtonEventArgs e)
             if (gestures.PushItems.Matches(e.Source, e))
             {
                 // Suppress the context menu if the mouse moved beyond the defined drag threshold
-                if (e.ChangedButton == MouseButton.Right && Editor.ContextMenu != null)
+                if (e.ChangedButton == MouseButton.Right && Editor.HasContextMenu)
                 {
                     double dragThreshold = NodifyEditor.MouseActionSuppressionThreshold * NodifyEditor.MouseActionSuppressionThreshold;
                     double dragDistance = (Editor.MouseLocation - _initialPosition).LengthSquared;
diff --git a/Nodify/EditorStates/EditorSelectingState.cs b/Nodify/EditorStates/EditorSelectingState.cs
@@ -61,7 +61,7 @@ public override void HandleMouseUp(MouseButtonEventArgs e)
             if (gestures.Select.Matches(e.Source, e))
             {
                 // Suppress the context menu if the mouse moved beyond the defined drag threshold
-                if (e.ChangedButton == MouseButton.Right && Editor.ContextMenu != null)
+                if (e.ChangedButton == MouseButton.Right && Editor.HasContextMenu)
                 {
                     double dragThreshold = NodifyEditor.MouseActionSuppressionThreshold * NodifyEditor.MouseActionSuppressionThreshold;
                     double dragDistance = (Editor.MouseLocation - _initialPosition).LengthSquared;
diff --git a/Nodify/ItemContainer.cs b/Nodify/ItemContainer.cs
@@ -33,6 +33,18 @@ public class ItemContainer : ContentControl, INodifyCanvasItem
         private static readonly DependencyPropertyKey IsPreviewingLocationPropertyKey = DependencyProperty.RegisterReadOnly(nameof(IsPreviewingLocation), typeof(bool), typeof(ItemContainer), new FrameworkPropertyMetadata(BoxValue.False));
         public static readonly DependencyProperty IsPreviewingLocationProperty = IsPreviewingLocationPropertyKey.DependencyProperty;
         public static readonly DependencyProperty IsDraggableProperty = DependencyProperty.Register(nameof(IsDraggable), typeof(bool), typeof(ItemContainer), new FrameworkPropertyMetadata(BoxValue.True));
+        public static readonly DependencyProperty HasCustomContextMenuProperty = NodifyEditor.HasCustomContextMenuProperty.AddOwner(typeof(ItemContainer));
+
+        private static void OnLocationChanged(DependencyObject d, DependencyPropertyChangedEventArgs e)
+        {
+            var item = (ItemContainer)d;
+            item.OnLocationChanged();
+
+            if (item.Editor.IsLoaded && !item.Editor.IsBulkUpdatingItems)
+            {
+                item.Editor.ItemsHost.InvalidateArrange();
+            }
+        }
 
         /// <summary>
         /// Gets or sets the brush used when the <see cref="PendingConnection.IsOverElementProperty"/> attached property is true for this <see cref="ItemContainer"/>.
@@ -135,17 +147,21 @@ public bool IsDraggable
             set => SetValue(IsDraggableProperty, value);
         }
 
-        private static void OnLocationChanged(DependencyObject d, DependencyPropertyChangedEventArgs e)
+        /// <summary>
+        /// Gets or sets a value indicating whether the container uses a custom context menu.
+        /// </summary>
+        /// <remarks>When set to true, the container handles the right-click event for specific operations.</remarks>
+        public bool HasCustomContextMenu
         {
-            var item = (ItemContainer)d;
-            item.OnLocationChanged();
-
-            if (item.Editor.IsLoaded && !item.Editor.IsBulkUpdatingItems)
-            {
-                item.Editor.ItemsHost.InvalidateArrange();
-            }
+            get => (bool)GetValue(HasCustomContextMenuProperty);
+            set => SetValue(HasCustomContextMenuProperty, value);
         }
 
+        /// <summary>
+        /// Gets a value indicating whether the container has a context menu.
+        /// </summary>
+        public bool HasContextMenu => ContextMenu != null || HasCustomContextMenu;
+
         #endregion
 
         #region Routed Events
diff --git a/Nodify/NodifyEditor.cs b/Nodify/NodifyEditor.cs
@@ -349,6 +349,7 @@ public Point MouseLocation
         public static readonly DependencyProperty PendingConnectionProperty = DependencyProperty.Register(nameof(PendingConnection), typeof(object), typeof(NodifyEditor));
         public static readonly DependencyProperty GridCellSizeProperty = DependencyProperty.Register(nameof(GridCellSize), typeof(uint), typeof(NodifyEditor), new FrameworkPropertyMetadata(BoxValue.UInt1, OnGridCellSizeChanged, OnCoerceGridCellSize));
         public static readonly DependencyProperty DisableZoomingProperty = DependencyProperty.Register(nameof(DisableZooming), typeof(bool), typeof(NodifyEditor), new FrameworkPropertyMetadata(BoxValue.False));
+        public static readonly DependencyProperty HasCustomContextMenuProperty = DependencyProperty.Register(nameof(HasCustomContextMenu), typeof(bool), typeof(NodifyEditor), new FrameworkPropertyMetadata(BoxValue.False));
         public static readonly DependencyProperty DecoratorsProperty = DependencyProperty.Register(nameof(Decorators), typeof(IEnumerable), typeof(NodifyEditor));
 
         private static object OnCoerceGridCellSize(DependencyObject d, object value)
@@ -401,6 +402,21 @@ public bool DisableZooming
             set => SetValue(DisableZoomingProperty, value);
         }
 
+        /// <summary>
+        /// Gets or sets a value indicating whether the editor uses a custom context menu.
+        /// </summary>
+        /// <remarks>When set to true, the editor handles the right-click event for specific operations.</remarks>
+        public bool HasCustomContextMenu
+        {
+            get => (bool)GetValue(HasCustomContextMenuProperty);
+            set => SetValue(HasCustomContextMenuProperty, value);
+        }
+
+        /// <summary>
+        /// Gets a value indicating whether the editor has a context menu.
+        /// </summary>
+        public bool HasContextMenu => ContextMenu != null || HasCustomContextMenu;
+
         #endregion
 
         #region Command Dependency Properties

Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@ public EditorView()`
`16`	`16`
`17`	`17`	`private void OpenOperationsMenu(object sender, MouseButtonEventArgs e)`
`18`	`18`	`{`
`19`		`- if (!e.Handled && e.OriginalSource is NodifyEditor editor && !editor.IsPanning && editor.DataContext is CalculatorViewModel calculator)`
	`19`	`+ if (!e.Handled && e.OriginalSource is NodifyEditor editor && editor.DataContext is CalculatorViewModel calculator)`
`20`	`20`	`{`
`21`	`21`	`e.Handled = true;`
`22`	`22`	`calculator.OperationsMenu.OpenAt(editor.MouseLocation);`
Original file line number	Diff line number	Diff line change
`@@ -69,7 +69,7 @@ public override void HandleMouseUp(MouseButtonEventArgs e)`
`69`	`69`	`// explicit context menu or is configured to preserve the selection on right-click, the selection`
`70`	`70`	`// remains unchanged. This ensures that the context menu applies to the entire selection rather`
`71`	`71`	`// than only the clicked item.`
`72`		`- bool hasContextMenu = Container.ContextMenu != null \|\| ItemContainer.PreserveSelectionOnRightClick;`
	`72`	`+ bool hasContextMenu = Container.HasContextMenu \|\| ItemContainer.PreserveSelectionOnRightClick;`
`73`	`73`	`bool allowContextMenu = e.ChangedButton == MouseButton.Right && Container.IsSelected && hasContextMenu;`
`74`	`74`	`if (!(_selectionType == SelectionType.Replace && allowContextMenu))`
`75`	`75`	`{`
Original file line number	Diff line number	Diff line change
`@@ -56,7 +56,7 @@ public override void HandleMouseUp(MouseButtonEventArgs e)`
`56`	`56`	`if (gestures.Drag.Matches(e.Source, e))`
`57`	`57`	`{`
`58`	`58`	`// Suppress the context menu if the mouse moved beyond the defined drag threshold`
`59`		`- if (e.ChangedButton == MouseButton.Right && Editor.ContextMenu != null)`
	`59`	`+ if (e.ChangedButton == MouseButton.Right && (Container.HasContextMenu \|\| Editor.HasContextMenu))`
`60`	`60`	`{`
`61`	`61`	`double dragThreshold = NodifyEditor.MouseActionSuppressionThreshold * NodifyEditor.MouseActionSuppressionThreshold;`
`62`	`62`	`double dragDistance = (Editor.MouseLocation - _initialMousePosition).LengthSquared;`
Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,7 @@ public override void HandleMouseUp(MouseButtonEventArgs e)`
`39`	`39`	`if (gestures.Cutting.Matches(e.Source, e))`
`40`	`40`	`{`
`41`	`41`	`// Suppress the context menu if the mouse moved beyond the defined drag threshold`
`42`		`- if (e.ChangedButton == MouseButton.Right && Editor.ContextMenu != null)`
	`42`	`+ if (e.ChangedButton == MouseButton.Right && Editor.HasContextMenu)`
`43`	`43`	`{`
`44`	`44`	`double dragThreshold = NodifyEditor.MouseActionSuppressionThreshold * NodifyEditor.MouseActionSuppressionThreshold;`
`45`	`45`	`double dragDistance = (Editor.MouseLocation - _initialPosition).LengthSquared;`
Original file line number	Diff line number	Diff line change
`@@ -59,7 +59,7 @@ public override void HandleMouseUp(MouseButtonEventArgs e)`
`59`	`59`	`if (gestures.Pan.Matches(e.Source, e))`
`60`	`60`	`{`
`61`	`61`	`// Suppress the context menu if the mouse moved beyond the defined drag threshold or the editor is selecting`
`62`		`- if (e.ChangedButton == MouseButton.Right && Editor.ContextMenu != null)`
	`62`	`+ if (e.ChangedButton == MouseButton.Right && Editor.HasContextMenu)`
`63`	`63`	`{`
`64`	`64`	`double dragThreshold = NodifyEditor.MouseActionSuppressionThreshold * NodifyEditor.MouseActionSuppressionThreshold;`
`65`	`65`	`double dragDistance = (_currentMousePosition - _initialMousePosition).LengthSquared;`
Original file line number	Diff line number	Diff line change
`@@ -63,7 +63,7 @@ public override void HandleMouseUp(MouseButtonEventArgs e)`
`63`	`63`	`if (gestures.PushItems.Matches(e.Source, e))`
`64`	`64`	`{`
`65`	`65`	`// Suppress the context menu if the mouse moved beyond the defined drag threshold`
`66`		`- if (e.ChangedButton == MouseButton.Right && Editor.ContextMenu != null)`
	`66`	`+ if (e.ChangedButton == MouseButton.Right && Editor.HasContextMenu)`
`67`	`67`	`{`
`68`	`68`	`double dragThreshold = NodifyEditor.MouseActionSuppressionThreshold * NodifyEditor.MouseActionSuppressionThreshold;`
`69`	`69`	`double dragDistance = (Editor.MouseLocation - _initialPosition).LengthSquared;`
Original file line number	Diff line number	Diff line change
`@@ -61,7 +61,7 @@ public override void HandleMouseUp(MouseButtonEventArgs e)`
`61`	`61`	`if (gestures.Select.Matches(e.Source, e))`
`62`	`62`	`{`
`63`	`63`	`// Suppress the context menu if the mouse moved beyond the defined drag threshold`
`64`		`- if (e.ChangedButton == MouseButton.Right && Editor.ContextMenu != null)`
	`64`	`+ if (e.ChangedButton == MouseButton.Right && Editor.HasContextMenu)`
`65`	`65`	`{`
`66`	`66`	`double dragThreshold = NodifyEditor.MouseActionSuppressionThreshold * NodifyEditor.MouseActionSuppressionThreshold;`
`67`	`67`	`double dragDistance = (Editor.MouseLocation - _initialPosition).LengthSquared;`