using System;
using System.ComponentModel;
using System.Drawing;
using System.Windows.Forms;

namespace Wunnell.Windows.Forms
{
    [ToolboxBitmap(typeof(ToolStripStatusLabel))]
    public class ToolStripDateTimeStatusLabel : ToolStripStatusLabel
    {
        #region Constants

        /// <summary>
        /// The default value for the CustomFormat property.
        /// </summary>
        const string DEFAULT_CUSTOM_FORMAT = (string)null;
        /// <summary>
        /// The default value for the Format property.
        /// </summary>
        const DateTimePickerFormat DEFAULT_FORMAT = DateTimePickerFormat.Time;

        #endregion // Constants

        #region Variables

        /// <summary>
        /// The custom format string used to format the date and/or time in the control.
        /// </summary>
        private string _customFormat;
        /// <summary>
        /// Determines whether dates and times are displayed using standard or custom formatting.
        /// </summary>
        private DateTimePickerFormat _format;

        #endregion // Variables

        #region Properties

        /// <summary>
        /// Gets or sets the custom date/time format string.
        /// </summary>
        /// <value>
        /// A string that represents the custom date/time format. The default is a null reference (<b>Nothing</b> in Visual Basic).
        /// </value>
        [
            Category("Behavior"),
            DefaultValue(DEFAULT_CUSTOM_FORMAT),
            Description("The custom format string used to format the date and/or time in the control.")
        ]
        public string CustomFormat
        {
            get
            {
                return this._customFormat;
            }
            set
            {
                if (value != this._customFormat)
                {
                    this._customFormat = value;
                    this.UpdateText();

                    if (this._format == DateTimePickerFormat.Custom)
                    {
                        this.OnFormatChanged(EventArgs.Empty);
                    }
                }
            }
        }

        /// <summary>
        /// Gets or sets the format of the date and time displayed in the control.
        /// </summary>
        /// <value>
        /// One of the <see cref="DateTimePickerFormat"/> values. The default is <see cref="DateTimePickerFormat">Time</see>.
        /// </value>
        [
            Category("Appearance"),
            DefaultValue(DEFAULT_FORMAT),
            Description("Determines whether dates and times are displayed using standard or custom formatting.")
        ]
        public DateTimePickerFormat Format
        {
            get
            {
                return this._format;
            }
            set
            {
                if (value != this._format)
                {
                    this._format = value;
                    this.UpdateText();
                    this.OnFormatChanged(EventArgs.Empty);
                }
            }
        }

        #region Hidden Base Properties

        /// <summary>
        /// Gets the color used to display an active link.
        /// </summary>
        /// <value>
        /// Always returns <see cref="Color.Empty"/>.
        /// </value>
        [
            Bindable(false),
            Browsable(false),
            DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden),
            EditorBrowsable(EditorBrowsableState.Never)
        ]
        public new Color ActiveLinkColor
        {
            get { return Color.Empty; }
        }

