MonoRail/Castle.MonoRail.Framework/ViewComponents/UpdatePage.cs

   1 // Copyright 2004-2007 Castle Project - http://www.castleproject.org/
   2 //
   3 // Licensed under the Apache License, Version 2.0 (the "License");
   4 // you may not use this file except in compliance with the License.
   5 // You may obtain a copy of the License at
   6 //
   7 //     http://www.apache.org/licenses/LICENSE-2.0
   8 //
   9 // Unless required by applicable law or agreed to in writing, software
  10 // distributed under the License is distributed on an "AS IS" BASIS,
  11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12 // See the License for the specific language governing permissions and
  13 // limitations under the License.
  14
  15 namespace Castle.MonoRail.Framework.ViewComponents
  16 {
  17         using System.IO;
  18         using Helpers;
  19
  20         /// <summary>
  21         /// Renders a javascript content that changes the page
  22         /// elements using a special dsl-like language.
  23         /// </summary>
  24         ///
  25         /// <seealso cref="PrototypeHelper"/>
  26         ///
  27         /// <example>
  28         /// The following illustrates its use.
  29         /// <code>
  30         /// #blockcomponent(UpdatePage)
  31         ///   $page.ReplaceHtml('myotherdiv', 'new content')
  32         ///   $page.Highlight('mydivid')
  33         /// #end
  34         /// </code>
  35         /// </example>
  36         /// <remarks>
  37         /// The current implementation is dependent on
  38         /// prototype.js and scriptaculous.js
  39         /// </remarks>
  40         public class UpdatePage : ViewComponent
  41         {
  42                 /// <summary>
  43                 /// Called by the framework so the component can
  44                 /// render its content
  45                 /// </summary>
  46                 public override void Render()
  47                 {
  48                         Context.Writer.WriteLine(GenerateJS());
  49                 }
  50
  51                 /// <summary>
  52                 /// Evaluates the component's body providing a <c>page</c>
  53                 /// instance which is a <see cref="PrototypeHelper"/>
  54                 /// </summary>
  55                 /// <returns></returns>
  56                 protected string GenerateJS()
  57                 {
  58                         object generator = Context.ViewEngine.CreateJSGenerator(RailsContext);
  59
  60                         PropertyBag["page"] = generator;
  61
  62                         Context.RenderBody(new StringWriter());
  63
  64                         PropertyBag.Remove("page");
  65
  66                         return generator.ToString();
  67                 }
  68         }
  69 }