MonoRail/Castle.MonoRail.Framework/JSGeneration/IJSElementGenerator.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.JSGeneration
  16 {
  17         /// <summary>
  18         /// Depicts the operations supported by the element Js generator.
  19         /// </summary>
  20         ///
  21         /// <remarks>
  22         /// In practice you can access this generator by using the element accessor.
  23         /// For example (using nvelocity syntax):
  24         ///
  25         /// <code>
  26         ///   $page.el('element id') -> IJSElementGenerator instance
  27         /// </code>
  28         ///
  29         /// </remarks>
  30     public interface IJSElementGenerator
  31         {
  32         /// <summary>
  33         /// Gets the parent generator.
  34         /// </summary>
  35         /// <value>The parent generator.</value>
  36         IJSGenerator ParentGenerator { get; }
  37
  38                 /// <summary>
  39                 /// Replaces the content of the element.
  40                 /// </summary>
  41                 ///
  42                 /// <example>
  43                 /// The following example uses nvelocity syntax:
  44                 ///
  45                 /// <code>
  46                 ///   $page.el('elementid').ReplaceHtml("%{partial='shared/newmessage.vm'}")
  47                 /// </code>
  48                 /// </example>
  49                 ///
  50                 /// <param name="renderOptions">Defines what to render</param>
  51                 void ReplaceHtml(object renderOptions);
  52
  53                 /// <summary>
  54                 /// Replaces the entire element's content -- and not only its innerHTML --
  55                 /// by the content evaluated.
  56                 /// </summary>
  57                 ///
  58                 /// <example>
  59                 /// The following example uses nvelocity syntax:
  60                 ///
  61                 /// <code>
  62                 ///   $page.el('messagediv').Replace("%{partial='shared/newmessage.vm'}")
  63                 /// </code>
  64                 /// </example>
  65                 ///
  66                 /// <param name="renderOptions">Defines what to render</param>
  67                 void Replace(object renderOptions);
  68     }
  69 }