source: default/framework/trunk/WebLibrary/Sources/UI/WebControls/LocalizedMessage.cs @ 864

// ----------------------------------------------------------------------------
// <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.Collections.Specialized;
    using System.ComponentModel;
    using System.Drawing.Design;
    using System.Web;
    using System.Web.UI;
    using System.Web.UI.WebControls;


    /// <summary>
    /// ローカライズされたメッセージを表すコントロールです。
    /// </summary>
    [ParseChildren(true)]
    [PersistChildren(false)]
    [ControlBuilder(typeof(ControlBuilder))]
    [ToolboxData("<{0}:LocalizedMessage runat=\"server\" Text=\"message\"/>")]
    [WebDescription("Description_LocalizedMessage")]
    [ControlInitializerTarget]
    public class LocalizedMessage :
        Localize
    {
        /// <summary>
        /// テキストのパラメータ。
        /// </summary>
        private ParameterCollection textParameters;

        /// <summary>
        /// 表示するかどうか。
        /// </summary>
        private bool visible;

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


        /// <summary>
        /// サーバー コントロールを UI としてページに表示するかどうかを示す値を取得または設定します。
        /// </summary>
        /// <value>
        /// コントロールがページに表示される場合は <see langword="true"/>。
        /// それ以外の場合は <see langword="false"/>。
        /// 既定値は <see langword="false"/>。
        /// </value>
        /// <remarks>
        /// このプロパティの値はポストバックされる度に <see langword="false"/> になります。
        /// </remarks>
        [DefaultValue(false)]
        public override bool Visible
        {
            get
            {
                return visible;
            }

            set
            {
                visible = value;
            }
        }

        /// <summary>
        /// <see cref="Text"/> プロパティに埋め込むためのパラメータコレクションです。
        /// パラメータの名前は無視され、並び順だけが意識されます。
        /// </summary>
        /// <value>
        /// <see cref="Text"/> プロパティに埋め込むためのパラメータコレクション。
        /// </value>
        [Editor("System.Web.UI.Design.WebControls.ParameterCollectionEditor, " + AssemblyRef.SystemDesign, typeof(UITypeEditor))]
        [MergableProperty(false)]
        [PersistenceMode(PersistenceMode.InnerProperty)]
        [Themeable(false)]
        [DefaultValue(null)]
        [WebCategory("Appearance")]
        [WebDescription("Description_LocalizedMessage_TextParameters")]
        public ParameterCollection TextParameters
        {
            get
            {
                if (textParameters == null)
                {
                    textParameters = new ParameterCollection();

                    if (IsTrackingViewState)
                    {
                        ((IStateManager)textParameters).TrackViewState();
                    }
                }

                return textParameters;
            }
        }


        /// <summary>
        /// <see cref="LocalizedMessage"/> コントロールに XML 要素または HTML 要素が解析されたことを通知し、
        /// その要素をコントロールの <see cref="ControlCollection"/> に追加します。
        /// </summary>
        /// <param name="obj">
        /// 解析された要素を表す <see cref="object"/>。
        /// </param>
        protected override void AddParsedSubObject(object obj)
        {
            Control control = obj as Control;
            if (control != null)
            {
                Controls.Add(control);
            }
        }

        /// <summary>
        /// コントロールへの変更の追跡および保存の開始点を、
        /// コントロールのビューステートの一部としてマークします。
        /// </summary>
        protected override void TrackViewState()
        {
            // 親を呼び出す
            base.TrackViewState();

            if (textParameters != null)
            {
                ((IStateManager)textParameters).TrackViewState();
            }
        }

        /// <summary>
        /// <see cref="LocalizedMessage"/> コントロールの保存された状態を読み込みます。
        /// </summary>
        /// <param name="savedState">
        /// <see cref="LocalizedMessage"/> の保存された状態を格納している
        /// <see cref="object"/>。
        /// </param>
        protected override void LoadViewState(object savedState)
        {
            if (savedState == null)
            {
                return;
            }

            Pair state = (Pair)savedState;

            // 親を呼び出す
            base.LoadViewState(state.First);

            if (state.Second != null)
            {
                ((IStateManager)TextParameters).LoadViewState(state.Second);
            }
        }

        /// <summary>
        /// <see cref="LocalizedMessage"/> コントロールの状態を格納します。
        /// </summary>
        /// <returns>
        /// <see cref="LocalizedMessage"/> の保存された状態を格納しているオブジェクト。
        /// </returns>
        protected override object SaveViewState()
        {
            Pair state = new Pair();

            // 親を呼び出す
            state.First = base.SaveViewState();

            if (textParameters != null)
            {
                state.Second = ((IStateManager)textParameters).SaveViewState();
            }

            if (state.First == null && state.Second == null)
            {
                return null;
            }

            return state;
        }

        /// <summary>
        /// 提供されたクライアントに表示される内容を書き込む
        /// <see cref="HtmlTextWriter"/> オブジェクトに、サーバー コントロールの内容を送信します。
        /// </summary>
        /// <param name="writer">
        /// ライタ。
        /// </param>
        protected override void Render(HtmlTextWriter writer)
        {
            string text = Text;
            if (string.IsNullOrEmpty(text))
            {
                return;
            }

            text = FormatText(text);

            if (Mode != LiteralMode.Encode)
            {
                writer.Write(text);
                return;
            }

            HttpUtility.HtmlEncode(text, writer);
        }


        /// <summary>
        /// 指定した文字列をフォーマットして返します。
        /// </summary>
        /// <param name="value">
        /// 文字列。
        /// </param>
        /// <returns>
        /// フォーマットした文字列。
        /// </returns>
        protected virtual string FormatText(string value)
        {
            object[] formatArgs;

            // パラメータを埋め込む
            if (textParameters != null)
            {
                IOrderedDictionary values = textParameters.GetValues(Context, this);
                formatArgs = new object[textParameters.Count];
                values.Values.CopyTo(formatArgs, 0);
            }
            else
            {
                formatArgs = new object[0];
            }

            return Utility.Format(value, formatArgs);
        }
    }
}