Changeset 10042 for branches/Breadcrumbs/HeuristicLab.MainForm.WindowsForms

Timestamp:

10/15/13 16:11:27 (11 years ago)

Author:

jkarder

Message:

#2116: added prototype of a breadcrumb navigation

Location:

branches/Breadcrumbs/HeuristicLab.MainForm.WindowsForms/3.3

Files:

• Controls/BreadcrumbControl.Designer.cs (added)
• Controls/BreadcrumbControl.cs (added)
• Controls/ViewContextMenuStrip.cs (modified) (4 diffs)
• Controls/ViewHost.Designer.cs (modified) (5 diffs)
• Controls/ViewHost.cs (modified) (12 diffs)
• HeuristicLab.MainForm.WindowsForms-3.3.csproj (modified) (1 diff)

branches/Breadcrumbs/HeuristicLab.MainForm.WindowsForms/3.3/Controls/ViewContextMenuStrip.cs

@@ -30 +30 @@
     public ViewContextMenuStrip() {
       InitializeComponent();
-      this.menuItems = new Dictionary<Type, ToolStripMenuItem>();
-      this.ignoredViewTypes = new List<Type>();
+      menuItems = new Dictionary<Type, ToolStripMenuItem>();
+      ignoredViewTypes = new List<Type>();
     }
 
     public ViewContextMenuStrip(IContainer container)
       : base(container) {
-        InitializeComponent();
-      this.menuItems = new Dictionary<Type, ToolStripMenuItem>();
-      this.ignoredViewTypes = new List<Type>();
+      InitializeComponent();
+      menuItems = new Dictionary<Type, ToolStripMenuItem>();
+      ignoredViewTypes = new List<Type>();
+      ShowBreadcrumbsToolStripMenuItem = new ToolStripMenuItem("Show Breadcrumbs");
+      ShowBreadcrumbsToolStripMenuItem.Click += ShowBreadcrumbsToolStripMenuItem_Click;
+      ShowBreadcrumbsToolStripMenuItem.CheckedChanged += ShowBreadcrumbsToolStripMenuItem_CheckedChanged;
     }
 
     private object item;
     public object Item {
-      get { return this.item; }
+      get { return item; }
       set {
-        if (this.item != value) {
-          this.item = value;
-          this.RefreshMenuItems();
+        if (item != value) {
+          item = value;
+          RefreshMenuItems();
         }
       }
@@ -54 +57 @@
     private List<Type> ignoredViewTypes;
     public IEnumerable<Type> IgnoredViewTypes {
-      get { return this.ignoredViewTypes; }
-      set { this.ignoredViewTypes = new List<Type>(value); RefreshMenuItems(); }
+      get { return ignoredViewTypes; }
+      set { ignoredViewTypes = new List<Type>(value); RefreshMenuItems(); }
     }
 
     private Dictionary<Type, ToolStripMenuItem> menuItems;
     public IEnumerable<KeyValuePair<Type, ToolStripMenuItem>> MenuItems {
-      get { return this.menuItems; }
+      get { return menuItems; }
     }
+
+    public ToolStripMenuItem ShowBreadcrumbsToolStripMenuItem { get; private set; }
 
     private void RefreshMenuItems() {
@@ -68 +73 @@
         foreach (ToolStripMenuItem m in menuItems.Values)
           m.Dispose();
-        this.Items.Clear();
-        this.menuItems.Clear();
+        Items.Clear();
+        menuItems.Clear();
 
-        if (this.item != null) {
+        if (item != null) {
           ToolStripMenuItem menuItem;
           IEnumerable<Type> types = MainFormManager.GetViewTypes(item.GetType(), true);
@@ -79 +84 @@
             menuItem.Text = ViewAttribute.GetViewName(t);
 
-            this.menuItems.Add(t, menuItem);
-            this.Items.Add(menuItem);
+            menuItems.Add(t, menuItem);
+            Items.Add(menuItem);
           }
+          if (Items.Count > 0)
+            Items.Add(new ToolStripSeparator());
+          Items.Add(ShowBreadcrumbsToolStripMenuItem);
         }
       }
     }
+
+    public event EventHandler ShowBreadcrumbsChanged;
+    private void OnShowBreadcrumbsChanged() {
+      var handler = ShowBreadcrumbsChanged;
+      if (handler != null) handler(this, EventArgs.Empty);
+    }
+
+    private void ShowBreadcrumbsToolStripMenuItem_CheckedChanged(object sender, EventArgs e) {
+      OnShowBreadcrumbsChanged();
+    }
+
+    private void ShowBreadcrumbsToolStripMenuItem_Click(object sender, EventArgs e) {
+      ShowBreadcrumbsToolStripMenuItem.Checked = !ShowBreadcrumbsToolStripMenuItem.Checked;
+    }
   }
 }

branches/Breadcrumbs/HeuristicLab.MainForm.WindowsForms/3.3/Controls/ViewHost.Designer.cs

