src/Tizen.NUI.Xaml/src/public/Xaml/ViewExtensions.cs

   1 //
   2 // ViewExtensions.cs
   3 //
   4 // Author:
   5 //       Stephane Delcroix <stephane@mi8.be>
   6 //
   7 // Copyright (c) 2013 Mobile Inception
   8 // Copyright (c) 2013 Xamarin, Inc
   9 //
  10 // Permission is hereby granted, free of charge, to any person obtaining a copy
  11 // of this software and associated documentation files (the "Software"), to deal
  12 // in the Software without restriction, including without limitation the rights
  13 // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  14 // copies of the Software, and to permit persons to whom the Software is
  15 // furnished to do so, subject to the following conditions:
  16 //
  17 // The above copyright notice and this permission notice shall be included in
  18 // all copies or substantial portions of the Software.
  19 //
  20 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  21 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  22 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  23 // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  24 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  25 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  26 // THE SOFTWARE.
  27
  28 using System;
  29 using System.Reflection;
  30 using System.ComponentModel;
  31 using Tizen.NUI.XamlBinding;
  32
  33 namespace Tizen.NUI.Xaml
  34 {
  35     /// <summary>
  36     /// Extension class for View defining Tizen.NUI.Xaml.Extensions.LoadFromXaml{TView} method.
  37     /// </summary>
  38     /// This will be public opened in tizen_5.5 after ACR done. Before ACR, need to be hidden as inhouse API.
  39     [EditorBrowsable(EditorBrowsableState.Never)]
  40     public static class Extensions
  41     {
  42         /// <summary>
  43         /// Returns an initialized view by loading the specified xaml.
  44         /// </summary>
  45         /// <typeparam name="TXaml">The type of view to initialize with state from XAML.</typeparam>
  46         /// <param name="view">The view on which this method operates.</param>
  47         /// <param name="callingType">The type of the caller.</param>
  48         /// <returns>A TXaml with the properties that are defined in the application manifest for callingType.</returns>
  49         /// This will be public opened in tizen_5.5 after ACR done. Before ACR, need to be hidden as inhouse API.
  50         [EditorBrowsable(EditorBrowsableState.Never)]
  51         public static TXaml LoadFromXaml<TXaml>(this TXaml view, Type callingType)
  52         {
  53             NameScopeExtensions.PushElement(view);
  54             XamlLoader.Load(view, callingType);
  55             NameScopeExtensions.PopElement();
  56
  57             return view;
  58         }
  59
  60         /// <summary>
  61         /// Returns an initialized view by loading the specified xaml.
  62         /// </summary>
  63         /// <typeparam name="TXaml">The type of view to initialize with state from XAML.</typeparam>
  64         /// <param name="view">The view on which this method operates.</param>
  65         /// <param name="callingType">The type of the caller.</param>
  66         /// <returns>A TXaml with the properties that are defined in the application manifest for callingType.</returns>
  67         /// This will be public opened in tizen_5.5 after ACR done. Before ACR, need to be hidden as inhouse API.
  68         [EditorBrowsable(EditorBrowsableState.Never)]
  69         public static TXaml LoadFromXaml1<TXaml>(this TXaml view, Type callingType)
  70         {
  71             NameScopeExtensions.PushElement(view);
  72             XamlLoader.Load(view, callingType);
  73             NameScopeExtensions.PopElement();
  74
  75             return view;
  76         }
  77
  78         /// <summary>
  79         /// Returns a TXaml with the properties that are defined in the application manifest for callingType.
  80         /// </summary>
  81         /// <typeparam name="TXaml">The type of view to initialize with state from XAML.</typeparam>
  82         /// <param name="view">The view on which this method operates.</param>
  83         /// <param name="xaml">The XAML that encodes the view state.</param>
  84         /// <returns>A TXaml with the properties that are defined in the application manifest for callingType.</returns>
  85         /// This will be public opened in tizen_5.5 after ACR done. Before ACR, need to be hidden as inhouse API.
  86         [EditorBrowsable(EditorBrowsableState.Never)]
  87         public static TXaml LoadFromXaml<TXaml>(this TXaml view, string xaml)
  88         {
  89             if (view is Element)
  90             {
  91                 NameScopeExtensions.PushElement(view);
  92             }
  93
  94             XamlLoader.Load(view, xaml);
  95
  96             if (view is Element)
  97             {
  98                 NameScopeExtensions.PopElement();
  99             }
 100
 101             return view;
 102         }
 103
 104         /// This will be public opened in tizen_5.5 after ACR done. Before ACR, need to be hidden as inhouse API.
 105         [EditorBrowsable(EditorBrowsableState.Never)]
 106         public static T LoadObject<T>(string path)
 107         {
 108             return XamlLoader.LoadObject<T>(path);
 109         }
 110     }
 111 }