Free cookie consent management tool by TermsFeed Policy Generator

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

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

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