@@ -52 +52 @@
       this.configurationLabel = new System.Windows.Forms.Label();
       this.helpLabel = new System.Windows.Forms.Label();
+      this.breadcrumbControl = new HeuristicLab.MainForm.WindowsForms.BreadcrumbControl();
       this.SuspendLayout();
       // 
@@ -86 +87 @@
       this.viewContextMenuStrip.Name = "viewContextMenuStrip";
       this.viewContextMenuStrip.Size = new System.Drawing.Size(61, 4);
+      this.viewContextMenuStrip.ShowBreadcrumbsChanged += new System.EventHandler(this.viewContextMenuStrip_ShowBreadcrumbsChanged);
       this.viewContextMenuStrip.ItemClicked += new System.Windows.Forms.ToolStripItemClickedEventHandler(this.viewContextMenuStrip_ItemClicked);
       // 
@@ -114 +116 @@
       this.helpLabel.DoubleClick += new System.EventHandler(this.helpLabel_DoubleClick);
       // 
+      // breadcrumbControl
+      // 
+      this.breadcrumbControl.Anchor = ((System.Windows.Forms.AnchorStyles)(((System.Windows.Forms.AnchorStyles.Top | System.Windows.Forms.AnchorStyles.Left) 
+            | System.Windows.Forms.AnchorStyles.Right)));
+      this.breadcrumbControl.Location = new System.Drawing.Point(0, 0);
+      this.breadcrumbControl.Name = "breadcrumbControl";
+      this.breadcrumbControl.Size = new System.Drawing.Size(202, 15);
+      this.breadcrumbControl.TabIndex = 4;
+      this.breadcrumbControl.ViewHost = null;
+      // 
       // ViewHost
       // 
-      this.AutoScaleDimensions = new System.Drawing.SizeF(6F, 13F);
       this.AutoScaleMode = System.Windows.Forms.AutoScaleMode.Inherit;
+      this.Controls.Add(this.breadcrumbControl);
       this.Controls.Add(this.helpLabel);
       this.Controls.Add(this.viewsLabel);
@@ -124 +136 @@
       this.Name = "ViewHost";
       this.Size = new System.Drawing.Size(227, 184);
+      this.VisibleChanged += new System.EventHandler(this.ViewHost_VisibleChanged);
       this.ResumeLayout(false);
 
@@ -135 +148 @@
     private System.Windows.Forms.Label configurationLabel;
     private System.Windows.Forms.Label helpLabel;
+    private BreadcrumbControl breadcrumbControl;
 
   }

branches/Breadcrumbs/HeuristicLab.MainForm.WindowsForms/3.3/Controls/ViewHost.cs

@@ -33 +33 @@
       InitializeComponent();
       startDragAndDrop = false;
-      viewContextMenuStrip.IgnoredViewTypes = new List<Type>() { typeof(ViewHost) };
+      viewContextMenuStrip.IgnoredViewTypes = new List<Type> { typeof(ViewHost) };
 
       viewType = null;
@@ -41 +41 @@
       viewsLabel.Visible = false;
       viewsLabelVisible = true;
+
+      breadcrumbControl.ViewHost = this;
     }
 
@@ -51 +53 @@
           viewsLabel.Visible = value;
           View view = activeView as View;
-          if (view != null) view.Dock = viewsLabelVisible ? DockStyle.None : DockStyle.Fill;
+          if (view != null) AdjustActiveViewSize();
         }
       }
@@ -87 +89 @@
             #endregion
 
-            this.Caption = activeView.Caption;
+            Caption = activeView.Caption;
             viewType = activeView.GetType();
             RegisterActiveViewEvents();
@@ -93 +95 @@
             if (view != null) {
               view.Visible = true;
-              if (ViewsLabelVisible) {
-                view.Anchor = AnchorStyles.Bottom | AnchorStyles.Left | AnchorStyles.Top | AnchorStyles.Right;
-                view.Size = new Size(Width - this.viewsLabel.Width - this.viewsLabel.Margin.Left - this.viewsLabel.Margin.Right, this.Height);
-              } else view.Dock = DockStyle.Fill;
+              AdjustActiveViewSize();
               if (!Controls.Contains((view))) Controls.Add(view);
               view.OnShown(new ViewShownEventArgs(view, false));
@@ -125 +124 @@
       }
     }
+
+    public bool ShowBreadcrumbs {
+      get { return viewContextMenuStrip.ShowBreadcrumbsToolStripMenuItem.Checked; }
+      set { viewContextMenuStrip.ShowBreadcrumbsToolStripMenuItem.Checked = value; }
+    }
+
+    private bool isOutmostViewHost;
+    public IEnumerable<IContent> Breadcrumbs { get { return breadcrumbControl.Breadcrumbs; } }
 
     protected override void SetEnabledStateOfControls() {
@@ -151 +158 @@
       UpdateLabels();
       UpdateActiveMenuItem();
+      UpdateBreadcrumbControl();
     }
 
