DynamicGridFilterButtonComponent.cs 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489
  1. using InABox.Configuration;
  2. using InABox.Core;
  3. using InABox.WPF;
  4. using System;
  5. using System.Collections.Generic;
  6. using System.Drawing;
  7. using System.Linq;
  8. using System.Text;
  9. using System.Threading.Tasks;
  10. using System.Windows;
  11. using System.Windows.Controls;
  12. namespace InABox.DynamicGrid;
  13. public class DynamicGridSelectedFilterSettings
  14. {
  15. public string? TemporaryFilter { get; set; }
  16. public List<CoreFilterDefinition> SelectedFilters { get; set; }
  17. public bool MultipleFilters { get; set; }
  18. public DynamicGridSelectedFilterSettings()
  19. {
  20. SelectedFilters = new List<CoreFilterDefinition>();
  21. MultipleFilters = false;
  22. }
  23. public DynamicGridSelectedFilterSettings(List<ICoreFilterDefinition> selectedFilters, bool multipleFilters, string? temporaryFilter)
  24. {
  25. SelectedFilters = selectedFilters.Select(x =>
  26. {
  27. if(x is CoreFilterDefinition def)
  28. {
  29. return def;
  30. }
  31. else
  32. {
  33. return new CoreFilterDefinition
  34. {
  35. Name = x.Name,
  36. Filter = ""
  37. };
  38. }
  39. }).ToList();
  40. MultipleFilters = multipleFilters || selectedFilters.Count > 1;
  41. TemporaryFilter = temporaryFilter;
  42. }
  43. }
  44. public class DynamicGridFilterComponentBuiltInFilter<T>(string name, Func<Filter<T>> getFilter) : ICoreFilterDefinition
  45. {
  46. public string Name { get; set; } = name;
  47. public Func<Filter<T>> GetFilter { get; set; } = getFilter;
  48. public Filter<T1>? AsFilter<T1>()
  49. {
  50. return null;
  51. }
  52. }
  53. public abstract class DynamicGridFilterComponent<T>
  54. {
  55. #region Private Fields
  56. private class FilterItem
  57. {
  58. public string Name { get; set; }
  59. public Filter<T>? Filter { get; }
  60. public ICoreFilterDefinition Definition { get; set; }
  61. public FilterItem(string name, Filter<T>? filter, ICoreFilterDefinition definition)
  62. {
  63. Name = name;
  64. Filter = filter;
  65. Definition = definition;
  66. }
  67. public Filter<T>? GetFilter()
  68. {
  69. if(Definition is DynamicGridFilterComponentBuiltInFilter<T> definition)
  70. {
  71. return definition.GetFilter();
  72. }
  73. else
  74. {
  75. return Filter;
  76. }
  77. }
  78. }
  79. private List<FilterItem> SelectedFilters = new();
  80. private Filter<T>? TemporaryFilter = null;
  81. private int NumberOfFilters => SelectedFilters.Count + (TemporaryFilter is null ? 0 : 1);
  82. #endregion
  83. #region Public Properties
  84. public IConfiguration<CoreFilterDefinitions> GlobalConfiguration { get; set; }
  85. public IConfiguration<CoreFilterDefinitions> UserConfiguration { get; set; }
  86. public List<DynamicGridFilterComponentBuiltInFilter<T>> BuiltInFilters { get; init; } = new();
  87. private bool _multipleFilters = false;
  88. private bool MultipleFilters
  89. {
  90. get => _multipleFilters;
  91. set
  92. {
  93. if (_multipleFilters != value)
  94. {
  95. _multipleFilters = value;
  96. if (!_multipleFilters && NumberOfFilters > 1)
  97. {
  98. ClearFilters(true);
  99. }
  100. }
  101. }
  102. }
  103. private string? _buttonText;
  104. public string? ButtonText
  105. {
  106. get => _buttonText;
  107. set
  108. {
  109. if (!string.Equals(_buttonText, value))
  110. {
  111. _buttonText = value;
  112. UpdateButton();
  113. }
  114. }
  115. }
  116. #endregion
  117. #region Events
  118. public delegate void FilterSelectedHandler(DynamicGridSelectedFilterSettings filters);
  119. public event FilterSelectedHandler? OnFiltersSelected;
  120. public delegate void FilterRefreshHandler();
  121. public event FilterRefreshHandler? OnFilterRefresh;
  122. #endregion
  123. public DynamicGridFilterComponent(
  124. IConfiguration<CoreFilterDefinitions> globalConfiguration,
  125. IConfiguration<CoreFilterDefinitions> userConfiguration)
  126. {
  127. GlobalConfiguration = globalConfiguration;
  128. UserConfiguration = userConfiguration;
  129. }
  130. public void SetSettings(DynamicGridSelectedFilterSettings settings, bool refresh)
  131. {
  132. _multipleFilters = settings.MultipleFilters;
  133. TemporaryFilter = Serialization.Deserialize<Filter<T>>(settings.TemporaryFilter);
  134. SelectFilters(settings.SelectedFilters, refresh);
  135. }
  136. #region Menu
  137. private ContextMenu? Menu;
  138. public void PopulateMenu(ContextMenu menu)
  139. {
  140. RebuildMenu(menu);
  141. }
  142. public void PopulateMenu(MenuItem menu)
  143. {
  144. RebuildMenu(menu);
  145. }
  146. private void RebuildMenu(ItemsControl menu)
  147. {
  148. menu.Items.Clear();
  149. if (TemporaryFilter is null)
  150. {
  151. menu.AddCheckMenuItem("Filter...", TemporaryFilter_Click, isChecked: false);
  152. }
  153. else
  154. {
  155. menu.AddCheckMenuItem("<Custom Filter>", TemporaryFilter_Click, isChecked: true);
  156. }
  157. menu.AddMenuItem("Clear Filters", null, ClearFilter_Click);
  158. var multipleFilters = menu.AddCheckMenuItem("Use Multiple Filters", MultipleFilters_Click, MultipleFilters);
  159. multipleFilters.StaysOpenOnClick = true;
  160. menu.AddMenuSeparatorIfNeeded();
  161. var globalFilters = Security.IsAllowed<CanEditGlobalFilters>() ? GlobalConfiguration.Load() : new CoreFilterDefinitions();
  162. var userFilters = UserConfiguration.Load();
  163. var filters = new CoreFilterDefinitions(globalFilters.Count + userFilters.Count);
  164. foreach (var filter in BuiltInFilters.Concat<ICoreFilterDefinition>(globalFilters).Concat(userFilters))
  165. {
  166. var item = menu.AddCheckMenuItem(filter.Name, filter, Filter_Toggle);
  167. item.StaysOpenOnClick = true;
  168. if (SelectedFilters.Any(x => x.Name.Equals(filter.Name)))
  169. {
  170. item.IsChecked = true;
  171. }
  172. if(filter is CoreFilterDefinition coreFilter)
  173. {
  174. filters.Add(coreFilter);
  175. }
  176. }
  177. if (Security.IsAllowed<CanCustomiseFilters>())
  178. {
  179. menu.AddMenuSeparatorIfNeeded();
  180. menu.AddMenuItem("Manage Filters", null, () =>
  181. {
  182. var window = new DynamicGridFilterEditor(filters, typeof(T));
  183. if (window.ShowDialog() == true)
  184. {
  185. globalFilters.Clear();
  186. globalFilters.AddRange(filters.Where(x => !x.Private));
  187. userFilters.Clear();
  188. userFilters.AddRange(filters.Where(x => x.Private));
  189. if (Security.IsAllowed<CanEditGlobalFilters>())
  190. {
  191. GlobalConfiguration.Save(globalFilters);
  192. }
  193. UserConfiguration.Save(userFilters);
  194. }
  195. });
  196. }
  197. }
  198. private void TemporaryFilter_Click(bool isChecked)
  199. {
  200. var window = new FilterEditorWindow();
  201. window.SetFilter(TemporaryFilter ?? new Filter<T>());
  202. if (window.ShowDialog() == true)
  203. {
  204. TemporaryFilter = window.GetFilter<T>();
  205. if (TemporaryFilter is not null && !MultipleFilters)
  206. {
  207. SelectedFilters.Clear();
  208. }
  209. UpdateFilters(true);
  210. }
  211. }
  212. protected void DoFilter()
  213. {
  214. Menu = new ContextMenu();
  215. RebuildMenu(Menu);
  216. Menu.IsOpen = true;
  217. Menu.Closed += Menu_Closed;
  218. }
  219. private void Menu_Closed(object sender, RoutedEventArgs e)
  220. {
  221. if (Menu == sender)
  222. {
  223. Menu = null;
  224. }
  225. }
  226. private void ClearFilter_Click()
  227. {
  228. ClearFilters(true);
  229. }
  230. private void MultipleFilters_Click(bool isChecked)
  231. {
  232. MultipleFilters = isChecked;
  233. if (Menu is not null)
  234. {
  235. RebuildMenu(Menu);
  236. }
  237. SaveSettings();
  238. }
  239. private void Filter_Toggle(ICoreFilterDefinition tag, bool isChecked)
  240. {
  241. if (MultipleFilters)
  242. {
  243. if (isChecked)
  244. {
  245. SelectFilter(tag, true, true);
  246. }
  247. else
  248. {
  249. DeselectFilter(tag, true);
  250. }
  251. }
  252. else
  253. {
  254. SelectFilter(tag, false, true);
  255. if (Menu is not null)
  256. {
  257. Menu.IsOpen = false;
  258. }
  259. }
  260. }
  261. #endregion
  262. public void ClearFilters(bool refresh)
  263. {
  264. if (NumberOfFilters > 0)
  265. {
  266. SelectedFilters.Clear();
  267. TemporaryFilter = null;
  268. UpdateFilters(refresh);
  269. }
  270. }
  271. public void DeselectFilter(ICoreFilterDefinition filter, bool refresh)
  272. {
  273. var removed = SelectedFilters.RemoveAll(x => x.Name.Equals(filter.Name));
  274. if (removed > 0)
  275. {
  276. UpdateFilters(refresh);
  277. }
  278. }
  279. /// <summary>
  280. /// Select a new filter. If <paramref name="additional"/> is <see langword="true"/>, adds it to the list of selected filters;
  281. /// otherwise, it sets this as the only filter.
  282. /// </summary>
  283. /// <param name="filter"></param>
  284. /// <param name="additional"></param>
  285. /// <param name="refresh"></param>
  286. public void SelectFilter(ICoreFilterDefinition? filter, bool additional, bool refresh)
  287. {
  288. var originalCount = SelectedFilters.Count;
  289. var alreadyHas = filter is null || SelectedFilters.Any(x => x.Name.Equals(filter.Name));
  290. if (!additional)
  291. {
  292. SelectedFilters.Clear();
  293. TemporaryFilter = null;
  294. }
  295. if (filter is not null && !SelectedFilters.Any(x => x.Name.Equals(filter.Name)))
  296. {
  297. SelectedFilters.Add(new(filter.Name, filter.AsFilter<T>(), filter));
  298. }
  299. if (SelectedFilters.Count != originalCount || !alreadyHas)
  300. {
  301. UpdateFilters(refresh);
  302. }
  303. }
  304. public void SelectFilters(IEnumerable<ICoreFilterDefinition> filters, bool refresh)
  305. {
  306. SelectedFilters.Clear();
  307. foreach (var filter in filters)
  308. {
  309. var builtIn = BuiltInFilters.FirstOrDefault(x => x.Name == filter.Name);
  310. if(builtIn is not null)
  311. {
  312. SelectedFilters.Add(new(filter.Name, null, builtIn));
  313. }
  314. else
  315. {
  316. SelectedFilters.Add(new(filter.Name, filter.AsFilter<T>(), filter));
  317. }
  318. }
  319. if (NumberOfFilters > 1 && !MultipleFilters)
  320. {
  321. MultipleFilters = true;
  322. }
  323. UpdateFilters(refresh);
  324. }
  325. private void UpdateFilters(bool refresh)
  326. {
  327. UpdateButton();
  328. SaveSettings();
  329. if (refresh)
  330. {
  331. OnFilterRefresh?.Invoke();
  332. }
  333. }
  334. protected abstract void UpdateButtonText(Bitmap image, string text);
  335. private void UpdateButton()
  336. {
  337. var image = NumberOfFilters > 0
  338. ? Wpf.Resources.filter_set
  339. : Wpf.Resources.filter;
  340. var filterNames = SelectedFilters.Select(x => x.Name);
  341. if (TemporaryFilter is not null)
  342. {
  343. filterNames = CoreUtils.One("Custom").Concat(filterNames);
  344. }
  345. var text = string.Join(", ", filterNames);
  346. if (!ButtonText.IsNullOrWhiteSpace())
  347. {
  348. if (text.IsNullOrWhiteSpace())
  349. {
  350. text = ButtonText;
  351. }
  352. else
  353. {
  354. text = $"{ButtonText}: {text}";
  355. }
  356. }
  357. UpdateButtonText(image, text);
  358. }
  359. private void SaveSettings()
  360. {
  361. OnFiltersSelected?.Invoke(new DynamicGridSelectedFilterSettings(
  362. SelectedFilters.Select(x => x.Definition).ToList(),
  363. MultipleFilters,
  364. TemporaryFilter is not null ? Serialization.Serialize(TemporaryFilter) : null));
  365. }
  366. public Filter<T>? GetFilter()
  367. {
  368. var filters = new Filters<T>();
  369. filters.AddRange(SelectedFilters.Select(x => x.GetFilter()));
  370. filters.Add(TemporaryFilter);
  371. return filters.Combine();
  372. }
  373. }
  374. public class DynamicGridFilterButtonComponent<T> : DynamicGridFilterComponent<T>
  375. where T : BaseObject, new()
  376. {
  377. private readonly IDynamicGrid Grid;
  378. private Button FilterBtn = null!;
  379. private bool _showFilterList;
  380. public bool ShowFilterList
  381. {
  382. get => _showFilterList;
  383. set
  384. {
  385. _showFilterList = value;
  386. if (FilterBtn != null)
  387. FilterBtn.Visibility = value ? Visibility.Visible : Visibility.Collapsed;
  388. }
  389. }
  390. public DynamicGridFilterButtonComponent(
  391. IDynamicGrid grid,
  392. IConfiguration<CoreFilterDefinitions> globalConfiguration,
  393. IConfiguration<CoreFilterDefinitions> userConfiguration) : base(globalConfiguration, userConfiguration)
  394. {
  395. Grid = grid;
  396. CreateButton();
  397. }
  398. private void CreateButton()
  399. {
  400. FilterBtn = Grid.AddButton("", Wpf.Resources.filter.AsBitmapImage(), Click);
  401. FilterBtn.Margin = new Thickness(0, 2, 7, 0);
  402. FilterBtn.Padding = new Thickness(0);
  403. }
  404. private bool Click(Button _arg1, CoreRow[] _arg2)
  405. {
  406. DoFilter();
  407. return false;
  408. }
  409. protected override void UpdateButtonText(Bitmap image, string text)
  410. {
  411. Grid.UpdateButton(FilterBtn, image.AsBitmapImage(), text);
  412. }
  413. }