Free cookie consent management tool by TermsFeed Policy Generator

source: trunk/sources/HeuristicLab.Optimization.Views/3.3/RunCollectionView.cs @ 4096

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

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