Free cookie consent management tool by TermsFeed Policy Generator

source: trunk/sources/HeuristicLab.Core.Views/3.3/Clipboard.cs @ 3758

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

Implemented ErrorDialog and OperatorExecutionException (#1007)
File size: 12.7 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.IO;
25using System.Linq;
26using System.Threading;
27using System.Windows.Forms;
28using HeuristicLab.MainForm;
29using HeuristicLab.Persistence.Default.Xml;
30using HeuristicLab.PluginInfrastructure;
31
32namespace HeuristicLab.Core.Views {
33  [View("Clipboard")]
34  public sealed partial class Clipboard<T> : HeuristicLab.MainForm.WindowsForms.Sidebar where T : class, IItem {
35    private TypeSelectorDialog typeSelectorDialog;
36    private Dictionary<T, ListViewItem> itemListViewItemTable;
37
38    private string itemsPath;
39    public string ItemsPath {
40      get { return itemsPath; }
41      private set {
42        if (string.IsNullOrEmpty(value)) throw new ArgumentException(string.Format("Invalid items path \"{0}\".", value));
43        itemsPath = value;
44        try {
45          if (!Directory.Exists(itemsPath)) {
46            Directory.CreateDirectory(itemsPath);
47            // directory creation might take some time -> wait until it is definitively created
48            while (!Directory.Exists(itemsPath)) {
49              Thread.Sleep(100);
50              Directory.CreateDirectory(itemsPath);
51            }
52          }
53        }
54        catch (Exception ex) {
55          throw new ArgumentException(string.Format("Invalid items path \"{0}\".", itemsPath), ex);
56        }
57      }
58    }
59
60    public Clipboard() {
61      InitializeComponent();
62      ItemsPath = Environment.GetFolderPath(Environment.SpecialFolder.ApplicationData) +
63                  Path.DirectorySeparatorChar + "HeuristicLab" + Path.DirectorySeparatorChar + "Clipboard";
64      itemListViewItemTable = new Dictionary<T, ListViewItem>();
65    }
66    public Clipboard(string itemsPath) {
67      InitializeComponent();
68      ItemsPath = itemsPath;
69      itemListViewItemTable = new Dictionary<T, ListViewItem>();
70    }
71
72    protected override void OnInitialized(EventArgs e) {
73      base.OnInitialized(e);
74      SetEnabledStateOfControls();
75      Enabled = false;
76      infoLabel.Text = "Loading ...";
77      progressBar.Value = 0;
78      infoPanel.Visible = true;
79      ThreadPool.QueueUserWorkItem(new WaitCallback(LoadItems));
80    }
81    protected override void OnReadOnlyChanged() {
82      base.OnReadOnlyChanged();
83      SetEnabledStateOfControls();
84    }
85
86    private void SetEnabledStateOfControls() {
87      addButton.Enabled = !ReadOnly;
88      removeButton.Enabled = !ReadOnly && listView.SelectedItems.Count > 0;
89      saveButton.Enabled = !ReadOnly;
90    }
91
92    public void AddItem(T item) {
93      if (InvokeRequired)
94        Invoke(new Action<T>(AddItem), item);
95      else {
96        if (!itemListViewItemTable.ContainsKey(item)) {
97          ListViewItem listViewItem = new ListViewItem(item.ToString());
98          listViewItem.ToolTipText = item.ItemName + ": " + item.ItemDescription;
99          listView.SmallImageList.Images.Add(item.ItemImage);
100          listViewItem.ImageIndex = listView.SmallImageList.Images.Count - 1;
101          listViewItem.Tag = item;
102          listView.Items.Add(listViewItem);
103          itemListViewItemTable.Add(item, listViewItem);
104          item.ItemImageChanged += new EventHandler(Item_ItemImageChanged);
105          item.ToStringChanged += new EventHandler(Item_ToStringChanged);
106          sortAscendingButton.Enabled = sortDescendingButton.Enabled = listView.Items.Count > 1;
107          AdjustListViewColumnSizes();
108        }
109      }
110    }
111
112    private void RemoveItem(T item) {
113      if (InvokeRequired)
114        Invoke(new Action<T>(RemoveItem), item);
115      else {
116        if (itemListViewItemTable.ContainsKey(item)) {
117          item.ItemImageChanged -= new EventHandler(Item_ItemImageChanged);
118          item.ToStringChanged -= new EventHandler(Item_ToStringChanged);
119          ListViewItem listViewItem = itemListViewItemTable[item];
120          listViewItem.Remove();
121          foreach (ListViewItem other in listView.Items)
122            if (other.ImageIndex > listViewItem.ImageIndex) other.ImageIndex--;
123          listView.SmallImageList.Images.RemoveAt(listViewItem.ImageIndex);
124          itemListViewItemTable.Remove(item);
125          sortAscendingButton.Enabled = sortDescendingButton.Enabled = listView.Items.Count > 1;
126        }
127      }
128    }
129    private void Save() {
130      if (InvokeRequired)
131        Invoke(new Action(Save));
132      else {
133        Enabled = false;
134        infoLabel.Text = "Saving ...";
135        progressBar.Value = 0;
136        infoPanel.Visible = true;
137        ThreadPool.QueueUserWorkItem(new WaitCallback(SaveItems));
138      }
139    }
140
141    #region Loading/Saving Items
142    private void LoadItems(object state) {
143      string[] items = Directory.GetFiles(ItemsPath);
144      foreach (string filename in items) {
145        try {
146          T item = XmlParser.Deserialize<T>(filename);
147          OnItemLoaded(item, progressBar.Maximum / items.Length);
148        }
149        catch (Exception) { }
150      }
151      OnAllItemsLoaded();
152    }
153    private void OnItemLoaded(T item, int progress) {
154      if (InvokeRequired)
155        Invoke(new Action<T, int>(OnItemLoaded), item, progress);
156      else {
157        AddItem(item);
158        progressBar.Value += progress;
159      }
160    }
161    private void OnAllItemsLoaded() {
162      if (InvokeRequired)
163        Invoke(new Action(OnAllItemsLoaded));
164      else {
165        Enabled = true;
166        if (listView.Items.Count > 0) {
167          for (int i = 0; i < listView.Columns.Count; i++)
168            listView.Columns[i].AutoResize(ColumnHeaderAutoResizeStyle.ColumnContent);
169        }
170        infoPanel.Visible = false;
171      }
172    }
173    private void SaveItems(object param) {
174      Directory.Delete(ItemsPath, true);
175      Directory.CreateDirectory(ItemsPath);
176      // directory creation might take some time -> wait until it is definitively created
177      while (!Directory.Exists(ItemsPath)) {
178        Thread.Sleep(100);
179        Directory.CreateDirectory(ItemsPath);
180      }
181
182      int i = 0;
183      T[] items = itemListViewItemTable.Keys.ToArray();
184      foreach (T item in items) {
185        try {
186          i++;
187          XmlGenerator.Serialize(item, ItemsPath + Path.DirectorySeparatorChar + i.ToString("00000000") + ".hl", 9);
188          OnItemSaved(item, progressBar.Maximum / listView.Items.Count);
189        }
190        catch (Exception) { }
191      }
192      OnAllItemsSaved();
193    }
194    private void OnItemSaved(T item, int progress) {
195      if (item != null) {
196        if (InvokeRequired)
197          Invoke(new Action<T, int>(OnItemLoaded), item, progress);
198        else
199          progressBar.Value += progress;
200      }
201    }
202    private void OnAllItemsSaved() {
203      if (InvokeRequired)
204        Invoke(new Action(OnAllItemsLoaded));
205      else {
206        Enabled = true;
207        infoPanel.Visible = false;
208      }
209    }
210    #endregion
211
212    #region ListView Events
213    private void listView_SelectedIndexChanged(object sender, EventArgs e) {
214      removeButton.Enabled = !ReadOnly && listView.SelectedItems.Count > 0;
215    }
216    private void listView_KeyDown(object sender, KeyEventArgs e) {
217      if (e.KeyCode == Keys.Delete) {
218        if (!ReadOnly && (listView.SelectedItems.Count > 0)) {
219          foreach (ListViewItem item in listView.SelectedItems)
220            RemoveItem((T)item.Tag);
221        }
222      }
223    }
224    private void listView_DoubleClick(object sender, EventArgs e) {
225      if (listView.SelectedItems.Count == 1) {
226        T item = (T)listView.SelectedItems[0].Tag;
227        IView view = MainFormManager.MainForm.ShowContent(item);
228        if (view != null) {
229          view.ReadOnly = this.ReadOnly;
230        }
231      }
232    }
233    private void listView_ItemDrag(object sender, ItemDragEventArgs e) {
234      ListViewItem listViewItem = (ListViewItem)e.Item;
235      T item = (T)listViewItem.Tag;
236      DataObject data = new DataObject();
237      data.SetData("Type", item.GetType());
238      data.SetData("Value", item);
239      if (ReadOnly) {
240        DragDropEffects result = DoDragDrop(data, DragDropEffects.Copy | DragDropEffects.Link);
241      } else {
242        DragDropEffects result = DoDragDrop(data, DragDropEffects.Copy | DragDropEffects.Link | DragDropEffects.Move);
243        if ((result & DragDropEffects.Move) == DragDropEffects.Move)
244          RemoveItem(item);
245      }
246    }
247    private void listView_DragEnterOver(object sender, DragEventArgs e) {
248      e.Effect = DragDropEffects.None;
249      Type type = e.Data.GetData("Type") as Type;
250      T item = e.Data.GetData("Value") as T;
251      if (!ReadOnly && (type != null) && (item != null)) {
252        if ((e.KeyState & 32) == 32) e.Effect = DragDropEffects.Link;  // ALT key
253        else if (((e.KeyState & 4) == 4) && !itemListViewItemTable.ContainsKey(item)) e.Effect = DragDropEffects.Move;  // SHIFT key
254        else if ((e.AllowedEffect & DragDropEffects.Copy) == DragDropEffects.Copy) e.Effect = DragDropEffects.Copy;
255        else if (((e.AllowedEffect & DragDropEffects.Move) == DragDropEffects.Move) && !itemListViewItemTable.ContainsKey(item)) e.Effect = DragDropEffects.Move;
256        else if (((e.AllowedEffect & DragDropEffects.Link) == DragDropEffects.Link) && !itemListViewItemTable.ContainsKey(item)) e.Effect = DragDropEffects.Link;
257      }
258    }
259    private void listView_DragDrop(object sender, DragEventArgs e) {
260      if (e.Effect != DragDropEffects.None) {
261        T item = e.Data.GetData("Value") as T;
262        if ((e.Effect & DragDropEffects.Copy) == DragDropEffects.Copy) item = (T)item.Clone();
263        AddItem(item);
264      }
265    }
266    #endregion
267
268    #region Button Events
269    private void addButton_Click(object sender, EventArgs e) {
270      if (typeSelectorDialog == null) {
271        typeSelectorDialog = new TypeSelectorDialog();
272        typeSelectorDialog.Caption = "Select Item";
273        typeSelectorDialog.TypeSelector.Caption = "Available Items";
274        typeSelectorDialog.TypeSelector.Configure(typeof(T), false, true);
275      }
276
277      if (typeSelectorDialog.ShowDialog(this) == DialogResult.OK) {
278        try {
279          AddItem((T)typeSelectorDialog.TypeSelector.CreateInstanceOfSelectedType());
280        }
281        catch (Exception ex) {
282          ErrorHandling.ShowErrorDialog(this, ex);
283        }
284      }
285    }
286    private void sortAscendingButton_Click(object sender, EventArgs e) {
287      listView.Sorting = SortOrder.None;
288      listView.Sorting = SortOrder.Ascending;
289    }
290    private void sortDescendingButton_Click(object sender, EventArgs e) {
291      listView.Sorting = SortOrder.None;
292      listView.Sorting = SortOrder.Descending;
293    }
294    private void removeButton_Click(object sender, EventArgs e) {
295      if (listView.SelectedItems.Count > 0) {
296        foreach (ListViewItem item in listView.SelectedItems)
297          RemoveItem((T)item.Tag);
298      }
299    }
300    private void saveButton_Click(object sender, EventArgs e) {
301      Save();
302    }
303    #endregion
304
305    #region Item Events
306    private void Item_ItemImageChanged(object sender, EventArgs e) {
307      if (InvokeRequired)
308        Invoke(new EventHandler(Item_ItemImageChanged), sender, e);
309      else {
310        T item = (T)sender;
311        ListViewItem listViewItem = itemListViewItemTable[item];
312        int i = listViewItem.ImageIndex;
313        listViewItem.ImageList.Images[i] = item.ItemImage;
314        listViewItem.ImageIndex = -1;
315        listViewItem.ImageIndex = i;
316      }
317    }
318    private void Item_ToStringChanged(object sender, EventArgs e) {
319      if (InvokeRequired)
320        Invoke(new EventHandler(Item_ToStringChanged), sender, e);
321      else {
322        T item = (T)sender;
323        itemListViewItemTable[item].Text = item.ToString();
324        listView.Sort();
325        AdjustListViewColumnSizes();
326      }
327    }
328    #endregion
329
330    #region Helpers
331    private void AdjustListViewColumnSizes() {
332      if (listView.Items.Count > 0) {
333        for (int i = 0; i < listView.Columns.Count; i++)
334          listView.Columns[i].AutoResize(ColumnHeaderAutoResizeStyle.ColumnContent);
335      }
336    }
337    #endregion
338  }
339}
Note: See TracBrowser for help on using the repository browser.