[NUI] Deceleration of scrolling (#1759)
[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         /// <param name="adapter">Recycle adapter of List.</param>
37         /// <since_tizen> 8 </since_tizen>
38         /// This may be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API
39         [EditorBrowsable(EditorBrowsableState.Never)]
40         public WearableList() : base(new RecycleAdapter(), new FishEyeLayoutManager())
41         {
42             ScrollingDirection = ScrollableBase.Direction.Vertical;
43
44             ScrollDragStarted += OnScrollDragStarted;
45             ScrollAnimationEnded += OnAnimationEnded;
46
47             ContentContainer.PositionUsesPivotPoint = true;
48             ContentContainer.ParentOrigin = Tizen.NUI.ParentOrigin.Center;
49             ContentContainer.PivotPoint = Tizen.NUI.PivotPoint.TopCenter;
50             NoticeAnimationEndBeforePosition = 50;
51
52             ScrollAvailableArea = new Vector2(0, ContentContainer.SizeHeight);
53
54             SetFocus(0, false);
55
56             Scrollbar = new CircularScrollbar();
57             DecelerationThreshold = 60.0f;
58             DecelerationRate = 0.991f;
59         }
60
61         protected override void SetScrollbar()
62         {
63             if(LayoutManager != null)
64             {
65                 Scrollbar.Initialize(ContentContainer.Size.Height, LayoutManager.StepSize, ContentContainer.CurrentPosition.Y, false);
66             }
67         }
68
69         public new RecycleAdapter Adapter
70         {
71             get
72             {
73                 return base.Adapter;
74             }
75
76             set
77             {
78                 base.Adapter = value;
79
80                 foreach (View child in Children)
81                 {
82                     child.PositionUsesPivotPoint = true;
83                     child.ParentOrigin = Tizen.NUI.ParentOrigin.TopCenter;
84                 }
85
86                 ScrollAvailableArea = new Vector2( 0, ContentContainer.SizeHeight );
87             }
88         }
89
90         /// <summary>
91         /// Set focus to item which has specific data index.
92         /// </summary>
93         /// <param name="dataIndex">Data index of item.</param>
94         /// <param name="animated">If set true, scroll to item using animation.</param>
95         /// <since_tizen> 8 </since_tizen>
96         /// This may be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API
97         public void SetFocus(int dataIndex, bool animated)
98         {
99             foreach (RecycleItem item in Children)
100             {
101                 if (item.DataIndex == dataIndex)
102                 {
103                     RecycleItem prevFocusedItem = FocusedItem;
104                     prevFocusedItem?.OnFocusLost();
105                     FocusedItem = item;
106                     FocusedItem.OnFocusGained();
107
108                     ScrollTo(item.DataIndex * mLayoutManager.StepSize, animated);
109                 }
110             }
111         }
112
113         private void OnAnimationEnded(object source, ScrollEventArgs args)
114         {
115         }
116
117         /// <summary>
118         /// This helps developer who wants to know before scroll is reaching target position.
119         /// </summary>
120         /// <param name="targetPosition">Index of item.</param>
121         /// <since_tizen> 8 </since_tizen>
122         /// This may be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API
123         protected override void OnPreReachedTargetPosition(float targetPosition)
124         {
125             int targetDataIndex = (int)Math.Round(Math.Abs(targetPosition) / mLayoutManager.StepSize);
126
127             for (int i = 0; i < Children.Count; i++)
128             {
129                 RecycleItem item = Children[i] as RecycleItem;
130
131                 if (targetDataIndex == item.DataIndex)
132                 {
133                     FocusedItem = item;
134                     item.OnFocusGained();
135                     break;
136                 }
137             }
138         }
139
140         private void OnScrollDragStarted(object source, ScrollEventArgs args)
141         {
142             RecycleItem prevFocusedItem = FocusedItem;
143             prevFocusedItem?.OnFocusLost();
144         }
145     }
146 }