//-----------------------------------------------------------------------
// <copyright file="PanelTreeNode.cs" company="bedug.com">
//     Copyright © 2012 Nils Hammar. All rights reserved.
// </copyright>
//-----------------------------------------------------------------------
/*
 * Software to access vehicle information via the OBD-II connector.
 * 
 * Copyright © 2012 Nils Hammar
 * 
 * This program 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.
 * This program 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 this program. If not, see <http://www.gnu.org/licenses/>.
 * 
 * Alternative licensing is possible, see the licensing document.
 * 
 * The above text may not be removed or modified.
 */

namespace UserInterface.GUI.Objects
{
    using System;
    using System.Runtime.Serialization;
    using System.Windows.Forms;

    /// <summary>
    /// Class extending the TreeNode class with connected data.
    /// </summary>
    [Serializable]
    public class PanelTreeNode : TreeNode, ISerializable
    {
        /// <summary>
        /// Gets the user control bound to the node.
        /// </summary>
        public UserControl userControl { get; private set; }

        /// <summary>
        /// Gets Freeze Frame number.
        /// </summary>
        public int frameNumber { get; private set; }

        /// <summary>
        /// Initializes a new instance of the <see cref="PanelTreeNode" /> class.
        /// </summary>
        /// <param name="userControl">The user control bound to the node.</param>
        public PanelTreeNode(UserControl userControl)
            : base()
        {
            this.userControl = userControl;
            this.frameNumber = 0;
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="PanelTreeNode" /> class.
        /// </summary>
        /// <param name="text">Text to display for node.</param>
        /// <param name="userControl">The user control bound to the node.</param>
        public PanelTreeNode(string text, UserControl userControl)
            : base(text)
        {
            this.userControl = userControl;
            this.frameNumber = 0;
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="PanelTreeNode" /> class.
        /// </summary>
        /// <param name="text">Text to display for node.</param>
        /// <param name="children">Child Nodes.</param>
        /// <param name="userControl">The user control bound to the node.</param>
        public PanelTreeNode(string text, TreeNode[] children, UserControl userControl)
            : base(text, children)
        {
            this.userControl = userControl;
            this.frameNumber = 0;
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="PanelTreeNode" /> class.
        /// </summary>
        /// <param name="text">Text to display for node.</param>
        /// <param name="imageKey">Image icon for unselected node.</param>
        /// <param name="selectedImageKey">Image icon for selected node.</param>
        /// <param name="userControl">The user control bound to the node.</param>
        public PanelTreeNode(string text, string imageKey, string selectedImageKey, UserControl userControl)
            : base(text)
        {
            this.userControl = userControl;
            this.ImageKey = imageKey;
            this.SelectedImageKey = selectedImageKey;
            this.frameNumber = 0;
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="PanelTreeNode" /> class.
        /// </summary>
        /// <param name="text">Text to display for node.</param>
        /// <param name="imageKey">Image icon for unselected node.</param>
        /// <param name="selectedImageKey">Image icon for selected node.</param>
        /// <param name="userControl">The user control bound to the node.</param>
        /// <param name="frameNumber">Freeze Frame number.</param>
        public PanelTreeNode(string text, string imageKey, string selectedImageKey, UserControl userControl, int frameNumber)
            : base(text)
        {
            this.userControl = userControl;
            this.ImageKey = imageKey;
            this.SelectedImageKey = selectedImageKey;
            this.frameNumber = frameNumber;
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="PanelTreeNode" /> class.
        /// </summary>
        /// <param name="text">Text to display for node.</param>
        /// <param name="imageKey">Image icon for unselected node.</param>
        /// <param name="selectedImageKey">Image icon for selected node.</param>
        /// <param name="children">Child Nodes.</param>
        /// <param name="userControl">The user control bound to the node.</param>
        public PanelTreeNode(string text, string imageKey, string selectedImageKey, TreeNode[] children, UserControl userControl)
            : base(text, children)
        {
            this.userControl = userControl;
            this.ImageKey = imageKey;
            this.SelectedImageKey = selectedImageKey;
            this.frameNumber = 0;
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="PanelTreeNode" /> class.
        /// </summary>
        /// <param name="info">Serialization info.</param>
        /// <param name="context">Streaming context.</param>
        protected PanelTreeNode(SerializationInfo info, StreamingContext context)
            : base(info, context)
        {
            if (info != null)
            {
                this.userControl = (UserControl)info.GetValue("userControl", typeof(UserControl));
            }

            this.frameNumber = 0;
        }

        /// <summary>
        /// Serialize the object.
        /// </summary>
        /// <param name="info">Serialization info.</param>
        /// <param name="context">Streaming context.</param>
        public virtual void GetObjectData(SerializationInfo info, StreamingContext context)
        {
            if (info != null)
            {
                info.AddValue("userControl", this.userControl);
            }
        }
    }
}