source: default/framework/trunk/WebLibrary/Sources/UI/WebControls/Form.cs @ 1687

// ----------------------------------------------------------------------------
// <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;
    using System.Web.UI;
    using System.Web.UI.HtmlControls;
    using System.Web.UI.WebControls;


    /// <summary>
    /// フォーム機能を提供するクラスです。
    /// </summary>
    [ControlInitializerTarget]
    public class Form :
        HtmlForm
    {
        /// <summary>
        /// <see cref="SuppressHtmlValidation"/> プロパティ用のキー。
        /// </summary>
        private const string SuppressHtmlValidationKey = "SuppressHtmlValidation";


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


        /// <summary>
        /// HTML バリデーションを抑制するかどうかを取得または設定します。
        /// </summary>
        /// <value>
        /// HTML バリデーションを抑制する場合は <see langword="true"/>、
        /// それ以外の場合は <see langword="false"/>。
        /// 既定値は <see langword="false"/> です。
        /// </value>
        [Themeable(false)]
        [DefaultValue(false)]
        [WebCategory("Behavior")]
        [WebDescription("Description_SuppressHtmlValidation")]
        public virtual bool SuppressHtmlValidation
        {
            get
            {
                return (bool)(ViewState[SuppressHtmlValidationKey] ?? false);
            }

            set
            {
                ViewState[SuppressHtmlValidationKey] = value;
            }
        }


        /// <summary>
        /// 指定した <see cref="HtmlTextWriter" /> オブジェクトに、
        /// <see cref="Form" /> コントロールの属性をレンダリングします。
        /// </summary>
        /// <param name="writer">表示される内容を受け取る <see cref="HtmlTextWriter" />。</param>
        /// <exception cref="InvalidOperationException">
        /// <see cref="HtmlForm.DefaultButton" /> プロパティに設定されたコントロール ID の型は
        /// <see cref="IButtonControl" /> ではありません。
        /// </exception>
        protected override void RenderAttributes(HtmlTextWriter writer)
        {
            const string NoValidateAttributeName = @"novalidate";

            Attributes.Remove(NoValidateAttributeName);

            // 親を呼び出す
            base.RenderAttributes(writer);

            if (SuppressHtmlValidation)
            {
                writer.WriteAttribute(NoValidateAttributeName, NoValidateAttributeName);
            }
        }

        /// <summary>
        /// <see cref="Form" /> コントロールの子コントロールを表示します。
        /// </summary>
        /// <param name="writer">表示される内容を受け取る <see cref="HtmlTextWriter" />。</param>
        /// <exception cref="HttpException">
        /// Web ページにはサーバー側の &lt;form&gt; タグが複数あります。
        /// </exception>
        protected override void RenderChildren(HtmlTextWriter writer)
        {
            // Page.BeginFormRender で処理が足りない箇所の保管
            BeginFormRender();

            // 親を呼び出す
            base.RenderChildren(writer);
        }

        /// <summary>
        /// <see cref="HtmlForm.DefaultButton"/> に設定したコントロールのネーミングコンテナが
        /// <see cref="Page"/> では無い場合に正しく動作しないため、それを補完します。
        /// </summary>
        /// <remarks>
        /// <see cref="HtmlForm.DefaultButton"/> は <see cref="Control.UniqueID"/>
        /// を指定しないと <see cref="HtmlForm.RenderAttributes"/> 内で例外を投げるが、
        /// <c>Page.BeginFormRender</c> 内では <see cref="HtmlForm.DefaultButton"/>
        /// を <see cref="Control.ClientID"/> として期待しているためにその違いを吸収します。
        /// </remarks>
        private void BeginFormRender()
        {
            //// MEMO: Page.BeginFormRender の抜粋です

            string defaultButton = DefaultButton;
            if (string.IsNullOrEmpty(defaultButton))
            {
                return;
            }

            Control defaultButtonControl = Reflections.Control.FindControlFromPageIfNecessary(this, defaultButton);
            if (defaultButtonControl == null)
            {
                return;
            }

            string defaultButtonClientID = defaultButtonControl.ClientID;

            // 同じ場合 (ネーミングコンテナが Page の場合) は Page.BeginFormRender の実装で正しく動作している
            if (defaultButton == defaultButtonClientID)
            {
                return;
            }

            Page page = Page;

            // フォーカス設定用のクライアントスクリプトが使用出来ない場合
            if (!Reflections.Page.GetClientSupportsJavaScript(page)
                || !Reflections.Page.GetClientSupportsFocus(page))
            {
                return;
            }

            if (!string.IsNullOrEmpty(Reflections.Page.GetFocusedControlID(page)))
            {
                return;
            }

            if (Reflections.Page.GetFocusedControl(page) != null)
            {
                return;
            }

            if (!string.IsNullOrEmpty(Reflections.Page.GetValidatorInvalidControl(page)))
            {
                return;
            }

            if (!string.IsNullOrEmpty(Reflections.Page.GetLastFocusedControl(page)))
            {
                return;
            }

            if (!string.IsNullOrEmpty(DefaultFocus))
            {
                return;
            }

            Page.ClientScript.RegisterClientScriptResource(typeof(HtmlForm), "Focus.js");

            const string AutoFocusScriptName = "Focus";
            if (!Page.ClientScript.IsClientScriptBlockRegistered(typeof(HtmlForm), AutoFocusScriptName))
            {
                Reflections.Page.RegisterWebFormsScript(page);
                Page.ClientScript.RegisterStartupScript(
                    typeof(HtmlForm),
                    AutoFocusScriptName,
                    "WebForm_AutoFocus(" + ClientScriptUtility.CreateStringLiteral(defaultButtonClientID) + ");",
                    true);
            }

            object scriptManager = Reflections.Page.GetScriptManager(page);
            if (scriptManager != null)
            {
                Reflections.InternalScriptManager.SetFocusInternal(scriptManager, defaultButtonClientID);
            }
        }
    }
}