@@ -201 +209 @@
       OnChanged();
     }
+    private void ViewHost_VisibleChanged(object sender, EventArgs e) {
+      PerformOuterViewHostDetection();
+    }
+    private void viewContextMenuStrip_ShowBreadcrumbsChanged(object sender, EventArgs e) {
+      UpdateBreadcrumbControl();
+      AdjustActiveViewSize();
+    }
 
     protected override void OnSizeChanged(EventArgs e) {
@@ -263 +278 @@
     }
 
+    private void UpdateBreadcrumbControl() {
+      breadcrumbControl.Visible = ShowBreadcrumbs;
+      if (ShowBreadcrumbs)
+        UpdateBreadcrumbTrail(breadcrumbControl.Breadcrumbs, BuildBreadcrumbTrail());
+    }
+
     private bool ViewCanShowContent(Type viewType, object content) {
       if (content == null) // every view can display null
@@ -274 +295 @@
       IContentView view = MainFormManager.MainForm.ShowContent(this.Content, this.ViewType);
       if (view != null) {
-        view.ReadOnly = this.ReadOnly;
-        view.Locked = this.Locked;
+        view.ReadOnly = ReadOnly;
+        view.Locked = Locked;
       }
     }
@@ -285 +306 @@
     private bool startDragAndDrop;
     private void viewsLabel_MouseDown(object sender, MouseEventArgs e) {
-      if (e.Button == System.Windows.Forms.MouseButtons.Right) {
+      if (e.Button == MouseButtons.Right) {
         Screen screen = Screen.FromControl(viewsLabel);
-        int rightBorder = viewsLabel.PointToScreen(viewsLabel.Location).X + viewContextMenuStrip.Width; //
+        int rightBorder = viewsLabel.PointToScreen(viewsLabel.Location).X + viewContextMenuStrip.Width;
         rightBorder = rightBorder - screen.Bounds.X; //pixel position on active screen
 
@@ -319 +340 @@
     }
     #endregion
+
+    #region Helpers
+    private void AdjustActiveViewSize() {
+      var view = activeView as View;
+      if (view == null) return;
+      int width = viewsLabelVisible ? Width - viewsLabel.Width - viewsLabel.Margin.Left - viewsLabel.Margin.Right : Width;
+      int height = ShowBreadcrumbs ? Height - viewsLabel.Height - viewsLabel.Margin.Top - viewsLabel.Margin.Bottom : Height;
+      view.Location = new Point(0, Height - height);
+      view.Anchor = AnchorStyles.Bottom | AnchorStyles.Left | AnchorStyles.Top | AnchorStyles.Right;
+      view.Size = new Size(width, height);
+    }
+
+    private IEnumerable<IContent> BuildBreadcrumbTrail() {
+      var ll = new LinkedList<IContent>();
+      for (var control = (Control)this; control != null; control = control.Parent) {
+        var viewHost = control as ViewHost;
+        if (viewHost != null && viewHost.Content != null)
+          ll.AddFirst(viewHost.Content);
+      }
+      return ll;
+    }
+
+    public void UpdateBreadcrumbTrail(IEnumerable<IContent> oldCrumbs, IEnumerable<IContent> newCrumbs) {
+      if (!newCrumbs.Any()) return;
+      var ll = new LinkedList<IContent>();
+      foreach (var c in oldCrumbs) {
+        if (c != newCrumbs.First())
+          ll.AddLast(c);
+        else break;
+      }
+      foreach (var c in newCrumbs)
+        ll.AddLast(c);
+      breadcrumbControl.Breadcrumbs = ll;
+    }
+
+    private void PerformOuterViewHostDetection() {
+      var outmostViewHost = this;
+      for (var parent = Parent; parent != null; parent = parent.Parent) {
+        var vh = parent as ViewHost;
+        if (vh != null) outmostViewHost = vh;
+      }
+      isOutmostViewHost = outmostViewHost == this;
+      viewContextMenuStrip.ShowBreadcrumbsToolStripMenuItem.Checked = isOutmostViewHost;
+    }
+    #endregion
   }
 }

branches/Breadcrumbs/HeuristicLab.MainForm.WindowsForms/3.3/HeuristicLab.MainForm.WindowsForms-3.3.csproj

@@ -120 +120 @@
   <ItemGroup>
     <Compile Include="ActionUserInterfaceItem.cs" />
+    <Compile Include="Controls\BreadcrumbControl.cs">
+      <SubType>UserControl</SubType>
+    </Compile>
+    <Compile Include="Controls\BreadcrumbControl.Designer.cs">
+      <DependentUpon>BreadcrumbControl.cs</DependentUpon>
+    </Compile>
     <Compile Include="Controls\DragOverTabControl.cs">
       <SubType>Component</SubType>