src/Tizen.NUI/src/public/Container.cs

   1 /*
   2  * Copyright(c) 2017 Samsung Electronics Co., Ltd.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  *
  16  */
  17
  18 using System;
  19 using System.Collections.Generic;
  20 using Tizen.NUI.BaseComponents;
  21
  22 namespace Tizen.NUI
  23 {
  24     /// <summary>
  25     /// The Container is an abstract class to be inherited from by classes that desire to have views
  26     /// added to them.
  27     /// </summary>
  28     /// <since_tizen> 4 </since_tizen>
  29     public abstract class Container : Animatable
  30     {
  31
  32         private List<View> _childViews = new List<View>();
  33         internal BaseHandle InternalParent;
  34
  35         /// <summary>
  36         /// List of children of Container.
  37         /// </summary>
  38         /// <since_tizen> 4 </since_tizen>
  39         public List<View> Children
  40         {
  41             get
  42             {
  43                 return _childViews;
  44             }
  45         }
  46
  47         internal Container(global::System.IntPtr cPtr, bool cMemoryOwn) : base(cPtr, cMemoryOwn)
  48         {
  49             // No un-managed data hence no need to store a native ptr
  50         }
  51
  52         /// <summary>
  53         /// Dispose.
  54         /// </summary>
  55         /// <since_tizen> 4 </since_tizen>
  56         protected override void Dispose(DisposeTypes type)
  57         {
  58             if (disposed)
  59             {
  60                 return;
  61             }
  62
  63             base.Dispose(type);
  64         }
  65
  66         /// <summary>
  67         /// Adds a child view to this Container.
  68         /// </summary>
  69         /// <pre>This Container (the parent) has been initialized. The child view has been initialized. The child view is not the same as the parent view.</pre>
  70         /// <post>The child will be referenced by its parent. This means that the child will be kept alive, even if the handle passed into this method is reset or destroyed.</post>
  71         /// <remarks>If the child already has a parent, it will be removed from the old parent and reparented to this view. This may change child's position, color, scale, etc. as it now inherits them from this view.</remarks>
  72         /// <param name="view">The child view to add.</param>
  73         /// <since_tizen> 4 </since_tizen>
  74         public abstract void Add( View view );
  75
  76         /// <summary>
  77         /// Removes a child view from this view. If the view was not a child of this view, this is a no-op.
  78         /// </summary>
  79         /// <pre>This View(the parent) has been initialized. The child view is not the same as the parent view.</pre>
  80         /// <param name="view">The view to remove</param>
  81         /// <since_tizen> 4 </since_tizen>
  82         public abstract void Remove( View view );
  83
  84         /// <summary>
  85         /// Retrieves the child view by the index.
  86         /// </summary>
  87         /// <pre>The view has been initialized.</pre>
  88         /// <param name="index">The index of the child to retrieve.</param>
  89         /// <returns>The view for the given index or empty handle if children are not initialized.</returns>
  90         /// <since_tizen> 4 </since_tizen>
  91         public abstract View GetChildAt( uint index );
  92
  93         /// <summary>
  94         /// Gets the parent of this container.
  95         /// </summary>
  96         /// <pre>The child container has been initialized.</pre>
  97         /// <returns>The parent container.</returns>
  98         /// <since_tizen> 4 </since_tizen>
  99         public abstract Container GetParent();
 100
 101         /// <summary>
 102         /// Gets the number of children for this container.
 103         /// </summary>
 104         /// <pre>The container has been initialized.</pre>
 105         /// <returns>The number of children.</returns>
 106         /// <since_tizen> 4 </since_tizen>
 107         public abstract UInt32 GetChildCount();
 108
 109         /// <summary>
 110         /// Gets the parent container.
 111         /// Read only
 112         /// </summary>
 113         /// <pre>The child container has been initialized.</pre>
 114         /// <returns>The parent container.</returns>
 115         /// <since_tizen> 4 </since_tizen>
 116         public new Container Parent
 117         {
 118             get
 119             {
 120                 return GetParent();
 121             }
 122         }
 123
 124         /// <summary>
 125         /// Gets the number of children for this container.
 126         /// Read only
 127         /// </summary>
 128         /// <pre>The container has been initialized.</pre>
 129         /// <returns>The number of children.</returns>
 130         /// <since_tizen> 4 </since_tizen>
 131         public uint ChildCount
 132         {
 133             get
 134             {
 135                 return GetChildCount();
 136             }
 137         }
 138     }
 139 } // namespace Tizen.NUI