MDIParentForm.MDIFeatures.cs

using System;
using System.Collections.Generic;
using System.Windows.Forms;
using be.gaudry.model.exceptions;
 
namespace be.gaudry.view
{
    partial class MDIParentForm
	{
        #region declarations
        /// <summary>
        /// Used to prevent toolstrip bug with the office style
        /// </summary>
        private string toolStripPadding="                    ";
        /// <summary>
        /// Available menus on the <code>MDIParentForm</code>
        /// Used e.g. to define where putting a menu item
        /// </summary>
        public enum MENU
        {
            file,
            display,
            tools,
            toolBars,
            window,
            help
        } 
        /// <summary>
        /// Used to store instances of childs
        /// </summary>
        private Dictionary<Type, Form> mdiChilds = new Dictionary<Type, Form>();
        //private System.ComponentModel.BackgroundWorker openMdiChildBGW;
        #endregion
 
        #region single instance of child
 
        /// <summary>
        /// Ensure having only one instance of this type of child form in the MDI parent (this)
        /// Create new child if not exists, <b>and show it</b>.
        /// Use this method only if you don't have to call some method before opening the form. 
        /// Otherwise, call the <code>createMDIChild()</code> method to get the instance, call the needed method on the child, and call the 
        /// </summary>
        /// <typeparam name="T">Type of the form to show.</typeparam>
        /// <returns>New form if not existed, or existing form</returns>
        protected T showMDIChild<T>() where T : Form, new()
        {
            return showMDIChild<T>("");
        }
        /// <summary>
        /// Ensure having only one instance of this type of child form in the MDI parent (this)
        /// Create new child if not exists, <b>and show it</b>.
        /// Use this method only if you don't have to call some method before opening the form. 
        /// Otherwise, call the <code>createMDIChild()</code> method to get the instance, call the needed method on the child, and call the 
        /// </summary>
        /// <typeparam name="T">Type of the form to show.</typeparam>
        /// <param name="progressInfo">Text to display along the progress of creating instance</param>
        /// <returns>New form if not existed, or existing form</returns>
        protected T showMDIChild<T>(string progressInfo) where T : Form, new()
        {
            T child = createMDIChild<T>(progressInfo);
            showMDIChild(child);
            child.WindowState = FormWindowState.Maximized;
            return child;
        }
        /// <summary>
        /// Show an instance of form.
        /// This method <b>may not ensure single instance of child form</b>. 
        /// To ensure single instance, use <code>createMDIChild()</code> method to get the single instance of the child form 
        /// to have this method parameter.
        /// </summary>
        /// <param name="child">Form to show</param>
        protected void showMDIChild(Form child)
        {
            if (child != null)
            {
                child.Show();
                child.Activate();
            }
        } 
        /// <summary>
        /// Ensure having only one instance of this type of child form in the MDI parent (this)
        /// Create new child if not exists, <b>but don't show it</b>.
        /// </summary>
        /// <typeparam name="T">Type of the form to show.</typeparam>
        /// <returns>New form if not existed, or existing form</returns>
        protected T createMDIChild<T>() where T : Form, new()
        {
            return createMDIChild<T>("");
        }
        /// <summary>
        /// Ensure having only one instance of this type of child form in the MDI parent (this)
        /// Create new child if not exists, <b>but don't show it</b>.
        /// </summary>
        /// <typeparam name="T">Type of the form to show.</typeparam>
        /// <param name="progressInfo">Text to display along the progress of creating instance</param>
        /// <returns>New form if not existed, or existing form</returns>
        protected T createMDIChild<T>(string progressInfo) where T : Form, new()
        {
            // Create new child if not exists in the collection and add it
            if (!this.mdiChilds.ContainsKey(typeof(T)))
            {
 
                bool showProgress = !string.Empty.Equals(progressInfo);
                if (showProgress)
                {
                    /*if (statusStrip.Visible)
                    {
                        startProgress();
                        setStatusMessage(progressInfo);
                    }
                    else
                    {*/
                        Splasher.show(progressInfo);
                    //}
                    //System.Threading.Thread.Sleep(10000);
                }
                T mdiChildForm = new T();
                // Set up the necessary properties
                mdiChildForm.MdiParent = this;
                mdiChildForm.WindowState = FormWindowState.Maximized;
                if (mdiChildForm is IMDIChild)
                {
                    MenuStrip menuStrip = ((IMDIChild)mdiChildForm).getMainMenuStrip();
                    if (menuStrip != null)
                    {
                        menuStrip.Visible = false;
                    }
                }
                // Remove form from the collection when the mdiChild is closed
                mdiChildForm.FormClosed += new FormClosedEventHandler(delegate(object sender, FormClosedEventArgs e)
                {
                    this.mdiChilds.Remove(sender.GetType());
                });
                // 
 
 
                this.mdiChilds.Add(typeof(T), mdiChildForm);
                //if (showProgress)
                //{
                    /*if (statusStrip.Visible)
                    {
                        stopProgress();
                        resetStatusStrip();
                    }
                    else
                    {*/
                        Splasher.close();
                    //}
                //}
            }
 
            // return the child
            T formToActivate = (T)this.mdiChilds[typeof(T)];
            return formToActivate;
        }
        #endregion
 
