Free cookie consent management tool by TermsFeed Policy Generator

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

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

Fixed disabling of details group boxes (#1100)

File size: 18.5 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;
29using HeuristicLab.PluginInfrastructure;
30
31namespace HeuristicLab.Core.Views {
32  /// <summary>
33  /// The visual representation of all variables in a specified scope.
34  /// </summary>
35  [View("ItemList View")]
36  [Content(typeof(ItemList<>), true)]
37  [Content(typeof(IItemList<>), false)]
38  public partial class ItemListView<T> : ItemView where T : class, IItem {
39    protected TypeSelectorDialog typeSelectorDialog;
40
41    /// <summary>
42    /// Gets or sets the scope whose variables to represent visually.
43    /// </summary>
44    /// <remarks>Uses property <see cref="ViewBase.Item"/> of base class <see cref="ViewBase"/>.
45    /// No won data storage present.</remarks>
46    public new IItemList<T> Content {
47      get { return (IItemList<T>)base.Content; }
48      set { base.Content = value; }
49    }
50
51    public ListView ItemsListView {
52      get { return itemsListView; }
53    }
54
55    /// <summary>
56    /// Initializes a new instance of <see cref="VariablesScopeView"/> with caption "Variables Scope View".
57    /// </summary>
58    public ItemListView() {
59      InitializeComponent();
60    }
61
62    /// <summary>
63    /// Removes the eventhandlers from the underlying <see cref="IScope"/>.
64    /// </summary>
65    /// <remarks>Calls <see cref="ViewBase.RemoveItemEvents"/> of base class <see cref="ViewBase"/>.</remarks>
66    protected override void DeregisterContentEvents() {
67      Content.ItemsAdded -= new CollectionItemsChangedEventHandler<IndexedItem<T>>(Content_ItemsAdded);
68      Content.ItemsRemoved -= new CollectionItemsChangedEventHandler<IndexedItem<T>>(Content_ItemsRemoved);
69      Content.ItemsReplaced -= new CollectionItemsChangedEventHandler<IndexedItem<T>>(Content_ItemsReplaced);
70      Content.ItemsMoved -= new CollectionItemsChangedEventHandler<IndexedItem<T>>(Content_ItemsMoved);
71      Content.CollectionReset -= new CollectionItemsChangedEventHandler<IndexedItem<T>>(Content_CollectionReset);
72      base.DeregisterContentEvents();
73    }
74
75    /// <summary>
76    /// Adds eventhandlers to the underlying <see cref="IScope"/>.
77    /// </summary>
78    /// <remarks>Calls <see cref="ViewBase.AddItemEvents"/> of base class <see cref="ViewBase"/>.</remarks>
79    protected override void RegisterContentEvents() {
80      base.RegisterContentEvents();
81      Content.ItemsAdded += new CollectionItemsChangedEventHandler<IndexedItem<T>>(Content_ItemsAdded);
82      Content.ItemsRemoved += new CollectionItemsChangedEventHandler<IndexedItem<T>>(Content_ItemsRemoved);
83      Content.ItemsReplaced += new CollectionItemsChangedEventHandler<IndexedItem<T>>(Content_ItemsReplaced);
84      Content.ItemsMoved += new CollectionItemsChangedEventHandler<IndexedItem<T>>(Content_ItemsMoved);
85      Content.CollectionReset += new CollectionItemsChangedEventHandler<IndexedItem<T>>(Content_CollectionReset);
86    }
87
88    protected override void OnContentChanged() {
89      base.OnContentChanged();
90
91      int selectedIndex = -1;
92      if (itemsListView.SelectedItems.Count == 1) selectedIndex = itemsListView.SelectedIndices[0];
93
94      while (itemsListView.Items.Count > 0) RemoveListViewItem(itemsListView.Items[0]);
95      viewHost.Content = null;
96      if (Content != null) {
97        foreach (T item in Content)
98          AddListViewItem(CreateListViewItem(item));
99        if ((selectedIndex != -1) && (selectedIndex < itemsListView.Items.Count))
100          itemsListView.Items[selectedIndex].Selected = true;
101      }
102      SetEnabledStateOfControls();
103    }
104
105    protected override void SetEnabledStateOfControls() {
106      base.SetEnabledStateOfControls();
107      if (Content == null) {
108        addButton.Enabled = false;
109        moveUpButton.Enabled = false;
110        moveDownButton.Enabled = false;
111        removeButton.Enabled = false;
112        itemsListView.Enabled = false;
113        detailsGroupBox.Enabled = false;
114      } else {
115        addButton.Enabled = !Content.IsReadOnly && !ReadOnly;
116        moveUpButton.Enabled = itemsListView.SelectedItems.Count == 1 &&
117                               itemsListView.SelectedIndices[0] != 0 &&
118                               !Content.IsReadOnly && !ReadOnly;
119        moveDownButton.Enabled = itemsListView.SelectedItems.Count == 1 &&
120                                 itemsListView.SelectedIndices[0] != itemsListView.Items.Count - 1 &&
121                                 !Content.IsReadOnly && !ReadOnly;
122        removeButton.Enabled = itemsListView.SelectedItems.Count > 0 &&
123                               !Content.IsReadOnly && !ReadOnly;
124        itemsListView.Enabled = true;
125        detailsGroupBox.Enabled = itemsListView.SelectedItems.Count == 1;
126      }
127    }
128
129    protected virtual T CreateItem() {
130      if (typeSelectorDialog == null) {
131        typeSelectorDialog = new TypeSelectorDialog();
132        typeSelectorDialog.Caption = "Select Item";
133        typeSelectorDialog.TypeSelector.Caption = "Available Items";
134        typeSelectorDialog.TypeSelector.Configure(typeof(T), false, true);
135      }
136
137      if (typeSelectorDialog.ShowDialog(this) == DialogResult.OK) {
138        try {
139          return (T)typeSelectorDialog.TypeSelector.CreateInstanceOfSelectedType();
140        }
141        catch (Exception ex) {
142          ErrorHandling.ShowErrorDialog(this, ex);
143        }
144      }
145      return null;
146    }
147    protected virtual ListViewItem CreateListViewItem(T item) {
148      ListViewItem listViewItem = new ListViewItem();
149      listViewItem.Text = item.ToString();
150      listViewItem.ToolTipText = item.ItemName + ": " + item.ItemDescription;
151      listViewItem.Tag = item;
152      itemsListView.SmallImageList.Images.Add(item.ItemImage);
153      listViewItem.ImageIndex = itemsListView.SmallImageList.Images.Count - 1;
154      return listViewItem;
155    }
156    protected virtual void AddListViewItem(ListViewItem listViewItem) {
157      itemsListView.Items.Add(listViewItem);
158      ((T)listViewItem.Tag).ItemImageChanged += new EventHandler(Item_ItemImageChanged);
159      ((T)listViewItem.Tag).ToStringChanged += new EventHandler(Item_ToStringChanged);
160      AdjustListViewColumnSizes();
161    }
162    protected virtual void InsertListViewItem(int index, ListViewItem listViewItem) {
163      itemsListView.Items.Insert(index, listViewItem);
164      ((T)listViewItem.Tag).ItemImageChanged += new EventHandler(Item_ItemImageChanged);
165      ((T)listViewItem.Tag).ToStringChanged += new EventHandler(Item_ToStringChanged);
166      AdjustListViewColumnSizes();
167    }
168    protected virtual void RemoveListViewItem(ListViewItem listViewItem) {
169      ((T)listViewItem.Tag).ItemImageChanged -= new EventHandler(Item_ItemImageChanged);
170      ((T)listViewItem.Tag).ToStringChanged -= new EventHandler(Item_ToStringChanged);
171      listViewItem.Remove();
172      foreach (ListViewItem other in itemsListView.Items)
173        if (other.ImageIndex > listViewItem.ImageIndex) other.ImageIndex--;
174      itemsListView.SmallImageList.Images.RemoveAt(listViewItem.ImageIndex);
175    }
176    protected virtual void UpdateListViewItemImage(ListViewItem listViewItem) {
177      int i = listViewItem.ImageIndex;
178      listViewItem.ImageList.Images[i] = ((T)listViewItem.Tag).ItemImage;
179      listViewItem.ImageIndex = -1;
180      listViewItem.ImageIndex = i;
181    }
182    protected virtual void UpdateListViewItemText(ListViewItem listViewItem) {
183      if (!listViewItem.Text.Equals(listViewItem.Tag.ToString()))
184        listViewItem.Text = listViewItem.Tag.ToString();
185    }
186
187    #region ListView Events
188    protected virtual void itemsListView_SelectedIndexChanged(object sender, EventArgs e) {
189      moveUpButton.Enabled = itemsListView.SelectedItems.Count == 1 &&
190                             itemsListView.SelectedIndices[0] != 0 &&
191                             (Content != null) && !Content.IsReadOnly && !ReadOnly;
192      moveDownButton.Enabled = itemsListView.SelectedItems.Count == 1 &&
193                               itemsListView.SelectedIndices[0] != itemsListView.Items.Count - 1 &&
194                               (Content != null) && !Content.IsReadOnly && !ReadOnly;
195      removeButton.Enabled = itemsListView.SelectedItems.Count > 0 &&
196                             (Content != null) && !Content.IsReadOnly && !ReadOnly;
197      AdjustListViewColumnSizes();
198
199      if (showDetailsCheckBox.Checked) {
200        if (itemsListView.SelectedItems.Count == 1) {
201          T item = (T)itemsListView.SelectedItems[0].Tag;
202          detailsGroupBox.Enabled = true;
203          viewHost.Content = item;
204        } else {
205          viewHost.Content = null;
206          detailsGroupBox.Enabled = false;
207        }
208      }
209    }
210
211    protected virtual void itemsListView_KeyDown(object sender, KeyEventArgs e) {
212      if (e.KeyCode == Keys.Delete) {
213        if ((itemsListView.SelectedItems.Count > 0) && !Content.IsReadOnly && !ReadOnly) {
214          foreach (ListViewItem item in itemsListView.SelectedItems)
215            Content.RemoveAt(item.Index);
216        }
217      }
218    }
219
220    protected virtual void itemsListView_DoubleClick(object sender, EventArgs e) {
221      if (itemsListView.SelectedItems.Count == 1) {
222        T item = (T)itemsListView.SelectedItems[0].Tag;
223        IContentView view = MainFormManager.MainForm.ShowContent(item);
224        if (view != null) {
225          view.ReadOnly = ReadOnly;
226          view.Locked = Locked;
227        }
228      }
229    }
230
231    protected virtual void itemsListView_ItemDrag(object sender, ItemDragEventArgs e) {
232      if (!Locked) {
233        ListViewItem listViewItem = (ListViewItem)e.Item;
234        T item = (T)listViewItem.Tag;
235        DataObject data = new DataObject();
236        data.SetData("Type", item.GetType());
237        data.SetData("Value", item);
238        if (Content.IsReadOnly || ReadOnly) {
239          DoDragDrop(data, DragDropEffects.Copy | DragDropEffects.Link);
240        } else {
241          DragDropEffects result = DoDragDrop(data, DragDropEffects.Copy | DragDropEffects.Link | DragDropEffects.Move);
242          if ((result & DragDropEffects.Move) == DragDropEffects.Move)
243            Content.RemoveAt(listViewItem.Index);
244        }
245      }
246    }
247    protected virtual void itemsListView_DragEnterOver(object sender, DragEventArgs e) {
248      e.Effect = DragDropEffects.None;
249      Type type = e.Data.GetData("Type") as Type;
250      if (!Content.IsReadOnly && !ReadOnly && (type != null) && (typeof(T).IsAssignableFrom(type))) {
251        if ((e.KeyState & 32) == 32) e.Effect = DragDropEffects.Link;  // ALT key
252        else if ((e.KeyState & 4) == 4) e.Effect = DragDropEffects.Move;  // SHIFT key
253        else if ((e.AllowedEffect & DragDropEffects.Copy) == DragDropEffects.Copy) e.Effect = DragDropEffects.Copy;
254        else if ((e.AllowedEffect & DragDropEffects.Move) == DragDropEffects.Move) e.Effect = DragDropEffects.Move;
255        else if ((e.AllowedEffect & DragDropEffects.Link) == DragDropEffects.Link) e.Effect = DragDropEffects.Link;
256      }
257    }
258    protected virtual void itemsListView_DragDrop(object sender, DragEventArgs e) {
259      if (e.Effect != DragDropEffects.None) {
260        T item = e.Data.GetData("Value") as T;
261        if ((e.Effect & DragDropEffects.Copy) == DragDropEffects.Copy) item = (T)item.Clone();
262
263        Point p = itemsListView.PointToClient(new Point(e.X, e.Y));
264        ListViewItem listViewItem = itemsListView.GetItemAt(p.X, p.Y);
265        if (listViewItem != null) Content.Insert(listViewItem.Index, item);
266        else Content.Add(item);
267      }
268    }
269    #endregion
270
271    #region Button Events
272    protected virtual void addButton_Click(object sender, EventArgs e) {
273      T item = CreateItem();
274      if (item != null)
275        Content.Add(item);
276    }
277    protected virtual void moveUpButton_Click(object sender, EventArgs e) {
278      if (itemsListView.SelectedItems.Count == 1) {
279        int index = itemsListView.SelectedIndices[0];
280        T item = Content[index - 1];
281        Content[index - 1] = Content[index];
282        itemsListView.Items[index].Selected = false;
283        itemsListView.Items[index - 1].Selected = true;
284        Content[index] = item;
285      }
286    }
287    protected virtual void moveDownButton_Click(object sender, EventArgs e) {
288      if (itemsListView.SelectedItems.Count == 1) {
289        int index = itemsListView.SelectedIndices[0];
290        T item = Content[index + 1];
291        Content[index + 1] = Content[index];
292        itemsListView.Items[index].Selected = false;
293        itemsListView.Items[index + 1].Selected = true;
294        Content[index] = item;
295      }
296    }
297    protected virtual void removeButton_Click(object sender, EventArgs e) {
298      if (itemsListView.SelectedItems.Count > 0) {
299        foreach (ListViewItem item in itemsListView.SelectedItems)
300          Content.RemoveAt(item.Index);
301      }
302    }
303    #endregion
304
305    #region CheckBox Events
306    protected virtual void showDetailsCheckBox_CheckedChanged(object sender, EventArgs e) {
307      if (showDetailsCheckBox.Checked) {
308        splitContainer.Panel2Collapsed = false;
309        detailsGroupBox.Enabled = itemsListView.SelectedItems.Count == 1;
310        viewHost.Content = itemsListView.SelectedItems.Count == 1 ? (T)itemsListView.SelectedItems[0].Tag : null;
311      } else {
312        splitContainer.Panel2Collapsed = true;
313        viewHost.Content = null;
314        viewHost.ClearCache();
315      }
316    }
317    #endregion
318
319    #region Content Events
320    protected virtual void Content_ItemsAdded(object sender, CollectionItemsChangedEventArgs<IndexedItem<T>> e) {
321      if (InvokeRequired)
322        Invoke(new CollectionItemsChangedEventHandler<IndexedItem<T>>(Content_ItemsAdded), sender, e);
323      else
324        foreach (IndexedItem<T> item in e.Items)
325          InsertListViewItem(item.Index, CreateListViewItem(item.Value));
326    }
327    protected virtual void Content_ItemsRemoved(object sender, CollectionItemsChangedEventArgs<IndexedItem<T>> e) {
328      if (InvokeRequired)
329        Invoke(new CollectionItemsChangedEventHandler<IndexedItem<T>>(Content_ItemsRemoved), sender, e);
330      else {
331        List<ListViewItem> listViewItems = new List<ListViewItem>();
332        foreach (IndexedItem<T> item in e.Items)
333          listViewItems.Add(itemsListView.Items[item.Index]);
334        foreach (ListViewItem listViewItem in listViewItems)
335          RemoveListViewItem(listViewItem);
336      }
337    }
338    protected virtual void Content_ItemsReplaced(object sender, CollectionItemsChangedEventArgs<IndexedItem<T>> e) {
339      if (InvokeRequired)
340        Invoke(new CollectionItemsChangedEventHandler<IndexedItem<T>>(Content_ItemsReplaced), sender, e);
341      else {
342        int[] selected = new int[itemsListView.SelectedIndices.Count];
343        itemsListView.SelectedIndices.CopyTo(selected, 0);
344
345        List<ListViewItem> listViewItems = new List<ListViewItem>();
346        foreach (IndexedItem<T> item in e.OldItems)
347          listViewItems.Add(itemsListView.Items[item.Index]);
348        foreach (ListViewItem listViewItem in listViewItems)
349          RemoveListViewItem(listViewItem);
350
351        foreach (IndexedItem<T> item in e.Items)
352          InsertListViewItem(item.Index, CreateListViewItem(item.Value));
353
354        for (int i = 0; i < selected.Length; i++)
355          itemsListView.Items[selected[i]].Selected = true;
356      }
357    }
358    protected virtual void Content_ItemsMoved(object sender, CollectionItemsChangedEventArgs<IndexedItem<T>> e) {
359      if (InvokeRequired)
360        Invoke(new CollectionItemsChangedEventHandler<IndexedItem<T>>(Content_ItemsMoved), sender, e);
361      else {
362        foreach (IndexedItem<T> item in e.Items) {
363          ListViewItem listViewItem = itemsListView.Items[item.Index];
364          listViewItem.Tag = item.Value;
365          UpdateListViewItemImage(listViewItem);
366          UpdateListViewItemText(listViewItem);
367        }
368      }
369    }
370    protected virtual void Content_CollectionReset(object sender, CollectionItemsChangedEventArgs<IndexedItem<T>> e) {
371      if (InvokeRequired)
372        Invoke(new CollectionItemsChangedEventHandler<IndexedItem<T>>(Content_CollectionReset), sender, e);
373      else {
374        List<ListViewItem> listViewItems = new List<ListViewItem>();
375        foreach (IndexedItem<T> item in e.OldItems)
376          listViewItems.Add(itemsListView.Items[item.Index]);
377        foreach (ListViewItem listViewItem in listViewItems)
378          RemoveListViewItem(listViewItem);
379
380        foreach (IndexedItem<T> item in e.Items)
381          InsertListViewItem(item.Index, CreateListViewItem(item.Value));
382      }
383    }
384    #endregion
385
386    #region Item Events
387    protected virtual void Item_ItemImageChanged(object sender, EventArgs e) {
388      if (InvokeRequired)
389        Invoke(new EventHandler(Item_ItemImageChanged), sender, e);
390      else {
391        T item = (T)sender;
392        foreach (ListViewItem listViewItem in itemsListView.Items) {
393          if (((T)listViewItem.Tag) == item)
394            UpdateListViewItemImage(listViewItem);
395        }
396      }
397    }
398    protected virtual void Item_ToStringChanged(object sender, EventArgs e) {
399      if (InvokeRequired)
400        Invoke(new EventHandler(Item_ToStringChanged), sender, e);
401      else {
402        T item = (T)sender;
403        foreach (ListViewItem listViewItem in itemsListView.Items) {
404          if (((T)listViewItem.Tag) == item)
405            UpdateListViewItemText(listViewItem);
406        }
407      }
408    }
409    #endregion
410
411    #region Helpers
412    protected virtual void AdjustListViewColumnSizes() {
413      if (itemsListView.Items.Count > 0) {
414        for (int i = 0; i < itemsListView.Columns.Count; i++)
415          itemsListView.Columns[i].AutoResize(ColumnHeaderAutoResizeStyle.ColumnContent);
416      }
417    }
418    #endregion
419  }
420}
Note: See TracBrowser for help on using the repository browser.