Changeset 9893 for trunk/sources/HeuristicLab.MainForm.WindowsForms/3.3/Controls/ProgressView.cs

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...)

File:

• trunk/sources/HeuristicLab.MainForm.WindowsForms/3.3/Controls/ProgressView.cs (modified) (5 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();
     }
   }