mattercontrol/MatterControlLib/Library/Widgets/ListView/IconListView.cs

/*
Copyright (c) 2018, 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.Collections.Generic;
using Markdig.Agg;
using MatterHackers.Agg;
using MatterHackers.Agg.Image;
using MatterHackers.Agg.Platform;
using MatterHackers.Agg.UI;
using MatterHackers.VectorMath;

namespace MatterHackers.MatterControl.CustomWidgets
{
	public class IconListView : IconView
	{
		private FlowLayoutWidget rowButtonContainer = null;

		private int cellIndex = 0;
		private int columnCount = 1;
		private int reflownWidth = -1;

		private List<IconViewItem> allIconViews = new List<IconViewItem>();

		private List<GuiWidget> headerItems = new List<GuiWidget>();

		public IconListView(ThemeConfig theme, int thumbnailSize = -1)
			: base(theme, thumbnailSize)
		{
		}

		public override void OnBoundsChanged(EventArgs e)
		{
			if (!reloading)
			{
				this.LayoutIcons();
			}

			base.OnBoundsChanged(e);
		}

		private void Row_Click(object sender, MouseEventArgs e)
		{
			if (sender is GuiWidget guiWidget)
			{
				var screenPosition = guiWidget.TransformToScreenSpace(e.Position);
				var thisPosition = this.TransformFromScreenSpace(screenPosition);
				var thisMouseClick = new MouseEventArgs(e, thisPosition.X, thisPosition.Y);
				OnClick(thisMouseClick);
			}
		}

		private void LayoutIcons()
		{
			int currentWidth = (int)this.Size.X;
			if (reflownWidth != currentWidth)
			{
				reflownWidth = currentWidth;

				int newColumnCount = RecomputeFlowValues(1);
				if (newColumnCount != columnCount)
				{
					columnCount = newColumnCount;

					// Reflow Children
					foreach (var iconView in allIconViews)
					{
						iconView.Parent?.RemoveChild(iconView);
						iconView.Margin = new BorderDouble(leftRightMargin, 0);
					}

					foreach (var child in Children)
					{
						child.Click -= Row_Click;
					}

					foreach (var headerItem in headerItems)
					{
						headerItem.Parent?.RemoveChild(headerItem);
					}

					this.CloseChildren();

					foreach (var headerItem in headerItems)
					{
						headerItem.ClearRemovedFlag();
						this.AddChild(headerItem);
					}

					foreach (var iconView in allIconViews)
					{
						iconView.ClearRemovedFlag();
						AddColumnAndChild(iconView);
					}
				}
				else
				{
					foreach (var iconView in allIconViews)
					{
						iconView.Margin = new BorderDouble(leftRightMargin, 0);
					}
				}
			}
		}

		private int RecomputeFlowValues(int leftRightItemMargin)
		{
			int scaledWidth = (int)(ThumbWidth * GuiWidget.DeviceScale);
			int itemWidth = scaledWidth + (iconViewPadding * 2) + (leftRightItemMargin * 2);

			int newColumnCount = (int)Math.Floor(this.LocalBounds.Width / itemWidth);
			int remainingSpace = (int)this.LocalBounds.Width - newColumnCount * itemWidth;

			// Reset position before reflow
			cellIndex = 0;
			rowButtonContainer = null;

			// There should always be at least one visible column
			if (newColumnCount < 1)
			{
				newColumnCount = 1;
				remainingSpace = 0;
			}

			// Only center items if extra space exists

			// we find the space we want between each column and the sides
			double spacePerColumn = (remainingSpace > 0) ? remainingSpace / (newColumnCount + 1) : 0;

			// set the margin to be 1/2 the space (it will happen on each side of each icon)

			// put in padding to get the "other" side of the outside icons
			double leftRightMarginRaw = (remainingSpace > 0) ? spacePerColumn / 2 : 0;

			// Inflate to account for scaling
			leftRightMargin = Math.Floor(leftRightMarginRaw / GuiWidget.DeviceScale);

			this.Padding = new BorderDouble(leftRightMargin, 0);

			return newColumnCount;
		}

		public void AddHeaderItem(GuiWidget widget)
		{
			headerItems.Add(widget);
			this.AddChild(widget);
		}

		public override ListViewItemBase AddItem(ListViewItem item)
		{
			var iconView = new IconViewItem(item, this.ThumbWidth, this.ThumbHeight, theme);
			iconView.Margin = new BorderDouble(leftRightMargin, 0);

			allIconViews.Add(iconView);

			AddColumnAndChild(iconView);

			return iconView;
		}

		private void AddColumnAndChild(IconViewItem iconView)
		{
			if (rowButtonContainer == null)
			{
				rowButtonContainer = new FlowLayoutWidget(FlowDirection.LeftToRight)
				{
					HAnchor = HAnchor.Stretch,
					Padding = 0,
					Margin = new BorderDouble(bottom: 6)
				};
				this.AddChild(rowButtonContainer);
				rowButtonContainer.Click += Row_Click;
			}

			rowButtonContainer?.AddChild(iconView);

			if (cellIndex++ >= columnCount - 1)
			{
				rowButtonContainer = null;
				cellIndex = 0;
			}
		}

		public override void ClearItems()
		{
			cellIndex = 0;
			rowButtonContainer = null;
			allIconViews.Clear();
			headerItems.Clear();

			this.CloseChildren();
		}

		private bool reloading = false;

		public override void BeginReload()
		{
			reloading = true;
			columnCount = RecomputeFlowValues(1);
		}

		public override void EndReload()
		{
			reloading = false;
			this.LayoutIcons();
		}
	}

	public class IconView : FlowLayoutWidget, IListContentView
	{
		public int ThumbWidth { get; set; } = 100;

		public int ThumbHeight { get; set; } = 100;

		protected int iconViewPadding = IconViewItem.ItemPadding;

		protected ThemeConfig theme;

		protected double leftRightMargin;

		public IconView(ThemeConfig theme, double thumbnailSize = -1)
			: base(FlowDirection.TopToBottom)
		{
			this.theme = theme;

			if (thumbnailSize != -1)
			{
				this.ThumbHeight = (int)thumbnailSize;
				this.ThumbWidth = (int)thumbnailSize;
			}
		}

		public virtual ListViewItemBase AddItem(ListViewItem item)
		{
			var iconView = new IconViewItem(item, this.ThumbWidth, this.ThumbHeight, theme)
			{
				Margin = new BorderDouble(leftRightMargin, 6, leftRightMargin, 0),
				HAnchor = HAnchor.Center
			};

			this.AddChild(iconView);

			return iconView;
		}

		public virtual void BeginReload()
		{
		}

		public virtual void EndReload()
		{
		}

		public virtual void ClearItems()
		{
			this.CloseChildren();
		}
	}

	public class IconViewItem : ListViewItemBase
	{
		private static ImageBuffer loadingImage = StaticData.Instance.LoadIcon("IC_32x32.png", 32, 32);

		internal static int ItemPadding = 0;

		private TextWidget text;

		public IconViewItem(ListViewItem item, int thumbWidth, int thumbHeight, ThemeConfig theme)
			: base(item, thumbWidth, thumbHeight, theme)
		{
			this.VAnchor = VAnchor.Fit;
			this.HAnchor = HAnchor.Fit;
			this.Padding = IconViewItem.ItemPadding;
			this.Margin = new BorderDouble(6, 0, 0, 6);
			this.Border = 1;

			int scaledWidth = (int)(thumbWidth * GuiWidget.DeviceScale);
			int scaledHeight = (int)(thumbHeight * GuiWidget.DeviceScale);

			int maxWidth = scaledWidth - 4;

			if (thumbWidth < 75)
			{
				imageWidget = new ImageWidget(scaledWidth, scaledHeight)
				{
					AutoResize = false,
					Name = "List Item Thumbnail",
					BackgroundColor = theme.ThumbnailBackground,
					Margin = 0,
					Selectable = false
				};
				this.AddChild(imageWidget);
			}
			else
			{
				var container = new FlowLayoutWidget(FlowDirection.TopToBottom)
				{
					Selectable = false
				};
				this.AddChild(container);

				imageWidget = new ImageWidget(scaledWidth, scaledHeight)
				{
					AutoResize = false,
					Name = "List Item Thumbnail",
					BackgroundColor = theme.ThumbnailBackground,
					Margin = 0,
					Selectable = false
				};
				container.AddChild(imageWidget);

				text = new TextWidget(item.Model.Name, 0, 0, 9, textColor: theme.TextColor)
				{
					AutoExpandBoundsToText = false,
					EllipsisIfClipped = true,
					HAnchor = HAnchor.Center,
					Margin = new BorderDouble(0, 0, 0, 3),
					Selectable = false
				};

				text.MaximumSize = new Vector2(maxWidth, 20);
				if (text.Printer.LocalBounds.Width > maxWidth)
				{
					text.Width = maxWidth;
					text.Text = item.Model.Name;
				}

				container.AddChild(text);
			}
		}

		public override string ToolTipText
		{
			get => text?.ToolTipText;
			set
			{
				if (text != null)
				{
					text.ToolTipText = value;
				}
			}
		}

		public override Color BackgroundColor
		{
			get => this.IsSelected ? theme.AccentMimimalOverlay : Color.Transparent;
			set { }
		}
	}
}