source: trunk/sources/HeuristicLab.MainForm/3.2/MainFormBase.cs @ 2456

#region License Information
/* HeuristicLab
 * Copyright (C) 2002-2008 Heuristic and Evolutionary Algorithms Laboratory (HEAL)
 *
 * This file is part of HeuristicLab.
 *
 * HeuristicLab is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * HeuristicLab is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with HeuristicLab. If not, see <http://www.gnu.org/licenses/>.
 */
#endregion

using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Linq;
using System.Text;
using System.Windows.Forms;

using HeuristicLab.PluginInfrastructure;

namespace HeuristicLab.MainForm {
  public partial class MainFormBase : Form, IMainForm {
    protected MainFormBase()
      : base() {
      InitializeComponent();
      views = new List<IView>();
      toolStripItems = new List<IToolStripItem>();
      this.StatusStripText = "";
    }

    protected MainFormBase(Type userInterfaceItemType)
      : this() {
      this.userInterfaceItemType = userInterfaceItemType;
      CreateGUI();
      OnActiveViewChanged();
      FireMainFormChanged();
    }

    #region IMainForm Members
    public string Title {
      get { return this.Text; }
      set {
        if (InvokeRequired) {
          Action<string> action = delegate(string s) { this.Title = s; };
          Invoke(action, value);
        } else
          this.Text = value;
      }
    }

    public string StatusStripText {
      get { return this.toolStripStatusLabel.Text; }
      set {
        if (InvokeRequired) {
          Action<string> action = delegate(string s) { this.StatusStripText = s; };
          Invoke(action, value);
        } else
          this.toolStripStatusLabel.Text = value;
      }
    }

    public bool StatusStripProgressBarVisible {
      get { return this.toolStripProgressBar.Visible; }
      set {
        if (InvokeRequired) {
          Action<bool> action = delegate(bool b) { this.StatusStripProgressBarVisible = b; };
          Invoke(action, value);
        } else
          this.toolStripProgressBar.Visible = value;
      }
    }

    public override Cursor Cursor {
      get { return base.Cursor; }
      set {
        if (InvokeRequired) {
          Action<Cursor> action = delegate(Cursor c) { this.Cursor = c; };
          Invoke(action, value);
        } else
          base.Cursor = value;
      }
    }

    private Type userInterfaceItemType;
    public Type UserInterfaceItemType {
      get { return this.userInterfaceItemType; }
      protected set { this.userInterfaceItemType = value; }
    }

    protected List<IView> views;
    public IEnumerable<IView> Views {
      get { return views; }
    }

    private IView activeView;
    public IView ActiveView {
      get { return this.activeView; }
      protected set {
        if (this.activeView != value) {
          if (InvokeRequired) {
            Action<IView> action = delegate(IView activeView) { this.ActiveView = activeView; };
            Invoke(action, value);
          } else {
            this.activeView = value;
            OnActiveViewChanged();
          }
        }
      }
    }

    private List<IToolStripItem> toolStripItems;
    protected IEnumerable<IToolStripItem> ToolStripItems {
      get { return this.toolStripItems; }
    }

    public event EventHandler ActiveViewChanged;
    protected virtual void OnActiveViewChanged() {
      if (InvokeRequired)
        Invoke((MethodInvoker)OnActiveViewChanged);
      else if (ActiveViewChanged != null)
        ActiveViewChanged(this, new EventArgs());
    }

    public event EventHandler MainFormChanged;
    public void FireMainFormChanged() {
      OnMainFormChanged();
    }
    protected virtual void OnMainFormChanged() {
      if (InvokeRequired)
        Invoke((MethodInvoker)FireMainFormChanged);
      else if (MainFormChanged != null)
        MainFormChanged(this, new EventArgs());
    }

    public virtual void ShowView(IView view) {
      if (!views.Contains(view)) {
        view.MainForm = this;
        views.Add(view);
        ActiveView = view;
      }
    }

    public virtual void CloseView(IView view) {
    }

