// Copyright (C) Stichting Deltares 2016. All rights reserved.
//
// This file is part of Ringtoets.
//
// Ringtoets is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser 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 Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
//
// All names, logos, and references to "Deltares" are registered trademarks of
// Stichting Deltares and remain full property of Stichting Deltares at all times.
// All rights reserved.

using System.Windows.Forms;
using Core.Common.Gui.ContextMenu;

namespace Core.Common.Gui.TestUtil.ContextMenu
{
    /// <summary>
    /// This class can be used for easily testing the custom items which are added to a context menu.
    /// </summary>
    public class CustomItemsOnlyContextMenuBuilder : IContextMenuBuilder
    {
        /// <summary>
        /// The context menu which is build.
        /// </summary>
        private readonly ContextMenuStrip contextMenu = new ContextMenuStrip();

        /// <summary>
        /// Adds a dummy <see cref="ToolStripItem"/> to the <see cref="ContextMenuStrip"/>.
        /// </summary>
        /// <returns>The <see cref="CustomItemsOnlyContextMenuBuilder"/>.</returns>
        public IContextMenuBuilder AddRenameItem()
        {
            contextMenu.Items.Add(StubItem());
            return this;
        }

        /// <summary>
        /// Adds a dummy <see cref="ToolStripItem"/> to the <see cref="ContextMenuStrip"/>.
        /// </summary>
        /// <returns>The <see cref="CustomItemsOnlyContextMenuBuilder"/>.</returns>
        public IContextMenuBuilder AddDeleteItem()
        {
            contextMenu.Items.Add(StubItem());
            return this;
        }

        /// <summary>
        /// Adds a dummy <see cref="ToolStripItem"/> to the <see cref="ContextMenuStrip"/>.
        /// </summary>
        /// <returns>The <see cref="CustomItemsOnlyContextMenuBuilder"/>.</returns>
        public IContextMenuBuilder AddDeleteChildrenItem()
        {
            contextMenu.Items.Add(StubItem());
            return this;
        }

        /// <summary>
        /// Adds a dummy <see cref="ToolStripItem"/> to the <see cref="ContextMenuStrip"/>.
        /// </summary>
        /// <returns>The <see cref="CustomItemsOnlyContextMenuBuilder"/>.</returns>
        public IContextMenuBuilder AddExpandAllItem()
        {
            contextMenu.Items.Add(StubItem());
            return this;
        }

        /// <summary>
        /// Adds a dummy <see cref="ToolStripItem"/> to the <see cref="ContextMenuStrip"/>.
        /// </summary>
        /// <returns>The <see cref="CustomItemsOnlyContextMenuBuilder"/>.</returns>
        public IContextMenuBuilder AddCollapseAllItem()
        {
            contextMenu.Items.Add(StubItem());
            return this;
        }

        /// <summary>
        /// Adds a dummy <see cref="ToolStripItem"/> to the <see cref="ContextMenuStrip"/>.
        /// </summary>
        /// <returns>The <see cref="CustomItemsOnlyContextMenuBuilder"/>.</returns>
        public IContextMenuBuilder AddOpenItem()
        {
            contextMenu.Items.Add(StubItem());
            return this;
        }

        /// <summary>
        /// Adds a dummy <see cref="ToolStripItem"/> to the <see cref="ContextMenuStrip"/>.
        /// </summary>
        /// <returns>The <see cref="CustomItemsOnlyContextMenuBuilder"/>.</returns>
        public IContextMenuBuilder AddExportItem()
        {
            contextMenu.Items.Add(StubItem());
            return this;
        }

        /// <summary>
        /// Adds a dummy <see cref="ToolStripItem"/> to the <see cref="ContextMenuStrip"/>.
        /// </summary>
        /// <returns>The <see cref="CustomItemsOnlyContextMenuBuilder"/>.</returns>
        public IContextMenuBuilder AddImportItem()
        {
            contextMenu.Items.Add(StubItem());
            return this;
        }

        /// <summary>
        /// Adds a dummy <see cref="ToolStripItem"/> to the <see cref="ContextMenuStrip"/>.
        /// </summary>
        /// <returns>The <see cref="CustomItemsOnlyContextMenuBuilder"/>.</returns>
        public IContextMenuBuilder AddPropertiesItem()
        {
            contextMenu.Items.Add(StubItem());
            return this;
        }

        /// <summary>
        /// Adds a toolstrip separator.
        /// </summary>
        /// <returns>The <see cref="CustomItemsOnlyContextMenuBuilder"/>.</returns>
        public IContextMenuBuilder AddSeparator()
        {
            contextMenu.Items.Add(new ToolStripSeparator());
            return this;
        }

        /// <summary>
        /// Adds a dummy <see cref="ToolStripItem"/> to the <see cref="ContextMenuStrip"/>.
        /// </summary>
        /// <param name="item">The custom <see cref="StrictContextMenuItem"/> to add to the <see cref="ContextMenuStrip"/>.</param>
        /// <returns>The <see cref="CustomItemsOnlyContextMenuBuilder"/>.</returns>
        public IContextMenuBuilder AddCustomItem(StrictContextMenuItem item)
        {
            contextMenu.Items.Add(item);
            return this;
        }

        /// <summary>
        /// Obtain the <see cref="ContextMenuStrip"/>, which has been constructed by using <see cref="AddCustomItem"/>.
        /// </summary>
        /// <returns>The constructed <see cref="ContextMenuStrip"/>.</returns>
        public ContextMenuStrip Build()
        {
            return contextMenu;
        }

        private static ToolStripItem StubItem()
        {
            return new StrictContextMenuItem(string.Empty, string.Empty, null, (sender, args) => { });
        }
    }
}