//-----------------------------------------------------------------------
// <copyright file="CenterFlowPanel.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 Gauges.TelltalePanel
{
    using System.Drawing.Imaging;
    using System.Windows.Forms;
    using System.Windows.Forms.Layout;

    /// <summary>
    /// FlowLayout panel that lays out components around center of the panel.
    /// </summary>
    public class CenterFlowPanel : Panel
    {
        /// <summary>
        /// Layout engine instance.
        /// </summary>
        private CenterLayout layoutEngine;

        /// <summary>
        /// Gets or sets Palette instances container.
        /// </summary>
        public PaletteCreator paletteCreator { get; set; }

        /// <summary>
        /// Initializes a new instance of the <see cref="CenterFlowPanel" /> class.
        /// </summary>
        public CenterFlowPanel()
        {
        }

        /// <summary>
        /// Layout engine for panel.
        /// </summary>
        public override LayoutEngine LayoutEngine
        {
            get
            {
                if (this.layoutEngine == null)
                {
                    this.layoutEngine = new CenterLayout();
                }

                return this.layoutEngine;
            }
        }

        /// <summary>
        /// Toggles a flash icon on or off.
        /// </summary>
        /// <param name="toggleOn">'true' if icon shall toggle on.</param>
        [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Performance", "CA1800:DoNotCastUnnecessarily", Justification = "Reviewed.")]
        public void toggleIconFlash(bool toggleOn)
        {
            ColorPalette palette;

            if (toggleOn)
            {
                palette = this.paletteCreator.paletteFlashOn;
            }
            else
            {
                palette = this.paletteCreator.paletteFlashOff;
            }

            foreach (Control c in this.Controls)
            {
                if (c is TellTale)
                {
                    TellTale tt = (TellTale)c;
                    tt.setPalette(palette);
                }
            }
        }
    }
}