        /// <summary>
        /// Gets a value indicating whether the ToolStripLabel is a hyperlink.
        /// </summary>
        /// <value>
        /// Always returns <b>false</b>.
        /// </value>
        [
            Bindable(false),
            Browsable(false),
            DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden),
            EditorBrowsable(EditorBrowsableState.Never)
        ]
        public new bool IsLink
        {
            get
            {
                return false;
            }
        }

        /// <summary>
        /// Gets a value that represents the behavior of a link
        /// </summary>
        /// <value>
        /// Always returns <see cref="LinkBehavior.SystemDefault"/>.
        /// </value>
        [
            Bindable(false),
            Browsable(false),
            DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden),
            EditorBrowsable(EditorBrowsableState.Never)
        ]
        public new LinkBehavior LinkBehavior
        {
            get
            {
                return LinkBehavior.SystemDefault;
            }
        }

        /// <summary>
        /// Gets the color used to display an active link.
        /// </summary>
        /// <value>
        /// Always returns <see cref="Color.Empty"/>.
        /// </value>
        [
            Bindable(false),
            Browsable(false),
            DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden),
            EditorBrowsable(EditorBrowsableState.Never)
        ]
        public new Color LinkColor
        {
            get { return Color.Empty; }
        }

        /// <summary>
        /// Overridden.  Gets the text that is to be displayed on the item.
        /// </summary>
        [
            Bindable(false),
            Browsable(false),
            DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden),
            EditorBrowsable(EditorBrowsableState.Never)
        ]
        public override string Text
        {
            get
            {
                return base.Text;
            }
        }

        /// <summary>
        /// Gets the color used when displaying a link that that has been previously visited.
        /// </summary>
        /// <value>
        /// Always returns <see cref="Color.Empty"/>.
        /// </value>
        [
            Bindable(false),
            Browsable(false),
            DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden),
            EditorBrowsable(EditorBrowsableState.Never)
        ]
        public new Color VisitedLinkColor
        {
            get { return Color.Empty; }
        }

        #endregion // Hidden Base Properties.

        #endregion // Properties

        #region Constructors

        /// <summary>
        /// Initializes a new instance of the <b>ToolStripDateTimeStatusLabel</b> class.
        /// </summary>
        /// <remarks>
        /// This constructor sets the initial <see cref="Format"/> property value to <see cref="DateTimePickerFormat">Time</see>.
        /// </remarks>
        public ToolStripDateTimeStatusLabel()
            : base()
        {
            this.InitializeComponent();

            // Set the default property values.
            this._format = DEFAULT_FORMAT;
            this._customFormat = DEFAULT_CUSTOM_FORMAT;
            
            // Display the initial formatted date and time.
            this.UpdateText();
        }

        #endregion // Constructors

        #region Events

        /// <summary>
        /// Occurs when the <see cref="Format"/> property value has changed or else the <b>Format</b> property value is
        /// <see cref="DateTimePickerFormat">Custom</see> and the <see cref="CustomFormat"/> property value has changed.
        /// </summary>
        [Description("Occurs when the format used to display date and/or time values in the control has changed.")]
        public event EventHandler FormatChanged;

        #endregion // Events

        #region Event Handlers

        private void clock_Tick(object sender, EventArgs e)
        {
            this.UpdateText();
        }

        #endregion // Event Handlers

        #region Methods

        /// <summary>
        /// Gets a string representing the current date and/or time formatted in
        /// accordance with the current Format and CustomFormat property values.
        /// </summary>
        /// <returns>
        /// A formatted string representing the current date and/or time.
        /// </returns>
        private string GetFormattedDateAndTime()
        {
            string formattedString;

            switch (this._format)
            {
                case DateTimePickerFormat.Long:
                    formattedString = DateTime.Now.ToLongDateString();
                    break;
                case DateTimePickerFormat.Short:
                    formattedString = DateTime.Now.ToShortDateString();
                    break;
                case DateTimePickerFormat.Time:
                    formattedString = DateTime.Now.ToLongTimeString();
                    break;
                case DateTimePickerFormat.Custom:
                default:
                    formattedString = DateTime.Now.ToString(this._customFormat);
                    break;
            }

            return formattedString;
        }

        /// <summary>
        /// Raises the <see cref="FormatChanged"/> event.
        /// </summary>
        /// <param name="e">
        /// An <seealso cref="EventArgs"/> that contains the event data.
        /// </param>
        protected virtual void OnFormatChanged(EventArgs e)
        {
            if (this.FormatChanged != null)
            {
                this.FormatChanged(this, e);
            }
        }

        /// <summary>
        /// Raises the <see cref="ParentChanged"/> event.
        /// </summary>
        /// <param name="oldParent">
        /// The original parent of the item.
        /// </param>
        /// <param name="newParent">
        /// The new parent of the item.
        /// </param>
        protected override void OnParentChanged(ToolStrip oldParent, ToolStrip newParent)
        {
            // Enable the timer if an only if the button is displayed in a run time form.
            this.clock.Enabled = (!this.DesignMode && newParent != null);

            if (this.clock.Enabled)
            {
                this.UpdateText();
            }

            base.OnParentChanged(oldParent, newParent);
        }

        /// <summary>
        /// Displays a formatted string representing the current date and/or time.
        /// </summary>
        private void UpdateText()
        {
            base.Text = this.GetFormattedDateAndTime();
        }

        #endregion // Methods

        #region Auto-generated Code

        private Timer clock;
        private IContainer components;

        private void InitializeComponent()
        {
            this.components = new System.ComponentModel.Container();
            this.clock = new System.Windows.Forms.Timer(this.components);
            // 
            // clock
            // 
            this.clock.Interval = 1000;
            this.clock.Tick += new System.EventHandler(this.clock_Tick);

        }

        #endregion // Auto-generated Code
    }
}