Free cookie consent management tool by TermsFeed Policy Generator

source: tags/3.3.0/HeuristicLab.Optimization.Views/3.3/RunCollectionView.cs @ 3838

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

Implemented reviewers' comments (#893)
File size: 16.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 HeuristicLab.Collections;
23using HeuristicLab.Common;
24using HeuristicLab.Core;
25using HeuristicLab.Core.Views;
26using HeuristicLab.MainForm;
27using HeuristicLab.MainForm.WindowsForms;
28using System.Windows.Forms;
29using System;
30using System.Drawing;
31using System.Collections.Generic;
32using System.Linq;
33
34namespace HeuristicLab.Optimization.Views {
35  [View("RunCollection View")]
36  [Content(typeof(RunCollection), true)]
37  [Content(typeof(IItemCollection<IRun>), false)]
38  public partial class RunCollectionView : ItemView {
39    public new IItemCollection<IRun> Content {
40      get { return (IItemCollection<IRun>)base.Content; }
41      set { base.Content = value; }
42    }
43
44    public RunCollection RunCollection {
45      get { return Content as RunCollection; }
46    }
47
48    public ListView ItemsListView {
49      get { return itemsListView; }
50    }
51
52    public RunCollectionView() {
53      InitializeComponent();
54      itemsGroupBox.Text = "Runs";
55    }
56
57    protected override void DeregisterContentEvents() {
58      Content.ItemsAdded -= new CollectionItemsChangedEventHandler<IRun>(Content_ItemsAdded);
59      Content.ItemsRemoved -= new CollectionItemsChangedEventHandler<IRun>(Content_ItemsRemoved);
60      Content.CollectionReset -= new CollectionItemsChangedEventHandler<IRun>(Content_CollectionReset);
61      DeregisterRunEvents(Content);
62      base.DeregisterContentEvents();
63    }
64    protected override void RegisterContentEvents() {
65      base.RegisterContentEvents();
66      Content.ItemsAdded += new CollectionItemsChangedEventHandler<IRun>(Content_ItemsAdded);
67      Content.ItemsRemoved += new CollectionItemsChangedEventHandler<IRun>(Content_ItemsRemoved);
68      Content.CollectionReset += new CollectionItemsChangedEventHandler<IRun>(Content_CollectionReset);
69      RegisterRunEvents(Content);
70    }
71    protected virtual void RegisterRunEvents(IEnumerable<IRun> runs) {
72      foreach (IRun run in runs)
73        run.Changed += new EventHandler(Run_Changed);
74    }
75    protected virtual void DeregisterRunEvents(IEnumerable<IRun> runs) {
76      foreach (IRun run in runs)
77        run.Changed -= new EventHandler(Run_Changed);
78    }
79
80    protected override void OnInitialized(EventArgs e) {
81      base.OnInitialized(e);
82      var viewTypes = MainFormManager.GetViewTypes(typeof(RunCollection), true);
83      foreach (Type viewType in viewTypes.OrderBy(x => ViewAttribute.GetViewName(x))) {
84        if ((viewType != typeof(ItemCollectionView<IRun>)) && (viewType != typeof(ViewHost))) {
85          ToolStripMenuItem menuItem = new ToolStripMenuItem();
86          menuItem.Text = ViewAttribute.GetViewName(viewType);
87          menuItem.Tag = viewType;
88          menuItem.Click += new EventHandler(menuItem_Click);
89          analyzeRunsToolStripDropDownButton.DropDownItems.Add(menuItem);
90        }
91      }
92    }
93
94    protected override void OnContentChanged() {
95      base.OnContentChanged();
96
97      string selectedName = null;
98      if ((itemsListView.SelectedItems.Count == 1) && (itemsListView.SelectedItems[0].Tag != null))
99        selectedName = ((IRun)itemsListView.SelectedItems[0].Tag).Name;
100
101      while (itemsListView.Items.Count > 0) RemoveListViewItem(itemsListView.Items[0]);
102      viewHost.Content = null;
103
104      if (Content != null) {
105        if (RunCollection != null) {
106          if (!tabControl.TabPages.Contains(constraintPage))
107            tabControl.TabPages.Add(constraintPage);
108          runCollectionConstraintCollectionView.Content = RunCollection.Constraints;
109          runCollectionConstraintCollectionView.ReadOnly = itemsListView.Items.Count == 0;
110        }
111        foreach (IRun item in Content) {
112          ListViewItem listViewItem = CreateListViewItem(item);
113          AddListViewItem(listViewItem);
114          UpdateRun(item);
115          if ((selectedName != null) && item.Name.Equals(selectedName))
116            listViewItem.Selected = true;
117        }
118      } else {
119        runCollectionConstraintCollectionView.Content = null;
120        if (tabControl.TabPages.Contains(constraintPage))
121          tabControl.TabPages.Remove(constraintPage);
122      }
123      SetEnabledStateOfControls();
124    }
125
126    protected override void OnReadOnlyChanged() {
127      base.OnReadOnlyChanged();
128      SetEnabledStateOfControls();
129    }
130    private void SetEnabledStateOfControls() {
131      if (Content == null) {
132        analyzeRunsToolStripDropDownButton.Enabled = false;
133        runCollectionConstraintCollectionView.ReadOnly = true;
134        itemsListView.Enabled = false;
135        detailsGroupBox.Enabled = false;
136        viewHost.Enabled = false;
137        removeButton.Enabled = false;
138        clearButton.Enabled = false;
139      } else {
140        analyzeRunsToolStripDropDownButton.Enabled = itemsListView.Items.Count > 0;
141        runCollectionConstraintCollectionView.ReadOnly = itemsListView.Items.Count == 0;
142        itemsListView.Enabled = true;
143        detailsGroupBox.Enabled = true;
144        removeButton.Enabled = itemsListView.SelectedItems.Count > 0 && !Content.IsReadOnly && !ReadOnly;
145        clearButton.Enabled = itemsListView.Items.Count > 0 && !Content.IsReadOnly && !ReadOnly;
146        viewHost.Enabled = true;
147      }
148    }
149
150    protected virtual ListViewItem CreateListViewItem(IRun item) {
151      ListViewItem listViewItem = new ListViewItem();
152      listViewItem.Text = item.ToString();
153      listViewItem.ToolTipText = item.ItemName + ": " + item.ItemDescription;
154      itemsListView.SmallImageList.Images.Add(item.ItemImage);
155      listViewItem.ImageIndex = itemsListView.SmallImageList.Images.Count - 1;
156      listViewItem.Tag = item;
157      return listViewItem;
158    }
159    protected virtual void AddListViewItem(ListViewItem listViewItem) {
160      itemsListView.Items.Add(listViewItem);
161      ((IRun)listViewItem.Tag).ItemImageChanged += new EventHandler(Item_ItemImageChanged);
162      ((IRun)listViewItem.Tag).ToStringChanged += new EventHandler(Item_ToStringChanged);
163      AdjustListViewColumnSizes();
164    }
165    protected virtual void RemoveListViewItem(ListViewItem listViewItem) {
166      ((IRun)listViewItem.Tag).ItemImageChanged -= new EventHandler(Item_ItemImageChanged);
167      ((IRun)listViewItem.Tag).ToStringChanged -= new EventHandler(Item_ToStringChanged);
168      listViewItem.Remove();
169      foreach (ListViewItem other in itemsListView.Items)
170        if (other.ImageIndex > listViewItem.ImageIndex) other.ImageIndex--;
171      itemsListView.SmallImageList.Images.RemoveAt(listViewItem.ImageIndex);
172    }
173    protected virtual void UpdateListViewItemImage(ListViewItem listViewItem) {
174      int i = listViewItem.ImageIndex;
175      listViewItem.ImageList.Images[i] = ((IRun)listViewItem.Tag).ItemImage;
176      listViewItem.ImageIndex = -1;
177      listViewItem.ImageIndex = i;
178    }
179    protected virtual void UpdateListViewItemText(ListViewItem listViewItem) {
180      if (!listViewItem.Text.Equals(listViewItem.Tag.ToString()))
181        listViewItem.Text = listViewItem.Tag.ToString();
182    }
183    protected virtual IEnumerable<ListViewItem> GetListViewItemsForItem(IRun item) {
184      foreach (ListViewItem listViewItem in itemsListView.Items) {
185        if (((IRun)listViewItem.Tag) == item)
186          yield return listViewItem;
187      }
188    }
189
190    #region ListView Events
191    protected virtual void itemsListView_SelectedIndexChanged(object sender, EventArgs e) {
192      removeButton.Enabled = itemsListView.SelectedItems.Count > 0 && (Content != null) && !Content.IsReadOnly && !ReadOnly;
193      AdjustListViewColumnSizes();
194      if (itemsListView.SelectedItems.Count == 1) {
195        IRun item = (IRun)itemsListView.SelectedItems[0].Tag;
196        detailsGroupBox.Enabled = true;
197        viewHost.Content = item;
198      } else {
199        viewHost.Content = null;
200        detailsGroupBox.Enabled = false;
201      }
202    }
203    protected virtual void itemsListView_KeyDown(object sender, KeyEventArgs e) {
204      if (e.KeyCode == Keys.Delete) {
205        if ((itemsListView.SelectedItems.Count > 0) && !Content.IsReadOnly && !ReadOnly) {
206          foreach (ListViewItem item in itemsListView.SelectedItems)
207            Content.Remove((IRun)item.Tag);
208        }
209      }
210    }
211    protected virtual void itemsListView_DoubleClick(object sender, EventArgs e) {
212      if (itemsListView.SelectedItems.Count == 1) {
213        IRun item = (IRun)itemsListView.SelectedItems[0].Tag;
214        IContentView view = MainFormManager.MainForm.ShowContent(item);
215        if (view != null) {
216          view.ReadOnly = ReadOnly;
217          view.Locked = Locked;
218        }
219      }
220    }
221    protected virtual void itemsListView_ItemDrag(object sender, ItemDragEventArgs e) {
222      if (!Locked) {
223        ListViewItem listViewItem = (ListViewItem)e.Item;
224        IRun item = (IRun)listViewItem.Tag;
225        DataObject data = new DataObject();
226        data.SetData("Type", item.GetType());
227        data.SetData("Value", item);
228        if (Content.IsReadOnly || ReadOnly) {
229          DoDragDrop(data, DragDropEffects.Copy | DragDropEffects.Link);
230        } else {
231          DragDropEffects result = DoDragDrop(data, DragDropEffects.Copy | DragDropEffects.Link | DragDropEffects.Move);
232          if ((result & DragDropEffects.Move) == DragDropEffects.Move)
233            Content.Remove(item);
234        }
235      }
236    }
237    protected virtual void itemsListView_DragEnterOver(object sender, DragEventArgs e) {
238      e.Effect = DragDropEffects.None;
239      Type type = e.Data.GetData("Type") as Type;
240      if (!Content.IsReadOnly && !ReadOnly && (type != null) && (typeof(IRun).IsAssignableFrom(type))) {
241        if ((e.KeyState & 32) == 32) e.Effect = DragDropEffects.Link;  // ALT key
242        else if ((e.KeyState & 4) == 4) e.Effect = DragDropEffects.Move;  // SHIFT key
243        else if ((e.AllowedEffect & DragDropEffects.Copy) == DragDropEffects.Copy) e.Effect = DragDropEffects.Copy;
244        else if ((e.AllowedEffect & DragDropEffects.Move) == DragDropEffects.Move) e.Effect = DragDropEffects.Move;
245        else if ((e.AllowedEffect & DragDropEffects.Link) == DragDropEffects.Link) e.Effect = DragDropEffects.Link;
246      }
247    }
248    protected virtual void itemsListView_DragDrop(object sender, DragEventArgs e) {
249      if (e.Effect != DragDropEffects.None) {
250        IRun item = e.Data.GetData("Value") as IRun;
251        if ((e.Effect & DragDropEffects.Copy) == DragDropEffects.Copy) item = (IRun)item.Clone();
252        Content.Add(item);
253      }
254    }
255    #endregion
256
257    #region Button Events
258    protected virtual void menuItem_Click(object sender, EventArgs e) {
259      ToolStripMenuItem menuItem = (ToolStripMenuItem)sender;
260      Type viewType = (Type)menuItem.Tag;
261      IContentView view = MainFormManager.MainForm.ShowContent(Content, viewType);
262      if (view != null) {
263        view.Locked = Locked;
264        view.ReadOnly = ReadOnly;
265      }
266    }
267    protected virtual void removeButton_Click(object sender, EventArgs e) {
268      if (itemsListView.SelectedItems.Count > 0) {
269        foreach (ListViewItem item in itemsListView.SelectedItems)
270          Content.Remove((IRun)item.Tag);
271        itemsListView.SelectedItems.Clear();
272      }
273    }
274    protected virtual void clearButton_Click(object sender, EventArgs e) {
275      Content.Clear();
276    }
277    #endregion
278
279    #region Content Events
280    protected virtual void Content_ItemsAdded(object sender, CollectionItemsChangedEventArgs<IRun> e) {
281      if (InvokeRequired)
282        Invoke(new CollectionItemsChangedEventHandler<IRun>(Content_ItemsAdded), sender, e);
283      else {
284        RegisterRunEvents(e.Items);
285        foreach (IRun item in e.Items)
286          AddListViewItem(CreateListViewItem(item));
287        analyzeRunsToolStripDropDownButton.Enabled = itemsListView.Items.Count > 0;
288        clearButton.Enabled = itemsListView.Items.Count > 0 && !Content.IsReadOnly && !ReadOnly;
289        runCollectionConstraintCollectionView.ReadOnly = itemsListView.Items.Count == 0;
290      }
291    }
292    protected virtual void Content_ItemsRemoved(object sender, CollectionItemsChangedEventArgs<IRun> e) {
293      if (InvokeRequired)
294        Invoke(new CollectionItemsChangedEventHandler<IRun>(Content_ItemsRemoved), sender, e);
295      else {
296        DeregisterRunEvents(e.Items);
297        foreach (IRun item in e.Items) {
298          foreach (ListViewItem listViewItem in GetListViewItemsForItem(item)) {
299            RemoveListViewItem(listViewItem);
300            break;
301          }
302        }
303        analyzeRunsToolStripDropDownButton.Enabled = itemsListView.Items.Count > 0;
304        clearButton.Enabled = itemsListView.Items.Count > 0 && !Content.IsReadOnly && !ReadOnly;
305        runCollectionConstraintCollectionView.ReadOnly = itemsListView.Items.Count == 0;
306      }
307    }
308    protected virtual void Content_CollectionReset(object sender, CollectionItemsChangedEventArgs<IRun> e) {
309      if (InvokeRequired)
310        Invoke(new CollectionItemsChangedEventHandler<IRun>(Content_CollectionReset), sender, e);
311      else {
312        DeregisterRunEvents(e.OldItems);
313        foreach (IRun item in e.OldItems) {
314          foreach (ListViewItem listViewItem in GetListViewItemsForItem(item)) {
315            RemoveListViewItem(listViewItem);
316            break;
317          }
318        }
319        RegisterRunEvents(e.Items);
320        foreach (IRun item in e.Items)
321          AddListViewItem(CreateListViewItem(item));
322        analyzeRunsToolStripDropDownButton.Enabled = itemsListView.Items.Count > 0;
323        clearButton.Enabled = itemsListView.Items.Count > 0 && !Content.IsReadOnly && !ReadOnly;
324        runCollectionConstraintCollectionView.ReadOnly = itemsListView.Items.Count == 0;
325      }
326    }
327    #endregion
328
329    #region Item Events
330    protected virtual void Item_ItemImageChanged(object sender, EventArgs e) {
331      if (InvokeRequired)
332        Invoke(new EventHandler(Item_ItemImageChanged), sender, e);
333      else {
334        IRun item = (IRun)sender;
335        foreach (ListViewItem listViewItem in GetListViewItemsForItem(item))
336          UpdateListViewItemImage(listViewItem);
337      }
338    }
339    protected virtual void Item_ToStringChanged(object sender, EventArgs e) {
340      if (InvokeRequired)
341        Invoke(new EventHandler(Item_ToStringChanged), sender, e);
342      else {
343        IRun item = (IRun)sender;
344        foreach (ListViewItem listViewItem in GetListViewItemsForItem(item))
345          UpdateListViewItemText(listViewItem);
346        AdjustListViewColumnSizes();
347      }
348    }
349    protected virtual void Run_Changed(object sender, EventArgs e) {
350      if (InvokeRequired)
351        this.Invoke(new EventHandler(Run_Changed), sender, e);
352      else {
353        IRun run = (IRun)sender;
354        UpdateRun(run);
355      }
356    }
357
358    protected virtual void UpdateRun(IRun run) {
359      foreach (ListViewItem listViewItem in GetListViewItemsForItem(run)) {
360        if (run.Visible) {
361          listViewItem.Font = new Font(listViewItem.Font, FontStyle.Regular);
362          listViewItem.ForeColor = run.Color;
363        } else {
364          listViewItem.Font = new Font(listViewItem.Font, FontStyle.Italic);
365          listViewItem.ForeColor = Color.LightGray;
366        }
367      }
368    }
369    #endregion
370
371    #region Helpers
372    protected virtual void AdjustListViewColumnSizes() {
373      if (itemsListView.Items.Count > 0) {
374        for (int i = 0; i < itemsListView.Columns.Count; i++) {
375          itemsListView.Columns[i].AutoResize(ColumnHeaderAutoResizeStyle.ColumnContent);
376        }
377      }
378    }
379    #endregion
380  }
381}
382
Note: See TracBrowser for help on using the repository browser.