MonoRail/Castle.MonoRail.Framework/ViewComponents/UpdatePageTag.cs

   1 // Copyright 2004-2008 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 Castle.MonoRail.Framework.Helpers;
  18         using JSGeneration;
  19
  20         /// <summary>
  21         /// Renders a javascript tag block with an inline javascript
  22         /// that changes the page
  23         /// elements using a special dsl-like language.
  24         /// </summary>
  25         ///
  26         /// <seealso cref="IJSGenerator"/>
  27         ///
  28         /// <example>
  29         /// The following illustrates its use.
  30         /// <code>
  31         /// #blockcomponent(UpdatePageTag)
  32         ///   $page.ReplaceHtml('myotherdiv', 'new content')
  33         ///   $page.Highlight('mydivid')
  34         /// #end
  35         /// </code>
  36         /// </example>
  37         /// <remarks>
  38         /// The current implementation is dependent on
  39         /// prototype.js and scriptaculous.js
  40         /// </remarks>
  41         public class UpdatePageTag : UpdatePage
  42         {
  43                 /// <summary>
  44                 /// Called by the framework so the component can
  45                 /// render its content
  46                 /// </summary>
  47                 public override void Render()
  48                 {
  49                         Context.Writer.WriteLine(AbstractHelper.ScriptBlock(GenerateJS()));
  50                 }
  51         }
  52 }