Free cookie consent management tool by TermsFeed Policy Generator

source: branches/PersistenceSpeedUp/HeuristicLab.Optimization.Views/3.3/RunCollectionView.cs @ 11544

Last change on this file since 11544 was 6760, checked in by epitzer, 13 years ago

#1530 integrate changes from trunk
File size: 20.9 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.Common;
30using HeuristicLab.Core;
31using HeuristicLab.Core.Views;
32using HeuristicLab.MainForm;
33using HeuristicLab.MainForm.WindowsForms;
34
35namespace HeuristicLab.Optimization.Views {
36  [View("RunCollection View")]
37  [Content(typeof(RunCollection), true)]
38  [Content(typeof(IItemCollection<IRun>), false)]
39  public sealed partial class RunCollectionView : ItemView {
40    private Dictionary<IRun, List<ListViewItem>> itemListViewItemMapping;
41    private bool validDragOperation;
42
43    public new IItemCollection<IRun> Content {
44      get { return (IItemCollection<IRun>)base.Content; }
45      set { base.Content = value; }
46    }
47
48    public RunCollection RunCollection {
49      get { return Content as RunCollection; }
50    }
51
52    public ListView ItemsListView {
53      get { return itemsListView; }
54    }
55
56    public RunCollectionView() {
57      InitializeComponent();
58      itemsGroupBox.Text = "Runs";
59      itemListViewItemMapping = new Dictionary<IRun, List<ListViewItem>>();
60      runCollectionModifiersListView.Evaluator = EvaluateModifications;
61    }
62
63    protected override void DeregisterContentEvents() {
64      Content.ItemsAdded -= new CollectionItemsChangedEventHandler<IRun>(Content_ItemsAdded);
65      Content.ItemsRemoved -= new CollectionItemsChangedEventHandler<IRun>(Content_ItemsRemoved);
66      Content.CollectionReset -= new CollectionItemsChangedEventHandler<IRun>(Content_CollectionReset);
67      foreach (IRun run in itemListViewItemMapping.Keys) {
68        DeregisterItemEvents(run);
69      }
70      base.DeregisterContentEvents();
71    }
72    protected override void RegisterContentEvents() {
73      base.RegisterContentEvents();
74      Content.ItemsAdded += new CollectionItemsChangedEventHandler<IRun>(Content_ItemsAdded);
75      Content.ItemsRemoved += new CollectionItemsChangedEventHandler<IRun>(Content_ItemsRemoved);
76      Content.CollectionReset += new CollectionItemsChangedEventHandler<IRun>(Content_CollectionReset);
77    }
78    private void DeregisterItemEvents(IRun item) {
79      item.ItemImageChanged -= new EventHandler(Item_ItemImageChanged);
80      item.ToStringChanged -= new EventHandler(Item_ToStringChanged);
81      item.Changed -= new EventHandler(Item_Changed);
82    }
83    private void RegisterItemEvents(IRun item) {
84      item.ItemImageChanged += new EventHandler(Item_ItemImageChanged);
85      item.ToStringChanged += new EventHandler(Item_ToStringChanged);
86      item.Changed += new EventHandler(Item_Changed);
87    }
88
89    protected override void OnInitialized(EventArgs e) {
90      base.OnInitialized(e);
91      var viewTypes = MainFormManager.GetViewTypes(typeof(RunCollection), true);
92      foreach (Type viewType in viewTypes.OrderBy(x => ViewAttribute.GetViewName(x))) {
93        if ((viewType != typeof(ItemCollectionView<IRun>)) && (viewType != typeof(ViewHost))) {
94          ToolStripMenuItem menuItem = new ToolStripMenuItem();
95          menuItem.Text = ViewAttribute.GetViewName(viewType);
96          menuItem.Tag = viewType;
97          menuItem.Click += new EventHandler(menuItem_Click);
98          analyzeRunsToolStripDropDownButton.DropDownItems.Add(menuItem);
99        }
100      }
101    }
102
103    protected override void OnContentChanged() {
104      base.OnContentChanged();
105
106      string selectedName = null;
107      if ((itemsListView.SelectedItems.Count == 1) && (itemsListView.SelectedItems[0].Tag != null))
108        selectedName = ((IRun)itemsListView.SelectedItems[0].Tag).Name;
109
110      itemsListView.Items.Clear();
111      itemListViewItemMapping.Clear();
112      RebuildImageList();
113      viewHost.Content = null;
114
115      if (Content != null) {
116        if (RunCollection != null) {
117          if (!tabControl.TabPages.Contains(constraintPage))
118            tabControl.TabPages.Add(constraintPage);
119          runCollectionConstraintCollectionView.Content = RunCollection.Constraints;
120          runCollectionConstraintCollectionView.ReadOnly = itemsListView.Items.Count == 0;
121          if (!tabControl.TabPages.Contains(modifiersPage))
122            tabControl.TabPages.Add(modifiersPage);
123          runCollectionModifiersListView.Content = RunCollection.Modifiers;
124        }
125        foreach (IRun item in Content) {
126          ListViewItem listViewItem = CreateListViewItem(item);
127          AddListViewItem(listViewItem);
128          if ((selectedName != null) && item.Name.Equals(selectedName))
129            listViewItem.Selected = true;
130        }
131        AdjustListViewColumnSizes();
132      } else {
133        runCollectionConstraintCollectionView.Content = null;
134        if (tabControl.TabPages.Contains(constraintPage))
135          tabControl.TabPages.Remove(constraintPage);
136        if (tabControl.TabPages.Contains(modifiersPage))
137          tabControl.TabPages.Remove(modifiersPage);
138      }
139    }
140
141    protected override void SetEnabledStateOfControls() {
142      base.SetEnabledStateOfControls();
143      if (Content == null) {
144        analyzeRunsToolStripDropDownButton.Enabled = false;
145        runCollectionConstraintCollectionView.ReadOnly = true;
146        itemsListView.Enabled = false;
147        detailsGroupBox.Enabled = false;
148        viewHost.Enabled = false;
149        removeButton.Enabled = false;
150        clearButton.Enabled = false;
151      } else {
152        analyzeRunsToolStripDropDownButton.Enabled = itemsListView.Items.Count > 0;
153        runCollectionConstraintCollectionView.ReadOnly = itemsListView.Items.Count == 0;
154        itemsListView.Enabled = true;
155        detailsGroupBox.Enabled = itemsListView.SelectedItems.Count == 1;
156        removeButton.Enabled = itemsListView.SelectedItems.Count > 0 && !Content.IsReadOnly && !ReadOnly;
157        clearButton.Enabled = itemsListView.Items.Count > 0 && !Content.IsReadOnly && !ReadOnly;
158        viewHost.Enabled = true;
159      }
160    }
161
162    private ListViewItem CreateListViewItem(IRun item) {
163      ListViewItem listViewItem = new ListViewItem();
164      if (item == null) {
165        listViewItem.Text = "null";
166        itemsListView.SmallImageList.Images.Add(HeuristicLab.Common.Resources.VSImageLibrary.Nothing);
167        listViewItem.ImageIndex = itemsListView.SmallImageList.Images.Count - 1;
168      } else {
169        listViewItem.Text = item.ToString();
170        listViewItem.ToolTipText = item.ItemName + ": " + item.ItemDescription;
171        itemsListView.SmallImageList.Images.Add(item.ItemImage);
172        listViewItem.ImageIndex = itemsListView.SmallImageList.Images.Count - 1;
173        listViewItem.Tag = item;
174
175        if (item.Visible) {
176          listViewItem.Font = new Font(listViewItem.Font, FontStyle.Regular);
177          listViewItem.ForeColor = item.Color;
178        } else {
179          listViewItem.Font = new Font(listViewItem.Font, FontStyle.Italic);
180          listViewItem.ForeColor = Color.LightGray;
181        }
182      }
183      return listViewItem;
184    }
185    private void AddListViewItem(ListViewItem listViewItem) {
186      if (listViewItem == null) throw new ArgumentNullException();
187      itemsListView.Items.Add(listViewItem);
188      IRun run = listViewItem.Tag as IRun;
189      if (run != null) {
190        if (!itemListViewItemMapping.ContainsKey(run)) {
191          itemListViewItemMapping.Add(run, new List<ListViewItem>());
192          RegisterItemEvents(run);
193        }
194        itemListViewItemMapping[run].Add(listViewItem);
195      }
196    }
197    private void RemoveListViewItem(ListViewItem listViewItem) {
198      if (listViewItem == null) throw new ArgumentNullException();
199      IRun run = listViewItem.Tag as IRun;
200      if (run != null) {
201        itemListViewItemMapping[run].Remove(listViewItem);
202        if (itemListViewItemMapping[run].Count == 0) {
203          DeregisterItemEvents(run);
204          itemListViewItemMapping.Remove(run);
205        }
206      }
207      listViewItem.Remove();
208    }
209    private void UpdateListViewItemImage(ListViewItem listViewItem) {
210      if (listViewItem == null) throw new ArgumentNullException();
211      IRun item = listViewItem.Tag as IRun;
212      int i = listViewItem.ImageIndex;
213      itemsListView.SmallImageList.Images[i] = item == null ? HeuristicLab.Common.Resources.VSImageLibrary.Nothing : item.ItemImage;
214      listViewItem.ImageIndex = -1;
215      listViewItem.ImageIndex = i;
216    }
217    private void UpdateListViewItemText(ListViewItem listViewItem) {
218      if (listViewItem == null) throw new ArgumentNullException();
219      IRun item = listViewItem.Tag as IRun;
220      listViewItem.Text = item == null ? "null" : item.ToString();
221      listViewItem.ToolTipText = item == null ? string.Empty : item.ItemName + ": " + item.ItemDescription;
222    }
223    private IEnumerable<ListViewItem> GetListViewItemsForItem(IRun item) {
224      if (item == null) {
225        List<ListViewItem> listViewItems = new List<ListViewItem>();
226        foreach (ListViewItem listViewItem in itemsListView.Items) {
227          if (listViewItem.Tag == null) listViewItems.Add(listViewItem);
228        }
229        return listViewItems;
230      } else {
231        List<ListViewItem> listViewItems = null;
232        itemListViewItemMapping.TryGetValue(item, out listViewItems);
233        return listViewItems == null ? Enumerable.Empty<ListViewItem>() : listViewItems;
234      }
235    }
236
237    #region ListView Events
238    private void itemsListView_SelectedIndexChanged(object sender, EventArgs e) {
239      removeButton.Enabled = itemsListView.SelectedItems.Count > 0 && (Content != null) && !Content.IsReadOnly && !ReadOnly;
240      AdjustListViewColumnSizes();
241      if (showDetailsCheckBox.Checked) {
242        if (itemsListView.SelectedItems.Count == 1) {
243          IRun item = (IRun)itemsListView.SelectedItems[0].Tag;
244          detailsGroupBox.Enabled = true;
245          viewHost.Content = item;
246        } else {
247          viewHost.Content = null;
248          detailsGroupBox.Enabled = false;
249        }
250      }
251    }
252    private void itemsListView_KeyDown(object sender, KeyEventArgs e) {
253      if (e.KeyCode == Keys.Delete) {
254        if ((itemsListView.SelectedItems.Count > 0) && !Content.IsReadOnly && !ReadOnly) {
255          foreach (ListViewItem item in itemsListView.SelectedItems)
256            Content.Remove((IRun)item.Tag);
257        }
258      }
259    }
260    private void itemsListView_DoubleClick(object sender, EventArgs e) {
261      if (itemsListView.SelectedItems.Count == 1) {
262        IRun item = itemsListView.SelectedItems[0].Tag as IRun;
263        if (item != null) {
264          IContentView view = MainFormManager.MainForm.ShowContent(item);
265          if (view != null) {
266            view.ReadOnly = ReadOnly;
267            view.Locked = Locked;
268          }
269        }
270      }
271    }
272    private void itemsListView_ItemDrag(object sender, ItemDragEventArgs e) {
273      if (!Locked) {
274        List<IRun> items = new List<IRun>();
275        foreach (ListViewItem listViewItem in itemsListView.SelectedItems) {
276          IRun item = listViewItem.Tag as IRun;
277          if (item != null) items.Add(item);
278        }
279
280        if (items.Count > 0) {
281          DataObject data = new DataObject();
282          if (items.Count == 1) data.SetData(HeuristicLab.Common.Constants.DragDropDataFormat, items[0]);
283          else data.SetData(HeuristicLab.Common.Constants.DragDropDataFormat, items);
284          if (Content.IsReadOnly || ReadOnly) {
285            DoDragDrop(data, DragDropEffects.Copy | DragDropEffects.Link);
286          } else {
287            DragDropEffects result = DoDragDrop(data, DragDropEffects.Copy | DragDropEffects.Link | DragDropEffects.Move);
288            if (result.HasFlag(DragDropEffects.Move)) {
289              foreach (IRun item in items) Content.Remove(item);
290            }
291          }
292        }
293      }
294    }
295    private void itemsListView_DragEnter(object sender, DragEventArgs e) {
296      validDragOperation = false;
297      if (!Content.IsReadOnly && !ReadOnly && (e.Data.GetData(HeuristicLab.Common.Constants.DragDropDataFormat) is IRun)) {
298        validDragOperation = true;
299      } else if (!Content.IsReadOnly && !ReadOnly && (e.Data.GetData(HeuristicLab.Common.Constants.DragDropDataFormat) is IEnumerable)) {
300        validDragOperation = true;
301        IEnumerable items = (IEnumerable)e.Data.GetData(HeuristicLab.Common.Constants.DragDropDataFormat);
302        foreach (object item in items)
303          validDragOperation = validDragOperation && (item is IRun);
304      }
305    }
306    private void itemsListView_DragOver(object sender, DragEventArgs e) {
307      e.Effect = DragDropEffects.None;
308      if (validDragOperation) {
309        if ((e.KeyState & 32) == 32) e.Effect = DragDropEffects.Link;  // ALT key
310        else if ((e.KeyState & 4) == 4) e.Effect = DragDropEffects.Move;  // SHIFT key
311        else if (e.AllowedEffect.HasFlag(DragDropEffects.Copy)) e.Effect = DragDropEffects.Copy;
312        else if (e.AllowedEffect.HasFlag(DragDropEffects.Move)) e.Effect = DragDropEffects.Move;
313        else if (e.AllowedEffect.HasFlag(DragDropEffects.Link)) e.Effect = DragDropEffects.Link;
314      }
315    }
316    private void itemsListView_DragDrop(object sender, DragEventArgs e) {
317      if (e.Effect != DragDropEffects.None) {
318        if (e.Data.GetData(HeuristicLab.Common.Constants.DragDropDataFormat) is IRun) {
319          IRun item = (IRun)e.Data.GetData(HeuristicLab.Common.Constants.DragDropDataFormat);
320          Content.Add(e.Effect.HasFlag(DragDropEffects.Copy) ? (IRun)item.Clone() : item);
321        } else if (e.Data.GetData(HeuristicLab.Common.Constants.DragDropDataFormat) is IEnumerable) {
322          IEnumerable<IRun> items = ((IEnumerable)e.Data.GetData(HeuristicLab.Common.Constants.DragDropDataFormat)).Cast<IRun>();
323          if (e.Effect.HasFlag(DragDropEffects.Copy)) {
324            Cloner cloner = new Cloner();
325            items = items.Select(x => cloner.Clone(x));
326          }
327          foreach (IRun item in items)
328            Content.Add(item);
329        }
330      }
331    }
332    #endregion
333
334    #region Button Events
335    private void menuItem_Click(object sender, EventArgs e) {
336      ToolStripMenuItem menuItem = (ToolStripMenuItem)sender;
337      Type viewType = (Type)menuItem.Tag;
338      IContentView view = MainFormManager.MainForm.ShowContent(Content, viewType);
339      if (view != null) {
340        view.Locked = Locked;
341        view.ReadOnly = ReadOnly;
342      }
343    }
344    private void removeButton_Click(object sender, EventArgs e) {
345      if (itemsListView.SelectedItems.Count > 0) {
346        foreach (ListViewItem item in itemsListView.SelectedItems)
347          Content.Remove((IRun)item.Tag);
348        itemsListView.SelectedItems.Clear();
349      }
350    }
351    private void clearButton_Click(object sender, EventArgs e) {
352      Content.Clear();
353    }
354    #endregion
355
356    #region Control Events
357    private void showDetailsCheckBox_CheckedChanged(object sender, EventArgs e) {
358      if (showDetailsCheckBox.Checked) {
359        splitContainer.Panel2Collapsed = false;
360        detailsGroupBox.Enabled = itemsListView.SelectedItems.Count == 1;
361        viewHost.Content = itemsListView.SelectedItems.Count == 1 ? (IRun)itemsListView.SelectedItems[0].Tag : null;
362      } else {
363        splitContainer.Panel2Collapsed = true;
364        viewHost.Content = null;
365      }
366    }
367    private void EvaluateModifications() {
368      if (RunCollection == null)
369        return;
370      ReadOnly = true;
371      try {
372        RunCollection.Modify();
373      } finally {
374        ReadOnly = false;
375      }
376    }
377    #endregion
378
379    #region Content Events
380    private void Content_ItemsAdded(object sender, CollectionItemsChangedEventArgs<IRun> e) {
381      if (InvokeRequired)
382        Invoke(new CollectionItemsChangedEventHandler<IRun>(Content_ItemsAdded), sender, e);
383      else {
384        foreach (IRun item in e.Items)
385          AddListViewItem(CreateListViewItem(item));
386
387        AdjustListViewColumnSizes();
388        analyzeRunsToolStripDropDownButton.Enabled = itemsListView.Items.Count > 0;
389        clearButton.Enabled = itemsListView.Items.Count > 0 && !Content.IsReadOnly && !ReadOnly;
390        runCollectionConstraintCollectionView.ReadOnly = itemsListView.Items.Count == 0;
391      }
392    }
393    private void Content_ItemsRemoved(object sender, CollectionItemsChangedEventArgs<IRun> e) {
394      if (InvokeRequired)
395        Invoke(new CollectionItemsChangedEventHandler<IRun>(Content_ItemsRemoved), sender, e);
396      else {
397        foreach (IRun item in e.Items) {
398          //remove only the first matching ListViewItem, because the IRun could be contained multiple times in the ItemCollection
399          ListViewItem listViewItem = GetListViewItemsForItem(item).FirstOrDefault();
400          if (listViewItem != null) RemoveListViewItem(listViewItem);
401        }
402        RebuildImageList();
403        analyzeRunsToolStripDropDownButton.Enabled = itemsListView.Items.Count > 0;
404        clearButton.Enabled = itemsListView.Items.Count > 0 && !Content.IsReadOnly && !ReadOnly;
405        runCollectionConstraintCollectionView.ReadOnly = itemsListView.Items.Count == 0;
406      }
407    }
408    private void Content_CollectionReset(object sender, CollectionItemsChangedEventArgs<IRun> e) {
409      if (InvokeRequired)
410        Invoke(new CollectionItemsChangedEventHandler<IRun>(Content_CollectionReset), sender, e);
411      else {
412        foreach (IRun item in e.OldItems) {
413          //remove only the first matching ListViewItem, because the IRun could be contained multiple times in the ItemCollection
414          ListViewItem listViewItem = GetListViewItemsForItem(item).FirstOrDefault();
415          if (listViewItem != null) RemoveListViewItem(listViewItem);
416        }
417        RebuildImageList();
418        foreach (IRun item in e.Items)
419          AddListViewItem(CreateListViewItem(item));
420
421        AdjustListViewColumnSizes();
422        analyzeRunsToolStripDropDownButton.Enabled = itemsListView.Items.Count > 0;
423        clearButton.Enabled = itemsListView.Items.Count > 0 && !Content.IsReadOnly && !ReadOnly;
424        runCollectionConstraintCollectionView.ReadOnly = itemsListView.Items.Count == 0;
425      }
426    }
427    #endregion
428
429    #region Item Events
430    private void Item_ItemImageChanged(object sender, EventArgs e) {
431      if (InvokeRequired)
432        Invoke(new EventHandler(Item_ItemImageChanged), sender, e);
433      else {
434        IRun item = (IRun)sender;
435        foreach (ListViewItem listViewItem in GetListViewItemsForItem(item))
436          UpdateListViewItemImage(listViewItem);
437      }
438    }
439    private void Item_ToStringChanged(object sender, EventArgs e) {
440      if (InvokeRequired)
441        Invoke(new EventHandler(Item_ToStringChanged), sender, e);
442      else {
443        IRun item = (IRun)sender;
444        foreach (ListViewItem listViewItem in GetListViewItemsForItem(item))
445          UpdateListViewItemText(listViewItem);
446        AdjustListViewColumnSizes();
447      }
448    }
449    private void Item_Changed(object sender, EventArgs e) {
450      if (InvokeRequired)
451        this.Invoke(new EventHandler(Item_Changed), sender, e);
452      else {
453        IRun run = (IRun)sender;
454        UpdateRun(run);
455      }
456    }
457
458    private void UpdateRun(IRun run) {
459      foreach (ListViewItem listViewItem in GetListViewItemsForItem(run)) {
460        if (run.Visible) {
461          listViewItem.Font = new Font(listViewItem.Font, FontStyle.Regular);
462          listViewItem.ForeColor = run.Color;
463        } else {
464          listViewItem.Font = new Font(listViewItem.Font, FontStyle.Italic);
465          listViewItem.ForeColor = Color.LightGray;
466        }
467      }
468    }
469    #endregion
470
471    #region Helpers
472    private void AdjustListViewColumnSizes() {
473      if (itemsListView.Items.Count > 0) {
474        for (int i = 0; i < itemsListView.Columns.Count; i++) {
475          itemsListView.Columns[i].AutoResize(ColumnHeaderAutoResizeStyle.ColumnContent);
476        }
477      }
478    }
479    private void RebuildImageList() {
480      itemsListView.SmallImageList.Images.Clear();
481      foreach (ListViewItem listViewItem in itemsListView.Items) {
482        IRun item = listViewItem.Tag as IRun;
483        itemsListView.SmallImageList.Images.Add(item == null ? HeuristicLab.Common.Resources.VSImageLibrary.Nothing : item.ItemImage);
484        listViewItem.ImageIndex = itemsListView.SmallImageList.Images.Count - 1;
485      }
486    }
487    #endregion
488  }
489}
Note: See TracBrowser for help on using the repository browser.