source: branches/HeuristicLab.Hive_Milestone3/sources/HeuristicLab.Visualization/3.2/Legend/LegendShape.cs @ 5143

using System.Collections.Generic;
using System.Drawing;
using HeuristicLab.Visualization.Drawing;

namespace HeuristicLab.Visualization.Legend {
  public enum LegendPosition {
    Top,
    Bottom,
    Left,
    Right
  }

  public class LegendShape : WorldShape {
    private readonly IList<LegendItem> legendItems = new List<LegendItem>();
    // legend draw default value: column

    private Color color = Color.Blue;
    private Font font = new Font("Arial", 8);

    public bool Row { get; set; }
    public bool Top { get; set; }

    public LegendShape() {
      CreateLegend();
    }

    private bool ExistsLegendItems() {
      return legendItems.Count > 0;
    }
    
    /// <summary>
    /// paints the legend on the canvas
    /// </summary>
    public void CreateLegend() {
      if (ExistsLegendItems()) {
        ClearShapes();
        double x = ClippingArea.X1;
        double y = ClippingArea.Y2;

        if (Row && !Top) {
          y = GetOptimalBottomHeight();
        }
        int legendItemCounter = 1;
        foreach (LegendItem item in legendItems) {
          if (!Row) {
            CreateColumn(item, y);
            y -= Font.Height;
          } else {
            if (IsNewRow(legendItemCounter)) {
              x = ClippingArea.X1;
              y -= Font.Height+15;
            }
            CreateRow(item, x, y);
            x += GetLabelLengthInPixel(item);
            legendItemCounter++;
          }
        }
      }
    }

    /// <summary>
    /// calculates the optimal height, when the legend shall be draw at the bottom
    /// </summary>
    /// <returns>optimal bottom height</returns>
    private double GetOptimalBottomHeight() {
      int rowsToDraw = 1;
      for (int i = 0; i < legendItems.Count; i++) {
        if (IsNewRow(i + 1)) {
          rowsToDraw++;
        }
      }
      return (Font.Height + 12) * rowsToDraw;
    }

    /// <summary>
    /// returns a boolean value, if the new legend item has to be paint in a 
    /// new row
    /// </summary>
    /// <returns>
    ///   true, draw legend item in a new row
    ///   false, draw the legend item in the current row
    /// </returns>
    private bool IsNewRow(int toCurrentItem) {
      double sum = 0;
      double caw = ClippingArea.Width;
      for (int i = 0; i < toCurrentItem; i++) {
        sum += GetLabelLengthInPixel(legendItems[i]);
        if (sum > caw) {
          return true;
        }
      }
      return false;
    }

    /// <summary>
    /// returns the length of the current legenditem in pixel
    /// </summary>
    /// <param name="item">legend item to calculate the length</param>
    /// <returns>length of the legend item</returns>
    private int GetLabelLengthInPixel(LegendItem item) {
      int dummy = (int)(item.Label.Length*Font.Size + 20);
      if (dummy < LegendItem.WIDTH) {
        return LegendItem.WIDTH;
      }
      return dummy;
    }

    /// <summary>
    /// draws the legend as a row at the top or bottom of the WorldShape
    /// </summary>
    /// <param name="item">the legenditem to draw</param>
    /// <param name="x">x axis to draw the item</param>
    /// <param name="y">y axis to draw the item</param>
    private void CreateRow(LegendItem item, double x, double y) {
      AddShape(new LineShape(x, y - (Font.Height / 2), x + 20, y - (Font.Height / 2), item.Color, item.Thickness, DrawingStyle.Solid));
      AddShape(new TextShape(x + 25, y, item.Label, Font, Color));
    }

    /// <summary>
    /// draws the legend as a column on the right or left side of the WorldShape
    /// </summary>
    /// <param name="item">the legenditem to draw</param>
    /// <param name="y">y axis to draw the item</param>
    private void CreateColumn(LegendItem item, double y) {
      AddShape(new LineShape(10, y - (Font.Height / 2), 30, y - (Font.Height / 2), item.Color, item.Thickness, DrawingStyle.Solid));
      AddShape(new TextShape(35, y, item.Label, Font, Color));//Font.Height+12
    }

    /// <summary>
    /// adds a legenditem to the items list
    /// </summary>
    /// <param name="item">legenditem to add</param>
    public void AddLegendItem(LegendItem item) {
      legendItems.Add(item);
    }

    /// <summary>
    /// searches the longest label and returns it with factor of the the current font size
    /// useful to set the width of the legend area on the left or right side
    /// </summary>
    /// <returns>max label length with factor of the current font size</returns>
    public int GetMaxLabelLength() {
      int maxLabelLength = 0;
      if (ExistsLegendItems()) {
        maxLabelLength = legendItems[0].Label.Length;
        foreach (var item in legendItems) {
          if (item.Label.Length > maxLabelLength) {
            maxLabelLength = item.Label.Length;
          }
        }
        maxLabelLength = (int)(maxLabelLength*Font.Size);
      }
      return maxLabelLength < LegendItem.WIDTH ? LegendItem.WIDTH : maxLabelLength;
    }

    /// <summary>
    /// removes a legenditem from the items list
    /// </summary>
    /// <param name="item">legenditem to remove</param>
    public void RemoveLegendItem(LegendItem item) {
      legendItems.Remove(item);
    }

    /// <summary>
    /// deletes the legenditem list
    /// </summary>
    public void ClearLegendItems() {
      legendItems.Clear();
    }

    public Color Color {
      get { return color; }
      set {
        color = value;
        UpdateTextShapes();
      }
    }

    public Font Font {
      get { return font; }
      set {
        font = value;
        UpdateTextShapes();
      }
    }

    /// <summary>
    /// updates the font settings of the legend
    /// </summary>
    private void UpdateTextShapes() {
      foreach (IShape shape in shapes) {
        TextShape textShape = shape as TextShape;

        if (textShape != null) {
          textShape.Font = font;
          textShape.Color = color;
        }
      }
    }
  }
}