//-----------------------------------------------------------------------
// <copyright file="UIPropertyGroupDescription.cs" company="Microsoft">
//     Copyright (c) Microsoft Corporation.  All rights reserved.
// </copyright>
// <summary>
// ExpressionEditor definition
//</summary>
//-----------------------------------------------------------------------

namespace Microsoft.Management.UI.Internal
{
    using System;
    using System.Collections.Specialized;
    using System.ComponentModel;
    using System.Diagnostics.CodeAnalysis;
    using System.Windows.Data;

    /// <summary>
    /// Describes a property that has visual representation and can be sorted and grouped.
    /// </summary>
    [SuppressMessage("Microsoft.MSInternal", "CA903:InternalNamespaceShouldNotContainPublicTypes")]
    public class UIPropertyGroupDescription : PropertyGroupDescription, INotifyPropertyChanged
    {
        private ListSortDirection sortDirection = ListSortDirection.Ascending;

        #region Constructors
        /// <summary>
        /// Initializes a new instance of the <see cref="UIPropertyGroupDescription"/> class with the specified property name and display name.
        /// This constructor assumes that the type of data is <see cref="string"/>.
        /// </summary>
        /// <param name="propertyName">The name of the property that this instance describes.</param>
        /// <param name="displayName">The name displayed to users for this data.</param>
        public UIPropertyGroupDescription(string propertyName, string displayName)
            : this(propertyName, displayName, typeof(string))
        {
            // This constructor just calls another constructor to default the data type to a string.
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="UIPropertyGroupDescription"/> class with the specified property name, display name and data type.
        /// </summary>
        /// <param name="propertyName">The name of the property that this instance describes.</param>
        /// <param name="displayName">The name displayed to users for this data.</param>
        /// <param name="dataType">The type of the data that this instance describes.</param>
        public UIPropertyGroupDescription(string propertyName, string displayName, Type dataType)
            : base(propertyName)
        {
            this.DataType = dataType;
            this.DisplayName = displayName;
            this.DisplayContent = displayName;

            // Ignore case when sorting and grouping by default \\
            this.StringComparison = StringComparison.CurrentCultureIgnoreCase;
        }
        #endregion Constructors

        #region Properties
        /// <summary>
        /// Gets or sets the localizable display name representing the associated property.
        /// </summary>
        public string DisplayName
        {
            get;
            set;
        }

        /// <summary>
        /// Gets or sets the display content representing the associated property.
        /// </summary>
        public object DisplayContent
        {
            get;
            set;
        }

        /// <summary>
        /// Gets or sets which direction the associated property should be sorted.
        /// </summary>
        public ListSortDirection SortDirection
        {
            get
            {
                return this.sortDirection;
            }
            set
            {
                this.sortDirection = value;
                this.OnPropertyChanged(new PropertyChangedEventArgs("SortDirection"));
            }
        }

        /// <summary>
        /// Gets or sets the type of the associated property.
        /// </summary>
        public Type DataType
        {
            get;
            set;
        }
        #endregion Properties

        #region Methods
        /// <summary>
        /// Reverses the current sort direction.
        /// </summary>
        /// <returns>The new sort direction.</returns>
        public ListSortDirection ReverseSortDirection()
        {
            if (this.SortDirection == ListSortDirection.Descending)
            {
                this.SortDirection = ListSortDirection.Ascending;
            }
            else
            {
                this.SortDirection = ListSortDirection.Descending;
            }

            return this.SortDirection;
        }
        #endregion Methods

        #region ToString
        /// <summary>
        /// Displayable string identifying this class instance.
        /// </summary>
        /// <returns>A string to represent the instance of this class.</returns>
        public override string ToString()
        {
            return this.PropertyName;
        }
        #endregion ToString
    }
}
