MonoRail/Castle.MonoRail.Framework/Helpers/EffectsFatHelper.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.Helpers
  16 {
  17         using System;
  18
  19         /// <summary>
  20         /// Just apply the CSS class "fade" to any element and it will fade from yellow
  21         /// to its background color or white if none is specified.
  22         /// <para>
  23         /// Key Features <br/>
  24         ///
  25         /// * Fade an infinite number of elements. <br/>
  26         ///
  27         /// * No inline JavaScript. Simply give an element a class of "fade", the script does the rest "automagically". <br/>
  28         ///
  29         /// * Background color aware. FAT will do better than simply fade to white if the element (or it's parents) have a
  30         /// CSS background color, it will fade to that background color instead. <br/>
  31         ///
  32         /// * Fade from any color. For example, if you wanted a list of error messages
  33         /// to fade out from red you would simply give the list a class of "fade-FF0000". <br/>
  34         ///
  35         /// * Super smooth fading. By default, elements will fade at 30 frames per second
  36         /// (the same rate as a television) over 3 seconds. You can adjust this to any
  37         /// framerate and any duration. You could easily fade elements at 60 frames
  38         /// per second over 4, 5, 10 seconds! <br/>
  39         /// </para>
  40         /// </summary>
  41         /// <remarks>
  42         /// NOTE: All elements to be faded must have an id tag!
  43         /// BASIC USE: <p id="paragraph1" class="fade">Watch me fade</p>
  44         /// ADVANCED USE: Change the default fade from color:
  45         /// <p id="paragraph1" class="fade-0066FF">Watch me fade from Blue (#0066FF)</p>
  46         /// SEE MORE HERE: http://www.axentric.com/posts/default/7
  47         /// </remarks>
  48         public class EffectsFatHelper : AbstractHelper
  49         {
  50                 #region Constructors
  51                 /// <summary>
  52                 /// Initializes a new instance of the <see cref="EffectsFatHelper"/> class.
  53                 /// </summary>
  54                 public EffectsFatHelper() { }
  55                 /// <summary>
  56                 /// Initializes a new instance of the <see cref="EffectsFatHelper"/> class.
  57                 /// setting the Controller, Context and ControllerContext.
  58                 /// </summary>
  59                 /// <param name="engineContext">The engine context.</param>
  60                 public EffectsFatHelper(IEngineContext engineContext) : base(engineContext) { }
  61                 #endregion
  62
  63                 /// <summary>
  64                 /// Renders a Javascript library inside a single script tag.
  65                 /// </summary>
  66                 /// <returns></returns>
  67                 public String InstallScripts()
  68                 {
  69                         return RenderScriptBlockToSource("/MonoRail/Files/EffectsFatScripts");
  70                 }
  71
  72                 /// <summary>
  73                 /// Renders a Javascript library inside a single script tag.
  74                 /// </summary>
  75                 /// <returns></returns>
  76                 [Obsolete("Please use the preferred InstallScripts function.")]
  77                 public String GetJavascriptFunctions()
  78                 {
  79                         return InstallScripts();
  80                 }
  81         }
  82 }