MonoRail/Castle.MonoRail.Framework/Attributes/LayoutAttribute.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
  16 {
  17         using System;
  18
  19         using Castle.MonoRail.Framework.Internal;
  20
  21         /// <summary>
  22         /// Associates a layout name with a controller.
  23         /// The layout can later be changed using the LayoutName
  24         /// property of the <see cref="Controller"/>.
  25         /// </summary>
  26         [AttributeUsage(AttributeTargets.Class | AttributeTargets.Method, AllowMultiple=false), Serializable]
  27         public class LayoutAttribute : Attribute, ILayoutDescriptorBuilder
  28         {
  29                 private readonly String layoutName;
  30
  31                 /// <summary>
  32                 /// Constructs a LayoutAttribute with the
  33                 /// layout name.
  34                 /// </summary>
  35                 public LayoutAttribute(String layoutName)
  36                 {
  37                         if (layoutName == null || layoutName.Length == 0)
  38                         {
  39                                 throw new ArgumentNullException("layoutName", "Invalid layout name");
  40                         }
  41
  42                         this.layoutName = layoutName;
  43                 }
  44
  45                 /// <summary>
  46                 /// Gets the layout name
  47                 /// </summary>
  48                 public String LayoutName
  49                 {
  50                         get { return layoutName; }
  51                 }
  52
  53                 /// <summary>
  54                 /// <see cref="ILayoutDescriptorBuilder"/> implementation.
  55                 /// Gets the descriptor that describes the layout.
  56                 /// </summary>
  57                 public LayoutDescriptor BuildLayoutDescriptor()
  58                 {
  59                         return new LayoutDescriptor(layoutName);
  60                 }
  61         }
  62 }