Free cookie consent management tool by TermsFeed Policy Generator

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

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

Operator architecture refactoring (#95)

  • implemented reviewers' comments
File size: 15.2 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.Drawing;
25using System.Windows.Forms;
26using HeuristicLab.Collections;
27using HeuristicLab.MainForm;
28using HeuristicLab.MainForm.WindowsForms;
29
30namespace HeuristicLab.Core.Views {
31  /// <summary>
32  /// The visual representation of all variables in a specified scope.
33  /// </summary>
34  [View("ItemList View")]
35  [Content(typeof(ItemList<>), true)]
36  [Content(typeof(IObservableList<>), false)]
37  public partial class ItemListView<T> : ContentView where T : class, IItem {
38    /// <summary>
39    /// Gets or sets the scope whose variables to represent visually.
40    /// </summary>
41    /// <remarks>Uses property <see cref="ViewBase.Item"/> of base class <see cref="ViewBase"/>.
42    /// No won data storage present.</remarks>
43    public new IObservableList<T> Content {
44      get { return (IObservableList<T>)base.Content; }
45      set { base.Content = value; }
46    }
47
48    public ListView ItemsListView {
49      get { return itemsListView; }
50    }
51
52    /// <summary>
53    /// Initializes a new instance of <see cref="VariablesScopeView"/> with caption "Variables Scope View".
54    /// </summary>
55    public ItemListView() {
56      InitializeComponent();
57      Caption = "Item List";
58    }
59    public ItemListView(IObservableList<T> content)
60      : this() {
61      Content = content;
62    }
63
64    /// <summary>
65    /// Removes the eventhandlers from the underlying <see cref="IScope"/>.
66    /// </summary>
67    /// <remarks>Calls <see cref="ViewBase.RemoveItemEvents"/> of base class <see cref="ViewBase"/>.</remarks>
68    protected override void DeregisterContentEvents() {
69      Content.ItemsAdded -= new CollectionItemsChangedEventHandler<IndexedItem<T>>(Content_ItemsAdded);
70      Content.ItemsRemoved -= new CollectionItemsChangedEventHandler<IndexedItem<T>>(Content_ItemsRemoved);
71      Content.ItemsReplaced -= new CollectionItemsChangedEventHandler<IndexedItem<T>>(Content_ItemsReplaced);
72      Content.ItemsMoved -= new CollectionItemsChangedEventHandler<IndexedItem<T>>(Content_ItemsMoved);
73      Content.CollectionReset -= new CollectionItemsChangedEventHandler<IndexedItem<T>>(Content_CollectionReset);
74      base.DeregisterContentEvents();
75    }
76
77    /// <summary>
78    /// Adds eventhandlers to the underlying <see cref="IScope"/>.
79    /// </summary>
80    /// <remarks>Calls <see cref="ViewBase.AddItemEvents"/> of base class <see cref="ViewBase"/>.</remarks>
81    protected override void RegisterContentEvents() {
82      base.RegisterContentEvents();
83      Content.ItemsAdded += new CollectionItemsChangedEventHandler<IndexedItem<T>>(Content_ItemsAdded);
84      Content.ItemsRemoved += new CollectionItemsChangedEventHandler<IndexedItem<T>>(Content_ItemsRemoved);
85      Content.ItemsReplaced += new CollectionItemsChangedEventHandler<IndexedItem<T>>(Content_ItemsReplaced);
86      Content.ItemsMoved += new CollectionItemsChangedEventHandler<IndexedItem<T>>(Content_ItemsMoved);
87      Content.CollectionReset += new CollectionItemsChangedEventHandler<IndexedItem<T>>(Content_CollectionReset);
88    }
89
90    protected override void OnContentChanged() {
91      base.OnContentChanged();
92      Caption = "Item List";
93      while (itemsListView.Items.Count > 0) RemoveListViewItem(itemsListView.Items[0]);
94      itemsListView.Enabled = false;
95      detailsGroupBox.Enabled = false;
96      viewHost.Content = null;
97      addButton.Enabled = false;
98      moveUpButton.Enabled = false;
99      moveDownButton.Enabled = false;
100      removeButton.Enabled = false;
101
102      if (Content != null) {
103        Caption += " (" + Content.GetType().Name + ")";
104        itemsListView.Enabled = true;
105        addButton.Enabled = !Content.IsReadOnly;
106        foreach (T item in Content)
107          AddListViewItem(CreateListViewItem(item));
108      }
109    }
110
111    protected virtual T CreateItem() {
112      try {
113        return (T)Activator.CreateInstance(typeof(T));
114      }
115      catch (Exception ex) {
116        Auxiliary.ShowErrorMessageBox(ex);
117        return null;
118      }
119    }
120    protected virtual ListViewItem CreateListViewItem(T item) {
121      if (!itemsListView.SmallImageList.Images.ContainsKey(item.GetType().FullName))
122        itemsListView.SmallImageList.Images.Add(item.GetType().FullName, item.ItemImage);
123
124      ListViewItem listViewItem = new ListViewItem();
125      listViewItem.Text = item.ToString();
126      listViewItem.ToolTipText = item.ItemName + ": " + item.ItemDescription;
127      listViewItem.ImageIndex = itemsListView.SmallImageList.Images.IndexOfKey(item.GetType().FullName);
128      listViewItem.Tag = item;
129      return listViewItem;
130    }
131    protected virtual void AddListViewItem(ListViewItem listViewItem) {
132      itemsListView.Items.Add(listViewItem);
133      ((T)listViewItem.Tag).Changed += new ChangedEventHandler(Item_Changed);
134    }
135    protected virtual void InsertListViewItem(int index, ListViewItem listViewItem) {
136      itemsListView.Items.Insert(index, listViewItem);
137      ((T)listViewItem.Tag).Changed += new ChangedEventHandler(Item_Changed);
138    }
139    protected virtual void RemoveListViewItem(ListViewItem listViewItem) {
140      ((T)listViewItem.Tag).Changed -= new ChangedEventHandler(Item_Changed);
141      listViewItem.Remove();
142    }
143    protected virtual void UpdateListViewItem(ListViewItem listViewItem) {
144      T item = (T)listViewItem.Tag;
145      if (!itemsListView.SmallImageList.Images.ContainsKey(item.GetType().FullName))
146        itemsListView.SmallImageList.Images.Add(item.GetType().FullName, item.ItemImage);
147
148      listViewItem.Text = item.ToString();
149      listViewItem.ToolTipText = item.ItemName + ": " + item.ItemDescription;
150      listViewItem.ImageIndex = itemsListView.SmallImageList.Images.IndexOfKey(item.GetType().FullName);
151    }
152
153    protected virtual void itemsListView_SelectedIndexChanged(object sender, EventArgs e) {
154      moveUpButton.Enabled = itemsListView.SelectedItems.Count == 1 &&
155                             itemsListView.SelectedIndices[0] != 0 &&
156                             !Content.IsReadOnly;
157      moveDownButton.Enabled = itemsListView.SelectedItems.Count == 1 &&
158                               itemsListView.SelectedIndices[0] != itemsListView.Items.Count - 1 &&
159                               !Content.IsReadOnly;
160      removeButton.Enabled = itemsListView.SelectedItems.Count > 0 &&
161                             !Content.IsReadOnly;
162
163      if (itemsListView.SelectedItems.Count == 1) {
164        T item = (T)itemsListView.SelectedItems[0].Tag;
165        detailsGroupBox.Enabled = true;
166        viewHost.Content = item;
167      } else {
168        viewHost.Content = null;
169        detailsGroupBox.Enabled = false;
170      }
171    }
172
173    #region ListView Events
174    protected virtual void itemsListView_SizeChanged(object sender, EventArgs e) {
175      if (itemsListView.Columns.Count > 0)
176        itemsListView.Columns[0].Width = Math.Max(0, itemsListView.Width - 25);
177    }
178
179    protected virtual void itemsListView_KeyDown(object sender, KeyEventArgs e) {
180      if (e.KeyCode == Keys.Delete) {
181        if ((itemsListView.SelectedItems.Count > 0) && !Content.IsReadOnly) {
182          foreach (ListViewItem item in itemsListView.SelectedItems)
183            Content.RemoveAt(item.Index);
184        }
185      }
186    }
187
188    protected virtual void itemsListView_DoubleClick(object sender, EventArgs e) {
189      if (itemsListView.SelectedItems.Count == 1) {
190        T item = (T)itemsListView.SelectedItems[0].Tag;
191        IView view = MainFormManager.CreateDefaultView(item);
192        if (view != null) view.Show();
193      }
194    }
195
196    protected virtual void itemsListView_ItemDrag(object sender, ItemDragEventArgs e) {
197      ListViewItem listViewItem = (ListViewItem)e.Item;
198      T item = (T)listViewItem.Tag;
199      DataObject data = new DataObject();
200      data.SetData("Type", item.GetType());
201      data.SetData("Value", item);
202      if (Content.IsReadOnly) {
203        DoDragDrop(data, DragDropEffects.Copy | DragDropEffects.Link);
204      } else {
205        DragDropEffects result = DoDragDrop(data, DragDropEffects.Copy | DragDropEffects.Link | DragDropEffects.Move);
206        if ((result & DragDropEffects.Move) == DragDropEffects.Move)
207          Content.RemoveAt(listViewItem.Index);
208      }
209    }
210    protected virtual void itemsListView_DragEnterOver(object sender, DragEventArgs e) {
211      e.Effect = DragDropEffects.None;
212      Type type = e.Data.GetData("Type") as Type;
213      if ((!Content.IsReadOnly) && (type != null) && (typeof(T).IsAssignableFrom(type))) {
214        if ((e.KeyState & 8) == 8) e.Effect = DragDropEffects.Copy;  // CTRL key
215        else if ((e.KeyState & 4) == 4) e.Effect = DragDropEffects.Move;  // SHIFT key
216        else if ((e.AllowedEffect & DragDropEffects.Link) == DragDropEffects.Link) e.Effect = DragDropEffects.Link;
217        else if ((e.AllowedEffect & DragDropEffects.Copy) == DragDropEffects.Copy) e.Effect = DragDropEffects.Copy;
218        else if ((e.AllowedEffect & DragDropEffects.Move) == DragDropEffects.Move) e.Effect = DragDropEffects.Move;
219      }
220    }
221    protected virtual void itemsListView_DragDrop(object sender, DragEventArgs e) {
222      if (e.Effect != DragDropEffects.None) {
223        T item = e.Data.GetData("Value") as T;
224        if ((e.Effect & DragDropEffects.Copy) == DragDropEffects.Copy) item = (T)item.Clone();
225
226        Point p = itemsListView.PointToClient(new Point(e.X, e.Y));
227        ListViewItem listViewItem = itemsListView.GetItemAt(p.X, p.Y);
228        if (listViewItem != null) Content.Insert(listViewItem.Index, item);
229        else Content.Add(item);
230      }
231    }
232    #endregion
233
234    #region Button Events
235    protected virtual void addButton_Click(object sender, EventArgs e) {
236      T item = CreateItem();
237      if (item != null)
238        Content.Add(item);
239    }
240    protected virtual void moveUpButton_Click(object sender, EventArgs e) {
241      if (itemsListView.SelectedItems.Count == 1) {
242        int index = itemsListView.SelectedIndices[0];
243        T item = Content[index - 1];
244        Content[index - 1] = Content[index];
245        itemsListView.Items[index].Selected = false;
246        itemsListView.Items[index - 1].Selected = true;
247        Content[index] = item;
248      }
249    }
250    protected virtual void moveDownButton_Click(object sender, EventArgs e) {
251      if (itemsListView.SelectedItems.Count == 1) {
252        int index = itemsListView.SelectedIndices[0];
253        T item = Content[index + 1];
254        Content[index + 1] = Content[index];
255        itemsListView.Items[index].Selected = false;
256        itemsListView.Items[index + 1].Selected = true;
257        Content[index] = item;
258      }
259    }
260    protected virtual void removeButton_Click(object sender, EventArgs e) {
261      if (itemsListView.SelectedItems.Count > 0) {
262        foreach (ListViewItem item in itemsListView.SelectedItems)
263          Content.RemoveAt(item.Index);
264      }
265    }
266    #endregion
267
268    #region Content Events
269    protected virtual void Content_ItemsAdded(object sender, CollectionItemsChangedEventArgs<IndexedItem<T>> e) {
270      if (InvokeRequired)
271        Invoke(new CollectionItemsChangedEventHandler<IndexedItem<T>>(Content_ItemsAdded), sender, e);
272      else
273        foreach (IndexedItem<T> item in e.Items)
274          InsertListViewItem(item.Index, CreateListViewItem(item.Value));
275    }
276    protected virtual void Content_ItemsRemoved(object sender, CollectionItemsChangedEventArgs<IndexedItem<T>> e) {
277      if (InvokeRequired)
278        Invoke(new CollectionItemsChangedEventHandler<IndexedItem<T>>(Content_ItemsRemoved), sender, e);
279      else {
280        List<ListViewItem> listViewItems = new List<ListViewItem>();
281        foreach (IndexedItem<T> item in e.Items)
282          listViewItems.Add(itemsListView.Items[item.Index]);
283        foreach (ListViewItem listViewItem in listViewItems)
284          RemoveListViewItem(listViewItem);
285      }
286    }
287    protected virtual void Content_ItemsReplaced(object sender, CollectionItemsChangedEventArgs<IndexedItem<T>> e) {
288      if (InvokeRequired)
289        Invoke(new CollectionItemsChangedEventHandler<IndexedItem<T>>(Content_ItemsReplaced), sender, e);
290      else {
291        int[] selected = new int[itemsListView.SelectedIndices.Count];
292        itemsListView.SelectedIndices.CopyTo(selected, 0);
293
294        List<ListViewItem> listViewItems = new List<ListViewItem>();
295        foreach (IndexedItem<T> item in e.OldItems)
296          listViewItems.Add(itemsListView.Items[item.Index]);
297        foreach (ListViewItem listViewItem in listViewItems)
298          RemoveListViewItem(listViewItem);
299
300        foreach (IndexedItem<T> item in e.Items)
301          InsertListViewItem(item.Index, CreateListViewItem(item.Value));
302
303        for (int i = 0; i < selected.Length; i++)
304          itemsListView.Items[selected[i]].Selected = true;
305      }
306    }
307    protected virtual void Content_ItemsMoved(object sender, CollectionItemsChangedEventArgs<IndexedItem<T>> e) {
308      if (InvokeRequired)
309        Invoke(new CollectionItemsChangedEventHandler<IndexedItem<T>>(Content_ItemsMoved), sender, e);
310      else {
311        foreach (IndexedItem<T> item in e.Items) {
312          ListViewItem listViewItem = itemsListView.Items[item.Index];
313          listViewItem.Tag = item.Value;
314          UpdateListViewItem(listViewItem);
315        }
316      }
317    }
318    protected virtual void Content_CollectionReset(object sender, CollectionItemsChangedEventArgs<IndexedItem<T>> e) {
319      if (InvokeRequired)
320        Invoke(new CollectionItemsChangedEventHandler<IndexedItem<T>>(Content_CollectionReset), sender, e);
321      else {
322        List<ListViewItem> listViewItems = new List<ListViewItem>();
323        foreach (IndexedItem<T> item in e.OldItems)
324          listViewItems.Add(itemsListView.Items[item.Index]);
325        foreach (ListViewItem listViewItem in listViewItems)
326          RemoveListViewItem(listViewItem);
327
328        foreach (IndexedItem<T> item in e.Items)
329          InsertListViewItem(item.Index, CreateListViewItem(item.Value));
330      }
331    }
332    #endregion
333
334    #region Item Events
335    protected virtual void Item_Changed(object sender, ChangedEventArgs e) {
336      if (InvokeRequired)
337        Invoke(new ChangedEventHandler(Item_Changed), sender, e);
338      else {
339        T item = (T)sender;
340        foreach (ListViewItem listViewItem in itemsListView.Items) {
341          if (((T)listViewItem.Tag) == item)
342            UpdateListViewItem(listViewItem);
343        }
344      }
345    }
346    #endregion
347  }
348}
Note: See TracBrowser for help on using the repository browser.