source: tags/3.3.6/HeuristicLab.ExtLibs/HeuristicLab.Netron/3.0.2672.12446/Netron.Diagramming.Core-3.0.2672.12446/Core/Ambience.cs @ 13398

using System;
using System.Drawing;

namespace Netron.Diagramming.Core {
  /// <summary>
  /// <para>
  /// The ambient properties of the canvas (background style, default line 
  /// style etc) are collected in this class. The ambience class is part 
  /// of the model and is serialized together with the diagram.
  /// </para>
  /// </summary>
  public partial class Ambience : IDisposable, IVersion {
    #region Events
    /// <summary>
    /// Occurs when the Ambience has changed
    /// </summary>
    public event EventHandler<AmbienceEventArgs> OnAmbienceChanged;
    #endregion

    #region Fields

    // ------------------------------------------------------------------
    /// <summary>
    /// Implementation of IVersion - the current version of 
    /// Ambience.
    /// </summary>
    // ------------------------------------------------------------------
    protected const double ambienceVersion = 1.0;

    // ------------------------------------------------------------------
    /// <summary>
    /// pointer to the model
    /// </summary>
    // ------------------------------------------------------------------
    private IModel mModel;

    // ------------------------------------------------------------------
    /// <summary>
    /// the background type 
    /// </summary>
    // ------------------------------------------------------------------
    private CanvasBackgroundTypes mBackgroundType;

    // ------------------------------------------------------------------
    /// <summary>
    /// the GradientColor1 field
    /// </summary>
    // ------------------------------------------------------------------
    private Color mGradientColor1;

    /// <summary>
    /// the GradientColor2 field
    /// </summary>
    private Color mGradientColor2;

    // ------------------------------------------------------------------
    /// <summary>
    /// the BackgroundColor field
    /// </summary>
    // ------------------------------------------------------------------
    private Color mBackgroundColor;

    // ------------------------------------------------------------------
    /// <summary>
    /// The color of the page.
    /// </summary>
    // ------------------------------------------------------------------
    private Color mPageColor;

    // ------------------------------------------------------------------
    /// <summary>
    /// The starting gradient color for the page.
    /// </summary>
    // ------------------------------------------------------------------
    private Color mPageGradientColor1;

    // ------------------------------------------------------------------
    /// <summary>
    /// The ending gradient color for the page.
    /// </summary>
    // ------------------------------------------------------------------
    private Color mPageGradientColor2;

    // ------------------------------------------------------------------
    /// <summary>
    /// The background type of the page.
    /// </summary>
    // ------------------------------------------------------------------
    private CanvasBackgroundTypes mPageBackgroundType =
        CanvasBackgroundTypes.FlatColor;

    // ------------------------------------------------------------------
    /// <summary>
    /// Specifies if the page is rendered in landscape orientation.
    /// </summary>
    // ------------------------------------------------------------------
    private bool mLandscape = true;

    // ------------------------------------------------------------------
    /// <summary>
    /// The size of the page in mils (thousandths of an inch).
    /// </summary>
    // ------------------------------------------------------------------
    private Size mPageSize = new Size(8500, 11000);

    // ------------------------------------------------------------------
    /// <summary>
    /// The title of the page.
    /// </summary>
    // ------------------------------------------------------------------
    private string mTitle = "Default page: no title.";

    // ------------------------------------------------------------------
    /// <summary>
    /// the Page field
    /// </summary>
    // ------------------------------------------------------------------
    private IPage mPage;

    #endregion

    #region Properties

    // ------------------------------------------------------------------
    /// <summary>
    /// Gets the current version.
    /// </summary>
    // ------------------------------------------------------------------
    public virtual double Version {
      get {
        return ambienceVersion;
      }
    }

    // ------------------------------------------------------------------
    /// <summary>
    /// Gets or sets the title of the page.
    /// </summary>
    /// <value>The title.</value>
    // ------------------------------------------------------------------
    public string Title {
      get { return mTitle; }
      set { mTitle = value; }
    }

    // ------------------------------------------------------------------
    /// <summary>
    /// Gets or sets the size of the page in mils (thousandths of an inch).  
    /// The default is letter 8.5" x 11".
    /// </summary>
    /// <value>The size of the page.</value>
    // ------------------------------------------------------------------
    public Size PageSize {
      get { return mPageSize; }
      set { mPageSize = value; }
    }

    // ------------------------------------------------------------------
    /// <summary>
    /// Gets or sets the Page to which this ambience belongs
    /// </summary>
    // ------------------------------------------------------------------
    public IPage Page {
      get {
        return mPage;
      }
      set {
        mPage = value;
      }
    }

    // ------------------------------------------------------------------
    /// <summary>
    /// Gets or sets if the page is rendered and printed in landscape
    /// orientation.
    /// </summary>
    // ------------------------------------------------------------------
    public bool Landscape {
      get {
        return mLandscape;
      }
      set {
        mLandscape = value;
      }
    }

    // ------------------------------------------------------------------
    /// <summary>
    /// Gets or sets the type of the background.
    /// </summary>
    /// <value>The type of the background.</value>
    // ------------------------------------------------------------------
    public CanvasBackgroundTypes BackgroundType {
      get { return this.mBackgroundType; }
      set {
        this.mBackgroundType = value;
        RaiseOnAmbienceChanged();
      }
    }