        #region menu
        /// <summary>
        /// Add a menuItem on the main <code>MenuStrip</code> to open a single instance of the mdiChild.
        /// Add necessary actions on click.
        /// </summary>
        /// <typeparam name="T">Type of the mdiChild to open</typeparam>
        /// <param name="childTsMi"><code>ToolStripMenuItem</code> to use on the main MenuStrip.</param>
        /// <param name="progressInfo">Text to display along the progress of creating instance. Empty string or null value may be used to avoid displaying progression.</param>
        /// <exception cref="be.gaudry.exceptions.PluginException">Plugin exception if childTsMi is null or don't have text to display.</exception>
        public void addChildMenu<T>(ToolStripMenuItem childTsMi, string progressInfo) where T : Form, new()
        {
            if (childTsMi == null || string.Empty.Equals(childTsMi.Text))
            {
                throw new PluginException("Tentative d'ajout d'un menu vide ou dont le titre n'est pas spécifié.");
            }
            mainMenuStrip.Items.Insert(2, childTsMi);
            //Console.WriteLine("add menu : " + typeof(T));
            childTsMi.Click += new EventHandler(delegate(object sender, EventArgs e)
            {
                if (string.Empty.Equals(progressInfo))
                {
                    showMDIChild<T>();
                }
                else
                {
                    showMDIChild<T>(progressInfo);
                }
            });
        }
        /// <summary>
        /// Add a menuItem on the main <code>MenuStrip</code> to open a single instance of the mdiChild.
        /// Add necessary actions on click.
        /// </summary>
        /// <typeparam name="T">Type of the mdiChild to open</typeparam>
        /// <param name="childTsMi"><code>ToolStripMenuItem</code> to use on the main MenuStrip.</param>
        /// <param name="menu">Location of the <code>ToolStripMenuItem</code></param>
        /// <param name="progressInfo">Text to display along the progress of creating instance. Empty string or null value may be used to avoid displaying progression.</param>
        /// <exception cref="be.gaudry.exceptions.PluginException">Plugin exception if childTsMi is null or don't have text to display.</exception>
        public void addChildMenu<T>(ToolStripMenuItem childTsMi, MENU menu, string progressInfo) where T : Form, new()
        {
            if (childTsMi == null || string.Empty.Equals(childTsMi.Text))
            {
                throw new PluginException("Tentative d'ajout d'un menu vide ou dont le titre n'est pas spécifié.");
            }
            switch (menu)
            {
                case MENU.display: displayTsMi.DropDownItems.Add(childTsMi); break;
                case MENU.file: fileTsMi.DropDownItems.Add(childTsMi); break;
                case MENU.help: helpTsMi.DropDownItems.Add(childTsMi); break;
                case MENU.tools: toolsTsMi.DropDownItems.Add(childTsMi); break;
                case MENU.toolBars: displayToolBarTsMi.DropDownItems.Add(childTsMi); break;
                case MENU.window: windowTsMi.DropDownItems.Add(childTsMi); break;
            }
            //Console.WriteLine("add menu : " + typeof(T));
            childTsMi.Click += new EventHandler(delegate(object sender, EventArgs e)
            {
                if (string.Empty.Equals(progressInfo))
                {
                    showMDIChild<T>();
                }
                else
                {
                    showMDIChild<T>(progressInfo);
                }
            });
        } 
        #endregion
 
