source: stable/HeuristicLab.Core.Views/3.3/ItemCollectionView.cs @ 17148

Last change on this file since 17148 was 17148, checked in by abeham, 2 months ago

#1616: merged to stable (17127)

File size: 19.9 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2019 Heuristic and Evolutionary Algorithms Laboratory (HEAL)
4 *
5 * This file is part of HeuristicLab.
6 *
7 * HeuristicLab is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
11 *
12 * HeuristicLab is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with HeuristicLab. If not, see <http://www.gnu.org/licenses/>.
19 */
20#endregion
21
22using System;
23using System.Collections;
24using System.Collections.Generic;
25using System.Linq;
26using System.Text;
27using System.Windows.Forms;
28using HeuristicLab.Collections;
29using HeuristicLab.Common;
30using HeuristicLab.MainForm;
31using HeuristicLab.PluginInfrastructure;
32
33namespace HeuristicLab.Core.Views {
34  [View("ItemCollection View")]
35  [Content(typeof(ItemCollection<>), true)]
36  [Content(typeof(IItemCollection<>), false)]
37  [Content(typeof(ReadOnlyItemCollection<>), true)]
38  public partial class ItemCollectionView<T> : ItemView where T : class, IItem {
39    protected Dictionary<T, List<ListViewItem>> itemListViewItemMapping;
40    protected TypeSelectorDialog typeSelectorDialog;
41    protected bool validDragOperation;
42
43    public new IItemCollection<T> Content {
44      get { return (IItemCollection<T>)base.Content; }
45      set { base.Content = value; }
46    }
47
48    public ObservableCollection<T> ItemCollection {
49      get { return Content as ObservableCollection<T>; }
50    }
51
52    public bool ShowDetails {
53      get { return showDetailsCheckBox.Checked; }
54      set { showDetailsCheckBox.Checked = value; }
55    }
56
57    public ListView ItemsListView {
58      get { return itemsListView; }
59    }
60
61    public ItemCollectionView() {
62      InitializeComponent();
63      itemListViewItemMapping = new Dictionary<T, List<ListViewItem>>();
64    }
65
66    protected override void Dispose(bool disposing) {
67      if (disposing) {
68        if (typeSelectorDialog != null) typeSelectorDialog.Dispose();
69        if (components != null) components.Dispose();
70      }
71      base.Dispose(disposing);
72    }
73
74    protected override void DeregisterContentEvents() {
75      Content.ItemsAdded -= new CollectionItemsChangedEventHandler<T>(Content_ItemsAdded);
76      Content.ItemsRemoved -= new CollectionItemsChangedEventHandler<T>(Content_ItemsRemoved);
77      Content.CollectionReset -= new CollectionItemsChangedEventHandler<T>(Content_CollectionReset);
78      foreach (T item in itemListViewItemMapping.Keys) {
79        DeregisterItemEvents(item);
80      }
81      base.DeregisterContentEvents();
82    }
83    protected override void RegisterContentEvents() {
84      base.RegisterContentEvents();
85      Content.ItemsAdded += new CollectionItemsChangedEventHandler<T>(Content_ItemsAdded);
86      Content.ItemsRemoved += new CollectionItemsChangedEventHandler<T>(Content_ItemsRemoved);
87      Content.CollectionReset += new CollectionItemsChangedEventHandler<T>(Content_CollectionReset);
88    }
89    protected virtual void DeregisterItemEvents(T item) {
90      item.ItemImageChanged -= new EventHandler(Item_ItemImageChanged);
91      item.ToStringChanged -= new EventHandler(Item_ToStringChanged);
92    }
93    protected virtual void RegisterItemEvents(T item) {
94      item.ItemImageChanged += new EventHandler(Item_ItemImageChanged);
95      item.ToStringChanged += new EventHandler(Item_ToStringChanged);
96    }
97
98    protected override void OnContentChanged() {
99      base.OnContentChanged();
100      itemsListView.Items.Clear();
101      itemListViewItemMapping.Clear();
102      RebuildImageList();
103      viewHost.Content = null;
104      if (Content != null) {
105        Caption += " (" + Content.GetType().Name + ")";
106        foreach (T item in Content.OrderBy(x => x.ToString()))
107          AddListViewItem(CreateListViewItem(item));
108        AdjustListViewColumnSizes();
109      }
110    }
111
112    protected override void SetEnabledStateOfControls() {
113      base.SetEnabledStateOfControls();
114      if (Content == null) {
115        addButton.Enabled = false;
116        sortAscendingButton.Enabled = false;
117        sortDescendingButton.Enabled = false;
118        removeButton.Enabled = false;
119        itemsListView.Enabled = false;
120        detailsGroupBox.Enabled = false;
121      } else {
122        addButton.Enabled = !Content.IsReadOnly && !ReadOnly;
123        sortAscendingButton.Enabled = itemsListView.Items.Count > 1;
124        sortDescendingButton.Enabled = itemsListView.Items.Count > 1;
125        removeButton.Enabled = !Content.IsReadOnly && !ReadOnly && itemsListView.SelectedItems.Count > 0;
126        itemsListView.Enabled = true;
127        detailsGroupBox.Enabled = itemsListView.SelectedItems.Count == 1;
128      }
129    }
130
131    protected virtual T CreateItem() {
132      if (typeSelectorDialog == null) {
133        typeSelectorDialog = new TypeSelectorDialog();
134        typeSelectorDialog.Caption = "Select Item";
135        typeSelectorDialog.TypeSelector.Caption = "Available Items";
136        typeSelectorDialog.TypeSelector.Configure(typeof(T), false, true);
137      }
138
139      if (typeSelectorDialog.ShowDialog(this) == DialogResult.OK) {
140        try {
141          return (T)typeSelectorDialog.TypeSelector.CreateInstanceOfSelectedType();
142        } catch (Exception ex) {
143          ErrorHandling.ShowErrorDialog(this, ex);
144        }
145      }
146      return null;
147    }
148    protected virtual ListViewItem CreateListViewItem(T item) {
149      ListViewItem listViewItem = new ListViewItem();
150      if (item == null) {
151        listViewItem.Text = "null";
152        itemsListView.SmallImageList.Images.Add(HeuristicLab.Common.Resources.VSImageLibrary.Nothing);
153        listViewItem.ImageIndex = itemsListView.SmallImageList.Images.Count - 1;
154      } else {
155        listViewItem.Text = item.ToString();
156        listViewItem.ToolTipText = item.ItemName + ": " + item.ItemDescription;
157        itemsListView.SmallImageList.Images.Add(item.ItemImage);
158        listViewItem.ImageIndex = itemsListView.SmallImageList.Images.Count - 1;
159        listViewItem.Tag = item;
160      }
161      return listViewItem;
162    }
163    protected virtual void AddListViewItem(ListViewItem listViewItem) {
164      if (listViewItem == null) throw new ArgumentNullException();
165      T item = (listViewItem.Tag as T);
166      itemsListView.Items.Add(listViewItem);
167      if (item != null) {
168        if (!itemListViewItemMapping.ContainsKey(item)) {
169          RegisterItemEvents(item);
170          itemListViewItemMapping.Add(item, new List<ListViewItem>());
171        }
172        itemListViewItemMapping[item].Add(listViewItem);
173      }
174      sortAscendingButton.Enabled = itemsListView.Items.Count > 1;
175      sortDescendingButton.Enabled = itemsListView.Items.Count > 1;
176    }
177    protected virtual void RemoveListViewItem(ListViewItem listViewItem) {
178      if (listViewItem == null) throw new ArgumentNullException();
179      T item = (listViewItem.Tag as T);
180      if (item != null) {
181        itemListViewItemMapping[item].Remove(listViewItem);
182        if (itemListViewItemMapping[item].Count == 0) {
183          itemListViewItemMapping.Remove(item);
184          DeregisterItemEvents(item);
185        }
186      }
187      listViewItem.Remove();
188      sortAscendingButton.Enabled = itemsListView.Items.Count > 1;
189      sortDescendingButton.Enabled = itemsListView.Items.Count > 1;
190    }
191    protected virtual void UpdateListViewItemImage(ListViewItem listViewItem) {
192      if (listViewItem == null) throw new ArgumentNullException();
193      T item = listViewItem.Tag as T;
194      int i = listViewItem.ImageIndex;
195      itemsListView.SmallImageList.Images[i] = item == null ? HeuristicLab.Common.Resources.VSImageLibrary.Nothing : item.ItemImage;
196      listViewItem.ImageIndex = -1;
197      listViewItem.ImageIndex = i;
198    }
199    protected virtual void UpdateListViewItemText(ListViewItem listViewItem) {
200      if (listViewItem == null) throw new ArgumentNullException();
201      T item = listViewItem.Tag as T;
202      listViewItem.Text = item == null ? "null" : item.ToString();
203      listViewItem.ToolTipText = item == null ? string.Empty : item.ItemName + ": " + item.ItemDescription;
204    }
205    protected virtual IEnumerable<ListViewItem> GetListViewItemsForItem(T item) {
206      if (item == null) {
207        List<ListViewItem> listViewItems = new List<ListViewItem>();
208        foreach (ListViewItem listViewItem in itemsListView.Items) {
209          if (listViewItem.Tag == null) listViewItems.Add(listViewItem);
210        }
211        return listViewItems;
212      } else {
213        List<ListViewItem> listViewItems = null;
214        itemListViewItemMapping.TryGetValue(item, out listViewItems);
215        return listViewItems == null ? Enumerable.Empty<ListViewItem>() : listViewItems;
216      }
217    }
218
219    #region ListView Events
220    protected virtual void itemsListView_SelectedIndexChanged(object sender, EventArgs e) {
221      removeButton.Enabled = (Content != null) && !Content.IsReadOnly && !ReadOnly && itemsListView.SelectedItems.Count > 0;
222      if (showDetailsCheckBox.Checked) {
223        if (itemsListView.SelectedItems.Count == 1) {
224          T item = (T)itemsListView.SelectedItems[0].Tag;
225          detailsGroupBox.Enabled = true;
226          viewHost.Content = item;
227        } else {
228          viewHost.Content = null;
229          detailsGroupBox.Enabled = false;
230        }
231      }
232    }
233    protected virtual void itemsListView_KeyDown(object sender, KeyEventArgs e) {
234      if (e.KeyCode == Keys.Delete) {
235        if ((itemsListView.SelectedItems.Count > 0) && !Content.IsReadOnly && !ReadOnly) {
236          if (ItemCollection != null) ItemCollection.RemoveRange(itemsListView.SelectedItems.Cast<ListViewItem>().Select(i => (T)i.Tag));
237          else {
238            foreach (ListViewItem item in itemsListView.SelectedItems)
239              Content.Remove((T)item.Tag);
240          }
241        }
242      } else if (e.KeyData == (Keys.Control | Keys.C)) {
243        if (itemsListView.SelectedItems.Count > 0) {
244          var builder = new StringBuilder();
245          foreach (ListViewItem selected in itemsListView.SelectedItems) {
246            builder.AppendLine(selected.Text);
247          }
248          Clipboard.SetText(builder.ToString());
249        }
250      } else if (itemsListView.MultiSelect && e.KeyData == (Keys.A | Keys.Control)) {
251        try {
252          itemsListView.BeginUpdate();
253          foreach (ListViewItem item in itemsListView.Items)
254            item.Selected = true;
255        } finally { itemsListView.EndUpdate(); }
256      }
257    }
258    protected virtual void itemsListView_DoubleClick(object sender, EventArgs e) {
259      if (itemsListView.SelectedItems.Count == 1) {
260        T item = itemsListView.SelectedItems[0].Tag as T;
261        if (item != null) {
262          IContentView view = MainFormManager.MainForm.ShowContent(item);
263          if (view != null) {
264            view.ReadOnly = ReadOnly;
265            view.Locked = Locked;
266          }
267        }
268      }
269    }
270    protected virtual void itemsListView_ItemDrag(object sender, ItemDragEventArgs e) {
271      if (!Locked) {
272        List<T> items = new List<T>();
273        foreach (ListViewItem listViewItem in itemsListView.SelectedItems) {
274          T item = listViewItem.Tag as T;
275          if (item != null) items.Add(item);
276        }
277
278        if (items.Count > 0) {
279          DataObject data = new DataObject();
280          if (items.Count == 1) data.SetData(HeuristicLab.Common.Constants.DragDropDataFormat, items[0]);
281          else data.SetData(HeuristicLab.Common.Constants.DragDropDataFormat, items);
282          if (Content.IsReadOnly || ReadOnly) {
283            DoDragDrop(data, DragDropEffects.Copy | DragDropEffects.Link);
284          } else {
285            DragDropEffects result = DoDragDrop(data, DragDropEffects.Copy | DragDropEffects.Link | DragDropEffects.Move);
286            if ((result & DragDropEffects.Move) == DragDropEffects.Move) {
287              foreach (T item in items) Content.Remove(item);
288            }
289          }
290        }
291      }
292    }
293    protected virtual void itemsListView_DragEnter(object sender, DragEventArgs e) {
294      validDragOperation = false;
295      if (!Content.IsReadOnly && !ReadOnly && (e.Data.GetData(HeuristicLab.Common.Constants.DragDropDataFormat) is T)) {
296        validDragOperation = true;
297      } else if (!Content.IsReadOnly && !ReadOnly && (e.Data.GetData(HeuristicLab.Common.Constants.DragDropDataFormat) is IEnumerable)) {
298        validDragOperation = true;
299        IEnumerable items = (IEnumerable)e.Data.GetData(HeuristicLab.Common.Constants.DragDropDataFormat);
300        foreach (object item in items)
301          validDragOperation = validDragOperation && (item is T);
302      }
303    }
304    protected virtual void itemsListView_DragOver(object sender, DragEventArgs e) {
305      e.Effect = DragDropEffects.None;
306      if (validDragOperation) {
307        if ((e.KeyState & 32) == 32) e.Effect = DragDropEffects.Link;  // ALT key
308        else if ((e.KeyState & 4) == 4) e.Effect = DragDropEffects.Move;  // SHIFT key
309        else if (e.AllowedEffect.HasFlag(DragDropEffects.Copy)) e.Effect = DragDropEffects.Copy;
310        else if (e.AllowedEffect.HasFlag(DragDropEffects.Move)) e.Effect = DragDropEffects.Move;
311        else if (e.AllowedEffect.HasFlag(DragDropEffects.Link)) e.Effect = DragDropEffects.Link;
312      }
313    }
314    protected virtual void itemsListView_DragDrop(object sender, DragEventArgs e) {
315      if (e.Effect != DragDropEffects.None) {
316        if (e.Data.GetData(HeuristicLab.Common.Constants.DragDropDataFormat) is T) {
317          T item = (T)e.Data.GetData(HeuristicLab.Common.Constants.DragDropDataFormat);
318          Content.Add(e.Effect.HasFlag(DragDropEffects.Copy) ? (T)item.Clone() : item);
319        } else if (e.Data.GetData(HeuristicLab.Common.Constants.DragDropDataFormat) is IEnumerable) {
320          IEnumerable<T> items = ((IEnumerable)e.Data.GetData(HeuristicLab.Common.Constants.DragDropDataFormat)).Cast<T>();
321          if (e.Effect.HasFlag(DragDropEffects.Copy)) {
322            Cloner cloner = new Cloner();
323            items = items.Select(x => cloner.Clone(x));
324          }
325          if (ItemCollection != null) ItemCollection.AddRange(items);
326          else {
327            foreach (T item in items)
328              Content.Add(item);
329          }
330        }
331      }
332    }
333    protected virtual void itemsListView_Layout(object sender, LayoutEventArgs e) {
334      if (itemsListView.Columns.Count == 1)
335        AdjustListViewColumnSizes();
336    }
337    #endregion
338
339    #region Button Events
340    protected virtual void addButton_Click(object sender, EventArgs e) {
341      T item = CreateItem();
342      if (item != null)
343        Content.Add(item);
344    }
345    protected virtual void sortAscendingButton_Click(object sender, EventArgs e) {
346      SortItemsListView(SortOrder.Ascending);
347    }
348    protected virtual void sortDescendingButton_Click(object sender, EventArgs e) {
349      SortItemsListView(SortOrder.Descending);
350    }
351    protected virtual void removeButton_Click(object sender, EventArgs e) {
352      if (itemsListView.SelectedItems.Count > 0) {
353        if (ItemCollection != null) {
354          ItemCollection.RemoveRange(itemsListView.SelectedItems.Cast<ListViewItem>().Select(i => (T)i.Tag));
355        } else {
356          foreach (ListViewItem item in itemsListView.SelectedItems)
357            Content.Remove((T)item.Tag);
358        }
359        itemsListView.SelectedItems.Clear();
360      }
361    }
362    #endregion
363
364    #region CheckBox Events
365    protected virtual void showDetailsCheckBox_CheckedChanged(object sender, EventArgs e) {
366      if (showDetailsCheckBox.Checked) {
367        splitContainer.Panel2Collapsed = false;
368        detailsGroupBox.Enabled = itemsListView.SelectedItems.Count == 1;
369        viewHost.Content = itemsListView.SelectedItems.Count == 1 ? (T)itemsListView.SelectedItems[0].Tag : null;
370      } else {
371        splitContainer.Panel2Collapsed = true;
372        viewHost.Content = null;
373      }
374    }
375    #endregion
376
377    #region Content Events
378    protected virtual void Content_ItemsAdded(object sender, CollectionItemsChangedEventArgs<T> e) {
379      if (InvokeRequired)
380        Invoke(new CollectionItemsChangedEventHandler<T>(Content_ItemsAdded), sender, e);
381      else {
382        foreach (T item in e.Items)
383          AddListViewItem(CreateListViewItem(item));
384        AdjustListViewColumnSizes();
385      }
386
387    }
388    protected virtual void Content_ItemsRemoved(object sender, CollectionItemsChangedEventArgs<T> e) {
389      if (InvokeRequired)
390        Invoke(new CollectionItemsChangedEventHandler<T>(Content_ItemsRemoved), sender, e);
391      else {
392        foreach (T item in e.Items) {
393          //remove only the first matching ListViewItem, because the IItem could be contained multiple times in the ItemCollection
394          ListViewItem listviewItem = GetListViewItemsForItem(item).FirstOrDefault();
395          if (listviewItem != null) RemoveListViewItem(listviewItem);
396        }
397        RebuildImageList();
398      }
399    }
400    protected virtual void Content_CollectionReset(object sender, CollectionItemsChangedEventArgs<T> e) {
401      if (InvokeRequired)
402        Invoke(new CollectionItemsChangedEventHandler<T>(Content_CollectionReset), sender, e);
403      else {
404        foreach (T item in e.OldItems) {
405          //remove only the first matching ListViewItem, because the IItem could be contained multiple times in the ItemCollection
406          ListViewItem listviewItem = GetListViewItemsForItem(item).FirstOrDefault();
407          if (listviewItem != null) RemoveListViewItem(listviewItem);
408        }
409        RebuildImageList();
410        foreach (T item in e.Items)
411          AddListViewItem(CreateListViewItem(item));
412      }
413    }
414    #endregion
415
416    #region Item Events
417    protected virtual void Item_ItemImageChanged(object sender, EventArgs e) {
418      if (InvokeRequired)
419        Invoke(new EventHandler(Item_ItemImageChanged), sender, e);
420      else {
421        T item = (T)sender;
422        foreach (ListViewItem listViewItem in GetListViewItemsForItem(item))
423          UpdateListViewItemImage(listViewItem);
424      }
425    }
426    protected virtual void Item_ToStringChanged(object sender, EventArgs e) {
427      if (InvokeRequired)
428        Invoke(new EventHandler(Item_ToStringChanged), sender, e);
429      else {
430        T item = (T)sender;
431        foreach (ListViewItem listViewItem in GetListViewItemsForItem(item))
432          UpdateListViewItemText(listViewItem);
433        if (itemsListView.Columns.Count > 1)
434          AdjustListViewColumnSizes();
435      }
436    }
437    #endregion
438
439    #region Helpers
440    protected virtual void SortItemsListView(SortOrder sortOrder) {
441      itemsListView.Sorting = SortOrder.None;
442      itemsListView.Sorting = sortOrder;
443      itemsListView.Sorting = SortOrder.None;
444    }
445    protected virtual void AdjustListViewColumnSizes() {
446      if (itemsListView.Columns.Count == 1) {
447        if (itemsListView.Columns[0].Width != itemsListView.ClientSize.Width)
448          itemsListView.Columns[0].Width = itemsListView.ClientSize.Width;
449      } else {
450        if (itemsListView.Items.Count > 0) {
451          for (int i = 0; i < itemsListView.Columns.Count; i++)
452            itemsListView.Columns[i].AutoResize(ColumnHeaderAutoResizeStyle.ColumnContent);
453        }
454      }
455    }
456    protected virtual void RebuildImageList() {
457      itemsListView.SmallImageList.Images.Clear();
458      foreach (ListViewItem listViewItem in itemsListView.Items) {
459        T item = listViewItem.Tag as T;
460        itemsListView.SmallImageList.Images.Add(item == null ? HeuristicLab.Common.Resources.VSImageLibrary.Nothing : item.ItemImage);
461        listViewItem.ImageIndex = itemsListView.SmallImageList.Images.Count - 1;
462      }
463    }
464    #endregion
465  }
466}
Note: See TracBrowser for help on using the repository browser.