Free cookie consent management tool by TermsFeed Policy Generator

source: trunk/sources/HeuristicLab.MainForm.WindowsForms/3.3/Controls/ViewHost.cs @ 6568

Last change on this file since 6568 was 6568, checked in by gkronber, 11 years ago

#1577: removed explicit disposal of cached views in the viewhost to fix the exception which occurs when the scroll bar of a view is used while the underlying content is changed.

File size: 11.4 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2011 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.Common;
28
29namespace HeuristicLab.MainForm.WindowsForms {
30  [Content(typeof(IContent))]
31  public sealed partial class ViewHost : AsynchronousContentView {
32    public ViewHost() {
33      InitializeComponent();
34      startDragAndDrop = false;
35      viewContextMenuStrip.IgnoredViewTypes = new List<Type>() { typeof(ViewHost) };
36
37      viewType = null;
38      activeView = null;
39      Content = null;
40      messageLabel.Visible = false;
41      viewsLabel.Visible = false;
42      viewsLabelVisible = true;
43    }
44
45    private bool viewsLabelVisible;
46    public bool ViewsLabelVisible {
47      get { return viewsLabelVisible; }
48      set {
49        if (viewsLabelVisible != value) {
50          viewsLabelVisible = value;
51          viewsLabel.Visible = value;
52          View view = activeView as View;
53          if (view != null) view.Dock = viewsLabelVisible ? DockStyle.None : DockStyle.Fill;
54        }
55      }
56    }
57
58    private IContentView cachedView;
59    private IContentView activeView;
60    public IContentView ActiveView {
61      get { return activeView; }
62      private set {
63        if (activeView != value) {
64          if (activeView != null) {
65            cachedView = activeView;
66            DeregisterActiveViewEvents();
67            View cached = cachedView as View;
68            if (cached != null) {
69              cached.OnHidden(EventArgs.Empty);
70              cached.Visible = false;
71            }
72          }
73
74          activeView = value;
75
76          if (activeView != null) {
77            #region dispose cachedView
78            if (activeView != cachedView) {
79              if (cachedView != null) cachedView.Content = null;  //needed to deregister events
80              View cached = cachedView as View;
81              if (cached != null) {
82                Controls.Remove(cached);
83              }
84              cachedView = null;
85            }
86            #endregion
87
88            this.Caption = activeView.Caption;
89            viewType = activeView.GetType();
90            RegisterActiveViewEvents();
91            View view = activeView as View;
92            if (view != null) {
93              view.Visible = true;
94              if (ViewsLabelVisible) {
95                view.Anchor = AnchorStyles.Bottom | AnchorStyles.Left | AnchorStyles.Top | AnchorStyles.Right;
96                view.Size = new Size(Width - this.viewsLabel.Width - this.viewsLabel.Margin.Left - this.viewsLabel.Margin.Right, this.Height);
97              } else view.Dock = DockStyle.Fill;
98              if (!Controls.Contains((view))) Controls.Add(view);
99              view.OnShown(new ViewShownEventArgs(view, false));
100            }
101          } else viewType = null;
102          configurationLabel.Visible = activeView is IConfigureableView;
103          configurationLabel.Enabled = activeView != null && !activeView.Locked;
104        }
105      }
106    }
107
108    private Type viewType;
109    public Type ViewType {
110      get { return viewType; }
111      set {
112        if (viewType != value) {
113          if (value == typeof(ViewHost))
114            throw new ArgumentException("Directly nested ViewHosts are not allowed.");
115          if (value != null && Content != null && !ViewCanShowContent(value, Content))
116            throw new ArgumentException(string.Format("View \"{0}\" cannot display content \"{1}\".", value, Content.GetType()));
117
118          viewType = value;
119          OnViewTypeChanged();
120        }
121      }
122    }
123
124    protected override void SetEnabledStateOfControls() {
125      Enabled = Content != null;
126    }
127
128    protected override void OnContentChanged() {
129      viewContextMenuStrip.Item = Content;
130      //change ViewType if view of ViewType can not show content or is null
131      if (Content != null) {
132        if (!ViewCanShowContent(viewType, Content)) {
133          Type defaultViewType = MainFormManager.GetDefaultViewType(Content.GetType());
134          if (cachedView != null && cachedView.GetType() == defaultViewType)
135            ActiveView = cachedView;
136          else if (defaultViewType != null)
137            ViewType = defaultViewType;
138          else if (viewContextMenuStrip.Items.Count > 0)  // create first available view if no default view is available
139            ViewType = (Type)viewContextMenuStrip.Items[0].Tag;
140          else {
141            ViewType = null;
142            ActiveView = null;
143          }
144        }
145        if (ActiveView != null) ActiveView.Content = Content;
146      } else ActiveView = null;
147      UpdateLabels();
148      UpdateActiveMenuItem();
149    }
150
151    private void UpdateLabels() {
152      if (Content != null && viewContextMenuStrip.Items.Count > 0) {
153        messageLabel.Visible = false;
154        viewsLabel.Visible = viewsLabelVisible;
155      } else if (Content != null) {
156        messageLabel.Visible = true;
157        viewsLabel.Visible = false;
158      } else {
159        messageLabel.Visible = false;
160        viewsLabel.Visible = false;
161      }
162    }
163
164    private void OnViewTypeChanged() {
165      if (viewType != null) {
166        if (!ViewCanShowContent(viewType, Content))
167          throw new InvalidOperationException(string.Format("View \"{0}\" cannot display content \"{1}\".",
168                                                            viewType, Content.GetType()));
169        IContentView view = MainFormManager.CreateView(viewType);
170        view.Locked = Locked;
171        view.ReadOnly = ReadOnly;
172        ActiveView = view; //necessary to allow the views to change the status of the viewhost
173        view.Content = Content;
174
175        UpdateActiveMenuItem();
176      }
177    }
178
179    private void RegisterActiveViewEvents() {
180      activeView.CaptionChanged += new EventHandler(activeView_CaptionChanged);
181      activeView.LockedChanged += new EventHandler(activeView_LockedChanged);
182    }
183    private void DeregisterActiveViewEvents() {
184      activeView.CaptionChanged -= new EventHandler(activeView_CaptionChanged);
185      activeView.LockedChanged -= new EventHandler(activeView_LockedChanged);
186    }
187    private void activeView_CaptionChanged(object sender, EventArgs e) {
188      Caption = activeView.Caption;
189    }
190    private void activeView_LockedChanged(object sender, EventArgs e) {
191      Locked = activeView.Locked;
192      configurationLabel.Enabled = !activeView.Locked;
193    }
194
195    protected override void OnSizeChanged(EventArgs e) {
196      //mkommend: solution to resizing issues. taken from http://support.microsoft.com/kb/953934
197      //not implemented with a panel to reduce the number of nested controls
198      if (Handle != null)
199        this.BeginInvoke((Action<EventArgs>)OnSizeChangedHelper, e);
200    }
201    private void OnSizeChangedHelper(EventArgs e) {
202      base.OnSizeChanged(e);
203      viewsLabel.Location = new Point(Width - viewsLabel.Margin.Right - viewsLabel.Width, viewsLabel.Margin.Top);
204      configurationLabel.Location = new Point(Width - configurationLabel.Margin.Right - configurationLabel.Width, viewsLabel.Bottom + viewsLabel.Margin.Bottom + configurationLabel.Margin.Top);
205     
206    }
207
208    #region forwarding of view events
209    internal protected override void OnShown(ViewShownEventArgs e) {
210      base.OnShown(e);
211      View view = ActiveView as View;
212      if (view != null)
213        view.OnShown(e);
214    }
215    internal protected override void OnHidden(EventArgs e) {
216      base.OnHidden(e);
217      View view = ActiveView as View;
218      if (view != null)
219        view.OnHidden(e);
220    }
221    internal protected override void OnClosing(FormClosingEventArgs e) {
222      base.OnClosing(e);
223      View view = ActiveView as View;
224      if (view != null)
225        view.OnClosing(e);
226    }
227    internal protected override void OnClosed(FormClosedEventArgs e) {
228      base.OnClosed(e);
229      View view = ActiveView as View;
230      if (view != null)
231        view.OnClosed(e);
232    }
233    #endregion
234
235    #region GUI actions
236    private void UpdateActiveMenuItem() {
237      foreach (KeyValuePair<Type, ToolStripMenuItem> item in viewContextMenuStrip.MenuItems) {
238        if (item.Key == viewType) {
239          item.Value.Checked = true;
240          item.Value.Enabled = false;
241        } else {
242          item.Value.Checked = false;
243          item.Value.Enabled = true;
244        }
245      }
246    }
247
248    private bool ViewCanShowContent(Type viewType, object content) {
249      if (content == null) // every view can display null
250        return true;
251      if (viewType == null)
252        return false;
253      return ContentAttribute.CanViewType(viewType, Content.GetType()) && viewContextMenuStrip.MenuItems.Any(item => item.Key == viewType);
254    }
255
256    private void viewsLabel_DoubleClick(object sender, EventArgs e) {
257      IContentView view = MainFormManager.MainForm.ShowContent(this.Content, this.ViewType);
258      if (view != null) {
259        view.ReadOnly = this.ReadOnly;
260        view.Locked = this.Locked;
261      }
262    }
263    private void viewContextMenuStrip_ItemClicked(object sender, ToolStripItemClickedEventArgs e) {
264      Type viewType = (Type)e.ClickedItem.Tag;
265      ViewType = viewType;
266    }
267
268    private bool startDragAndDrop;
269    private void viewsLabel_MouseDown(object sender, MouseEventArgs e) {
270      if (e.Button == System.Windows.Forms.MouseButtons.Right) {
271        Screen screen = Screen.FromControl(viewsLabel);
272        int rightBorder = viewsLabel.PointToScreen(viewsLabel.Location).X + viewContextMenuStrip.Width; //
273        rightBorder = rightBorder - screen.Bounds.X; //pixel position on active screen
274
275        if (rightBorder < screen.Bounds.Width)
276          viewContextMenuStrip.Show(viewsLabel, viewsLabel.Margin.Left, viewsLabel.Margin.Top);
277        else
278          viewContextMenuStrip.Show(screen.Bounds.X + screen.Bounds.Width - viewContextMenuStrip.Width, viewsLabel.PointToScreen(viewsLabel.Location).Y - viewsLabel.Margin.Top);
279      } else if (!Locked) {
280        startDragAndDrop = true;
281        viewsLabel.Capture = false;
282        viewsLabel.Focus();
283      }
284    }
285    private void viewsLabel_MouseLeave(object sender, EventArgs e) {
286      if ((Control.MouseButtons & MouseButtons.Left) == MouseButtons.Left && startDragAndDrop) {
287        DataObject data = new DataObject();
288        data.SetData(HeuristicLab.Common.Constants.DragDropDataFormat, Content);
289        DoDragDrop(data, DragDropEffects.Copy | DragDropEffects.Link);
290      } else
291        startDragAndDrop = false;
292    }
293
294    private void configurationLabel_MouseDoubleClick(object sender, MouseEventArgs e) {
295      ((IConfigureableView)ActiveView).ShowConfiguration();
296    }
297    #endregion
298  }
299}
Note: See TracBrowser for help on using the repository browser.