        #region open child in another thread
        /*private void initBackgroundWorker()
        {
            this.openMdiChildBGW = new System.ComponentModel.BackgroundWorker();
            this.openMdiChildBGW.WorkerReportsProgress = true;
            this.openMdiChildBGW.WorkerSupportsCancellation = true;
            this.openMdiChildBGW.DoWork += new System.ComponentModel.DoWorkEventHandler(this.openMdiChildBGW_DoWork);
            this.openMdiChildBGW.RunWorkerCompleted += new System.ComponentModel.RunWorkerCompletedEventHandler(this.openMdiChildBGW_RunWorkerCompleted);
            this.openMdiChildBGW.ProgressChanged += new System.ComponentModel.ProgressChangedEventHandler(this.openMdiChildBGW_ProgressChanged);
        }
        private void openMdiChildBGW_DoWork(object sender, DoWorkEventArgs e)
        {
 
        }
 
        private void openMdiChildBGW_ProgressChanged(object sender, ProgressChangedEventArgs e)
        {
 
        }
 
        private void openMdiChildBGW_RunWorkerCompleted(object sender, RunWorkerCompletedEventArgs e)
        {
 
        }*/
        #endregion
 
        #region IMDIParent Membres
        public bool joinToolStrip(ToolStrip ts)
        {
            this.topTSP.Join(ts);//this.topTSP.Join(ts, 1);
            return true;
        }
        public void setStatusMessage(string copyright, string version, string message)
        {
            if (InvokeRequired)
            {
                Invoke((MethodInvoker)delegate()
                {
                    setStatusMessage(copyright, version, message);
                });
            }
            else
            {
                copyrightTssLbl.Text = copyright;
                versionTssLbl.Text = version;
                infosTssLbl.Image = null;
                infosTssLbl.Text = message + toolStripPadding;
            }
        }
 
        public void setStatusMessage(string message)
        {
            if (InvokeRequired)
            {
                Invoke((MethodInvoker)delegate()
                {
                    setStatusMessage(message);
                });
            }
            else
            {
                infosTssLbl.Image = null;
                infosTssLbl.Text = message + toolStripPadding;
            }
        }
        /// <summary>
        /// Displays a message on the StatusStrip
        /// </summary>
        /// <param name="image">Image to display</param>
        /// <param name="message">Text to display on the status label</param>
        /// <param name="tooltip">Text to display on the status tooltip</param>
        public void setStatusMessage(System.Drawing.Image image, string message, string tooltip)
        {
            if (InvokeRequired)
            {
                Invoke((MethodInvoker)delegate()
                {
                    setStatusMessage(message);
                });
            }
            else
            {
                infosTssLbl.Image = image;
                infosTssLbl.Text = message + toolStripPadding;
                infosTssLbl.ToolTipText = tooltip;
            }
        }
        public void resetStatusStrip()
        {
            setStatusMessage(
                "Copyright © 2006 BrolDev",
                Application.ProductName + " " + Application.ProductVersion,
                ""
                );
        }
        public void startProgress()
        {
            /*if (InvokeRequired)
            {
                Invoke((MethodInvoker)delegate()
                {
                    startProgress();
                });
            }
            else
            {
                toolStripProgressBar.Style = ProgressBarStyle.Marquee;
                toolStripProgressBar.Width = 300;
                toolStripProgressBar.Visible = true;
            }*/
        }
 
        public void stopProgress()
        {
            /*if (InvokeRequired)
            {
                Invoke((MethodInvoker)delegate()
                {
                    stopProgress();
                });
            }
            else
            {
                toolStripProgressBar.Visible = false;
                toolStripProgressBar.Width = 1;
                toolStripProgressBar.Style = ProgressBarStyle.Blocks;
            }*/
        }
        #endregion
	}
}