    // ------------------------------------------------------------------
    /// <summary>
    /// Gets or sets the type of the background for the page portion.
    /// </summary>
    /// <value>The type of the background.</value>
    // ------------------------------------------------------------------
    public CanvasBackgroundTypes PageBackgroundType {
      get { return this.mPageBackgroundType; }
      set {
        this.mPageBackgroundType = value;
        RaiseOnAmbienceChanged();
      }
    }

    // ------------------------------------------------------------------
    /// <summary>
    /// Gets or sets the first gradient color for the background.
    /// </summary>
    /// <value>The first gradient color.</value>
    // ------------------------------------------------------------------
    public Color BackgroundGradientColor1 {
      get { return mGradientColor1; }
      set {
        mGradientColor1 = value;
        RaiseOnAmbienceChanged();
      }
    }

    // ------------------------------------------------------------------
    /// <summary>
    /// Gets or sets the second gradient color
    /// </summary>
    /// <value>The second gradient color.</value>
    // ------------------------------------------------------------------
    public Color BackgroundGradientColor2 {
      get { return mGradientColor2; }
      set {
        mGradientColor2 = value;
        RaiseOnAmbienceChanged();
      }
    }

    // ------------------------------------------------------------------
    /// <summary>
    /// Gets or sets the BackgroundColor
    /// </summary>
    /// <value>The color of the background.</value>
    // ------------------------------------------------------------------
    public Color BackgroundColor {
      get { return mBackgroundColor; }
      set {
        mBackgroundColor = value;
        //notify the world that things have changed
        RaiseOnAmbienceChanged();

      }
    }

    // ------------------------------------------------------------------
    /// <summary>
    /// Gets or sets the first gradient color for the background.
    /// </summary>
    /// <value>The first gradient color.</value>
    // ------------------------------------------------------------------
    public Color PageGradientColor1 {
      get { return mPageGradientColor1; }
      set {
        mPageGradientColor1 = value;
        RaiseOnAmbienceChanged();
      }
    }

    // ------------------------------------------------------------------
    /// <summary>
    /// Gets or sets the second gradient color
    /// </summary>
    /// <value>The second gradient color.</value>
    // ------------------------------------------------------------------
    public Color PageGradientColor2 {
      get { return mPageGradientColor2; }
      set {
        mPageGradientColor2 = value;
        RaiseOnAmbienceChanged();
      }
    }

    // ------------------------------------------------------------------
    /// <summary>
    /// Gets or sets the BackgroundColor
    /// </summary>
    /// <value>The color of the background.</value>
    // ------------------------------------------------------------------
    public Color PageColor {
      get { return mPageColor; }
      set {
        mPageColor = value;
        //notify the world that things have changed
        RaiseOnAmbienceChanged();

      }
    }

    // ------------------------------------------------------------------
    /// <summary>
    /// Gets the model.
    /// </summary>
    /// <value>The model.</value>
    // ------------------------------------------------------------------
    public IModel Model {
      get {
        return mModel;
      }
      internal set {
        mModel = value;
      }
    }

    #endregion

    #region Constructor

    // ------------------------------------------------------------------
    /// <summary>
    /// Default constructor
    /// </summary>
    /// <param name="page">The page.</param>
    // ------------------------------------------------------------------
    public Ambience(IPage page) {
      if (page == null)
        throw new ArgumentNullException(
            "The page paramter cannot be 'null'");
      if (page.Model == null)
        throw new ArgumentNullException("The Model is 'null'");

      //set default ambience
      //mBackgroundColor = Color.FromArgb(116, 118, 124);
      mBackgroundColor = ArtPalette.DefaultPageBackgroundColor;
      mBackgroundType = CanvasBackgroundTypes.FlatColor;
      mGradientColor1 = Color.WhiteSmoke;
      mGradientColor2 = Color.LightSlateGray;
      mPageBackgroundType = CanvasBackgroundTypes.FlatColor;
      mPageColor = ArtPalette.DefaultPageColor;
      mPageGradientColor1 = Color.WhiteSmoke;
      mPageGradientColor2 = Color.Silver;
      mModel = page.Model;
    }

    #endregion

    #region Methods

    /// <summary>
    /// Raises the <see cref="OnAmbienceChanged"/> event
    /// </summary>
    protected virtual void RaiseOnAmbienceChanged() {
      EventHandler<AmbienceEventArgs> handler = OnAmbienceChanged;
      if (handler != null) {
        handler(this, new AmbienceEventArgs(this));
      }
    }

    #endregion

    #region Standard IDispose implementation
    /// <summary>
    /// Disposes the view
    /// </summary>
    public void Dispose() {
      Dispose(true);
      GC.SuppressFinalize(this);


    }
    /// <summary>
    /// Part of the dispose implementation
    /// </summary>
    /// <param name="disposing">if set to <c>true</c> disposing.</param>
    protected virtual void Dispose(bool disposing) {
      if (disposing) {
        #region free managed resources

        #endregion
      }

    }

    #endregion
  }
}