using System;
using System.ComponentModel;
using System.Diagnostics;
using System.Runtime.InteropServices;
using System.Windows.Forms;
using System.Xml.Serialization;
using Nevron.GraphicsCore;
using Nevron.Reflection;
using Nevron.Chart.View;

namespace Nevron.Chart.Windows
{
 /// <summary>
 /// When present in the Tools collection instructs the
 /// control to display tooltips for the chart elements that have an
 /// assigned tooltip.
 /// </summary>
 [Serializable]
 [ClassInterface(ClassInterfaceType.AutoDual)]
 [NIcon("Resources.Icons.Tools.Tooltip.png")]
 public partial class NTooltipTool : NInteractivityTool,
        IDisposable
 {
  #region Constructors

  /// <summary>
  /// Creates a new NTooltipTool object with default settings.
  /// </summary>
  /// <remarks>
  /// This constructor sets AutoPopDelay to 5000ms, InitialDelay to 500ms
  /// and Reshow delay to 100ms.
  /// </remarks>
  public NTooltipTool()
  {
   m_nAutoPopDelay = defaultAutoPopDelay;
   m_nInitialDelay = defaultInitialDelay;
   m_nReshowDelay = defaultReshowDelay;
  }

  #endregion

  #region Properties

  /// <summary>
  /// Controls the period of time the tooltips remain visible if the
  /// mouse pointer is stationary within the chart.
  /// </summary>
  /// <remarks>
  /// This property enables you to shorten or lengthen the time that the
  /// tooltip window is displayed when the mouse pointer is over a control.
  /// For example, if you display extensive help in a tooltip window, you
  /// can increase the value of this property to ensure that the user has
  /// sufficient time to read the text.
  /// </remarks>
  [Category("Tooltips"), Description("Controls the period of time the tooltips remain visible if the mouse pointer is stationary within the chart.")]
  [DefaultValue(defaultAutoPopDelay)]
  [XmlAttribute]
  public int AutoPopDelay
  {
   get
   {
    return m_nAutoPopDelay;
   }
   set
   {
    m_nAutoPopDelay = value;
   }
  }
  /// <summary>
  /// Gets or sets the time that passes before the tooltip appears.
  /// </summary>
  /// <remarks>
  /// This property enables you to shorten or lengthen the time that the
  /// chart control waits before displaying a tooltip window. If the value
  /// of the InitialDelay property is set to a value that is too long
  /// in duration, the user of your application may not know that your
  /// application provides tooltip help. You can use this property to
  /// ensure that the user has tooltips displayed quickly by shortening
  /// the time specified.
  /// </remarks>
  [Category("Tooltips"), Description("Gets or sets the time that passes before the tooltip appears.")]
  [DefaultValue(defaultInitialDelay)]
  [XmlAttribute]
  public int InitialDelay
  {
   get
   {
    return m_nInitialDelay;
   }
   set
   {
    m_nInitialDelay = value;
   }
  }
  /// <summary>
  /// Gets or sets the length of time that must transpire before subsequent
  /// tooltip windows appear as the mouse pointer moves from one chart
  /// element to another.
  /// </summary>
  /// <remarks>
  /// This property enables you to shorten or lengthen the time that the
  /// tooltip waits before displaying a tooltip window after a previous
  /// tooltip window is displayed. The first time a tooltip window is
  /// displayed the value of the InitialDelay property is used to determine
  /// the delay to apply before initially showing the tooltip window. When
  /// a tooltip window is currently being displayed and the user moves the
  /// cursor to another chart element or control that displays a tooltip
  /// window, the value of the ReshowDelay property is used before showing
  /// the tooltip for the new control. The tooltip window from the previous
  /// control must still be displayed in order for the delay specified in
  /// the ReshowDelay property to be used; otherwise the InitialDelay
  /// property value is used.
  /// </remarks>
  [Category("Tooltips"), Description("Gets or sets the time that must transpire before subsequent tooltip windows appear.")]
  [DefaultValue(defaultReshowDelay)]
  [XmlAttribute]
  public int ReshowDelay
  {
   get
   {
    return m_nReshowDelay;
   }
   set
   {
    m_nReshowDelay = value;
   }
  }

  #endregion

  #region Overrides

  public override void OnMouseMove(object sender, NMouseEventArgs e)
  {
            NPointF mousePosition = new NPointF(e.X, e.Y);
            SetTooltip(mousePosition, GetTooltipFromPoint(mousePosition));
  }

  #endregion

        #region Interface implementations

        #region IDisposable

        public void Dispose()
  {
   ClearTooltip();
  }

  #endregion

  #region INReferenceHolder

  [EditorBrowsable(EditorBrowsableState.Never)]
  public override void UpdateReferences(INReferenceProvider provider)
  {
   // when removed from the collection clear the tooltip
            if (m_Provider != null)
            {
                ClearTooltip();
            }

   base.UpdateReferences(provider);
  }

  #endregion

  #endregion

  #region Implementation

  /// <summary>
  /// Gets the tooltip from the specified mouse position
  /// </summary>
  /// <param name="mousePosition"></param>
  /// <returns></returns>
  public virtual string GetTooltipFromPoint(NPointF mousePosition)
  {
   NInteractivityStyle interactivityStyle = GetInteractivityStyleFromPoint(mousePosition);
 
   if (interactivityStyle == null)
    return "";

   NTooltipAttribute tooltipAttribute = (NTooltipAttribute)interactivityStyle.FindAttributeOfType(typeof(NTooltipAttribute));

   if (tooltipAttribute == null)
    return "";

   NHitTestCacheService hitTestService = GetView().GetServiceOfType(typeof(NHitTestCacheService)) as NHitTestCacheService;

   if (hitTestService == null)
   {
    Debug.Assert(false);
    return "";
   }

   INTooltipFormatter tooltipFormatter = hitTestService.HitTest(mousePosition) as INTooltipFormatter;

   if (tooltipFormatter == null)
   {
    return tooltipAttribute.Text;
   }

   return tooltipFormatter.FormatTooltip(tooltipAttribute.Text);
  }

  protected virtual void SetTooltip(NPointF mousePosition, string tooltip)
  {
            GetView().SetTooltip(mousePosition, tooltip, this);
  }

        protected virtual void ClearTooltip()
  {
   NView view = GetView();

   if (view != null)
   {
    view.ClearTooltip();
   }
  }

  #endregion

  #region Fields

  protected int m_nAutoPopDelay;
  protected int m_nInitialDelay;
  protected int m_nReshowDelay;

  #endregion

  #region Default values

  protected const int defaultAutoPopDelay = 5000;
  protected const int defaultInitialDelay = 500;
  protected const int defaultReshowDelay = 100;

  #endregion
 }
}