Free cookie consent management tool by TermsFeed Policy Generator

source: trunk/sources/HeuristicLab.Core.Views/3.3/ItemCollectionView.cs @ 2797

Last change on this file since 2797 was 2790, checked in by swagner, 14 years ago

Operator architecture refactoring (#95)

  • implemented reviewers' comments
  • added additional plugins HeuristicLab.Evolutionary, HeuristicLab.Permutation, HeuristicLab.Selection, and HeuristicLab.Routing.TSP
File size: 11.3 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2010 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.Generic;
24using System.ComponentModel;
25using System.Data;
26using System.Drawing;
27using System.Text;
28using System.Windows.Forms;
29using HeuristicLab.Collections;
30using HeuristicLab.Common;
31using HeuristicLab.MainForm;
32using HeuristicLab.MainForm.WindowsForms;
33
34namespace HeuristicLab.Core.Views {
35  [Content(typeof(ItemCollection<>), true)]
36  [Content(typeof(IObservableCollection<>), false)]
37  public partial class ItemCollectionView<T> : ContentView where T : class, IItem {
38    public new IObservableCollection<T> Content {
39      get { return (IObservableCollection<T>)base.Content; }
40      set { base.Content = value; }
41    }
42
43    public ListView ItemsListView {
44      get { return itemsListView; }
45    }
46
47    public ItemCollectionView() {
48      InitializeComponent();
49      Caption = "Item Collection";
50    }
51    public ItemCollectionView(IObservableCollection<T> content)
52      : this() {
53      Content = content;
54    }
55
56    protected override void DeregisterContentEvents() {
57      Content.ItemsAdded -= new CollectionItemsChangedEventHandler<T>(Content_ItemsAdded);
58      Content.ItemsRemoved -= new CollectionItemsChangedEventHandler<T>(Content_ItemsRemoved);
59      Content.CollectionReset -= new CollectionItemsChangedEventHandler<T>(Content_CollectionReset);
60      base.DeregisterContentEvents();
61    }
62    protected override void RegisterContentEvents() {
63      base.RegisterContentEvents();
64      Content.ItemsAdded += new CollectionItemsChangedEventHandler<T>(Content_ItemsAdded);
65      Content.ItemsRemoved += new CollectionItemsChangedEventHandler<T>(Content_ItemsRemoved);
66      Content.CollectionReset += new CollectionItemsChangedEventHandler<T>(Content_CollectionReset);
67    }
68
69    protected override void OnContentChanged() {
70      base.OnContentChanged();
71      Caption = "Item Collection";
72      while (itemsListView.Items.Count > 0) RemoveListViewItem(itemsListView.Items[0]);
73      itemsListView.Enabled = false;
74      detailsGroupBox.Enabled = false;
75      viewHost.Content = null;
76      addButton.Enabled = false;
77      sortAscendingButton.Enabled = false;
78      sortDescendingButton.Enabled = false;
79      removeButton.Enabled = false;
80
81      if (Content != null) {
82        Caption += " (" + Content.GetType().Name + ")";
83        itemsListView.Enabled = true;
84        addButton.Enabled = !Content.IsReadOnly;
85        foreach (T item in Content)
86          AddListViewItem(CreateListViewItem(item));
87        sortAscendingButton.Enabled = itemsListView.Items.Count > 0;
88        sortDescendingButton.Enabled = itemsListView.Items.Count > 0;
89        SortItemsListView(SortOrder.Ascending);
90      }
91    }
92
93    protected virtual T CreateItem() {
94      try {
95        return (T)Activator.CreateInstance(typeof(T));
96      } catch(Exception ex) {
97        Auxiliary.ShowErrorMessageBox(ex);
98        return null;
99      }
100    }
101    protected virtual ListViewItem CreateListViewItem(T item) {
102      if (!itemsListView.SmallImageList.Images.ContainsKey(item.GetType().FullName))
103        itemsListView.SmallImageList.Images.Add(item.GetType().FullName, item.ItemImage);
104
105      ListViewItem listViewItem = new ListViewItem();
106      listViewItem.Text = item.ToString();
107      listViewItem.ToolTipText = item.ItemName + ": " + item.ItemDescription;
108      listViewItem.ImageIndex = itemsListView.SmallImageList.Images.IndexOfKey(item.GetType().FullName);
109      listViewItem.Tag = item;
110      return listViewItem;
111    }
112    protected virtual void AddListViewItem(ListViewItem listViewItem) {
113      itemsListView.Items.Add(listViewItem);
114      ((T)listViewItem.Tag).Changed += new ChangedEventHandler(Item_Changed);
115      sortAscendingButton.Enabled = itemsListView.Items.Count > 0;
116      sortDescendingButton.Enabled = itemsListView.Items.Count > 0;
117    }
118    protected virtual void RemoveListViewItem(ListViewItem listViewItem) {
119      ((T)listViewItem.Tag).Changed -= new ChangedEventHandler(Item_Changed);
120      listViewItem.Remove();
121      sortAscendingButton.Enabled = itemsListView.Items.Count > 0;
122      sortDescendingButton.Enabled = itemsListView.Items.Count > 0;
123    }
124    protected virtual void UpdateListViewItem(ListViewItem listViewItem) {
125      if (!listViewItem.Text.Equals(listViewItem.Tag.ToString())) {
126        listViewItem.Text = listViewItem.Tag.ToString();
127        itemsListView.Sort();
128      }
129    }
130    protected virtual IEnumerable<ListViewItem> GetListViewItemsForItem(T item) {
131      foreach (ListViewItem listViewItem in itemsListView.Items) {
132        if (((T)listViewItem.Tag) == item)
133          yield return listViewItem;
134      }
135    }
136
137    #region ListView Events
138    protected virtual void itemsListView_SelectedIndexChanged(object sender, EventArgs e) {
139      removeButton.Enabled = itemsListView.SelectedItems.Count > 0 && !Content.IsReadOnly;
140      if (itemsListView.SelectedItems.Count == 1) {
141        T item = (T)itemsListView.SelectedItems[0].Tag;
142        viewHost.Content = item;
143        detailsGroupBox.Enabled = true;
144      } else {
145        viewHost.Content = null;
146        detailsGroupBox.Enabled = false;
147      }
148    }
149    protected virtual void itemsListView_SizeChanged(object sender, EventArgs e) {
150      if (itemsListView.Columns.Count > 0)
151        itemsListView.Columns[0].Width = Math.Max(0, itemsListView.Width - 25);
152    }
153    protected virtual void itemsListView_KeyDown(object sender, KeyEventArgs e) {
154      if (e.KeyCode == Keys.Delete) {
155        if ((itemsListView.SelectedItems.Count > 0) && !Content.IsReadOnly) {
156          foreach (ListViewItem item in itemsListView.SelectedItems)
157            Content.Remove((T)item.Tag);
158        }
159      }
160    }
161    protected virtual void itemsListView_DoubleClick(object sender, EventArgs e) {
162      if (itemsListView.SelectedItems.Count == 1) {
163        T item = (T)itemsListView.SelectedItems[0].Tag;
164        IView view = MainFormManager.CreateDefaultView(item);
165        if (view != null) view.Show();
166      }
167    }
168    protected virtual void itemsListView_ItemDrag(object sender, ItemDragEventArgs e) {
169      ListViewItem listViewItem = (ListViewItem)e.Item;
170      T item = (T)listViewItem.Tag;
171      DataObject data = new DataObject();
172      data.SetData("Type", item.GetType());
173      data.SetData("Value", item);
174      if (Content.IsReadOnly) {
175        DoDragDrop(data, DragDropEffects.Copy | DragDropEffects.Link);
176      } else {
177        DragDropEffects result = DoDragDrop(data, DragDropEffects.Copy | DragDropEffects.Link | DragDropEffects.Move);
178        if ((result & DragDropEffects.Move) == DragDropEffects.Move)
179          Content.Remove(item);
180      }
181    }
182    protected virtual void itemsListView_DragEnterOver(object sender, DragEventArgs e) {
183      e.Effect = DragDropEffects.None;
184      Type type = e.Data.GetData("Type") as Type;
185      if ((!Content.IsReadOnly) && (type != null) && (typeof(T).IsAssignableFrom(type))) {
186        if ((e.KeyState & 8) == 8) e.Effect = DragDropEffects.Copy;  // CTRL key
187        else if ((e.KeyState & 4) == 4) e.Effect = DragDropEffects.Move;  // SHIFT key
188        else if ((e.AllowedEffect & DragDropEffects.Link) == DragDropEffects.Link) e.Effect = DragDropEffects.Link;
189        else if ((e.AllowedEffect & DragDropEffects.Copy) == DragDropEffects.Copy) e.Effect = DragDropEffects.Copy;
190        else if ((e.AllowedEffect & DragDropEffects.Move) == DragDropEffects.Move) e.Effect = DragDropEffects.Move;
191      }
192    }
193    protected virtual void itemsListView_DragDrop(object sender, DragEventArgs e) {
194      if (e.Effect != DragDropEffects.None) {
195        T item = e.Data.GetData("Value") as T;
196        if ((e.Effect & DragDropEffects.Copy) == DragDropEffects.Copy) item = (T)item.Clone();
197        Content.Add(item);
198      }
199    }
200    #endregion
201
202    #region Button Events
203    protected virtual void addButton_Click(object sender, EventArgs e) {
204      T item = CreateItem();
205      if (item != null)
206        Content.Add(item);
207    }
208    protected virtual void sortAscendingButton_Click(object sender, EventArgs e) {
209      SortItemsListView(SortOrder.Ascending);
210    }
211    protected virtual void sortDescendingButton_Click(object sender, EventArgs e) {
212      SortItemsListView(SortOrder.Descending);
213    }
214    protected virtual void removeButton_Click(object sender, EventArgs e) {
215      if (itemsListView.SelectedItems.Count > 0) {
216        foreach (ListViewItem item in itemsListView.SelectedItems)
217          Content.Remove((T)item.Tag);
218        itemsListView.SelectedItems.Clear();
219      }
220    }
221    #endregion
222
223    #region Content Events
224    protected virtual void Content_ItemsAdded(object sender, CollectionItemsChangedEventArgs<T> e) {
225      if (InvokeRequired)
226        Invoke(new CollectionItemsChangedEventHandler<T>(Content_ItemsAdded), sender, e);
227      else
228        foreach (T item in e.Items)
229          AddListViewItem(CreateListViewItem(item));
230    }
231    protected virtual void Content_ItemsRemoved(object sender, CollectionItemsChangedEventArgs<T> e) {
232      if (InvokeRequired)
233        Invoke(new CollectionItemsChangedEventHandler<T>(Content_ItemsRemoved), sender, e);
234      else {
235        foreach (T item in e.Items) {
236          foreach (ListViewItem listViewItem in GetListViewItemsForItem(item)) {
237            RemoveListViewItem(listViewItem);
238            break;
239          }
240        }
241      }
242    }
243    protected virtual void Content_CollectionReset(object sender, CollectionItemsChangedEventArgs<T> e) {
244      if (InvokeRequired)
245        Invoke(new CollectionItemsChangedEventHandler<T>(Content_CollectionReset), sender, e);
246      else {
247        foreach (T item in e.OldItems) {
248          foreach (ListViewItem listViewItem in GetListViewItemsForItem(item)) {
249            RemoveListViewItem(listViewItem);
250            break;
251          }
252        }
253        foreach (T item in e.Items)
254          AddListViewItem(CreateListViewItem(item));
255      }
256    }
257    #endregion
258
259    #region Item Events
260    protected virtual void Item_Changed(object sender, ChangedEventArgs e) {
261      if (InvokeRequired)
262        Invoke(new ChangedEventHandler(Item_Changed), sender, e);
263      else {
264        T item = (T)sender;
265        foreach (ListViewItem listViewItem in GetListViewItemsForItem(item))
266          UpdateListViewItem(listViewItem);
267      }
268    }
269    #endregion
270
271    #region Helpers
272    protected virtual void SortItemsListView(SortOrder sortOrder) {
273      itemsListView.Sorting = sortOrder;
274      itemsListView.Sort();
275      itemsListView.Sorting = SortOrder.None;
276    }
277    #endregion
278  }
279}
Note: See TracBrowser for help on using the repository browser.