[NUI] remove unused parameter docs tag. (#2083)
[platform/core/csapi/tizenfx.git] / src / Tizen.NUI.Wearable / src / public / WearableList.cs
1 /* Copyright (c) 2020 Samsung Electronics Co., Ltd.
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  */
16 using System;
17 using Tizen.NUI.BaseComponents;
18 using Tizen.NUI.Components;
19 using System.ComponentModel;
20
21 namespace Tizen.NUI.Wearable
22 {
23     /// <summary>
24     /// [Draft] This class provides a list view styled by wearable ux.
25     /// List will lay out all items with Fish-Eye layout manager.
26     /// </summary>
27     /// This may be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API.
28     [EditorBrowsable(EditorBrowsableState.Never)]
29     public class WearableList : RecyclerView
30     {
31         private RecycleItem FocusedItem = null;
32
33         /// <summary>
34         /// Default constructor.
35         /// </summary>
36         /// <since_tizen> 8 </since_tizen>
37         /// This may be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API
38         [EditorBrowsable(EditorBrowsableState.Never)]
39         public WearableList() : base(new RecycleAdapter(), new FishEyeLayoutManager())
40         {
41             ScrollingDirection = ScrollableBase.Direction.Vertical;
42
43             ScrollDragStarted += OnScrollDragStarted;
44             ScrollAnimationEnded += OnAnimationEnded;
45
46             ContentContainer.PositionUsesPivotPoint = true;
47             ContentContainer.ParentOrigin = Tizen.NUI.ParentOrigin.Center;
48             ContentContainer.PivotPoint = Tizen.NUI.PivotPoint.TopCenter;
49             NoticeAnimationEndBeforePosition = 50;
50
51             ScrollAvailableArea = new Vector2(0, ContentContainer.SizeHeight);
52
53             SetFocus(0, false);
54
55             Scrollbar = new CircularScrollbar();
56             DecelerationThreshold = 60.0f;
57             DecelerationRate = 0.991f;
58         }
59
60         protected override void SetScrollbar()
61         {
62             if(LayoutManager != null)
63             {
64                 Scrollbar.Initialize(ContentContainer.Size.Height, LayoutManager.StepSize, ContentContainer.CurrentPosition.Y, false);
65             }
66         }
67
68         public new RecycleAdapter Adapter
69         {
70             get
71             {
72                 return base.Adapter;
73             }
74
75             set
76             {
77                 base.Adapter = value;
78
79                 foreach (View child in Children)
80                 {
81                     child.PositionUsesPivotPoint = true;
82                     child.ParentOrigin = Tizen.NUI.ParentOrigin.TopCenter;
83                 }
84
85                 ScrollAvailableArea = new Vector2( 0, ContentContainer.SizeHeight );
86             }
87         }
88
89         /// <summary>
90         /// Set focus to item which has specific data index.
91         /// </summary>
92         /// <param name="dataIndex">Data index of item.</param>
93         /// <param name="animated">If set true, scroll to item using animation.</param>
94         /// <since_tizen> 8 </since_tizen>
95         /// This may be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API
96         public void SetFocus(int dataIndex, bool animated)
97         {
98             foreach (RecycleItem item in Children)
99             {
100                 if (item.DataIndex == dataIndex)
101                 {
102                     RecycleItem prevFocusedItem = FocusedItem;
103                     prevFocusedItem?.OnFocusLost();
104                     FocusedItem = item;
105                     FocusedItem.OnFocusGained();
106
107                     ScrollTo(item.DataIndex * LayoutManager.StepSize, animated);
108                 }
109             }
110         }
111
112         private void OnAnimationEnded(object source, ScrollEventArgs args)
113         {
114         }
115
116         /// <summary>
117         /// This helps developer who wants to know before scroll is reaching target position.
118         /// </summary>
119         /// <param name="targetPosition">Index of item.</param>
120         /// <since_tizen> 8 </since_tizen>
121         /// This may be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API
122         protected override void OnPreReachedTargetPosition(float targetPosition)
123         {
124             int targetDataIndex = (int)Math.Round(Math.Abs(targetPosition) / LayoutManager.StepSize);
125
126             for (int i = 0; i < Children.Count; i++)
127             {
128                 RecycleItem item = Children[i] as RecycleItem;
129
130                 if (targetDataIndex == item.DataIndex)
131                 {
132                     FocusedItem = item;
133                     item.OnFocusGained();
134                     break;
135                 }
136             }
137         }
138
139         private void OnScrollDragStarted(object source, ScrollEventArgs args)
140         {
141             RecycleItem prevFocusedItem = FocusedItem;
142             prevFocusedItem?.OnFocusLost();
143         }
144     }
145 }