source: default/framework/trunk/WebLibrary/Sources/UI/WebControls/CompareValidator.cs @ 1622

// ----------------------------------------------------------------------------
// <copyright company="F.C. Soft., Inc.">
//   Copyright(c) F.C. Soft., Inc.  All rights reserved.
// </copyright>
// <license>
//   Licensed to F.C. Soft., Inc. (FCSoft) under one or more contributor
//   license agreements.  See the NOTICE file distributed with this work for
//   additional information regarding copyright ownership.  FCSoft 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.
// </license>
// ----------------------------------------------------------------------------

namespace FCSoft.SilverFrost.Framework.Web.UI.WebControls
{
    using System;
    using System.ComponentModel;
    using System.Web.UI;


    /// <summary>
    /// ユーザーが入力コントロールに入力した値を、
    /// 別の入力コントロールに入力された値または定数値のいずれかと比較します。
    /// </summary>
    [WebDescription("Description_CompareValidator")]
    [ControlInitializerTarget]
    public class CompareValidator :
        System.Web.UI.WebControls.CompareValidator
    {
        /// <summary>
        /// <see cref="AffectedByAncestors"/> プロパティ用のキー。
        /// </summary>
        private const string AffectedByAncestorsKey = "AffectedByAncestors";

        /// <summary>
        /// <see cref="ErrorMessageFormatString"/> プロパティ用のキー。
        /// </summary>
        private const string ErrorMessageFormatStringKey = "ErrorMessageFormatString";

        /// <summary>
        /// <see cref="ControlNameToValidate"/> プロパティ用のキー。
        /// </summary>
        private const string ControlNameToValidateKey = "ControlNameToValidate";

        /// <summary>
        /// <see cref="CompareNameToValidate"/> プロパティ用のキー。
        /// </summary>
        private const string CompareNameToValidateKey = "CompareNameToValidate";


        /// <summary>
        /// エラーメッセージを準備する必要があるかどうか。
        /// </summary>
        private bool requiresErrorMessage;

        /// <summary>
        /// <see cref="Control.PreRender"/> に到達しているかどうか。
        /// </summary>
        private bool preRendered;


        /// <summary>
        /// インスタンスを作成します。
        /// </summary>
        public CompareValidator()
        {
            ControlInitializer.ApplyProperties(this);
        }


        /// <summary>
        /// 親や祖先の要素の影響を受けるかどうかを取得または設定します。
        /// </summary>
        /// <value>
        /// 親や祖先の要素の影響を受けてバリデーションを実行するかどうかを決定する場合は <see langword="true"/>。
        /// それ以外の場合は <see langword="false"/>。
        /// 既定値は <see langword="false"/>。
        /// </value>
        [Themeable(false)]
        [DefaultValue(false)]
        [WebCategory("Behavior")]
        [WebDescription("Description_AllowBlank")]
        public bool AffectedByAncestors
        {
            get
            {
                return (bool)(ViewState[AffectedByAncestorsKey] ?? false);
            }

            set
            {
                ViewState[AffectedByAncestorsKey] = value;
            }
        }

        /// <summary>
        /// <see cref="System.Web.UI.WebControls.BaseValidator.ErrorMessage"/> の元になるフォーマット文字列です。
        /// </summary>
        /// <value>
        /// <see cref="System.Web.UI.WebControls.BaseValidator.ErrorMessage"/> の元になるフォーマット文字列。
        /// 既定値は空文字。
        /// </value>
        /// <remarks>
        /// <para>
        /// このプロパティが設定されると、このプロパティ値をフォーマット文字列として
        /// <c>{0}</c> に <see cref="ControlNameToValidate"/>、
        /// <c>{1}</c> に <see cref="CompareNameToValidate"/>
        /// が埋め込まれた値が
        /// <see cref="System.Web.UI.WebControls.BaseValidator.ErrorMessage"/> が設定されます。
        /// </para>
        /// <para>
        /// フォーマット文字列を無効にする場合は、空文字列をセットします。
        /// ただし、その場合でも、元のエラーメッセージは復元されません。
        /// 再度 <see cref="System.Web.UI.WebControls.BaseValidator.ErrorMessage"/> に設定し直す必要があります。
        /// </para>
        /// </remarks>
        [Localizable(true)]
        [Themeable(false)]
        [DefaultValue("")]
        [WebCategory("Appearance")]
        [WebDescription("Description_ErrorMessageFormatString")]
        public string ErrorMessageFormatString
        {
            get
            {
                return (string)(ViewState[ErrorMessageFormatStringKey] ?? string.Empty);
            }

            set
            {
                if (ErrorMessageFormatString == value)
                {
                    return;
                }

                ViewState[ErrorMessageFormatStringKey] = value;
                RequiresErrorMessage = true;
            }
        }

        /// <summary>
        /// 検証対象のコントロールの名称を表します。
        /// </summary>
        /// <value>
        /// 検証対象のコントロールの名称。
        /// 既定値は空文字。
        /// </value>
        [Localizable(true)]
        [Themeable(false)]
        [DefaultValue("")]
        [WebCategory("Appearance")]
        [WebDescription("Description_ControlNameToValidate")]
        public virtual string ControlNameToValidate
        {
            get
            {
                return (string)(ViewState[ControlNameToValidateKey] ?? string.Empty);
            }

            set
            {
                if (ControlNameToValidate == value)
                {
                    return;
                }

                ViewState[ControlNameToValidateKey] = value;
                RequiresErrorMessage = true;
            }
        }

        /// <summary>
        /// 比較対象の名称を表します。
        /// </summary>
        /// <value>
        /// 比較対象の名称。
        /// 既定値は空文字。
        /// </value>
        [Localizable(true)]
        [Themeable(false)]
        [DefaultValue("")]
        [WebCategory("Appearance")]
        [WebDescription("Description_CompareNameToValidate")]
        public virtual string CompareNameToValidate
        {
            get
            {
                return (string)(ViewState[CompareNameToValidateKey] ?? string.Empty);
            }

            set
            {
                if (CompareNameToValidate == value)
                {
                    return;
                }

                ViewState[CompareNameToValidateKey] = value;
                RequiresErrorMessage = true;
            }
        }

        /// <summary>
        /// コントロールの <see cref="System.Web.UI.WebControls.WebControl.IsEnabled" />
        /// プロパティが <see langword="false"/> の場合、レンダリングされた HTML 要素の disabled 属性を
        /// "無効" に設定するかどうかを示す値を取得します。
        /// </summary>
        /// <value>
        /// <see cref="Control.RenderingCompatibility" /> プロパティが
        /// 4.0 より低い ASP.NET のバージョンを示す場合は <see langword="true"/>。
        /// それ以外の場合は <see langword="false"/>。
        /// </value>
        public override bool SupportsDisabledAttribute
        {
            get
            {
                return !AffectedByAncestors && base.SupportsDisabledAttribute;
            }
        }

        /// <summary>
        /// 検証コントロールを有効にするかどうかを示す値を取得または設定します。
        /// </summary>
        /// <value>
        /// 検証コントロールを有効にする場合は <see langword="true"/>。
        /// それ以外の場合は <see langword="false"/>。
        /// 既定値は、<see langword="true"/> です。
        /// </value>
        public override bool Enabled
        {
            get
            {
                return base.Enabled && (!AffectedByAncestors || IsEnabled);
            }

            set
            {
                base.Enabled = value;
            }
        }

        /// <summary>
        /// エラーメッセージを準備する必要があるかどうかを取得及び設定します。
        /// </summary>
        /// <value>
        /// 準備する場合は <see langword="true"/>、それ以外の場合は <see langword="false"/>。
        /// 既定値は <see langword="false"/>。
        /// </value>
        protected virtual bool RequiresErrorMessage
        {
            get
            {
                return requiresErrorMessage;
            }

            set
            {
                if (value && preRendered && Page != null && !Page.IsCallback)
                {
                    requiresErrorMessage = true;
                    EnsureErrorMessage();
                }
                else
                {
                    requiresErrorMessage = value;
                }
            }
        }


        /// <summary>
        /// <see cref="Control.Init"/> イベントを呼び出します。
        /// </summary>
        /// <param name="e">
        /// イベント データを格納している <see cref="EventArgs"/>。
        /// </param>
        protected override void OnInit(EventArgs e)
        {
            // 親を呼び出す
            base.OnInit(e);

            EnsureErrorMessage();
        }

        /// <summary>
        /// このコントロールがレンダリングされる直前に呼び出されるイベントハンドラです。
        /// </summary>
        /// <param name="e">
        /// イベント データを格納している <see cref="EventArgs"/>。
        /// </param>
        protected override void OnPreRender(EventArgs e)
        {
            preRendered = true;

            // エラーメッセージを準備
            EnsureErrorMessage();

            // 親を呼び出す
            base.OnPreRender(e);
        }

        /// <summary>
        /// エラーメッセージを作成する必要がある場合に作成します。
        /// </summary>
        protected virtual void EnsureErrorMessage()
        {
            if (!RequiresErrorMessage)
            {
                return;
            }

            BuildErrorMessage();
        }

        /// <summary>
        /// エラーメッセージを作成します。
        /// </summary>
        protected virtual void BuildErrorMessage()
        {
            string format = ErrorMessageFormatString;

            // フォーマット文字列が未設定の場合は何もしない
            if (string.IsNullOrEmpty(format))
            {
                return;
            }

            ErrorMessage
                = Utility.Format(
                    format,
                    ControlNameToValidate,
                    CompareNameToValidate);

            RequiresErrorMessage = false;
        }
    }
}