/* ====================================================================
   Licensed to the Apache Software Foundation (ASF) Under one or more
   contributor license agreements.  See the NOTICE file distributed with
   this work for Additional information regarding copyright ownership.
   The ASF licenses this file to You Under the Apache License, Version 2.0
   (the "License"); you may not use this file except in compliance with
   the License.  You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed Under the License is distributed on an "AS Is" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations Under the License.
==================================================================== */
namespace HH.WMS.Utils.NPOI.HSSF.UserModel
{
    using System;

    using HH.WMS.Utils.NPOI.HSSF.Util;
    using HH.WMS.Utils.NPOI.HSSF.Record;
    using HH.WMS.Utils.NPOI.HSSF.Record.CF;
    using HH.WMS.Utils.NPOI.HSSF.Record.Aggregates;
    using HH.WMS.Utils.NPOI.SS.Util;
    using HH.WMS.Utils.NPOI.SS.UserModel;

    /// <summary>
    /// HSSFConditionalFormatting class encapsulates all Settings of Conditional Formatting.
    /// The class can be used to make a copy HSSFConditionalFormatting Settings
    /// </summary>
    /// <example>
    /// HSSFConditionalFormatting cf = sheet.GetConditionalFormattingAt(index);
    /// newSheet.AddConditionalFormatting(cf);
    /// or to modify existing Conditional Formatting Settings (formatting regions and/or rules).
    /// Use {@link HSSFSheet#GetConditionalFormattingAt(int)} to Get access to an instance of this class.
    /// To Create a new Conditional Formatting Set use the following approach:
    /// 
    /// // Define a Conditional Formatting rule, which triggers formatting
    /// // when cell's value Is greater or equal than 100.0 and
    /// // applies patternFormatting defined below.
    /// HSSFConditionalFormattingRule rule = sheet.CreateConditionalFormattingRule(
    /// ComparisonOperator.GE,
    /// "100.0", // 1st formula
    /// null     // 2nd formula Is not used for comparison operator GE
    /// );
    /// // Create pattern with red background
    /// HSSFPatternFormatting patternFmt = rule.cretePatternFormatting();
    /// patternFormatting.SetFillBackgroundColor(HSSFColor.RED.index);
    /// // Define a region containing first column
    /// Region [] regions =
    /// {
    /// new Region(1,(short)1,-1,(short)1)
    /// };
    /// // Apply Conditional Formatting rule defined above to the regions
    /// sheet.AddConditionalFormatting(regions, rule);
    /// </example>
    /// <remarks>@author Dmitriy Kumshayev</remarks>
    public class HSSFConditionalFormatting : IConditionalFormatting
    {
        private HSSFWorkbook _workbook;
        private CFRecordsAggregate cfAggregate;

        /// <summary>
        /// Initializes a new instance of the <see cref="HSSFConditionalFormatting"/> class.
        /// </summary>
        /// <param name="workbook">The workbook.</param>
        /// <param name="cfAggregate">The cf aggregate.</param>
        public HSSFConditionalFormatting(HSSFWorkbook workbook, CFRecordsAggregate cfAggregate)
        {
            if (workbook == null)
            {
                throw new ArgumentException("workbook must not be null");
            }
            if (cfAggregate == null)
            {
                throw new ArgumentException("cfAggregate must not be null");
            }
            _workbook = workbook;
            this.cfAggregate = cfAggregate;
        }
        /// <summary>
        /// Gets the CF records aggregate.
        /// </summary>
        /// <returns></returns>
        public CFRecordsAggregate CFRecordsAggregate
        {
            get
            {
                return cfAggregate;
            }
        }

        /// <summary>
        /// Gets the array of Regions
        /// </summary>
        /// <returns></returns>
        [Obsolete]
        public Region[] GetFormattingRegions()
        {
            CellRangeAddress[] cellRanges = GetFormattingRanges();
            return Region.ConvertCellRangesToRegions(cellRanges);
        }
        /// <summary>
        /// Gets array of CellRangeAddresses
        /// </summary>
        /// <returns></returns>
        public CellRangeAddress[] GetFormattingRanges()
        {
            return cfAggregate.Header.CellRanges;
        }
        /// <summary>
        /// Replaces an existing Conditional Formatting rule at position idx.
        /// Excel allows to Create up to 3 Conditional Formatting rules.
        /// This method can be useful to modify existing  Conditional Formatting rules.
        /// </summary>
        /// <param name="idx">position of the rule. Should be between 0 and 2.</param>
        /// <param name="cfRule">Conditional Formatting rule</param>
        public void SetRule(int idx, HSSFConditionalFormattingRule cfRule)
        {
            cfAggregate.SetRule(idx, cfRule.CfRuleRecord);
        }
        public void SetRule(int idx, IConditionalFormattingRule cfRule)
        {
            SetRule(idx, (HSSFConditionalFormattingRule)cfRule);
        }
        /// <summary>
        /// Add a Conditional Formatting rule.
        /// Excel allows to Create up to 3 Conditional Formatting rules.
        /// </summary>
        /// <param name="cfRule">Conditional Formatting rule</param>
        public void AddRule(HSSFConditionalFormattingRule cfRule)
        {
            cfAggregate.AddRule(cfRule.CfRuleRecord);
        }
        public void AddRule(IConditionalFormattingRule cfRule)
        {
            AddRule((HSSFConditionalFormattingRule)cfRule);
        }
        /// <summary>
        /// Gets the Conditional Formatting rule at position idx
        /// </summary>
        /// <param name="idx">The index.</param>
        /// <returns></returns>
        public IConditionalFormattingRule GetRule(int idx)
        {
            CFRuleRecord ruleRecord = cfAggregate.GetRule(idx);
            return new HSSFConditionalFormattingRule(_workbook, ruleRecord);
        }
        /// <summary>
        /// Gets the number of Conditional Formatting rules.
        /// </summary>
        /// <value>The number of rules.</value>
        public int NumberOfRules
        {
            get { return cfAggregate.NumberOfRules; }
        }

        /// <summary>
        /// Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
        /// </summary>
        /// <returns>
        /// A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
        /// </returns>
        public override String ToString()
        {
            return cfAggregate.ToString();
        }
    }
}