Free cookie consent management tool by TermsFeed Policy Generator

source: trunk/sources/HeuristicLab.Core.Views/3.3/ItemListView.cs @ 5839

Last change on this file since 5839 was 5839, checked in by swagner, 13 years ago

Fixed NullReferenceException in collection views when updating the item image of a hidden item (#1377)

File size: 22.2 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2011 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.Drawing;
26using System.Linq;
27using System.Windows.Forms;
28using HeuristicLab.Collections;
29using HeuristicLab.MainForm;
30using HeuristicLab.MainForm.WindowsForms;
31using HeuristicLab.PluginInfrastructure;
32
33namespace HeuristicLab.Core.Views {
34  [View("ItemList View")]
35  [Content(typeof(ItemList<>), true)]
36  [Content(typeof(IItemList<>), false)]
37  public partial class ItemListView<T> : ItemView where T : class, IItem {
38    protected Dictionary<T, List<ListViewItem>> itemListViewItemMapping;
39    protected TypeSelectorDialog typeSelectorDialog;
40    protected bool validDragOperation;
41
42    public new IItemList<T> Content {
43      get { return (IItemList<T>)base.Content; }
44      set { base.Content = value; }
45    }
46
47    public ListView ItemsListView {
48      get { return itemsListView; }
49    }
50
51    public ItemListView() {
52      InitializeComponent();
53      itemListViewItemMapping = new Dictionary<T, List<ListViewItem>>();
54    }
55
56    protected override void Dispose(bool disposing) {
57      if (disposing) {
58        if (typeSelectorDialog != null) typeSelectorDialog.Dispose();
59        if (components != null) components.Dispose();
60      }
61      base.Dispose(disposing);
62    }
63
64    protected override void DeregisterContentEvents() {
65      Content.ItemsAdded -= new CollectionItemsChangedEventHandler<IndexedItem<T>>(Content_ItemsAdded);
66      Content.ItemsRemoved -= new CollectionItemsChangedEventHandler<IndexedItem<T>>(Content_ItemsRemoved);
67      Content.ItemsReplaced -= new CollectionItemsChangedEventHandler<IndexedItem<T>>(Content_ItemsReplaced);
68      Content.ItemsMoved -= new CollectionItemsChangedEventHandler<IndexedItem<T>>(Content_ItemsMoved);
69      Content.CollectionReset -= new CollectionItemsChangedEventHandler<IndexedItem<T>>(Content_CollectionReset);
70      foreach (T item in itemListViewItemMapping.Keys) {
71        DeregisterItemEvents(item);
72      }
73      base.DeregisterContentEvents();
74    }
75    protected override void RegisterContentEvents() {
76      base.RegisterContentEvents();
77      Content.ItemsAdded += new CollectionItemsChangedEventHandler<IndexedItem<T>>(Content_ItemsAdded);
78      Content.ItemsRemoved += new CollectionItemsChangedEventHandler<IndexedItem<T>>(Content_ItemsRemoved);
79      Content.ItemsReplaced += new CollectionItemsChangedEventHandler<IndexedItem<T>>(Content_ItemsReplaced);
80      Content.ItemsMoved += new CollectionItemsChangedEventHandler<IndexedItem<T>>(Content_ItemsMoved);
81      Content.CollectionReset += new CollectionItemsChangedEventHandler<IndexedItem<T>>(Content_CollectionReset);
82    }
83    protected virtual void DeregisterItemEvents(T item) {
84      item.ItemImageChanged -= new EventHandler(Item_ItemImageChanged);
85      item.ToStringChanged -= new EventHandler(Item_ToStringChanged);
86    }
87    protected virtual void RegisterItemEvents(T item) {
88      item.ItemImageChanged += new EventHandler(Item_ItemImageChanged);
89      item.ToStringChanged += new EventHandler(Item_ToStringChanged);
90    }
91
92    protected override void OnContentChanged() {
93      base.OnContentChanged();
94
95      int selectedIndex = -1;
96      if (itemsListView.SelectedItems.Count == 1) selectedIndex = itemsListView.SelectedIndices[0];
97
98      itemsListView.Items.Clear();
99      itemListViewItemMapping.Clear();
100      RebuildImageList();
101      viewHost.Content = null;
102      if (Content != null) {
103        foreach (T item in Content)
104          AddListViewItem(CreateListViewItem(item));
105        AdjustListViewColumnSizes();
106        if ((selectedIndex != -1) && (selectedIndex < itemsListView.Items.Count))
107          itemsListView.Items[selectedIndex].Selected = true;
108      }
109      SetEnabledStateOfControls();
110    }
111
112    protected override void SetEnabledStateOfControls() {
113      base.SetEnabledStateOfControls();
114      if (Content == null) {
115        addButton.Enabled = false;
116        moveUpButton.Enabled = false;
117        moveDownButton.Enabled = false;
118        removeButton.Enabled = false;
119        itemsListView.Enabled = false;
120        detailsGroupBox.Enabled = false;
121      } else {
122        addButton.Enabled = !Content.IsReadOnly && !ReadOnly;
123        moveUpButton.Enabled = itemsListView.SelectedItems.Count == 1 &&
124                               itemsListView.SelectedIndices[0] != 0 &&
125                               !Content.IsReadOnly && !ReadOnly;
126        moveDownButton.Enabled = itemsListView.SelectedItems.Count == 1 &&
127                                 itemsListView.SelectedIndices[0] != itemsListView.Items.Count - 1 &&
128                                 !Content.IsReadOnly && !ReadOnly;
129        removeButton.Enabled = itemsListView.SelectedItems.Count > 0 &&
130                               !Content.IsReadOnly && !ReadOnly;
131        itemsListView.Enabled = true;
132        detailsGroupBox.Enabled = itemsListView.SelectedItems.Count == 1;
133      }
134    }
135
136    protected virtual T CreateItem() {
137      if (typeSelectorDialog == null) {
138        typeSelectorDialog = new TypeSelectorDialog();
139        typeSelectorDialog.Caption = "Select Item";
140        typeSelectorDialog.TypeSelector.Caption = "Available Items";
141        typeSelectorDialog.TypeSelector.Configure(typeof(T), false, true);
142      }
143
144      if (typeSelectorDialog.ShowDialog(this) == DialogResult.OK) {
145        try {
146          return (T)typeSelectorDialog.TypeSelector.CreateInstanceOfSelectedType();
147        }
148        catch (Exception ex) {
149          ErrorHandling.ShowErrorDialog(this, ex);
150        }
151      }
152      return null;
153    }
154    protected virtual ListViewItem CreateListViewItem(T item) {
155      ListViewItem listViewItem = new ListViewItem();
156      if (item == null) {
157        listViewItem.Text = "null";
158        itemsListView.SmallImageList.Images.Add(HeuristicLab.Common.Resources.VSImageLibrary.Nothing);
159        listViewItem.ImageIndex = itemsListView.SmallImageList.Images.Count - 1;
160      } else {
161        listViewItem.Text = item.ToString();
162        listViewItem.ToolTipText = item.ItemName + ": " + item.ItemDescription;
163        itemsListView.SmallImageList.Images.Add(item.ItemImage);
164        listViewItem.ImageIndex = itemsListView.SmallImageList.Images.Count - 1;
165        listViewItem.Tag = item;
166      }
167      return listViewItem;
168    }
169    protected virtual void AddListViewItem(ListViewItem listViewItem) {
170      if (listViewItem == null) throw new ArgumentNullException();
171      T item = (listViewItem.Tag as T);
172      itemsListView.Items.Add(listViewItem);
173      if (item != null) {
174        if (!itemListViewItemMapping.ContainsKey(item)) {
175          RegisterItemEvents(item);
176          itemListViewItemMapping.Add(item, new List<ListViewItem>());
177        }
178        itemListViewItemMapping[item].Add(listViewItem);
179      }
180    }
181    protected virtual void InsertListViewItem(int index, ListViewItem listViewItem) {
182      if (listViewItem == null) throw new ArgumentNullException();
183      T item = (listViewItem.Tag as T);
184      itemsListView.Items.Insert(index, listViewItem);
185      if (item != null) {
186        if (!itemListViewItemMapping.ContainsKey(item)) {
187          RegisterItemEvents(item);
188          itemListViewItemMapping.Add(item, new List<ListViewItem>());
189        }
190        itemListViewItemMapping[item].Add(listViewItem);
191      }
192    }
193    protected virtual void RemoveListViewItem(ListViewItem listViewItem) {
194      if (listViewItem == null) throw new ArgumentNullException();
195      T item = (listViewItem.Tag as T);
196      if (item != null) {
197        itemListViewItemMapping[item].Remove(listViewItem);
198        if (itemListViewItemMapping[item].Count == 0) {
199          itemListViewItemMapping.Remove(item);
200          DeregisterItemEvents(item);
201        }
202      }
203      listViewItem.Remove();
204    }
205    protected virtual void UpdateListViewItemImage(ListViewItem listViewItem) {
206      if (listViewItem == null) throw new ArgumentNullException();
207      T item = listViewItem.Tag as T;
208      int i = listViewItem.ImageIndex;
209      itemsListView.SmallImageList.Images[i] = item == null ? HeuristicLab.Common.Resources.VSImageLibrary.Nothing : item.ItemImage;
210      listViewItem.ImageIndex = -1;
211      listViewItem.ImageIndex = i;
212    }
213    protected virtual void UpdateListViewItemText(ListViewItem listViewItem) {
214      if (listViewItem == null) throw new ArgumentNullException();
215      T item = listViewItem.Tag as T;
216      listViewItem.Text = item == null ? "null" : item.ToString();
217      listViewItem.ToolTipText = item == null ? string.Empty : item.ItemName + ": " + item.ItemDescription;
218    }
219    protected virtual IEnumerable<ListViewItem> GetListViewItemsForItem(T item) {
220      if (item == null) {
221        List<ListViewItem> listViewItems = new List<ListViewItem>();
222        foreach (ListViewItem listViewItem in itemsListView.Items) {
223          if (listViewItem.Tag == null) listViewItems.Add(listViewItem);
224        }
225        return listViewItems;
226      } else {
227        List<ListViewItem> listViewItems = null;
228        itemListViewItemMapping.TryGetValue(item, out listViewItems);
229        return listViewItems == null ? Enumerable.Empty<ListViewItem>() : listViewItems;
230      }
231    }
232
233    #region ListView Events
234    protected virtual void itemsListView_SelectedIndexChanged(object sender, EventArgs e) {
235      moveUpButton.Enabled = itemsListView.SelectedItems.Count == 1 &&
236                             itemsListView.SelectedIndices[0] != 0 &&
237                             (Content != null) && !Content.IsReadOnly && !ReadOnly;
238      moveDownButton.Enabled = itemsListView.SelectedItems.Count == 1 &&
239                               itemsListView.SelectedIndices[0] != itemsListView.Items.Count - 1 &&
240                               (Content != null) && !Content.IsReadOnly && !ReadOnly;
241      removeButton.Enabled = itemsListView.SelectedItems.Count > 0 &&
242                             (Content != null) && !Content.IsReadOnly && !ReadOnly;
243      AdjustListViewColumnSizes();
244
245      if (showDetailsCheckBox.Checked) {
246        if (itemsListView.SelectedItems.Count == 1) {
247          T item = (T)itemsListView.SelectedItems[0].Tag;
248          detailsGroupBox.Enabled = true;
249          viewHost.Content = item;
250        } else {
251          viewHost.Content = null;
252          detailsGroupBox.Enabled = false;
253        }
254      }
255    }
256
257    protected virtual void itemsListView_KeyDown(object sender, KeyEventArgs e) {
258      if (e.KeyCode == Keys.Delete) {
259        if ((itemsListView.SelectedItems.Count > 0) && !Content.IsReadOnly && !ReadOnly) {
260          foreach (ListViewItem item in itemsListView.SelectedItems)
261            Content.RemoveAt(item.Index);
262        }
263      }
264    }
265
266    protected virtual void itemsListView_DoubleClick(object sender, EventArgs e) {
267      if (itemsListView.SelectedItems.Count == 1) {
268        T item = itemsListView.SelectedItems[0].Tag as T;
269        if (item != null) {
270          IContentView view = MainFormManager.MainForm.ShowContent(item);
271          if (view != null) {
272            view.ReadOnly = ReadOnly;
273            view.Locked = Locked;
274          }
275        }
276      }
277    }
278
279    protected virtual void itemsListView_ItemDrag(object sender, ItemDragEventArgs e) {
280      if (!Locked) {
281        List<T> items = new List<T>();
282        foreach (ListViewItem listViewItem in itemsListView.SelectedItems) {
283          T item = listViewItem.Tag as T;
284          if (item != null) items.Add(item);
285        }
286
287        if (items.Count > 0) {
288          DataObject data = new DataObject();
289          if (items.Count == 1) data.SetData(HeuristicLab.Common.Constants.DragDropDataFormat, items[0]);
290          else data.SetData(HeuristicLab.Common.Constants.DragDropDataFormat, items);
291          if (Content.IsReadOnly || ReadOnly) {
292            DoDragDrop(data, DragDropEffects.Copy | DragDropEffects.Link);
293          } else {
294            DragDropEffects result = DoDragDrop(data, DragDropEffects.Copy | DragDropEffects.Link | DragDropEffects.Move);
295            if ((result & DragDropEffects.Move) == DragDropEffects.Move) {
296              foreach (ListViewItem listViewItem in itemsListView.SelectedItems.Cast<ListViewItem>().ToArray()) {
297                if (listViewItem.Tag != null) Content.RemoveAt(listViewItem.Index);
298              }
299            }
300          }
301        }
302      }
303    }
304    protected virtual void itemsListView_DragEnter(object sender, DragEventArgs e) {
305      validDragOperation = false;
306      if (!Content.IsReadOnly && !ReadOnly && (e.Data.GetData(HeuristicLab.Common.Constants.DragDropDataFormat) is T)) {
307        validDragOperation = true;
308      } else if (!Content.IsReadOnly && !ReadOnly && (e.Data.GetData(HeuristicLab.Common.Constants.DragDropDataFormat) is IEnumerable)) {
309        validDragOperation = true;
310        IEnumerable items = (IEnumerable)e.Data.GetData(HeuristicLab.Common.Constants.DragDropDataFormat);
311        foreach (object item in items)
312          validDragOperation = validDragOperation && (item is T);
313      }
314    }
315    protected virtual void itemsListView_DragOver(object sender, DragEventArgs e) {
316      e.Effect = DragDropEffects.None;
317      if (validDragOperation) {
318        if ((e.KeyState & 32) == 32) e.Effect = DragDropEffects.Link;  // ALT key
319        else if ((e.KeyState & 4) == 4) e.Effect = DragDropEffects.Move;  // SHIFT key
320        else if (e.AllowedEffect.HasFlag(DragDropEffects.Copy)) e.Effect = DragDropEffects.Copy;
321        else if (e.AllowedEffect.HasFlag(DragDropEffects.Move)) e.Effect = DragDropEffects.Move;
322        else if (e.AllowedEffect.HasFlag(DragDropEffects.Link)) e.Effect = DragDropEffects.Link;
323      }
324    }
325    protected virtual void itemsListView_DragDrop(object sender, DragEventArgs e) {
326      if (e.Effect != DragDropEffects.None) {
327        Point p = itemsListView.PointToClient(new Point(e.X, e.Y));
328        ListViewItem listViewItem = itemsListView.GetItemAt(p.X, p.Y);
329
330        if (e.Data.GetData(HeuristicLab.Common.Constants.DragDropDataFormat) is T) {
331          T item = (T)e.Data.GetData(HeuristicLab.Common.Constants.DragDropDataFormat);
332          if (listViewItem != null) Content.Insert(listViewItem.Index, e.Effect.HasFlag(DragDropEffects.Copy) ? (T)item.Clone() : item);
333          else Content.Add(e.Effect.HasFlag(DragDropEffects.Copy) ? (T)item.Clone() : item);
334        } else if (e.Data.GetData(HeuristicLab.Common.Constants.DragDropDataFormat) is IEnumerable) {
335          IEnumerable<T> items = ((IEnumerable)e.Data.GetData(HeuristicLab.Common.Constants.DragDropDataFormat)).Cast<T>();
336          foreach (T item in items) {
337            if (listViewItem != null) Content.Insert(listViewItem.Index, e.Effect.HasFlag(DragDropEffects.Copy) ? (T)item.Clone() : item);
338            else Content.Add(e.Effect.HasFlag(DragDropEffects.Copy) ? (T)item.Clone() : item);
339          }
340        }
341      }
342    }
343    #endregion
344
345    #region Button Events
346    protected virtual void addButton_Click(object sender, EventArgs e) {
347      T item = CreateItem();
348      if (item != null)
349        Content.Add(item);
350    }
351    protected virtual void moveUpButton_Click(object sender, EventArgs e) {
352      if (itemsListView.SelectedItems.Count == 1) {
353        int index = itemsListView.SelectedIndices[0];
354        T item = Content[index - 1];
355        Content[index - 1] = Content[index];
356        itemsListView.Items[index].Selected = false;
357        itemsListView.Items[index - 1].Selected = true;
358        Content[index] = item;
359      }
360    }
361    protected virtual void moveDownButton_Click(object sender, EventArgs e) {
362      if (itemsListView.SelectedItems.Count == 1) {
363        int index = itemsListView.SelectedIndices[0];
364        T item = Content[index + 1];
365        Content[index + 1] = Content[index];
366        itemsListView.Items[index].Selected = false;
367        itemsListView.Items[index + 1].Selected = true;
368        Content[index] = item;
369      }
370    }
371    protected virtual void removeButton_Click(object sender, EventArgs e) {
372      if (itemsListView.SelectedItems.Count > 0) {
373        foreach (ListViewItem item in itemsListView.SelectedItems)
374          Content.RemoveAt(item.Index);
375      }
376    }
377    #endregion
378
379    #region CheckBox Events
380    protected virtual void showDetailsCheckBox_CheckedChanged(object sender, EventArgs e) {
381      if (showDetailsCheckBox.Checked) {
382        splitContainer.Panel2Collapsed = false;
383        detailsGroupBox.Enabled = itemsListView.SelectedItems.Count == 1;
384        viewHost.Content = itemsListView.SelectedItems.Count == 1 ? (T)itemsListView.SelectedItems[0].Tag : null;
385      } else {
386        splitContainer.Panel2Collapsed = true;
387        viewHost.Content = null;
388      }
389    }
390    #endregion
391
392    #region Content Events
393    protected virtual void Content_ItemsAdded(object sender, CollectionItemsChangedEventArgs<IndexedItem<T>> e) {
394      if (InvokeRequired)
395        Invoke(new CollectionItemsChangedEventHandler<IndexedItem<T>>(Content_ItemsAdded), sender, e);
396      else {
397        foreach (IndexedItem<T> item in e.Items)
398          InsertListViewItem(item.Index, CreateListViewItem(item.Value));
399        AdjustListViewColumnSizes();
400      }
401    }
402    protected virtual void Content_ItemsRemoved(object sender, CollectionItemsChangedEventArgs<IndexedItem<T>> e) {
403      if (InvokeRequired)
404        Invoke(new CollectionItemsChangedEventHandler<IndexedItem<T>>(Content_ItemsRemoved), sender, e);
405      else {
406        List<ListViewItem> listViewItems = new List<ListViewItem>();
407        foreach (IndexedItem<T> item in e.Items)
408          listViewItems.Add(itemsListView.Items[item.Index]);
409        foreach (ListViewItem listViewItem in listViewItems)
410          RemoveListViewItem(listViewItem);
411        RebuildImageList();
412      }
413    }
414    protected virtual void Content_ItemsReplaced(object sender, CollectionItemsChangedEventArgs<IndexedItem<T>> e) {
415      if (InvokeRequired)
416        Invoke(new CollectionItemsChangedEventHandler<IndexedItem<T>>(Content_ItemsReplaced), sender, e);
417      else {
418        int[] selected = new int[itemsListView.SelectedIndices.Count];
419        itemsListView.SelectedIndices.CopyTo(selected, 0);
420
421        List<ListViewItem> listViewItems = new List<ListViewItem>();
422        foreach (IndexedItem<T> item in e.OldItems)
423          listViewItems.Add(itemsListView.Items[item.Index]);
424        foreach (ListViewItem listViewItem in listViewItems)
425          RemoveListViewItem(listViewItem);
426        RebuildImageList();
427
428        foreach (IndexedItem<T> item in e.Items)
429          InsertListViewItem(item.Index, CreateListViewItem(item.Value));
430        AdjustListViewColumnSizes();
431
432        for (int i = 0; i < selected.Length; i++)
433          itemsListView.Items[selected[i]].Selected = true;
434      }
435    }
436    protected virtual void Content_ItemsMoved(object sender, CollectionItemsChangedEventArgs<IndexedItem<T>> e) {
437      if (InvokeRequired)
438        Invoke(new CollectionItemsChangedEventHandler<IndexedItem<T>>(Content_ItemsMoved), sender, e);
439      else {
440        foreach (IndexedItem<T> item in e.Items) {
441          ListViewItem listViewItem = itemsListView.Items[item.Index];
442          listViewItem.Tag = item.Value;
443          UpdateListViewItemImage(listViewItem);
444          UpdateListViewItemText(listViewItem);
445        }
446      }
447    }
448    protected virtual void Content_CollectionReset(object sender, CollectionItemsChangedEventArgs<IndexedItem<T>> e) {
449      if (InvokeRequired)
450        Invoke(new CollectionItemsChangedEventHandler<IndexedItem<T>>(Content_CollectionReset), sender, e);
451      else {
452        List<ListViewItem> listViewItems = new List<ListViewItem>();
453        foreach (IndexedItem<T> item in e.OldItems)
454          listViewItems.Add(itemsListView.Items[item.Index]);
455        foreach (ListViewItem listViewItem in listViewItems)
456          RemoveListViewItem(listViewItem);
457        RebuildImageList();
458
459        foreach (IndexedItem<T> item in e.Items)
460          InsertListViewItem(item.Index, CreateListViewItem(item.Value));
461        AdjustListViewColumnSizes();
462      }
463    }
464    #endregion
465
466    #region Item Events
467    protected virtual void Item_ItemImageChanged(object sender, EventArgs e) {
468      if (InvokeRequired)
469        Invoke(new EventHandler(Item_ItemImageChanged), sender, e);
470      else {
471        T item = (T)sender;
472        foreach (ListViewItem listViewItem in GetListViewItemsForItem(item))
473          UpdateListViewItemImage(listViewItem);
474      }
475    }
476    protected virtual void Item_ToStringChanged(object sender, EventArgs e) {
477      if (InvokeRequired)
478        Invoke(new EventHandler(Item_ToStringChanged), sender, e);
479      else {
480        T item = (T)sender;
481        foreach (ListViewItem listViewItem in GetListViewItemsForItem(item))
482          UpdateListViewItemText(listViewItem);
483      }
484    }
485    #endregion
486
487    #region Helpers
488    protected virtual void AdjustListViewColumnSizes() {
489      if (itemsListView.Items.Count > 0) {
490        for (int i = 0; i < itemsListView.Columns.Count; i++)
491          itemsListView.Columns[i].AutoResize(ColumnHeaderAutoResizeStyle.ColumnContent);
492      }
493    }
494    protected virtual void RebuildImageList() {
495      itemsListView.SmallImageList.Images.Clear();
496      foreach (ListViewItem listViewItem in itemsListView.Items) {
497        T item = listViewItem.Tag as T;
498        itemsListView.SmallImageList.Images.Add(item == null ? HeuristicLab.Common.Resources.VSImageLibrary.Nothing : item.ItemImage);
499        listViewItem.ImageIndex = itemsListView.SmallImageList.Images.Count - 1;
500      }
501    }
502    #endregion
503  }
504}
Note: See TracBrowser for help on using the repository browser.