source: trunk/HeuristicLab.ExtLibs/HeuristicLab.Netron/3.0.2672.12446/Netron.Diagramming.Core-3.0.2672.12446/PropertySystem/PropertySpec.cs @ 15888

using System;
using System.Collections;
using System.ComponentModel;
using System.Drawing.Design;
namespace Netron.Diagramming.Core
{
  /// <summary>
  /// Represents the description of a property and is a transitional construction to the actual property descriptor of a property.
    /// This class is a modification of the original idea presented by Tony Allowatt (http://www.codeproject.com/cs/miscctrl/bending_property.asp) and used in
    /// a previous version of the graph library.
  /// </summary>
  [Serializable] public class PropertySpec
  {
    #region Fields
    private Attribute[] attributes;
    private string category;
    private object defaultValue;
    private string description;
    private string editor;
    private string name;
    private string type;
    private string typeConverter;

    #endregion

    #region Properties
    /// <summary>
    /// Gets or sets a collection of additional Attributes for this property.  This can
    /// be used to specify attributes beyond those supported intrinsically by the
    /// PropertySpec class, such as ReadOnly and Browsable.
    /// </summary>
    public Attribute[] Attributes
    {
      get { return attributes; }
      set { attributes = value; }
    }

    /// <summary>
    /// Gets or sets the category name of this property.
    /// </summary>
    public string Category
    {
      get { return category; }
      set { category = value; }
    }

    /// <summary>
    /// Gets or sets the fully qualified name of the type converter
    /// type for this property.
    /// </summary>
    public string ConverterTypeName
    {
      get { return typeConverter; }
      set { typeConverter = value; }
    }

    /// <summary>
    /// Gets or sets the default value of this property.
    /// </summary>
    public object DefaultValue
    {
      get { return defaultValue; }
      set { defaultValue = value; }
    }

    /// <summary>
    /// Gets or sets the help text description of this property.
    /// </summary>
    public string Description
    {
      get { return description; }
      set { description = value; }
    }

    /// <summary>
    /// Gets or sets the fully qualified name of the editor type for
    /// this property.
    /// </summary>
    public string EditorTypeName
    {
      get { return editor; }
      set { editor = value; }
    }

    /// <summary>
    /// Gets or sets the name of this property.
    /// </summary>
    public string Name
    {
      get { return name; }
      set { name = value; }
    }

    /// <summary>
    /// Gets or sets the fully qualfied name of the type of this
    /// property.
    /// </summary>
    public string TypeName
    {
      get { return type; }
      set { type = value; }
    }
    #endregion

    #region Constructors
    /// <summary>
    /// Initializes a new instance of the PropertySpec class.
    /// </summary>
    /// <param name="name">The name of the property displayed in the property grid.</param>
    /// <param name="type">The fully qualified name of the type of the property.</param>
    public PropertySpec(string name, string type) : this(name, type, null, null, null) { }

    /// <summary>
    /// Initializes a new instance of the PropertySpec class.
    /// </summary>
    /// <param name="name">The name of the property displayed in the property grid.</param>
    /// <param name="type">A Type that represents the type of the property.</param>
    public PropertySpec(string name, Type type) :
      this(name, type.AssemblyQualifiedName, null, null, null) { }

    /// <summary>
    /// Initializes a new instance of the PropertySpec class.
    /// </summary>
    /// <param name="name">The name of the property displayed in the property grid.</param>
    /// <param name="type">The fully qualified name of the type of the property.</param>
    /// <param name="category">The category under which the property is displayed in the
    /// property grid.</param>
    public PropertySpec(string name, string type, string category) : this(name, type, category, null, null) { }

    /// <summary>
    /// Initializes a new instance of the PropertySpec class.
    /// </summary>
    /// <param name="name">The name of the property displayed in the property grid.</param>
    /// <param name="type">A Type that represents the type of the property.</param>
    /// <param name="category"></param>
    public PropertySpec(string name, Type type, string category) :
      this(name, type.AssemblyQualifiedName, category, null, null) { }

    /// <summary>
    /// Initializes a new instance of the PropertySpec class.
    /// </summary>
    /// <param name="name">The name of the property displayed in the property grid.</param>
    /// <param name="type">The fully qualified name of the type of the property.</param>
    /// <param name="category">The category under which the property is displayed in the
    /// property grid.</param>
    /// <param name="description">A string that is displayed in the help area of the
    /// property grid.</param>
    public PropertySpec(string name, string type, string category, string description) :
      this(name, type, category, description, null) { }

    /// <summary>
    /// Initializes a new instance of the PropertySpec class.
    /// </summary>
    /// <param name="name">The name of the property displayed in the property grid.</param>
    /// <param name="type">A Type that represents the type of the property.</param>
    /// <param name="category">The category under which the property is displayed in the
    /// property grid.</param>
    /// <param name="description">A string that is displayed in the help area of the
    /// property grid.</param>
    public PropertySpec(string name, Type type, string category, string description) :
      this(name, type.AssemblyQualifiedName, category, description, null) { }

    /// <summary>
    /// Initializes a new instance of the PropertySpec class.
    /// </summary>
    /// <param name="name">The name of the property displayed in the property grid.</param>
    /// <param name="type">The fully qualified name of the type of the property.</param>
    /// <param name="category">The category under which the property is displayed in the
    /// property grid.</param>
    /// <param name="description">A string that is displayed in the help area of the
    /// property grid.</param>
    /// <param name="defaultValue">The default value of the property, or null if there is
    /// no default value.</param>
    public PropertySpec(string name, string type, string category, string description, object defaultValue)
    {
      this.name = name;
      this.type = type;
      this.category = category;
      this.description = description;
      this.defaultValue = defaultValue;
      this.attributes = null;
    }

    /// <summary>
    /// Initializes a new instance of the PropertySpec class.
    /// </summary>
    /// <param name="name">The name of the property displayed in the property grid.</param>
    /// <param name="type">A Type that represents the type of the property.</param>
    /// <param name="category">The category under which the property is displayed in the
    /// property grid.</param>
    /// <param name="description">A string that is displayed in the help area of the
    /// property grid.</param>
    /// <param name="defaultValue">The default value of the property, or null if there is
    /// no default value.</param>
    public PropertySpec(string name, Type type, string category, string description, object defaultValue) :
      this(name, type.AssemblyQualifiedName, category, description, defaultValue) { }

    /// <summary>
    /// Initializes a new instance of the PropertySpec class.
    /// </summary>
    /// <param name="name">The name of the property displayed in the property grid.</param>
    /// <param name="type">The fully qualified name of the type of the property.</param>
    /// <param name="category">The category under which the property is displayed in the
    /// property grid.</param>
    /// <param name="description">A string that is displayed in the help area of the
    /// property grid.</param>
    /// <param name="defaultValue">The default value of the property, or null if there is
    /// no default value.</param>
    /// <param name="editor">The fully qualified name of the type of the editor for this
    /// property.  This type must derive from UITypeEditor.</param>
    /// <param name="typeConverter">The fully qualified name of the type of the type
    /// converter for this property.  This type must derive from TypeConverter.</param>
    public PropertySpec(string name, string type, string category, string description, object defaultValue,
      string editor, string typeConverter) : this(name, type, category, description, defaultValue)
    {
      this.editor = editor;
      this.typeConverter = typeConverter;
    }

    /// <summary>
    /// Initializes a new instance of the PropertySpec class.
    /// </summary>
    /// <param name="name">The name of the property displayed in the property grid.</param>
    /// <param name="type">A Type that represents the type of the property.</param>
    /// <param name="category">The category under which the property is displayed in the
    /// property grid.</param>
    /// <param name="description">A string that is displayed in the help area of the
    /// property grid.</param>
    /// <param name="defaultValue">The default value of the property, or null if there is
    /// no default value.</param>
    /// <param name="editor">The fully qualified name of the type of the editor for this
    /// property.  This type must derive from UITypeEditor.</param>
    /// <param name="typeConverter">The fully qualified name of the type of the type
    /// converter for this property.  This type must derive from TypeConverter.</param>
    public PropertySpec(string name, Type type, string category, string description, object defaultValue,
      string editor, string typeConverter) :
      this(name, type.AssemblyQualifiedName, category, description, defaultValue, editor, typeConverter) { }

    /// <summary>
    /// Initializes a new instance of the PropertySpec class.
    /// </summary>
    /// <param name="name">The name of the property displayed in the property grid.</param>
    /// <param name="type">The fully qualified name of the type of the property.</param>
    /// <param name="category">The category under which the property is displayed in the
    /// property grid.</param>
    /// <param name="description">A string that is displayed in the help area of the
    /// property grid.</param>
    /// <param name="defaultValue">The default value of the property, or null if there is
    /// no default value.</param>
    /// <param name="editor">The Type that represents the type of the editor for this
    /// property.  This type must derive from UITypeEditor.</param>
    /// <param name="typeConverter">The fully qualified name of the type of the type
    /// converter for this property.  This type must derive from TypeConverter.</param>
    public PropertySpec(string name, string type, string category, string description, object defaultValue,
      Type editor, string typeConverter) :
      this(name, type, category, description, defaultValue, editor.AssemblyQualifiedName,
      typeConverter) { }

    /// <summary>
    /// Initializes a new instance of the PropertySpec class.
    /// </summary>
    /// <param name="name">The name of the property displayed in the property grid.</param>
    /// <param name="type">A Type that represents the type of the property.</param>
    /// <param name="category">The category under which the property is displayed in the
    /// property grid.</param>
    /// <param name="description">A string that is displayed in the help area of the
    /// property grid.</param>
    /// <param name="defaultValue">The default value of the property, or null if there is
    /// no default value.</param>
    /// <param name="editor">The Type that represents the type of the editor for this
    /// property.  This type must derive from UITypeEditor.</param>
    /// <param name="typeConverter">The fully qualified name of the type of the type
    /// converter for this property.  This type must derive from TypeConverter.</param>
    public PropertySpec(string name, Type type, string category, string description, object defaultValue,
      Type editor, string typeConverter) : 
      this(name, type.AssemblyQualifiedName, category, description, defaultValue,
      editor.AssemblyQualifiedName, typeConverter) { }

    /// <summary>
    /// Initializes a new instance of the PropertySpec class.
    /// </summary>
    /// <param name="name">The name of the property displayed in the property grid.</param>
    /// <param name="type">The fully qualified name of the type of the property.</param>
    /// <param name="category">The category under which the property is displayed in the
    /// property grid.</param>
    /// <param name="description">A string that is displayed in the help area of the
    /// property grid.</param>
    /// <param name="defaultValue">The default value of the property, or null if there is
    /// no default value.</param>
    /// <param name="editor">The fully qualified name of the type of the editor for this
    /// property.  This type must derive from UITypeEditor.</param>
    /// <param name="typeConverter">The Type that represents the type of the type
    /// converter for this property.  This type must derive from TypeConverter.</param>
    public PropertySpec(string name, string type, string category, string description, object defaultValue,
      string editor, Type typeConverter) :
      this(name, type, category, description, defaultValue, editor, typeConverter.AssemblyQualifiedName) { }

    /// <summary>
    /// Initializes a new instance of the PropertySpec class.
    /// </summary>
    /// <param name="name">The name of the property displayed in the property grid.</param>
    /// <param name="type">A Type that represents the type of the property.</param>
    /// <param name="category">The category under which the property is displayed in the
    /// property grid.</param>
    /// <param name="description">A string that is displayed in the help area of the
    /// property grid.</param>
    /// <param name="defaultValue">The default value of the property, or null if there is
    /// no default value.</param>
    /// <param name="editor">The fully qualified name of the type of the editor for this
    /// property.  This type must derive from UITypeEditor.</param>
    /// <param name="typeConverter">The Type that represents the type of the type
    /// converter for this property.  This type must derive from TypeConverter.</param>
    public PropertySpec(string name, Type type, string category, string description, object defaultValue,
      string editor, Type typeConverter) :
      this(name, type.AssemblyQualifiedName, category, description, defaultValue, editor,
      typeConverter.AssemblyQualifiedName) { }

    /// <summary>
    /// Initializes a new instance of the PropertySpec class.
    /// </summary>
    /// <param name="name">The name of the property displayed in the property grid.</param>
    /// <param name="type">The fully qualified name of the type of the property.</param>
    /// <param name="category">The category under which the property is displayed in the
    /// property grid.</param>
    /// <param name="description">A string that is displayed in the help area of the
    /// property grid.</param>
    /// <param name="defaultValue">The default value of the property, or null if there is
    /// no default value.</param>
    /// <param name="editor">The Type that represents the type of the editor for this
    /// property.  This type must derive from UITypeEditor.</param>
    /// <param name="typeConverter">The Type that represents the type of the type
    /// converter for this property.  This type must derive from TypeConverter.</param>
    public PropertySpec(string name, string type, string category, string description, object defaultValue,
      Type editor, Type typeConverter) :
      this(name, type, category, description, defaultValue, editor.AssemblyQualifiedName,
      typeConverter.AssemblyQualifiedName) { }

    /// <summary>
    /// Initializes a new instance of the PropertySpec class.
    /// </summary>
    /// <param name="name">The name of the property displayed in the property grid.</param>
    /// <param name="type">A Type that represents the type of the property.</param>
    /// <param name="category">The category under which the property is displayed in the
    /// property grid.</param>
    /// <param name="description">A string that is displayed in the help area of the
    /// property grid.</param>
    /// <param name="defaultValue">The default value of the property, or null if there is
    /// no default value.</param>
    /// <param name="editor">The Type that represents the type of the editor for this
    /// property.  This type must derive from UITypeEditor.</param>
    /// <param name="typeConverter">The Type that represents the type of the type
    /// converter for this property.  This type must derive from TypeConverter.</param>
    public PropertySpec(string name, Type type, string category, string description, object defaultValue,
      Type editor, Type typeConverter) :
      this(name, type.AssemblyQualifiedName, category, description, defaultValue,
      editor.AssemblyQualifiedName, typeConverter.AssemblyQualifiedName) { }


    #endregion

        #region Methods
        /// <summary>
        /// Converts this specification to an  property descriptor.
        /// </summary>
        /// <returns></returns>
        internal PropertySpecDescriptor ToPropertyDescriptor()
        {
            ArrayList attrs = new ArrayList();
            // If a category, description, editor, or type converter are specified
            // in the thisSpec, create attributes to define that relationship.
            if(this.Category != null)
                attrs.Add(new CategoryAttribute(this.Category));

            if(this.Description != null)
                attrs.Add(new DescriptionAttribute(this.Description));

            if(this.EditorTypeName != null)
                attrs.Add(new EditorAttribute(this.EditorTypeName, typeof(UITypeEditor)));

            if(this.ConverterTypeName != null)
                attrs.Add(new TypeConverterAttribute(this.ConverterTypeName));

            // Additionally, append the custom attributes associated with the
            // thisSpec, if any.
            if(this.Attributes != null)
                attrs.AddRange(this.Attributes);

            Attribute[] attrArray = (Attribute[]) attrs.ToArray(typeof(Attribute));

            // Create a new this descriptor for the this item, and add
            // it to the list.
            return new PropertySpecDescriptor(this, attrArray);
        }
            #endregion
    
        }

}