mattercontrol/original/MatterControlLib/SetupWizard/DialogPage.cs

/*
Copyright (c) 2022, Lars Brubaker, John Lewin
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this
   list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

The views and conclusions contained in the software and documentation are those
of the authors and should not be interpreted as representing official policies,
either expressed or implied, of the FreeBSD Project.
*/

using System;
using System.Linq;
using MatterHackers.Agg;
using MatterHackers.Agg.UI;
using MatterHackers.Localizations;
using MatterHackers.MatterControl.PartPreviewWindow;
using MatterHackers.VectorMath;

namespace MatterHackers.MatterControl
{
	public class DialogPage : FlowLayoutWidget
	{
		protected GuiWidget headerRow;
		protected FlowLayoutWidget contentRow;
		protected FlowLayoutWidget footerRow;

		private TextWidget headerLabel;

		public GuiWidget CancelButton { get; private set; }

		public Vector2 WindowSize { get; set; }

		protected double labelFontSize = 12 * GuiWidget.DeviceScale;

		protected double errorFontSize = 10 * GuiWidget.DeviceScale;

		protected ThemeConfig theme;
		private int actionCount = 0;
		private SystemWindow systemWindow;
		private GuiWidget _acceptButton;

		public DialogPage(string cancelButtonText = null, bool useOverflowBar = false)
			: base(FlowDirection.TopToBottom)
		{
			theme = ApplicationController.Instance.Theme;

			this.HAnchor = HAnchor.Stretch;
			this.VAnchor = VAnchor.Stretch;

			if (cancelButtonText == null)
			{
				cancelButtonText = "Cancel".Localize();
			}

			CancelButton = theme.CreateDialogButton(cancelButtonText);
			CancelButton.Margin = new BorderDouble(left: 3);
			CancelButton.Name = "Cancel Wizard Button";

			// Create the header row for the widget
			if (useOverflowBar)
			{
				headerRow = new OverflowBar(theme)
				{
					Name = "HeaderRow",
					Margin = new BorderDouble(0, 3, 0, 0),
					Padding = new BorderDouble(0, 12),
					HAnchor = HAnchor.Stretch,
					VAnchor = VAnchor.Fit
				};
			}
			else
			{
				headerRow = new FlowLayoutWidget(FlowDirection.LeftToRight)
				{
					Name = "HeaderRow",
					Margin = new BorderDouble(0, 3, 0, 0),
					Padding = new BorderDouble(0, 12),
					HAnchor = HAnchor.Stretch,
					VAnchor = VAnchor.Fit
				};
			}

			this.AddChild(headerRow);

			headerLabel = new TextWidget("Setup Wizard".Localize(), pointSize: 24, textColor: theme.PrimaryAccentColor)
			{
				AutoExpandBoundsToText = true,
				EllipsisIfClipped = true,
				HAnchor = HAnchor.Stretch
			};
			headerRow.AddChild(headerLabel);

			// Create the main control container
			contentRow = new FlowLayoutWidget(FlowDirection.TopToBottom)
			{
				Padding = new BorderDouble(10),
				BackgroundColor = theme.SectionBackgroundColor,
				HAnchor = HAnchor.Stretch,
				VAnchor = VAnchor.Stretch
			};
			this.AddChild(contentRow);

			// Create the footer (button) container
			footerRow = new FlowLayoutWidget(FlowDirection.LeftToRight)
			{
				Name = "FooterRow",
				HAnchor = HAnchor.Fit | HAnchor.Right,
				VAnchor = VAnchor.Fit,
				Margin = new BorderDouble(0, 6),
				Padding = new BorderDouble(top: 4, bottom: 2)
			};
			this.AddChild(footerRow);

#if !__ANDROID__
			headerRow.Padding = new BorderDouble(0, 3, 0, 3);

			headerLabel.PointSize = 14;
			headerLabel.TextColor = theme.TextColor;
			contentRow.Padding = new BorderDouble(5);

			footerRow.Padding = 0;
			footerRow.Margin = new BorderDouble(top: theme.DefaultContainerPadding);
#endif
		}

		public GuiWidget AcceptButton
		{
			get => _acceptButton;
			set
			{
				_acceptButton = value;
				theme.ApplyPrimaryActionStyle(_acceptButton);
			}
		}

		// Add public accessor for content panel
		public FlowLayoutWidget ContentRow => contentRow;

		public DialogWindow DialogWindow { get; set; }

		public string WindowTitle { get; set; }

		public bool AlwaysOnTopOfMain { get; set; } = true;

		public string HeaderText
		{
			get => headerLabel.Text;
			set => headerLabel.Text = value;
		}

		public void AddPageAction(GuiWidget button, bool highlightFirstAction = true)
		{
			if (highlightFirstAction
				&& actionCount++ == 0)
			{
				this.AcceptButton = button;
			}

			button.Margin = theme.ButtonSpacing;
			footerRow.AddChild(button);
		}

		protected void SetCancelButtonName(string newName)
		{
			CancelButton.Name = newName;
		}

		protected void SetCancelButtonText(string text)
		{
			CancelButton.Text = text;
		}

		protected void HideCancelButton()
		{
			CancelButton.Visible = false;
		}

		public override void OnLoad(EventArgs args)
		{
			// Add 'Close' event listener after derived types have had a chance to register event listeners
			CancelButton.Click += (s, e) =>
			{
				if (this.AllowCancel())
				{
					this.DialogWindow?.ClosePage();
				}
			};

			// Register listeners
			systemWindow = this.Parents<SystemWindow>().FirstOrDefault();
			systemWindow.KeyDown += SystemWindow_KeyDown;

			footerRow.AddChild(CancelButton);

			base.OnLoad(args);
		}

		public bool AllowCancel()
		{
			bool windowAbortCancel = false;

			this.OnCancel(out bool pageAbortCancel);

			if (!pageAbortCancel)
			{
				this.DialogWindow.OnCancel(out windowAbortCancel);
			}

			// Allow cancel if page and DialogWindow do not abort
			return !pageAbortCancel
				&& !windowAbortCancel;
		}

		protected virtual void OnCancel(out bool abortCancel)
		{
			abortCancel = false;
		}

		public override void OnClosed(EventArgs e)
		{
			// Unregister listeners
			if (systemWindow != null)
			{
				systemWindow.KeyDown -= SystemWindow_KeyDown;
			}

			base.OnClosed(e);
		}

		private void SystemWindow_KeyDown(object sender, KeyEventArgs e)
		{
			if (e.KeyCode == Keys.Escape
				&& !e.Handled)
			{
				this.OnCancel(out bool abortCancel);

				if (!abortCancel)
				{
					this.DialogWindow?.ClosePage();
				}
			}
			else if (e.KeyCode == Keys.Enter
				&& this.AcceptButton != null
				&& this.AcceptButton.Visible
				&& this.AcceptButton.Enabled)
			{
				var tabStops = this.ActiveTabStops();

				// If no tab stop child is actively focused, fire click on the AcceptButton
				if (!tabStops.Any(w => w.Focused))
				{
					this.AcceptButton.InvokeClick();
				}
			}
		}
	}
}