Changeset 9893 for trunk/sources/HeuristicLab.MainForm.WindowsForms

Timestamp:

08/21/13 23:08:47 (11 years ago)

Author:

ascheibe

Message:

#1042

• applied mkommends progress view patch
• adapted Hive views accordingly
• made some minor improvements (more to come...)

Location:

trunk/sources/HeuristicLab.MainForm.WindowsForms/3.3

Files:

• Controls/ProgressView.cs (modified) (5 diffs)
• Controls/ProgressView.designer.cs (modified) (5 diffs)
• MainForms/MainForm.cs (modified) (7 diffs)

trunk/sources/HeuristicLab.MainForm.WindowsForms/3.3/Controls/ProgressView.cs

@@ -21 +21 @@
 
 using System;
-using System.ComponentModel;
 using System.Windows.Forms;
 
 namespace HeuristicLab.MainForm.WindowsForms {
-  [View("ProgressView")]
-  [Content(typeof(IProgress), true)]
-  public partial class ProgressView : AsynchronousContentView {
-    private const int DefaultCancelTimeoutMs = 3000;
-    private readonly IView view;
-
-    [Category("Custom"), Description("The time that the process is allowed to exit.")]
-    [DefaultValue(DefaultCancelTimeoutMs)]
-    public int CancelTimeoutMs { get; set; }
-    private bool ShouldSerializeCancelTimeoutMs() { return CancelTimeoutMs != DefaultCancelTimeoutMs; }
-
-    public new IProgress Content {
-      get { return (IProgress)base.Content; }
-      set { base.Content = value; }
+  public sealed partial class ProgressView : UserControl {
+    private readonly Control control;
+    public Control Control {
+      get { return control; }
     }
 
-    private Control Control {
-      get { return (Control)view; }
+    private readonly IProgress content;
+    public IProgress Content {
+      get { return content; }
     }
 
-    public bool DisposeOnFinish { get; set; }
+    public ProgressView(Control control, IProgress content)
+      : base() {
+      if (control == null) throw new ArgumentNullException("control", "The control is null.");
+      if (content == null) throw new ArgumentNullException("content", "The passed progress is null.");
+      InitializeComponent();
 
-    public ProgressView() {
-      InitializeComponent();
+      this.control = control;
+      this.content = content;
+      if (content.ProgressState == ProgressState.Started)
+        ShowProgress();
+      RegisterContentEvents();
     }
 
-    public ProgressView(IView view)
-      : this() {
-      if (view == null) throw new ArgumentNullException("view", "The view is null.");
-      if (!(view is Control)) throw new ArgumentException("The view is not a control.", "view");
-      this.view = view;
+    private void RegisterContentEvents() {
+      content.StatusChanged += new EventHandler(progress_StatusChanged);
+      content.ProgressValueChanged += new EventHandler(progress_ProgressValueChanged);
+      content.ProgressStateChanged += new EventHandler(Content_ProgressStateChanged);
+      content.CanBeCanceledChanged += new EventHandler(Content_CanBeCanceledChanged);
     }
-    public ProgressView(IView view, IProgress progress)
-      : this(view) {
-      Content = progress;
-    }
-
-    public static ProgressView Attach(IView view, IProgress progress, bool disposeOnFinish = false) {
-      return new ProgressView(view, progress) {
-        DisposeOnFinish = disposeOnFinish
-      };
-    }
-
-    protected override void RegisterContentEvents() {
-      Content.StatusChanged += new EventHandler(progress_StatusChanged);
-      Content.ProgressValueChanged += new EventHandler(progress_ProgressValueChanged);
-      Content.ProgressStateChanged += new EventHandler(Content_ProgressStateChanged);
-      Content.CanBeCanceledChanged += new EventHandler(Content_CanBeCanceledChanged);
-      base.RegisterContentEvents();
-    }
-
-    protected override void DeregisterContentEvents() {
-      base.DeregisterContentEvents();
-      Content.StatusChanged -= new EventHandler(progress_StatusChanged);
-      Content.ProgressValueChanged -= new EventHandler(progress_ProgressValueChanged);
-      Content.ProgressStateChanged -= new EventHandler(Content_ProgressStateChanged);
-      Content.CanBeCanceledChanged -= new EventHandler(Content_CanBeCanceledChanged);
-    }
-
-    protected override void OnContentChanged() {
-      base.OnContentChanged();
-      if (Content == null) {
-        HideProgress();
-      } else {
-        if (Content.ProgressState == ProgressState.Started)
-          ShowProgress();
-      }
-    }
-
-    protected override void SetEnabledStateOfControls() {
-      base.SetEnabledStateOfControls();
-      cancelButton.Visible = Content != null && Content.CanBeCanceled;
-      cancelButton.Enabled = Content != null && Content.CanBeCanceled && !ReadOnly;
+    private void DeregisterContentEvents() {
+      content.StatusChanged -= new EventHandler(progress_StatusChanged);
+      content.ProgressValueChanged -= new EventHandler(progress_ProgressValueChanged);
+      content.ProgressStateChanged -= new EventHandler(Content_ProgressStateChanged);
+      content.CanBeCanceledChanged -= new EventHandler(Content_CanBeCanceledChanged);
     }
 
     private void ShowProgress() {
-      if (InvokeRequired) Invoke((Action)ShowProgress);
-      else {
-        if (view != null) {
-          Left = (Control.ClientRectangle.Width / 2) - (Width / 2);
-          Top = (Control.ClientRectangle.Height / 2) - (Height / 2);
-          Anchor = AnchorStyles.None;
+      if (Control.InvokeRequired) {
+        Control.Invoke((Action)ShowProgress);
+        return;
+      }
+      Left = (Control.ClientRectangle.Width / 2) - (Width / 2);
+      Top = (Control.ClientRectangle.Height / 2) - (Height / 2);
+      Anchor = AnchorStyles.None;
 
-          LockBackground();
-          Parent = Control.Parent;
-          BringToFront();
-        }
-        UpdateProgressValue();
-        UpdateProgressStatus();
-        Visible = true;
-      }
+      control.Enabled = false;
+      Parent = Control.Parent;
+      BringToFront();
+
+      UpdateProgressValue();
+      UpdateProgressStatus();
+      UpdateCancelButton();
+      Visible = true;
     }
 
@@ -121 +83 @@
       if (InvokeRequired) Invoke((Action)HideProgress);
       else {
-        if (view != null) {
-          Parent = null;
-          UnlockBackground();
-        }
+        control.Enabled = true;
+        Parent = null;
         Visible = false;
       }
@@ -138 +98 @@
 
     private void Content_ProgressStateChanged(object sender, EventArgs e) {
-      switch (Content.ProgressState) {
-        case ProgressState.Finished:
-          HideProgress();
-          if (DisposeOnFinish) {
-            Content = null;
-            Dispose();
-          }
-          break;
+      switch (content.ProgressState) {
+        case ProgressState.Finished: HideProgress(); break;
         case ProgressState.Canceled: HideProgress(); break;
         case ProgressState.Started: ShowProgress(); break;
+        default: throw new NotSupportedException("The progress state " + content.ProgressState + " is not supported by the ProgressView.");
       }
     }
 
     private void Content_CanBeCanceledChanged(object sender, EventArgs e) {
-      SetEnabledStateOfControls();
+      UpdateCancelButton();
     }
 
-    private void LockBackground() {
-      if (InvokeRequired) Invoke((Action)LockBackground);
-      else {
-        view.Enabled = false;
-      }
-    }
-
-    private void UnlockBackground() {
-      if (InvokeRequired) Invoke((Action)UnlockBackground);
-      else {
-        view.Enabled = true;
-      }
+    private void UpdateCancelButton() {
+      cancelButton.Visible = content != null && content.CanBeCanceled;
+      cancelButton.Enabled = content != null && content.CanBeCanceled;
     }
 
@@ -172 +118 @@
       if (InvokeRequired) Invoke((Action)UpdateProgressValue);
       else {
-        if (Content != null) {
-          double progressValue = Content.ProgressValue;
+        if (content != null) {
+          double progressValue = content.ProgressValue;
           if (progressValue <= 0.0 || progressValue > 1.0) {
-            if (progressBar.Style != ProgressBarStyle.Marquee)
-              progressBar.Style = ProgressBarStyle.Marquee;
+            progressBar.Style = ProgressBarStyle.Marquee;
           } else {
-            if (progressBar.Style != ProgressBarStyle.Blocks)
-              progressBar.Style = ProgressBarStyle.Blocks;
+            progressBar.Style = ProgressBarStyle.Blocks;
             progressBar.Value = (int)Math.Round(progressBar.Minimum + progressValue * (progressBar.Maximum - progressBar.Minimum));
           }
@@ -188 +132 @@
     private void UpdateProgressStatus() {
       if (InvokeRequired) Invoke((Action)UpdateProgressStatus);
-      else if (Content != null)
-        statusLabel.Text = Content.Status;
+      else if (content != null)
+        statusLabel.Text = content.Status;
     }
 
     private void cancelButton_Click(object sender, EventArgs e) {
-      if (Content != null) {
-        try {
-          Content.Cancel(CancelTimeoutMs);
-          ReadOnly = true;
-          cancelButtonTimer.Interval = CancelTimeoutMs;
-          cancelButtonTimer.Start();
-        } catch (NotSupportedException nse) {
-          PluginInfrastructure.ErrorHandling.ShowErrorDialog(nse);
-        }
-      }
-    }
-
-    private void cancelButtonTimer_Tick(object sender, EventArgs e) {
-      cancelButtonTimer.Stop();
-      if (Visible) ReadOnly = false;
+      content.Cancel();
     }
   }

trunk/sources/HeuristicLab.MainForm.WindowsForms/3.3/Controls/ProgressView.designer.cs

@@ -32 +32 @@
     /// <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
     protected override void Dispose(bool disposing) {
+      DeregisterContentEvents();
       if (disposing && (components != null)) {
         components.Dispose();
@@ -50 +51 @@
       this.cancelButton = new System.Windows.Forms.Button();
       this.panel = new System.Windows.Forms.Panel();
-      this.cancelButtonTimer = new System.Windows.Forms.Timer(this.components);
       this.panel.SuspendLayout();
       this.SuspendLayout();
@@ -97 +97 @@
       this.panel.TabIndex = 3;
       // 
-      // cancelButtonTimer
-      // 
-      this.cancelButtonTimer.Tick += new System.EventHandler(this.cancelButtonTimer_Tick);
-      // 
       // ProgressView
       // 
@@ -109 +105 @@
       this.panel.ResumeLayout(false);
       this.ResumeLayout(false);
-
     }
 
@@ -118 +113 @@
     private System.Windows.Forms.Button cancelButton;
     private System.Windows.Forms.Panel panel;
-    private System.Windows.Forms.Timer cancelButtonTimer;
   }
 }

trunk/sources/HeuristicLab.MainForm.WindowsForms/3.3/MainForms/MainForm.cs

@@ -30 +30 @@
 namespace HeuristicLab.MainForm.WindowsForms {
   public partial class MainForm : Form, IMainForm {
-    private readonly Dictionary<IContent, IProgress> contentProgressLookup;
-    private readonly Dictionary<IView, IProgress> viewProgressLookup;
     private bool initialized;
     private int appStartingCursors;
@@ -41 +39 @@
       this.views = new Dictionary<IView, Form>();
       this.userInterfaceItems = new List<IUserInterfaceItem>();
-      this.contentProgressLookup = new Dictionary<IContent, IProgress>();
-      this.viewProgressLookup = new Dictionary<IView, IProgress>();
       this.initialized = false;
       this.showContentInViewHost = false;
@@ -347 +343 @@
         CloseView(view, closeReason);
     }
+    #endregion
+
+    #region progress views
+    private readonly Dictionary<IContent, IProgress> contentProgressLookup = new Dictionary<IContent, IProgress>();
+    private readonly Dictionary<IView, IProgress> viewProgressLookup = new Dictionary<IView, IProgress>();
+    private readonly List<ProgressView> progressViews = new List<ProgressView>();
 
     /// <summary>
@@ -355 +357 @@
         throw new ArgumentException("A progress is already registered for the specified content.", "content");
 
-      var contentViews = Enumerable.Empty<IContentView>();
+      var contentViews = views.Keys.OfType<ContentView>();
+      if (!contentViews.Any(v => v.Content == content))
+        throw new ArgumentException("The content is not displayed in a top-level view", "content");
+
       if (addToObjectGraphObjects) {
         var containedObjects = content.GetObjectGraphObjects();
-        contentViews = views.Keys.OfType<IContentView>().Where(v => containedObjects.Contains(v.Content));
+        contentViews = contentViews.Where(v => containedObjects.Contains(v.Content));
       } else
-        contentViews = views.Keys.OfType<IContentView>().Where(v => v.Content == content);
-
-      var progress = new Progress(progressMessage);
-      foreach (var contentView in contentViews)
-        ProgressView.Attach(contentView, progress, true);
+        contentViews = contentViews.Where(v => v.Content == content);
+
+      var progress = new Progress(progressMessage, ProgressState.Started);
+      foreach (var contentView in contentViews) {
+        progressViews.Add(new ProgressView((Control)contentView, progress));
+      }
 
       contentProgressLookup[content] = progress;
@@ -376 +382 @@
         throw new ArgumentException("A progress is already registered for the specified view.", "view");
 
-      var progress = new Progress(progressMessage);
-      ProgressView.Attach(view, progress, true);
+      var control = view as Control;
+      if (control == null) throw new ArgumentException("The passed view must be a control.", "view");
+
+      var progress = new Progress(progressMessage, ProgressState.Started);
+      progressViews.Add(new ProgressView(control, progress));
       viewProgressLookup[view] = progress;
     }
@@ -390 +399 @@
 
       progress.Finish();
+      foreach (var progressView in progressViews.Where(v => v.Content == progress).ToList()) {
+        progressView.Dispose();
+        progressViews.Remove(progressView);
+      }
       contentProgressLookup.Remove(content);
     }
@@ -402 +415 @@
 
       progress.Finish();
+      foreach (var progressView in progressViews.Where(v => v.Content == progress).ToList()) {
+        progressView.Dispose();
+        progressViews.Remove(progressView);
+      }
       viewProgressLookup.Remove(view);
     }