    public virtual void CloseAllViews() {
      foreach (IView view in views.ToArray())
        CloseView(view);
    }

    protected virtual void ViewClosed(IView view) {
      views.Remove(view);
      if (ActiveView == view)
        ActiveView = null;
    }
    #endregion

    #region create menu and toolbar
    protected virtual void CreateGUI() {
      DiscoveryService ds = new DiscoveryService();

      object[] items = ds.GetInstances(userInterfaceItemType);
      IEnumerable<IToolStripMenuItem> toolStripMenuItems =
        from mi in items
        where mi is IToolStripMenuItem
        orderby ((IToolStripMenuItem)mi).Position
        select (IToolStripMenuItem)mi;
      foreach (IToolStripMenuItem menuItem in toolStripMenuItems)
        AddToolStripMenuItem(menuItem);

      items = ds.GetInstances(userInterfaceItemType);
      IEnumerable<IToolStripButtonItem> toolStripButtonItems =
        from bi in items
        where bi is IToolStripButtonItem
        orderby ((IToolStripButtonItem)bi).Position
        select (IToolStripButtonItem)bi;
      foreach (IToolStripButtonItem toolStripButtonItem in toolStripButtonItems)
        AddToolStripButtonItem(toolStripButtonItem);
    }

    private void AddToolStripMenuItem(IToolStripMenuItem menuItem) {
      ToolStripMenuItem item = new ToolStripMenuItem();
      SetToolStripItemProperties(item, menuItem);
      item.ShortcutKeys = menuItem.ShortCutKeys;

      ToolStripDropDownItem parent = FindParent(menuItem, menuStrip.Items);
      if (parent == null)
        menuStrip.Items.Add(item);
      else
        parent.DropDownItems.Add(item);
    }

    private void AddToolStripButtonItem(IToolStripButtonItem buttonItem) {
      ToolStripItem item;
      if (buttonItem.IsDropDownButton)
        item = new ToolStripDropDownButton();
      else
        item = new ToolStripButton();

      SetToolStripItemProperties(item, buttonItem);
      ToolStripDropDownItem parent = FindParent(buttonItem, toolStrip.Items);
      if (parent == null)
        toolStrip.Items.Add(item);
      else
        parent.DropDownItems.Add(item);
    }

    private ToolStripDropDownItem FindParent(IToolStripItem item, ToolStripItemCollection parentItems) {
      if (String.IsNullOrEmpty(item.Structure))
        return null;

      ToolStripDropDownItem parent = null;
      foreach (string structure in item.Structure.Split(item.StructureSeparator)) {
        if (parentItems.ContainsKey(structure))
          parent = (ToolStripDropDownItem)parentItems[structure];
        else
          throw new ArgumentException("Structure string for item " + item.Name +
            " is invalid. Could not find " + structure + " in toolstrip!");
        parentItems = parent.DropDownItems;
      }
      return parent;
    }

    private void SetToolStripItemProperties(ToolStripItem toolStripItem, IToolStripItem iToolStripItem) {
      toolStripItem.Text = iToolStripItem.Name;
      toolStripItem.Name = iToolStripItem.Name;
      toolStripItem.Tag = iToolStripItem;
      toolStripItem.Image = iToolStripItem.Image;
      toolStripItem.DisplayStyle = iToolStripItem.DisplayStyle;
      this.ActiveViewChanged += new EventHandler(iToolStripItem.ActiveViewChanged);
      this.MainFormChanged += new EventHandler(iToolStripItem.MainFormChanged);
      toolStripItem.Click += new EventHandler(ToolStripItemClicked);
      this.toolStripItems.Add(iToolStripItem);
      iToolStripItem.ToolStripItem = toolStripItem;
    }

    private void ToolStripItemClicked(object sender, EventArgs e) {
      System.Windows.Forms.ToolStripItem item = (System.Windows.Forms.ToolStripItem)sender;
      ((IAction)item.Tag).Execute(this);
    }
    #endregion
  }
}