2027803ade3140f98fe4af4f49173904f4e87223
[platform/core/csapi/tizenfx.git] / src / Tizen.NUI.Components / Controls / ScrollableBase.cs
1 /* Copyright (c) 2021 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 System.Collections.Generic;
19 using System.ComponentModel;
20 using System.Diagnostics;
21 using System.Runtime.InteropServices;
22 using Tizen.NUI.Accessibility;
23
24 namespace Tizen.NUI.Components
25 {
26     /// <summary>
27     /// ScrollEventArgs is a class to record scroll event arguments which will sent to user.
28     /// </summary>
29     /// <since_tizen> 8 </since_tizen>
30     [global::System.Diagnostics.CodeAnalysis.SuppressMessage("Design", "CA1001: Types that own disposable fields should be disposable.", Justification = "Scroll event is temporarily used for notifying scroll position update, so position will not be disposed during the event processing.")]
31     public class ScrollEventArgs : EventArgs
32     {
33         // Position class is derived class of Disposable class and they will be implicitly disposed by DisposeQueue,
34         // so that there will be no memory leak.
35         private Position position;
36         private Position scrollPosition;
37
38         /// <summary>
39         /// Default constructor.
40         /// </summary>
41         /// <param name="position">Current container position</param>
42         /// <since_tizen> 8 </since_tizen>
43         public ScrollEventArgs(Position position)
44         {
45             this.position = position;
46             this.scrollPosition = new Position(-position);
47         }
48
49         /// <summary>
50         /// Current position of ContentContainer.
51         /// </summary>
52         /// <since_tizen> 8 </since_tizen>
53         public Position Position
54         {
55             get
56             {
57                 return position;
58             }
59         }
60         /// <summary>
61         /// Current scroll position of scrollableBase pan.
62         /// This is the position in the opposite direction to the current position of ContentContainer.
63         /// </summary>
64         [EditorBrowsable(EditorBrowsableState.Never)]
65         public Position ScrollPosition
66         {
67             get
68             {
69                 return scrollPosition;
70             }
71         }
72     }
73
74     /// <summary>
75     /// ScrollOutofBoundEventArgs is to record scroll out-of-bound event arguments which will be sent to user.
76     /// </summary>
77     [EditorBrowsable(EditorBrowsableState.Never)]
78     public class ScrollOutOfBoundEventArgs : EventArgs
79     {
80         /// <summary>
81         /// The direction to be touched.
82         /// </summary>
83         [EditorBrowsable(EditorBrowsableState.Never)]
84         public enum Direction
85         {
86             /// <summary>
87             /// Upwards.
88             /// </summary>
89             [EditorBrowsable(EditorBrowsableState.Never)]
90             Up,
91
92             /// <summary>
93             /// Downwards.
94             /// </summary>
95             [EditorBrowsable(EditorBrowsableState.Never)]
96             Down,
97
98             /// <summary>
99             /// Left bound.
100             /// </summary>
101             [EditorBrowsable(EditorBrowsableState.Never)]
102             Left,
103
104             /// <summary>
105             /// Right bound.
106             /// </summary>
107             [EditorBrowsable(EditorBrowsableState.Never)]
108             Right,
109         }
110
111         /// <summary>
112         /// Constructor.
113         /// </summary>
114         /// <param name="direction">Current pan direction</param>
115         /// <param name="displacement">Current total displacement</param>
116         [EditorBrowsable(EditorBrowsableState.Never)]
117         public ScrollOutOfBoundEventArgs(Direction direction, float displacement)
118         {
119             PanDirection = direction;
120             Displacement = displacement;
121         }
122
123         /// <summary>
124         /// Current pan direction of ContentContainer.
125         /// </summary>
126         [EditorBrowsable(EditorBrowsableState.Never)]
127         public Direction PanDirection
128         {
129             get;
130         }
131
132         /// <summary>
133         /// Current total displacement of ContentContainer.
134         /// if its value is greater than 0, it is at the top/left;
135         /// if less than 0, it is at the bottom/right.
136         /// </summary>
137         [EditorBrowsable(EditorBrowsableState.Never)]
138         public float Displacement
139         {
140             get;
141         }
142     }
143
144     /// <summary>
145     /// This class provides a View that can scroll a single View with a layout. This View can be a nest of Views.
146     /// </summary>
147     /// <since_tizen> 8 </since_tizen>
148     public partial class ScrollableBase : Control
149     {
150         static bool LayoutDebugScrollableBase = false; // Debug flag
151         static bool focusDebugScrollableBase = false; // Debug flag
152         private Direction mScrollingDirection = Direction.Vertical;
153         private bool mScrollEnabled = true;
154         private int mScrollDuration = 125;
155         private int mPageWidth = 0;
156         private float mPageFlickThreshold = 0.4f;
157         private float mScrollingEventThreshold = 0.001f;
158         private bool fadeScrollbar = true;
159
160         private class ScrollableBaseCustomLayout : AbsoluteLayout
161         {
162             protected override void OnMeasure(MeasureSpecification widthMeasureSpec, MeasureSpecification heightMeasureSpec)
163             {
164                 MeasuredSize.StateType childWidthState = MeasuredSize.StateType.MeasuredSizeOK;
165                 MeasuredSize.StateType childHeightState = MeasuredSize.StateType.MeasuredSizeOK;
166
167                 Direction scrollingDirection = Direction.Vertical;
168                 ScrollableBase scrollableBase = this.Owner as ScrollableBase;
169                 if (scrollableBase != null)
170                 {
171                     scrollingDirection = scrollableBase.ScrollingDirection;
172                 }
173
174                 float totalWidth = 0.0f;
175                 float totalHeight = 0.0f;
176
177                 // measure child, should be a single scrolling child
178                 foreach (LayoutItem childLayout in LayoutChildren)
179                 {
180                     if (childLayout != null && childLayout.Owner.Name == "ContentContainer")
181                     {
182                         // Get size of child
183                         // Use an Unspecified MeasureSpecification mode so scrolling child is not restricted to it's parents size in Height (for vertical scrolling)
184                         // or Width for horizontal scrolling
185                         if (scrollingDirection == Direction.Vertical)
186                         {
187                             MeasureSpecification unrestrictedMeasureSpec = new MeasureSpecification(heightMeasureSpec.Size, MeasureSpecification.ModeType.Unspecified);
188                             MeasureChildWithMargins(childLayout, widthMeasureSpec, new LayoutLength(0), unrestrictedMeasureSpec, new LayoutLength(0)); // Height unrestricted by parent
189                         }
190                         else
191                         {
192                             MeasureSpecification unrestrictedMeasureSpec = new MeasureSpecification(widthMeasureSpec.Size, MeasureSpecification.ModeType.Unspecified);
193                             MeasureChildWithMargins(childLayout, unrestrictedMeasureSpec, new LayoutLength(0), heightMeasureSpec, new LayoutLength(0)); // Width unrestricted by parent
194                         }
195
196                         totalWidth = (childLayout.MeasuredWidth.Size + (childLayout.Padding.Start + childLayout.Padding.End)).AsDecimal();
197                         totalHeight = (childLayout.MeasuredHeight.Size + (childLayout.Padding.Top + childLayout.Padding.Bottom)).AsDecimal();
198
199                         if (childLayout.MeasuredWidth.State == MeasuredSize.StateType.MeasuredSizeTooSmall)
200                         {
201                             childWidthState = MeasuredSize.StateType.MeasuredSizeTooSmall;
202                         }
203                         if (childLayout.MeasuredHeight.State == MeasuredSize.StateType.MeasuredSizeTooSmall)
204                         {
205                             childHeightState = MeasuredSize.StateType.MeasuredSizeTooSmall;
206                         }
207                     }
208                 }
209
210                 MeasuredSize widthSizeAndState = ResolveSizeAndState(new LayoutLength(totalWidth), widthMeasureSpec, MeasuredSize.StateType.MeasuredSizeOK);
211                 MeasuredSize heightSizeAndState = ResolveSizeAndState(new LayoutLength(totalHeight), heightMeasureSpec, MeasuredSize.StateType.MeasuredSizeOK);
212                 totalWidth = widthSizeAndState.Size.AsDecimal();
213                 totalHeight = heightSizeAndState.Size.AsDecimal();
214
215                 // Ensure layout respects it's given minimum size
216                 totalWidth = Math.Max(totalWidth, SuggestedMinimumWidth.AsDecimal());
217                 totalHeight = Math.Max(totalHeight, SuggestedMinimumHeight.AsDecimal());
218
219                 widthSizeAndState.State = childWidthState;
220                 heightSizeAndState.State = childHeightState;
221
222                 SetMeasuredDimensions(ResolveSizeAndState(new LayoutLength(totalWidth), widthMeasureSpec, childWidthState),
223                     ResolveSizeAndState(new LayoutLength(totalHeight), heightMeasureSpec, childHeightState));
224
225                 // Size of ScrollableBase is changed. Change Page width too.
226                 if (scrollableBase != null)
227                 {
228                     scrollableBase.mPageWidth = (int)MeasuredWidth.Size.AsRoundedValue();
229                     scrollableBase.OnScrollingChildRelayout(null, null);
230                 }
231             }
232         } //  ScrollableBaseCustomLayout
233
234         /// <summary>
235         /// The direction axis to scroll.
236         /// </summary>
237         /// <since_tizen> 8 </since_tizen>
238         public enum Direction
239         {
240             /// <summary>
241             /// Horizontal axis.
242             /// </summary>
243             /// <since_tizen> 8 </since_tizen>
244             Horizontal,
245
246             /// <summary>
247             /// Vertical axis.
248             /// </summary>
249             /// <since_tizen> 8 </since_tizen>
250             Vertical
251         }
252
253         /// <summary>
254         /// Scrolling direction mode.
255         /// Default is Vertical scrolling.
256         /// </summary>
257         /// <since_tizen> 8 </since_tizen>
258         public Direction ScrollingDirection
259         {
260             get
261             {
262                 return (Direction)GetValue(ScrollingDirectionProperty);
263             }
264             set
265             {
266                 SetValue(ScrollingDirectionProperty, value);
267                 NotifyPropertyChanged();
268             }
269         }
270         private Direction InternalScrollingDirection
271         {
272             get
273             {
274                 return mScrollingDirection;
275             }
276             set
277             {
278                 if (value != mScrollingDirection)
279                 {
280                     //Reset scroll position and stop scroll animation
281                     ScrollTo(0, false);
282
283                     mScrollingDirection = value;
284                     mPanGestureDetector.ClearAngles();
285                     mPanGestureDetector.AddDirection(value == Direction.Horizontal ?
286                         PanGestureDetector.DirectionHorizontal : PanGestureDetector.DirectionVertical);
287
288                     ContentContainer.WidthSpecification = ScrollingDirection == Direction.Vertical ? LayoutParamPolicies.MatchParent : LayoutParamPolicies.WrapContent;
289                     ContentContainer.HeightSpecification = ScrollingDirection == Direction.Vertical ? LayoutParamPolicies.WrapContent : LayoutParamPolicies.MatchParent;
290                     SetScrollbar();
291                 }
292             }
293         }
294
295         /// <summary>
296         /// Enable or disable scrolling.
297         /// </summary>
298         /// <since_tizen> 8 </since_tizen>
299         public bool ScrollEnabled
300         {
301             get
302             {
303                 return (bool)GetValue(ScrollEnabledProperty);
304             }
305             set
306             {
307                 SetValue(ScrollEnabledProperty, value);
308                 NotifyPropertyChanged();
309             }
310         }
311         private bool InternalScrollEnabled
312         {
313             get
314             {
315                 return mScrollEnabled;
316             }
317             set
318             {
319                 if (value != mScrollEnabled)
320                 {
321                     mScrollEnabled = value;
322                     if (mScrollEnabled)
323                     {
324                         mPanGestureDetector.Detected += OnPanGestureDetected;
325                     }
326                     else
327                     {
328                         mPanGestureDetector.Detected -= OnPanGestureDetected;
329                     }
330                 }
331             }
332         }
333
334         /// <summary>
335         /// Gets scrollable status.
336         /// </summary>
337         [EditorBrowsable(EditorBrowsableState.Never)]
338         protected override bool AccessibilityIsScrollable()
339         {
340             return true;
341         }
342
343         /// <summary>
344         /// Pages mode, enables moving to the next or return to current page depending on pan displacement.
345         /// Default is false.
346         /// </summary>
347         /// <since_tizen> 8 </since_tizen>
348         public bool SnapToPage
349         {
350             get
351             {
352                 return (bool)GetValue(SnapToPageProperty);
353             }
354             set
355             {
356                 SetValue(SnapToPageProperty, value);
357                 NotifyPropertyChanged();
358             }
359         }
360         private bool InternalSnapToPage { set; get; } = false;
361
362         /// <summary>
363         /// Get current page.
364         /// Working property with SnapToPage property.
365         /// </summary>
366         /// <since_tizen> 8 </since_tizen>
367         public int CurrentPage { get; private set; } = 0;
368
369         /// <summary>
370         /// Duration of scroll animation.
371         /// Default value is 125ms.
372         /// </summary>
373         /// <since_tizen> 8 </since_tizen>
374         public int ScrollDuration
375         {
376             get
377             {
378                 return (int)GetValue(ScrollDurationProperty);
379             }
380             set
381             {
382                 SetValue(ScrollDurationProperty, value);
383                 NotifyPropertyChanged();
384             }
385         }
386         private int InternalScrollDuration
387         {
388             set
389             {
390                 mScrollDuration = value >= 0 ? value : mScrollDuration;
391             }
392             get
393             {
394                 return mScrollDuration;
395             }
396         }
397
398         /// <summary>
399         /// Scroll Available area.
400         /// </summary>
401         /// <since_tizen> 8 </since_tizen>
402         public Vector2 ScrollAvailableArea
403         {
404             get
405             {
406                 return GetValue(ScrollAvailableAreaProperty) as Vector2;
407             }
408             set
409             {
410                 SetValue(ScrollAvailableAreaProperty, value);
411                 NotifyPropertyChanged();
412             }
413         }
414         private Vector2 InternalScrollAvailableArea { set; get; }
415
416         /// <summary>
417         /// An event emitted when user starts dragging ScrollableBase, user can subscribe or unsubscribe to this event handler.<br />
418         /// </summary>
419         /// <since_tizen> 8 </since_tizen>
420         public event EventHandler<ScrollEventArgs> ScrollDragStarted;
421
422         /// <summary>
423         /// An event emitted when user stops dragging ScrollableBase, user can subscribe or unsubscribe to this event handler.<br />
424         /// </summary>
425         /// <since_tizen> 8 </since_tizen>
426         public event EventHandler<ScrollEventArgs> ScrollDragEnded;
427
428         /// <summary>
429         /// An event emitted when the scrolling slide animation starts, user can subscribe or unsubscribe to this event handler.<br />
430         /// </summary>
431         /// <since_tizen> 8 </since_tizen>
432         public event EventHandler<ScrollEventArgs> ScrollAnimationStarted;
433
434         /// <summary>
435         /// An event emitted when the scrolling slide animation ends, user can subscribe or unsubscribe to this event handler.<br />
436         /// </summary>
437         /// <since_tizen> 8 </since_tizen>
438         public event EventHandler<ScrollEventArgs> ScrollAnimationEnded;
439
440         /// <summary>
441         /// An event emitted when scrolling, user can subscribe or unsubscribe to this event handler.<br />
442         /// </summary>
443         /// <since_tizen> 8 </since_tizen>
444         public event EventHandler<ScrollEventArgs> Scrolling;
445
446         /// <summary>
447         /// An event emitted when scrolling out of bound, user can subscribe or unsubscribe to this event handler.<br />
448         /// </summary>
449         [EditorBrowsable(EditorBrowsableState.Never)]
450         public event EventHandler<ScrollOutOfBoundEventArgs> ScrollOutOfBound;
451
452         /// <summary>
453         /// Scrollbar for ScrollableBase.
454         /// </summary>
455         /// <since_tizen> 8 </since_tizen>
456         public ScrollbarBase Scrollbar
457         {
458             get
459             {
460                 return GetValue(ScrollbarProperty) as ScrollbarBase;
461             }
462             set
463             {
464                 SetValue(ScrollbarProperty, value);
465                 NotifyPropertyChanged();
466             }
467         }
468         private ScrollbarBase InternalScrollbar
469         {
470             get
471             {
472                 return scrollBar;
473             }
474             set
475             {
476                 if (scrollBar)
477                 {
478                     base.Remove(scrollBar);
479                 }
480                 scrollBar = value;
481
482                 if (scrollBar != null)
483                 {
484                     scrollBar.Name = "ScrollBar";
485                     base.Add(scrollBar);
486
487                     if (hideScrollbar)
488                     {
489                         scrollBar.Hide();
490                     }
491                     else
492                     {
493                         scrollBar.Show();
494                     }
495
496                     SetScrollbar();
497                 }
498             }
499         }
500
501         /// <summary>
502         /// Always hide Scrollbar.
503         /// </summary>
504         /// <since_tizen> 8 </since_tizen>
505         public bool HideScrollbar
506         {
507             get
508             {
509                 return (bool)GetValue(HideScrollbarProperty);
510             }
511             set
512             {
513                 SetValue(HideScrollbarProperty, value);
514                 NotifyPropertyChanged();
515             }
516         }
517         private bool InternalHideScrollbar
518         {
519             get
520             {
521                 return hideScrollbar;
522             }
523             set
524             {
525                 hideScrollbar = value;
526
527                 if (scrollBar)
528                 {
529                     if (value)
530                     {
531                         scrollBar.Hide();
532                     }
533                     else
534                     {
535                         scrollBar.Show();
536                         if (fadeScrollbar)
537                         {
538                             scrollBar.Opacity = 1.0f;
539                             scrollBar.FadeOut();
540                         }
541                     }
542                 }
543             }
544         }
545
546         /// <summary>
547         /// The boolean flag for automatic fading Scrollbar.
548         /// Scrollbar will be faded out when scroll stay in certain position longer than the threshold.
549         /// Scrollbar will be faded in scroll position changes.
550         /// </summary>
551         [EditorBrowsable(EditorBrowsableState.Never)]
552         public bool FadeScrollbar
553         {
554             get => (bool)GetValue(FadeScrollbarProperty);
555             set => SetValue(FadeScrollbarProperty, value);
556         }
557
558         private bool InternalFadeScrollbar
559         {
560             get
561             {
562                 return fadeScrollbar;
563             }
564             set
565             {
566                 fadeScrollbar = value;
567
568                 if (scrollBar != null && !hideScrollbar)
569                 {
570                     if (value)
571                     {
572                         scrollBar.FadeOut();
573                     }
574                     else
575                     {
576                         scrollBar.Opacity = 1.0f;
577                         // Removing fadeout timer and animation.
578                         scrollBar.FadeIn();
579                     }
580                 }
581             }
582         }
583
584         /// <summary>
585         /// Container which has content of ScrollableBase.
586         /// </summary>
587         /// <since_tizen> 8 </since_tizen>
588         public View ContentContainer { get; private set; }
589
590         /// <summary>
591         /// Set the layout on this View. Replaces any existing Layout.
592         /// </summary>
593         /// <since_tizen> 8 </since_tizen>
594         public new LayoutItem Layout
595         {
596             get
597             {
598                 return GetValue(LayoutProperty) as LayoutItem;
599             }
600             set
601             {
602                 SetValue(LayoutProperty, value);
603                 NotifyPropertyChanged();
604             }
605         }
606         private LayoutItem InternalLayout
607         {
608             get
609             {
610                 return ContentContainer.Layout;
611             }
612             set
613             {
614                 ContentContainer.Layout = value;
615             }
616         }
617
618         /// <summary>
619         /// List of children of Container.
620         /// </summary>
621         /// <since_tizen> 8 </since_tizen>
622         public new List<View> Children
623         {
624             get
625             {
626                 return ContentContainer.Children;
627             }
628         }
629
630         /// <summary>
631         /// Deceleration rate of scrolling by finger.
632         /// Rate should be bigger than 0 and smaller than 1.
633         /// Default value is 0.998f;
634         /// </summary>
635         /// <since_tizen> 8 </since_tizen>
636         public float DecelerationRate
637         {
638             get
639             {
640                 return (float)GetValue(DecelerationRateProperty);
641             }
642             set
643             {
644                 SetValue(DecelerationRateProperty, value);
645                 NotifyPropertyChanged();
646             }
647         }
648         private float InternalDecelerationRate
649         {
650             get
651             {
652                 return decelerationRate;
653             }
654             set
655             {
656                 decelerationRate = (value < 1 && value > 0) ? value : decelerationRate;
657                 logValueOfDeceleration = (float)Math.Log(value);
658             }
659         }
660
661         /// <summary>
662         /// Threshold not to go infinite at the end of scrolling animation.
663         /// </summary>
664         [EditorBrowsable(EditorBrowsableState.Never)]
665         public float DecelerationThreshold
666         {
667             get
668             {
669                 return (float)GetValue(DecelerationThresholdProperty);
670             }
671             set
672             {
673                 SetValue(DecelerationThresholdProperty, value);
674                 NotifyPropertyChanged();
675             }
676         }
677         private float InternalDecelerationThreshold { get; set; } = 0.1f;
678
679         /// <summary>
680         /// Scrolling event will be thrown when this amount of scroll position is changed.
681         /// If this threshold becomes smaller, the tracking detail increases but the scrolling range that can be tracked becomes smaller.
682         /// If large sized ContentContainer is required, please use larger threshold value.
683         /// Default ScrollingEventThreshold value is 0.001f.
684         /// </summary>
685         [EditorBrowsable(EditorBrowsableState.Never)]
686         public float ScrollingEventThreshold
687         {
688             get
689             {
690                 return (float)GetValue(ScrollingEventThresholdProperty);
691             }
692             set
693             {
694                 SetValue(ScrollingEventThresholdProperty, value);
695                 NotifyPropertyChanged();
696             }
697         }
698         private float InternalScrollingEventThreshold
699         {
700             get
701             {
702                 return mScrollingEventThreshold;
703             }
704             set
705             {
706                 if (mScrollingEventThreshold != value && value > 0)
707                 {
708                     ContentContainer.RemovePropertyNotification(propertyNotification);
709                     propertyNotification = ContentContainer.AddPropertyNotification("position", PropertyCondition.Step(value));
710                     propertyNotification.Notified += OnPropertyChanged;
711                     mScrollingEventThreshold = value;
712                 }
713             }
714         }
715
716         /// <summary>
717         /// Page will be changed when velocity of panning is over threshold.
718         /// The unit of threshold is pixel per millisecond.
719         /// </summary>
720         /// <since_tizen> 8 </since_tizen>
721         public float PageFlickThreshold
722         {
723             get
724             {
725                 return (float)GetValue(PageFlickThresholdProperty);
726             }
727             set
728             {
729                 SetValue(PageFlickThresholdProperty, value);
730                 NotifyPropertyChanged();
731             }
732         }
733         private float InternalPageFlickThreshold
734         {
735             get
736             {
737                 return mPageFlickThreshold;
738             }
739             set
740             {
741                 mPageFlickThreshold = value >= 0f ? value : mPageFlickThreshold;
742             }
743         }
744
745         /// <summary>
746         /// Padding for the ScrollableBase
747         /// </summary>
748         [EditorBrowsable(EditorBrowsableState.Never)]
749         public new Extents Padding
750         {
751             get
752             {
753                 return GetValue(PaddingProperty) as Extents;
754             }
755             set
756             {
757                 SetValue(PaddingProperty, value);
758                 NotifyPropertyChanged();
759             }
760         }
761         private Extents InternalPadding
762         {
763             get
764             {
765                 return ContentContainer.Padding;
766             }
767             set
768             {
769                 ContentContainer.Padding = value;
770             }
771         }
772
773         /// <summary>
774         /// Alphafunction for scroll animation.
775         /// </summary>
776         [EditorBrowsable(EditorBrowsableState.Never)]
777         public AlphaFunction ScrollAlphaFunction
778         {
779             get
780             {
781                 return GetValue(ScrollAlphaFunctionProperty) as AlphaFunction;
782             }
783             set
784             {
785                 SetValue(ScrollAlphaFunctionProperty, value);
786                 NotifyPropertyChanged();
787             }
788         }
789         private AlphaFunction InternalScrollAlphaFunction { get; set; } = new AlphaFunction(AlphaFunction.BuiltinFunctions.Linear);
790
791         private bool hideScrollbar = true;
792         private float maxScrollDistance;
793         private float childTargetPosition = 0.0f;
794         private PanGestureDetector mPanGestureDetector;
795         private ScrollbarBase scrollBar;
796         private bool scrolling = false;
797         private float ratioOfScreenWidthToCompleteScroll = 0.5f;
798         private float totalDisplacementForPan = 0.0f;
799         private Size previousContainerSize = new Size();
800         private Size previousSize = new Size();
801         private PropertyNotification propertyNotification;
802         private float noticeAnimationEndBeforePosition = 0.0f;
803         private bool readyToNotice = false;
804
805         /// <summary>
806         /// Notice before animation is finished.
807         /// </summary>
808         [EditorBrowsable(EditorBrowsableState.Never)]
809         // Let's consider more whether this needs to be set as protected.
810         public float NoticeAnimationEndBeforePosition
811         {
812             get
813             {
814                 return (float)GetValue(NoticeAnimationEndBeforePositionProperty);
815             }
816             set
817             {
818                 SetValue(NoticeAnimationEndBeforePositionProperty, value);
819                 NotifyPropertyChanged();
820             }
821         }
822         private float InternalNoticeAnimationEndBeforePosition
823         {
824             get => noticeAnimationEndBeforePosition;
825             set => noticeAnimationEndBeforePosition = value;
826         }
827
828         /// <summary>
829         /// Step scroll move distance.
830         /// Key focus originally moves focusable objects, but in ScrollableBase,
831         /// if focusable object is too far or un-exist and ScrollableBase is focusable,
832         /// it can scroll move itself by key input.
833         /// this value decide how long distance will it moves in one step.
834         /// if any value is not set, step will be moved quater size of ScrollableBase length.
835         /// </summary>
836         [EditorBrowsable(EditorBrowsableState.Never)]
837         public float StepScrollDistance
838         {
839             get
840             {
841                 return (float)GetValue(StepScrollDistanceProperty);
842             }
843             set
844             {
845                 SetValue(StepScrollDistanceProperty, value);
846                 NotifyPropertyChanged();
847             }
848         }
849         private float stepScrollDistance = 0f;
850
851         /// <summary>
852         /// Wheel scroll move distance.
853         /// This value decide how long distance will it moves in wheel event.
854         /// </summary>
855         [EditorBrowsable(EditorBrowsableState.Never)]
856         public float WheelScrollDistance
857         {
858             get
859             {
860                 return (float)GetValue(WheelScrollDistanceProperty);
861             }
862             set
863             {
864                 SetValue(WheelScrollDistanceProperty, value);
865                 NotifyPropertyChanged();
866             }
867         }
868         private float wheelScrollDistance = 50f;
869
870
871         // Let's consider more whether this needs to be set as protected.
872         private float finalTargetPosition;
873
874         private Animation scrollAnimation;
875         // Declare user alpha function delegate
876         [UnmanagedFunctionPointer(CallingConvention.StdCall)]
877         private delegate float UserAlphaFunctionDelegate(float progress);
878         private UserAlphaFunctionDelegate customScrollAlphaFunction;
879         private float velocityOfLastPan = 0.0f;
880         private float panAnimationDuration = 0.0f;
881         private float panAnimationDelta = 0.0f;
882         private float logValueOfDeceleration = 0.0f;
883         private float decelerationRate = 0.0f;
884
885         private View topOverShootingShadowView;
886         private View bottomOverShootingShadowView;
887         private View leftOverShootingShadowView;
888         private View rightOverShootingShadowView;
889         private const int overShootingShadowScaleHeightLimit = 64 * 3;
890         private const int overShootingShadowAnimationDuration = 300;
891         private Animation overShootingShadowAnimation;
892         private bool isOverShootingShadowShown = false;
893         private float startShowShadowDisplacement;
894
895         private void Initialize()
896         {
897             DecelerationRate = 0.998f;
898
899             base.Layout = new ScrollableBaseCustomLayout();
900             mPanGestureDetector = new PanGestureDetector();
901             mPanGestureDetector.Attach(this);
902             mPanGestureDetector.AddDirection(PanGestureDetector.DirectionVertical);
903             if (mPanGestureDetector.GetMaximumTouchesRequired() < 2) mPanGestureDetector.SetMaximumTouchesRequired(2);
904             mPanGestureDetector.Detected += OnPanGestureDetected;
905
906             ClippingMode = ClippingModeType.ClipToBoundingBox;
907
908             //Default Scrolling child
909             ContentContainer = new View()
910             {
911                 Name = "ContentContainer",
912                 WidthSpecification = ScrollingDirection == Direction.Vertical ? LayoutParamPolicies.MatchParent : LayoutParamPolicies.WrapContent,
913                 HeightSpecification = ScrollingDirection == Direction.Vertical ? LayoutParamPolicies.WrapContent : LayoutParamPolicies.MatchParent,
914             };
915             // Check if children's sizes change to update Scrollbar
916             ContentContainer.Relayout += OnScrollingChildRelayout;
917             propertyNotification = ContentContainer.AddPropertyNotification("position", PropertyCondition.Step(mScrollingEventThreshold));
918             propertyNotification.Notified += OnPropertyChanged;
919             base.Add(ContentContainer);
920             // Check if ScrollableBase's size changes to update Scrollbar
921             base.Relayout += OnScrollingChildRelayout;
922
923             Scrollbar = new Scrollbar();
924
925             //Show vertical shadow on the top (or bottom) of the scrollable when panning down (or up).
926             topOverShootingShadowView = new View
927             {
928                 BackgroundImage = FrameworkInformation.ResourcePath + "nui_component_default_scroll_over_shooting_top.png",
929                 Opacity = 1.0f,
930                 SizeHeight = 0.0f,
931                 PositionUsesPivotPoint = true,
932                 ParentOrigin = NUI.ParentOrigin.TopCenter,
933                 PivotPoint = NUI.PivotPoint.TopCenter,
934             };
935             bottomOverShootingShadowView = new View
936             {
937                 BackgroundImage = FrameworkInformation.ResourcePath + "nui_component_default_scroll_over_shooting_bottom.png",
938                 Opacity = 1.0f,
939                 SizeHeight = 0.0f,
940                 PositionUsesPivotPoint = true,
941                 ParentOrigin = NUI.ParentOrigin.BottomCenter,
942                 PivotPoint = NUI.PivotPoint.BottomCenter,
943             };
944             //Show horizontal shadow on the left (or right) of the scrollable when panning down (or up).
945             leftOverShootingShadowView = new View
946             {
947                 BackgroundImage = FrameworkInformation.ResourcePath + "nui_component_default_scroll_over_shooting_left.png",
948                 Opacity = 1.0f,
949                 SizeWidth = 0.0f,
950                 PositionUsesPivotPoint = true,
951                 ParentOrigin = NUI.ParentOrigin.CenterLeft,
952                 PivotPoint = NUI.PivotPoint.CenterLeft,
953             };
954             rightOverShootingShadowView = new View
955             {
956                 BackgroundImage = FrameworkInformation.ResourcePath + "nui_component_default_scroll_over_shooting_right.png",
957                 Opacity = 1.0f,
958                 SizeWidth = 0.0f,
959                 PositionUsesPivotPoint = true,
960                 ParentOrigin = NUI.ParentOrigin.CenterRight,
961                 PivotPoint = NUI.PivotPoint.CenterRight,
962             };
963
964             WheelEvent += OnWheelEvent;
965
966             AccessibilityManager.Instance.SetAccessibilityAttribute(this, AccessibilityManager.AccessibilityAttribute.Trait, "ScrollableBase");
967
968             SetKeyboardNavigationSupport(true);
969         }
970
971         /// <summary>
972         /// Default Constructor
973         /// </summary>
974         /// <since_tizen> 8 </since_tizen>
975         public ScrollableBase() : base()
976         {
977             Initialize();
978         }
979
980         /// <summary>
981         /// Creates a new instance of a ScrollableBase with style.
982         /// </summary>
983         /// <param name="style">A style applied to the newly created ScrollableBase.</param>
984         [EditorBrowsable(EditorBrowsableState.Never)]
985         public ScrollableBase(ControlStyle style) : base(style)
986         {
987             Initialize();
988         }
989
990         private bool OnInterruptTouchingChildTouched(object source, View.TouchEventArgs args)
991         {
992             if (args.Touch.GetState(0) == PointStateType.Down)
993             {
994                 if (scrolling && !SnapToPage)
995                 {
996                     StopScroll();
997                 }
998             }
999             return true;
1000         }
1001
1002         private void OnPropertyChanged(object source, PropertyNotification.NotifyEventArgs args)
1003         {
1004             OnScroll();
1005         }
1006
1007         /// <summary>
1008         /// Called after a child has been added to the owning view.
1009         /// </summary>
1010         /// <param name="view">The child which has been added.</param>
1011         /// <since_tizen> 8 </since_tizen>
1012         public override void Add(View view)
1013         {
1014             ContentContainer.Add(view);
1015         }
1016
1017         /// <summary>
1018         /// Called after a child has been removed from the owning view.
1019         /// </summary>
1020         /// <param name="view">The child which has been removed.</param>
1021         /// <since_tizen> 8 </since_tizen>
1022         public override void Remove(View view)
1023         {
1024             if (SnapToPage && CurrentPage == Children.IndexOf(view) && CurrentPage == Children.Count - 1 && Children.Count > 1)
1025             {
1026                 // Target View is current page and also last child.
1027                 // CurrentPage should be changed to previous page.
1028                 ScrollToIndex(CurrentPage - 1);
1029             }
1030
1031             ContentContainer.Remove(view);
1032         }
1033
1034         private void OnScrollingChildRelayout(object source, EventArgs args)
1035         {
1036             // Size is changed. Calculate maxScrollDistance.
1037             bool isSizeChanged = previousContainerSize.Width != ContentContainer.Size.Width || previousContainerSize.Height != ContentContainer.Size.Height ||
1038                 previousSize.Width != Size.Width || previousSize.Height != Size.Height;
1039
1040             if (isSizeChanged)
1041             {
1042                 maxScrollDistance = CalculateMaximumScrollDistance();
1043                 if (!ReviseContainerPositionIfNeed())
1044                 {
1045                     UpdateScrollbar();
1046                 }
1047             }
1048
1049             previousContainerSize = new Size(ContentContainer.Size);
1050             previousSize = new Size(Size);
1051         }
1052
1053         private bool ReviseContainerPositionIfNeed()
1054         {
1055             bool isHorizontal = ScrollingDirection == Direction.Horizontal;
1056             float currentPosition = isHorizontal ? ContentContainer.CurrentPosition.X : ContentContainer.CurrentPosition.Y;
1057
1058             if (Math.Abs(currentPosition) > maxScrollDistance)
1059             {
1060                 StopScroll();
1061                 var targetPosition = BoundScrollPosition(-maxScrollDistance);
1062                 if (isHorizontal) ContentContainer.PositionX = targetPosition;
1063                 else ContentContainer.PositionY = targetPosition;
1064                 return true;
1065             }
1066
1067             return false;
1068         }
1069
1070         /// <summary>
1071         /// The composition of a Scrollbar can vary depending on how you use ScrollableBase.
1072         /// Set the composition that will go into the ScrollableBase according to your ScrollableBase.
1073         /// </summary>
1074         /// <since_tizen> 8 </since_tizen>
1075         [EditorBrowsable(EditorBrowsableState.Never)]
1076         protected virtual void SetScrollbar()
1077         {
1078             if (Scrollbar)
1079             {
1080                 bool isHorizontal = ScrollingDirection == Direction.Horizontal;
1081                 float contentLength = isHorizontal ? ContentContainer.Size.Width : ContentContainer.Size.Height;
1082                 float viewportLength = isHorizontal ? Size.Width : Size.Height;
1083                 float currentPosition = isHorizontal ? ContentContainer.CurrentPosition.X : ContentContainer.CurrentPosition.Y;
1084                 Scrollbar.Initialize(contentLength, viewportLength, -currentPosition, isHorizontal);
1085             }
1086         }
1087
1088         /// Update scrollbar position and size.
1089         [EditorBrowsable(EditorBrowsableState.Never)]
1090         protected virtual void UpdateScrollbar()
1091         {
1092             if (Scrollbar)
1093             {
1094                 bool isHorizontal = ScrollingDirection == Direction.Horizontal;
1095                 float contentLength = isHorizontal ? ContentContainer.Size.Width : ContentContainer.Size.Height;
1096                 float viewportLength = isHorizontal ? Size.Width : Size.Height;
1097                 float currentPosition = isHorizontal ? ContentContainer.CurrentPosition.X : ContentContainer.CurrentPosition.Y;
1098                 Scrollbar.Update(contentLength, viewportLength, -currentPosition);
1099
1100                 if (!hideScrollbar && fadeScrollbar)
1101                 {
1102                     Scrollbar.FadeOut();
1103                 }
1104             }
1105         }
1106
1107         /// <summary>
1108         /// Scrolls to the item at the specified index.
1109         /// </summary>
1110         /// <param name="index">Index of item.</param>
1111         /// <since_tizen> 8 </since_tizen>
1112         public void ScrollToIndex(int index)
1113         {
1114             if (ContentContainer.ChildCount - 1 < index || index < 0)
1115             {
1116                 return;
1117             }
1118
1119             if (SnapToPage)
1120             {
1121                 CurrentPage = index;
1122             }
1123
1124             float targetPosition = Math.Min(ScrollingDirection == Direction.Vertical ? Children[index].Position.Y : Children[index].Position.X, maxScrollDistance);
1125             AnimateChildTo(ScrollDuration, -targetPosition);
1126         }
1127
1128         internal void ScrollToChild(View child, bool anim = false)
1129         {
1130             if (null == FindDescendantByID(child.ID)) return;
1131
1132             bool isHorizontal = (ScrollingDirection == Direction.Horizontal);
1133
1134             float viewScreenPosition = (isHorizontal ? ScreenPosition.X : ScreenPosition.Y);
1135             float childScreenPosition = (isHorizontal ? child.ScreenPosition.X : child.ScreenPosition.Y);
1136             float scrollPosition = (isHorizontal ? ScrollPosition.X : ScrollPosition.Y);
1137             float viewSize = (isHorizontal ? SizeWidth : SizeHeight);
1138             float childSize = (isHorizontal ? child.SizeWidth : child.SizeHeight);
1139
1140             if (viewScreenPosition > childScreenPosition ||
1141                 viewScreenPosition + viewSize < childScreenPosition + childSize)
1142             {// if object is outside
1143                 float targetPosition;
1144                 float dist = viewScreenPosition - childScreenPosition;
1145                 if (dist > 0)
1146                 {// if object is upper side
1147                     targetPosition = scrollPosition - dist;
1148                 }
1149                 else
1150                 {// if object is down side
1151                     targetPosition = scrollPosition - dist + childSize - viewSize;
1152                 }
1153                 ScrollTo(targetPosition, anim);
1154             }
1155         }
1156
1157         private void OnScrollDragStarted()
1158         {
1159             ScrollEventArgs eventArgs = new ScrollEventArgs(ContentContainer.CurrentPosition);
1160             ScrollDragStarted?.Invoke(this, eventArgs);
1161             EmitScrollStartedEvent();
1162
1163             if (!hideScrollbar && fadeScrollbar)
1164             {
1165                 scrollBar?.FadeIn();
1166             }
1167         }
1168
1169         private void OnScrollDragEnded()
1170         {
1171             ScrollEventArgs eventArgs = new ScrollEventArgs(ContentContainer.CurrentPosition);
1172             ScrollDragEnded?.Invoke(this, eventArgs);
1173             EmitScrollFinishedEvent();
1174
1175             if (!hideScrollbar && fadeScrollbar)
1176             {
1177                 scrollBar?.FadeOut();
1178             }
1179         }
1180
1181         private void OnScrollAnimationStarted()
1182         {
1183             ScrollEventArgs eventArgs = new ScrollEventArgs(ContentContainer.CurrentPosition);
1184             ScrollAnimationStarted?.Invoke(this, eventArgs);
1185             EmitScrollStartedEvent();
1186
1187             if (!hideScrollbar && fadeScrollbar)
1188             {
1189                 scrollBar?.FadeIn();
1190             }
1191         }
1192
1193         private void OnScrollAnimationEnded()
1194         {
1195             scrolling = false;
1196             this.InterceptTouchEvent -= OnInterruptTouchingChildTouched;
1197
1198             ScrollEventArgs eventArgs = new ScrollEventArgs(ContentContainer.CurrentPosition);
1199             ScrollAnimationEnded?.Invoke(this, eventArgs);
1200             EmitScrollFinishedEvent();
1201
1202             if (!hideScrollbar && fadeScrollbar)
1203             {
1204                 scrollBar?.FadeOut();
1205             }
1206         }
1207
1208         private void OnScroll()
1209         {
1210             ScrollEventArgs eventArgs = new ScrollEventArgs(ContentContainer.CurrentPosition);
1211             Scrolling?.Invoke(this, eventArgs);
1212
1213             bool isHorizontal = ScrollingDirection == Direction.Horizontal;
1214             float contentLength = isHorizontal ? ContentContainer.Size.Width : ContentContainer.Size.Height;
1215             float currentPosition = isHorizontal ? ContentContainer.CurrentPosition.X : ContentContainer.CurrentPosition.Y;
1216
1217             scrollBar?.Update(contentLength, Math.Abs(currentPosition));
1218             CheckPreReachedTargetPosition();
1219         }
1220
1221         private void CheckPreReachedTargetPosition()
1222         {
1223             // Check whether we reached pre-reached target position
1224             if (readyToNotice &&
1225                 ContentContainer.CurrentPosition.Y <= finalTargetPosition + NoticeAnimationEndBeforePosition &&
1226                 ContentContainer.CurrentPosition.Y >= finalTargetPosition - NoticeAnimationEndBeforePosition)
1227             {
1228                 //Notice first
1229                 readyToNotice = false;
1230                 OnPreReachedTargetPosition(finalTargetPosition);
1231             }
1232         }
1233
1234         /// <summary>
1235         /// This helps developer who wants to know before scroll is reaching target position.
1236         /// </summary>
1237         /// <param name="targetPosition">Index of item.</param>
1238         /// This may be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API
1239         [EditorBrowsable(EditorBrowsableState.Never)]
1240         protected virtual void OnPreReachedTargetPosition(float targetPosition)
1241         {
1242
1243         }
1244
1245         private void StopScroll()
1246         {
1247             if (scrollAnimation != null)
1248             {
1249                 if (scrollAnimation.State == Animation.States.Playing)
1250                 {
1251                     Debug.WriteLineIf(LayoutDebugScrollableBase, "StopScroll Animation Playing");
1252                     scrollAnimation.Stop(Animation.EndActions.Cancel);
1253                     OnScrollAnimationEnded();
1254                 }
1255                 scrollAnimation.Clear();
1256             }
1257         }
1258
1259         private void AnimateChildTo(int duration, float axisPosition)
1260         {
1261             Debug.WriteLineIf(LayoutDebugScrollableBase, "AnimationTo Animation Duration:" + duration + " Destination:" + axisPosition);
1262             finalTargetPosition = axisPosition;
1263
1264             StopScroll(); // Will replace previous animation so will stop existing one.
1265
1266             if (scrollAnimation == null)
1267             {
1268                 scrollAnimation = new Animation();
1269                 scrollAnimation.Finished += ScrollAnimationFinished;
1270             }
1271
1272             scrollAnimation.Duration = duration;
1273             scrollAnimation.DefaultAlphaFunction = new AlphaFunction(AlphaFunction.BuiltinFunctions.EaseOutSquare);
1274             scrollAnimation.AnimateTo(ContentContainer, (ScrollingDirection == Direction.Horizontal) ? "PositionX" : "PositionY", axisPosition, ScrollAlphaFunction);
1275             scrolling = true;
1276             OnScrollAnimationStarted();
1277             scrollAnimation.Play();
1278         }
1279
1280         /// <summary>
1281         /// Scroll to specific position with or without animation.
1282         /// </summary>
1283         /// <param name="position">Destination.</param>
1284         /// <param name="animate">Scroll with or without animation</param>
1285         /// <since_tizen> 8 </since_tizen>
1286         public void ScrollTo(float position, bool animate)
1287         {
1288             StopScroll();
1289             float currentPositionX = ContentContainer.CurrentPosition.X != 0 ? ContentContainer.CurrentPosition.X : ContentContainer.Position.X;
1290             float currentPositionY = ContentContainer.CurrentPosition.Y != 0 ? ContentContainer.CurrentPosition.Y : ContentContainer.Position.Y;
1291             float delta = ScrollingDirection == Direction.Horizontal ? currentPositionX : currentPositionY;
1292             // The argument position is the new pan position. So the new position of ScrollableBase becomes (-position).
1293             // To move ScrollableBase's position to (-position), it moves by (-position - currentPosition).
1294             delta = -position - delta;
1295
1296             ScrollBy(delta, animate);
1297         }
1298
1299         private float BoundScrollPosition(float targetPosition)
1300         {
1301             if (ScrollAvailableArea != null)
1302             {
1303                 float minScrollPosition = ScrollAvailableArea.X;
1304                 float maxScrollPosition = ScrollAvailableArea.Y;
1305
1306                 targetPosition = Math.Min(-minScrollPosition, targetPosition);
1307                 targetPosition = Math.Max(-maxScrollPosition, targetPosition);
1308             }
1309             else
1310             {
1311                 targetPosition = Math.Min(0, targetPosition);
1312                 targetPosition = Math.Max(-maxScrollDistance, targetPosition);
1313             }
1314
1315             return targetPosition;
1316         }
1317
1318         private void ScrollBy(float displacement, bool animate)
1319         {
1320             if (GetChildCount() == 0 || maxScrollDistance < 0)
1321             {
1322                 return;
1323             }
1324
1325             float childCurrentPosition = (ScrollingDirection == Direction.Horizontal) ? ContentContainer.PositionX : ContentContainer.PositionY;
1326
1327             Debug.WriteLineIf(LayoutDebugScrollableBase, "ScrollBy childCurrentPosition:" + childCurrentPosition +
1328                 " displacement:" + displacement,
1329                 " maxScrollDistance:" + maxScrollDistance);
1330
1331             childTargetPosition = childCurrentPosition + displacement; // child current position + gesture displacement
1332
1333             Debug.WriteLineIf(LayoutDebugScrollableBase, "ScrollBy currentAxisPosition:" + childCurrentPosition + "childTargetPosition:" + childTargetPosition);
1334
1335             if (animate)
1336             {
1337                 // Calculate scroll animation duration
1338                 float scrollDistance = Math.Abs(displacement);
1339                 readyToNotice = true;
1340
1341                 AnimateChildTo(ScrollDuration, BoundScrollPosition(AdjustTargetPositionOfScrollAnimation(BoundScrollPosition(childTargetPosition))));
1342             }
1343             else
1344             {
1345                 StopScroll();
1346                 finalTargetPosition = BoundScrollPosition(childTargetPosition);
1347
1348                 // Set position of scrolling child without an animation
1349                 if (ScrollingDirection == Direction.Horizontal)
1350                 {
1351                     ContentContainer.PositionX = finalTargetPosition;
1352                 }
1353                 else
1354                 {
1355                     ContentContainer.PositionY = finalTargetPosition;
1356                 }
1357             }
1358         }
1359
1360         /// <summary>
1361         /// you can override it to clean-up your own resources.
1362         /// </summary>
1363         /// <param name="type">DisposeTypes</param>
1364         /// This will be public opened in tizen_5.5 after ACR done. Before ACR, need to be hidden as inhouse API.
1365         [EditorBrowsable(EditorBrowsableState.Never)]
1366         protected override void Dispose(DisposeTypes type)
1367         {
1368             if (disposed)
1369             {
1370                 return;
1371             }
1372
1373             StopOverShootingShadowAnimation();
1374             StopScroll();
1375
1376             if (type == DisposeTypes.Explicit)
1377             {
1378                 mPanGestureDetector?.Dispose();
1379                 mPanGestureDetector = null;
1380
1381                 ContentContainer?.RemovePropertyNotification(propertyNotification);
1382                 propertyNotification?.Dispose();
1383                 propertyNotification = null;
1384             }
1385
1386             WheelEvent -= OnWheelEvent;
1387
1388             if (type == DisposeTypes.Explicit)
1389             {
1390
1391             }
1392             base.Dispose(type);
1393         }
1394
1395         private float CalculateMaximumScrollDistance()
1396         {
1397             float scrollingChildLength = 0;
1398             float scrollerLength = 0;
1399             if (ScrollingDirection == Direction.Horizontal)
1400             {
1401                 Debug.WriteLineIf(LayoutDebugScrollableBase, "Horizontal");
1402
1403                 scrollingChildLength = ContentContainer.Size.Width;
1404                 scrollerLength = Size.Width;
1405             }
1406             else
1407             {
1408                 Debug.WriteLineIf(LayoutDebugScrollableBase, "Vertical");
1409                 scrollingChildLength = ContentContainer.Size.Height;
1410                 scrollerLength = Size.Height;
1411             }
1412
1413             Debug.WriteLineIf(LayoutDebugScrollableBase, "ScrollBy maxScrollDistance:" + (scrollingChildLength - scrollerLength) +
1414                 " parent length:" + scrollerLength +
1415                 " scrolling child length:" + scrollingChildLength);
1416
1417             return Math.Max(scrollingChildLength - scrollerLength, 0);
1418         }
1419
1420         private void PageSnap(float velocity)
1421         {
1422             float destination;
1423
1424             Debug.WriteLineIf(LayoutDebugScrollableBase, "PageSnap with pan candidate totalDisplacement:" + totalDisplacementForPan +
1425                 " currentPage[" + CurrentPage + "]");
1426
1427             //Increment current page if total displacement enough to warrant a page change.
1428             if (Math.Abs(totalDisplacementForPan) > (mPageWidth * ratioOfScreenWidthToCompleteScroll))
1429             {
1430                 if (totalDisplacementForPan < 0)
1431                 {
1432                     CurrentPage = Math.Min(Math.Max(Children.Count - 1, 0), ++CurrentPage);
1433                 }
1434                 else
1435                 {
1436                     CurrentPage = Math.Max(0, --CurrentPage);
1437                 }
1438             }
1439             else if (Math.Abs(velocity) > PageFlickThreshold)
1440             {
1441                 if (velocity < 0)
1442                 {
1443                     CurrentPage = Math.Min(Math.Max(Children.Count - 1, 0), ++CurrentPage);
1444                 }
1445                 else
1446                 {
1447                     CurrentPage = Math.Max(0, --CurrentPage);
1448                 }
1449             }
1450
1451             // Animate to new page or reposition to current page
1452             if (ScrollingDirection == Direction.Horizontal)
1453                 destination = -(Children[CurrentPage].Position.X + Children[CurrentPage].CurrentSize.Width / 2 - CurrentSize.Width / 2); // set to middle of current page
1454             else
1455                 destination = -(Children[CurrentPage].Position.Y + Children[CurrentPage].CurrentSize.Height / 2 - CurrentSize.Height / 2);
1456
1457             AnimateChildTo(ScrollDuration, destination);
1458         }
1459
1460         /// <summary>
1461         /// Enable/Disable overshooting effect. default is disabled.
1462         /// </summary>
1463         [EditorBrowsable(EditorBrowsableState.Never)]
1464         public bool EnableOverShootingEffect
1465         {
1466             get
1467             {
1468                 return (bool)GetValue(EnableOverShootingEffectProperty);
1469             }
1470             set
1471             {
1472                 SetValue(EnableOverShootingEffectProperty, value);
1473                 NotifyPropertyChanged();
1474             }
1475         }
1476         private bool InternalEnableOverShootingEffect { get; set; } = false;
1477
1478         private void AttachOverShootingShadowView()
1479         {
1480             if (!EnableOverShootingEffect)
1481                 return;
1482
1483             // stop animation if necessary.
1484             StopOverShootingShadowAnimation();
1485
1486             if (ScrollingDirection == Direction.Horizontal)
1487             {
1488                 base.Add(leftOverShootingShadowView);
1489                 base.Add(rightOverShootingShadowView);
1490
1491                 leftOverShootingShadowView.Size = new Size(0.0f, SizeHeight);
1492                 leftOverShootingShadowView.Opacity = 1.0f;
1493                 leftOverShootingShadowView.RaiseToTop();
1494
1495                 rightOverShootingShadowView.Size = new Size(0.0f, SizeHeight);
1496                 rightOverShootingShadowView.Opacity = 1.0f;
1497                 rightOverShootingShadowView.RaiseToTop();
1498             }
1499             else
1500             {
1501                 base.Add(topOverShootingShadowView);
1502                 base.Add(bottomOverShootingShadowView);
1503
1504                 topOverShootingShadowView.Size = new Size(SizeWidth, 0.0f);
1505                 topOverShootingShadowView.Opacity = 1.0f;
1506                 topOverShootingShadowView.RaiseToTop();
1507
1508                 bottomOverShootingShadowView.Size = new Size(SizeWidth, 0.0f);
1509                 bottomOverShootingShadowView.Opacity = 1.0f;
1510                 bottomOverShootingShadowView.RaiseToTop();
1511             }
1512
1513             // at the beginning, height or width of overshooting shadow is 0, so it is invisible.
1514             isOverShootingShadowShown = false;
1515         }
1516
1517         private void DragOverShootingShadow(float totalPanDisplacement, float panDisplacement)
1518         {
1519             if (!EnableOverShootingEffect)
1520                 return;
1521
1522             if (totalPanDisplacement > 0) // downwards
1523             {
1524                 // check if reaching at the top / left.
1525                 if ((int)finalTargetPosition != 0)
1526                 {
1527                     isOverShootingShadowShown = false;
1528                     return;
1529                 }
1530
1531                 // save start displacement, and re-calculate displacement.
1532                 if (!isOverShootingShadowShown)
1533                 {
1534                     startShowShadowDisplacement = totalPanDisplacement;
1535                 }
1536                 isOverShootingShadowShown = true;
1537
1538                 float newDisplacement = (int)totalPanDisplacement < (int)startShowShadowDisplacement ? 0 : totalPanDisplacement - startShowShadowDisplacement;
1539
1540                 if (ScrollingDirection == Direction.Horizontal)
1541                 {
1542                     // scale limit of height is 60%.
1543                     float heightScale = newDisplacement / overShootingShadowScaleHeightLimit;
1544                     leftOverShootingShadowView.SizeHeight = heightScale > 0.6f ? SizeHeight * 0.4f : SizeHeight * (1.0f - heightScale);
1545
1546                     // scale limit of width is 300%.
1547                     leftOverShootingShadowView.SizeWidth = newDisplacement > overShootingShadowScaleHeightLimit ? overShootingShadowScaleHeightLimit : newDisplacement;
1548
1549                     // trigger event
1550                     ScrollOutOfBoundEventArgs.Direction scrollDirection = panDisplacement > 0 ?
1551                        ScrollOutOfBoundEventArgs.Direction.Right : ScrollOutOfBoundEventArgs.Direction.Left;
1552                     OnScrollOutOfBound(scrollDirection, totalPanDisplacement);
1553                 }
1554                 else
1555                 {
1556                     // scale limit of width is 60%.
1557                     float widthScale = newDisplacement / overShootingShadowScaleHeightLimit;
1558                     topOverShootingShadowView.SizeWidth = widthScale > 0.6f ? SizeWidth * 0.4f : SizeWidth * (1.0f - widthScale);
1559
1560                     // scale limit of height is 300%.
1561                     topOverShootingShadowView.SizeHeight = newDisplacement > overShootingShadowScaleHeightLimit ? overShootingShadowScaleHeightLimit : newDisplacement;
1562
1563                     // trigger event
1564                     ScrollOutOfBoundEventArgs.Direction scrollDirection = panDisplacement > 0 ?
1565                        ScrollOutOfBoundEventArgs.Direction.Down : ScrollOutOfBoundEventArgs.Direction.Up;
1566                     OnScrollOutOfBound(scrollDirection, totalPanDisplacement);
1567                 }
1568             }
1569             else if (totalPanDisplacement < 0) // upwards
1570             {
1571                 // check if reaching at the bottom.
1572                 if (-(int)finalTargetPosition != (int)maxScrollDistance)
1573                 {
1574                     isOverShootingShadowShown = false;
1575                     return;
1576                 }
1577
1578                 // save start displacement, and re-calculate displacement.
1579                 if (!isOverShootingShadowShown)
1580                 {
1581                     startShowShadowDisplacement = totalPanDisplacement;
1582                 }
1583                 isOverShootingShadowShown = true;
1584
1585                 float newDisplacement = (int)startShowShadowDisplacement < (int)totalPanDisplacement ? 0 : startShowShadowDisplacement - totalPanDisplacement;
1586
1587                 if (ScrollingDirection == Direction.Horizontal)
1588                 {
1589                     // scale limit of height is 60%.
1590                     float heightScale = newDisplacement / overShootingShadowScaleHeightLimit;
1591                     rightOverShootingShadowView.SizeHeight = heightScale > 0.6f ? SizeHeight * 0.4f : SizeHeight * (1.0f - heightScale);
1592
1593                     // scale limit of width is 300%.
1594                     rightOverShootingShadowView.SizeWidth = newDisplacement > overShootingShadowScaleHeightLimit ? overShootingShadowScaleHeightLimit : newDisplacement;
1595
1596                     // trigger event
1597                     ScrollOutOfBoundEventArgs.Direction scrollDirection = panDisplacement > 0 ?
1598                        ScrollOutOfBoundEventArgs.Direction.Right : ScrollOutOfBoundEventArgs.Direction.Left;
1599                     OnScrollOutOfBound(scrollDirection, totalPanDisplacement);
1600                 }
1601                 else
1602                 {
1603                     // scale limit of width is 60%.
1604                     float widthScale = newDisplacement / overShootingShadowScaleHeightLimit;
1605                     bottomOverShootingShadowView.SizeWidth = widthScale > 0.6f ? SizeWidth * 0.4f : SizeWidth * (1.0f - widthScale);
1606
1607                     // scale limit of height is 300%.
1608                     bottomOverShootingShadowView.SizeHeight = newDisplacement > overShootingShadowScaleHeightLimit ? overShootingShadowScaleHeightLimit : newDisplacement;
1609
1610                     // trigger event
1611                     ScrollOutOfBoundEventArgs.Direction scrollDirection = panDisplacement > 0 ?
1612                        ScrollOutOfBoundEventArgs.Direction.Down : ScrollOutOfBoundEventArgs.Direction.Up;
1613                     OnScrollOutOfBound(scrollDirection, totalPanDisplacement);
1614                 }
1615             }
1616             else
1617             {
1618                 // if total displacement is 0, shadow would become invisible.
1619                 isOverShootingShadowShown = false;
1620             }
1621         }
1622
1623         private void PlayOverShootingShadowAnimation()
1624         {
1625             if (!EnableOverShootingEffect)
1626                 return;
1627
1628             // stop animation if necessary.
1629             StopOverShootingShadowAnimation();
1630
1631             if (overShootingShadowAnimation == null)
1632             {
1633                 overShootingShadowAnimation = new Animation(overShootingShadowAnimationDuration);
1634                 overShootingShadowAnimation.Finished += OnOverShootingShadowAnimationFinished;
1635             }
1636
1637             if (ScrollingDirection == Direction.Horizontal)
1638             {
1639                 View targetView = totalDisplacementForPan < 0 ? rightOverShootingShadowView : leftOverShootingShadowView;
1640                 overShootingShadowAnimation.AnimateTo(targetView, "SizeHeight", SizeHeight);
1641                 overShootingShadowAnimation.AnimateTo(targetView, "SizeWidth", 0.0f);
1642                 overShootingShadowAnimation.AnimateTo(targetView, "Opacity", 0.0f);
1643             }
1644             else
1645             {
1646                 View targetView = totalDisplacementForPan < 0 ? bottomOverShootingShadowView : topOverShootingShadowView;
1647                 overShootingShadowAnimation.AnimateTo(targetView, "SizeWidth", SizeWidth);
1648                 overShootingShadowAnimation.AnimateTo(targetView, "SizeHeight", 0.0f);
1649                 overShootingShadowAnimation.AnimateTo(targetView, "Opacity", 0.0f);
1650             }
1651             overShootingShadowAnimation.Play();
1652         }
1653
1654         private void StopOverShootingShadowAnimation()
1655         {
1656             if (overShootingShadowAnimation == null || overShootingShadowAnimation.State != Animation.States.Playing)
1657                 return;
1658
1659             overShootingShadowAnimation.Stop(Animation.EndActions.Cancel);
1660             OnOverShootingShadowAnimationFinished(null, null);
1661             overShootingShadowAnimation.Clear();
1662         }
1663
1664         private void OnOverShootingShadowAnimationFinished(object sender, EventArgs e)
1665         {
1666             if (ScrollingDirection == Direction.Horizontal)
1667             {
1668                 base.Remove(leftOverShootingShadowView);
1669                 base.Remove(rightOverShootingShadowView);
1670
1671                 leftOverShootingShadowView.Size = new Size(0.0f, SizeHeight);
1672                 rightOverShootingShadowView.Size = new Size(0.0f, SizeHeight);
1673             }
1674             else
1675             {
1676                 base.Remove(topOverShootingShadowView);
1677                 base.Remove(bottomOverShootingShadowView);
1678
1679                 topOverShootingShadowView.Size = new Size(SizeWidth, 0.0f);
1680                 bottomOverShootingShadowView.Size = new Size(SizeWidth, 0.0f);
1681             }
1682
1683             // after animation finished, height/width & opacity of vertical shadow both are 0, so it is invisible.
1684             isOverShootingShadowShown = false;
1685         }
1686
1687         private void OnScrollOutOfBound(ScrollOutOfBoundEventArgs.Direction direction, float displacement)
1688         {
1689             ScrollOutOfBoundEventArgs args = new ScrollOutOfBoundEventArgs(direction, displacement);
1690             ScrollOutOfBound?.Invoke(this, args);
1691         }
1692
1693         private void OnPanGestureDetected(object source, PanGestureDetector.DetectedEventArgs e)
1694         {
1695             e.Handled = OnPanGesture(e.PanGesture);
1696         }
1697
1698         private bool OnPanGesture(PanGesture panGesture)
1699         {
1700             bool handled = true;
1701             if (SnapToPage && scrollAnimation != null && scrollAnimation.State == Animation.States.Playing)
1702             {
1703                 return handled;
1704             }
1705             if (panGesture.State == Gesture.StateType.Started)
1706             {
1707                 readyToNotice = false;
1708                 AttachOverShootingShadowView();
1709                 Debug.WriteLineIf(LayoutDebugScrollableBase, "Gesture Start");
1710                 if (scrolling && !SnapToPage)
1711                 {
1712                     StopScroll();
1713                 }
1714                 totalDisplacementForPan = 0.0f;
1715
1716                 // check if gesture need to propagation
1717                 var checkDisplacement = (ScrollingDirection == Direction.Horizontal) ? panGesture.Displacement.X : panGesture.Displacement.Y;
1718                 var checkChildCurrentPosition = (ScrollingDirection == Direction.Horizontal) ? ContentContainer.PositionX : ContentContainer.PositionY;
1719                 var checkChildTargetPosition = checkChildCurrentPosition + checkDisplacement;
1720                 var checkFinalTargetPosition = BoundScrollPosition(checkChildTargetPosition);
1721                 handled = !((int)checkFinalTargetPosition == 0 || -(int)checkFinalTargetPosition == (int)maxScrollDistance);
1722                 // If you propagate a gesture event, return;
1723                 if (!handled)
1724                 {
1725                     return handled;
1726                 }
1727
1728                 //Interrupt touching when panning is started
1729                 this.InterceptTouchEvent += OnInterruptTouchingChildTouched;
1730                 OnScrollDragStarted();
1731             }
1732             else if (panGesture.State == Gesture.StateType.Continuing)
1733             {
1734                 if (ScrollingDirection == Direction.Horizontal)
1735                 {
1736                     // if vertical shadow is shown, does not scroll.
1737                     if (!isOverShootingShadowShown)
1738                     {
1739                         ScrollBy(panGesture.Displacement.X, false);
1740                     }
1741                     totalDisplacementForPan += panGesture.Displacement.X;
1742                     DragOverShootingShadow(totalDisplacementForPan, panGesture.Displacement.X);
1743                 }
1744                 else
1745                 {
1746                     // if vertical shadow is shown, does not scroll.
1747                     if (!isOverShootingShadowShown)
1748                     {
1749                         ScrollBy(panGesture.Displacement.Y, false);
1750                     }
1751                     totalDisplacementForPan += panGesture.Displacement.Y;
1752                     DragOverShootingShadow(totalDisplacementForPan, panGesture.Displacement.Y);
1753                 }
1754                 Debug.WriteLineIf(LayoutDebugScrollableBase, "OnPanGestureDetected Continue totalDisplacementForPan:" + totalDisplacementForPan);
1755
1756             }
1757             else if (panGesture.State == Gesture.StateType.Finished || panGesture.State == Gesture.StateType.Cancelled)
1758             {
1759                 PlayOverShootingShadowAnimation();
1760                 OnScrollDragEnded();
1761                 StopScroll(); // Will replace previous animation so will stop existing one.
1762
1763                 if (scrollAnimation == null)
1764                 {
1765                     scrollAnimation = new Animation();
1766                     scrollAnimation.Finished += ScrollAnimationFinished;
1767                 }
1768
1769                 float panVelocity = (ScrollingDirection == Direction.Horizontal) ? panGesture.Velocity.X : panGesture.Velocity.Y;
1770
1771                 if (SnapToPage)
1772                 {
1773                     PageSnap(panVelocity);
1774                 }
1775                 else
1776                 {
1777                     if (panVelocity == 0)
1778                     {
1779                         float currentScrollPosition = (ScrollingDirection == Direction.Horizontal ? ContentContainer.CurrentPosition.X : ContentContainer.CurrentPosition.Y);
1780                         scrollAnimation.DefaultAlphaFunction = new AlphaFunction(AlphaFunction.BuiltinFunctions.Linear);
1781                         scrollAnimation.Duration = 0;
1782                         scrollAnimation.AnimateTo(ContentContainer, (ScrollingDirection == Direction.Horizontal) ? "PositionX" : "PositionY", currentScrollPosition);
1783                         scrollAnimation.Play();
1784                     }
1785                     else
1786                     {
1787                         Decelerating(panVelocity, scrollAnimation);
1788                     }
1789                 }
1790
1791                 totalDisplacementForPan = 0;
1792                 scrolling = true;
1793                 readyToNotice = true;
1794                 OnScrollAnimationStarted();
1795             }
1796             return handled;
1797         }
1798
1799         internal void BaseRemove(View view)
1800         {
1801             base.Remove(view);
1802         }
1803
1804         internal override bool OnAccessibilityPan(PanGesture gestures)
1805         {
1806             if (SnapToPage && scrollAnimation != null && scrollAnimation.State == Animation.States.Playing)
1807             {
1808                 return false;
1809             }
1810
1811             OnPanGesture(gestures);
1812             return true;
1813         }
1814
1815         private float CustomScrollAlphaFunction(float progress)
1816         {
1817             if (panAnimationDelta == 0)
1818             {
1819                 return 1.0f;
1820             }
1821             else
1822             {
1823                 // Parameter "progress" is normalized value. We need to multiply target duration to calculate distance.
1824                 // Can get real distance using equation of deceleration (check Decelerating function)
1825                 // After get real distance, normalize it
1826                 float realDuration = progress * panAnimationDuration;
1827                 float realDistance = velocityOfLastPan * ((float)Math.Pow(decelerationRate, realDuration) - 1) / logValueOfDeceleration;
1828                 float result = Math.Min(realDistance / Math.Abs(panAnimationDelta), 1.0f);
1829
1830                 // This is hot-fix for if the velocity has very small value, result is not updated even progress done.
1831                 if (progress > 0.99) result = 1.0f;
1832
1833                 return result;
1834             }
1835         }
1836
1837         /// <summary>
1838         /// you can override it to custom your decelerating
1839         /// </summary>
1840         /// <param name="velocity">Velocity of current pan.</param>
1841         /// <param name="animation">Scroll animation.</param>
1842         [EditorBrowsable(EditorBrowsableState.Never)]
1843         protected virtual void Decelerating(float velocity, Animation animation)
1844         {
1845             if (animation == null) throw new ArgumentNullException(nameof(animation));
1846             // Decelerating using deceleration equation ===========
1847             //
1848             // V   : velocity (pixel per millisecond)
1849             // V0  : initial velocity
1850             // d   : deceleration rate,
1851             // t   : time
1852             // X   : final position after decelerating
1853             // log : natural logarithm
1854             //
1855             // V(t) = V0 * d pow t;
1856             // X(t) = V0 * (d pow t - 1) / log d;  <-- Integrate the velocity function
1857             // X(∞) = V0 * d / (1 - d); <-- Result using infinite T can be final position because T is tending to infinity.
1858             //
1859             // Because of final T is tending to infinity, we should use threshold value to finish.
1860             // Final T = log(-threshold * log d / |V0| ) / log d;
1861
1862             velocityOfLastPan = Math.Abs(velocity);
1863
1864             float currentScrollPosition = -(ScrollingDirection == Direction.Horizontal ? ContentContainer.CurrentPosition.X : ContentContainer.CurrentPosition.Y);
1865             panAnimationDelta = (velocityOfLastPan * decelerationRate) / (1 - decelerationRate);
1866             panAnimationDelta = velocity > 0 ? -panAnimationDelta : panAnimationDelta;
1867
1868             float destination = -(panAnimationDelta + currentScrollPosition);
1869             float adjustDestination = AdjustTargetPositionOfScrollAnimation(destination);
1870             float maxPosition = ScrollAvailableArea != null ? ScrollAvailableArea.Y : maxScrollDistance;
1871             float minPosition = ScrollAvailableArea != null ? ScrollAvailableArea.X : 0;
1872
1873             if (destination < -maxPosition || destination > minPosition)
1874             {
1875                 panAnimationDelta = velocity > 0 ? (currentScrollPosition - minPosition) : (maxPosition - currentScrollPosition);
1876                 destination = velocity > 0 ? minPosition : -maxPosition;
1877
1878                 if (panAnimationDelta == 0)
1879                 {
1880                     panAnimationDuration = 0.0f;
1881                 }
1882                 else
1883                 {
1884                     panAnimationDuration = (float)Math.Log((panAnimationDelta * logValueOfDeceleration / velocityOfLastPan + 1), decelerationRate);
1885                 }
1886
1887                 Debug.WriteLineIf(LayoutDebugScrollableBase, "\n" +
1888                     "OverRange======================= \n" +
1889                     "[decelerationRate] " + decelerationRate + "\n" +
1890                     "[logValueOfDeceleration] " + logValueOfDeceleration + "\n" +
1891                     "[Velocity] " + velocityOfLastPan + "\n" +
1892                     "[CurrentPosition] " + currentScrollPosition + "\n" +
1893                     "[CandidateDelta] " + panAnimationDelta + "\n" +
1894                     "[Destination] " + destination + "\n" +
1895                     "[Duration] " + panAnimationDuration + "\n" +
1896                     "================================ \n"
1897                 );
1898             }
1899             else
1900             {
1901                 panAnimationDuration = (float)Math.Log(-DecelerationThreshold * logValueOfDeceleration / velocityOfLastPan) / logValueOfDeceleration;
1902
1903                 if (adjustDestination != destination)
1904                 {
1905                     destination = adjustDestination;
1906                     panAnimationDelta = destination + currentScrollPosition;
1907                     velocityOfLastPan = Math.Abs(panAnimationDelta * logValueOfDeceleration / ((float)Math.Pow(decelerationRate, panAnimationDuration) - 1));
1908                     panAnimationDuration = (float)Math.Log(-DecelerationThreshold * logValueOfDeceleration / velocityOfLastPan) / logValueOfDeceleration;
1909                 }
1910
1911                 Debug.WriteLineIf(LayoutDebugScrollableBase, "\n" +
1912                     "================================ \n" +
1913                     "[decelerationRate] " + decelerationRate + "\n" +
1914                     "[logValueOfDeceleration] " + logValueOfDeceleration + "\n" +
1915                     "[Velocity] " + velocityOfLastPan + "\n" +
1916                     "[CurrentPosition] " + currentScrollPosition + "\n" +
1917                     "[CandidateDelta] " + panAnimationDelta + "\n" +
1918                     "[Destination] " + destination + "\n" +
1919                     "[Duration] " + panAnimationDuration + "\n" +
1920                     "================================ \n"
1921                 );
1922             }
1923
1924             finalTargetPosition = destination;
1925
1926             customScrollAlphaFunction = new UserAlphaFunctionDelegate(CustomScrollAlphaFunction);
1927             animation.DefaultAlphaFunction = new AlphaFunction(customScrollAlphaFunction);
1928             GC.KeepAlive(customScrollAlphaFunction);
1929             animation.Duration = (int)panAnimationDuration;
1930             animation.AnimateTo(ContentContainer, (ScrollingDirection == Direction.Horizontal) ? "PositionX" : "PositionY", destination);
1931             animation.Play();
1932         }
1933
1934         private void ScrollAnimationFinished(object sender, EventArgs e)
1935         {
1936             OnScrollAnimationEnded();
1937         }
1938
1939         /// <summary>
1940         /// Adjust scrolling position by own scrolling rules.
1941         /// Override this function when developer wants to change destination of flicking.(e.g. always snap to center of item)
1942         /// </summary>
1943         /// This may be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API
1944         [EditorBrowsable(EditorBrowsableState.Never)]
1945         protected virtual float AdjustTargetPositionOfScrollAnimation(float position)
1946         {
1947             return position;
1948         }
1949
1950         /// <summary>
1951         /// Scroll position given to ScrollTo.
1952         /// This is the position in the opposite direction to the position of ContentContainer.
1953         /// </summary>
1954         /// <since_tizen> 8 </since_tizen>
1955         public Position ScrollPosition
1956         {
1957             get
1958             {
1959                 return new Position(-ContentContainer.Position);
1960             }
1961         }
1962
1963         /// <summary>
1964         /// Current scroll position in the middle of ScrollTo animation.
1965         /// This is the position in the opposite direction to the current position of ContentContainer.
1966         /// </summary>
1967         /// <since_tizen> 8 </since_tizen>
1968         public Position ScrollCurrentPosition
1969         {
1970             get
1971             {
1972                 return new Position(-ContentContainer.CurrentPosition);
1973             }
1974         }
1975
1976         /// <summary>
1977         /// Remove all children in ContentContainer.
1978         /// </summary>
1979         /// <param name="dispose">If true, removed child is disposed.</param>
1980         [EditorBrowsable(EditorBrowsableState.Never)]
1981         public void RemoveAllChildren(bool dispose = false)
1982         {
1983             RecursiveRemoveChildren(ContentContainer, dispose);
1984         }
1985
1986         private void RecursiveRemoveChildren(View parent, bool dispose)
1987         {
1988             if (parent == null)
1989             {
1990                 return;
1991             }
1992             int maxChild = (int)parent.GetChildCount();
1993             for (int i = maxChild - 1; i >= 0; --i)
1994             {
1995                 View child = parent.GetChildAt((uint)i);
1996                 if (child == null)
1997                 {
1998                     continue;
1999                 }
2000                 RecursiveRemoveChildren(child, dispose);
2001                 parent.Remove(child);
2002                 if (dispose)
2003                 {
2004                     child.Dispose();
2005                 }
2006             }
2007         }
2008
2009         internal bool IsChildNearlyVisble(View child, float offset = 0)
2010         {
2011             if (ScreenPosition.X - offset < child.ScreenPosition.X + child.SizeWidth &&
2012                 ScreenPosition.X + SizeWidth + offset > child.ScreenPosition.X &&
2013                 ScreenPosition.Y - offset < child.ScreenPosition.Y + child.SizeHeight &&
2014                 ScreenPosition.Y + SizeHeight + offset > child.ScreenPosition.Y)
2015             {
2016                 return true;
2017             }
2018             else
2019             {
2020                 return false;
2021             }
2022         }
2023
2024         /// <inheritdoc/>
2025         [EditorBrowsable(EditorBrowsableState.Never)]
2026         public override View GetNextFocusableView(View currentFocusedView, View.FocusDirection direction, bool loopEnabled)
2027         {
2028             bool isHorizontal = (ScrollingDirection == Direction.Horizontal);
2029             float targetPosition = -(ScrollingDirection == Direction.Horizontal ? ContentContainer.CurrentPosition.X : ContentContainer.CurrentPosition.Y);
2030             float stepDistance = (stepScrollDistance != 0 ? stepScrollDistance : (isHorizontal ? Size.Width * 0.25f : Size.Height * 0.25f));
2031
2032             bool forward = ((isHorizontal && direction == View.FocusDirection.Right) ||
2033                             (!isHorizontal && direction == View.FocusDirection.Down) ||
2034                             (direction == View.FocusDirection.Clockwise));
2035             bool backward = ((isHorizontal && direction == View.FocusDirection.Left) ||
2036                              (!isHorizontal && direction == View.FocusDirection.Up) ||
2037                              (direction == View.FocusDirection.CounterClockwise));
2038
2039             View nextFocusedView = FocusManager.Instance.GetNearestFocusableActor(this, currentFocusedView, direction);
2040
2041             // Move out focus from ScrollableBase.
2042             // FIXME: Forward, Backward is unimplemented other components.
2043             if (direction == View.FocusDirection.Forward ||
2044                 direction == View.FocusDirection.Backward ||
2045                 (nextFocusedView == null &&
2046                 ((forward && maxScrollDistance - targetPosition < 0.1f) ||
2047                  (backward && targetPosition < 0.1f))))
2048             {
2049                 var next = FocusManager.Instance.GetNearestFocusableActor(this.Parent, this, direction);
2050                 Debug.WriteLineIf(focusDebugScrollableBase, $"Focus move [{direction}] out from ScrollableBase! Next focus target {next}:{next?.ID}");
2051                 return next;
2052             }
2053
2054             if (focusDebugScrollableBase)
2055             {
2056                 global::System.Text.StringBuilder debugMessage = new global::System.Text.StringBuilder("=========================================================\n");
2057                 debugMessage.Append($"GetNextFocusableView On: {this}:{this.ID}\n");
2058                 debugMessage.Append($"----------------Current: {currentFocusedView}:{currentFocusedView?.ID}\n");
2059                 debugMessage.Append($"-------------------Next: {nextFocusedView}:{nextFocusedView?.ID}\n");
2060                 debugMessage.Append($"--------------Direction: {direction}\n");
2061                 debugMessage.Append("=========================================================");
2062                 Debug.WriteLineIf(focusDebugScrollableBase, debugMessage);
2063             }
2064
2065             if (nextFocusedView != null)
2066             {
2067                 if (null != FindDescendantByID(nextFocusedView.ID))
2068                 {
2069                     if (IsChildNearlyVisble(nextFocusedView, stepDistance) == true)
2070                     {
2071                         ScrollToChild(nextFocusedView, true);
2072                         return nextFocusedView;
2073                     }
2074                 }
2075             }
2076
2077             if (forward || backward)
2078             {
2079                 // Fallback to current focus or scrollableBase till next focus visible in scrollable.
2080                 if (null != currentFocusedView && null != FindDescendantByID(currentFocusedView.ID))
2081                 {
2082                     nextFocusedView = currentFocusedView;
2083                 }
2084                 else
2085                 {
2086                     Debug.WriteLineIf(focusDebugScrollableBase, "current focus view is not decendant. return ScrollableBase!");
2087                     return this;
2088                 }
2089
2090                 if (forward)
2091                 {
2092                     targetPosition += stepDistance;
2093                     targetPosition = targetPosition > maxScrollDistance ? maxScrollDistance : targetPosition;
2094
2095                 }
2096                 else if (backward)
2097                 {
2098                     targetPosition -= stepDistance;
2099                     targetPosition = targetPosition < 0 ? 0 : targetPosition;
2100                 }
2101
2102                 ScrollTo(targetPosition, true);
2103
2104                 Debug.WriteLineIf(focusDebugScrollableBase, $"ScrollTo :({targetPosition})");
2105             }
2106
2107             Debug.WriteLineIf(focusDebugScrollableBase, $"return end : {nextFocusedView}:{nextFocusedView?.ID}");
2108             return nextFocusedView;
2109         }
2110
2111         /// <inheritdoc/>
2112         [EditorBrowsable(EditorBrowsableState.Never)]
2113         protected override bool AccessibilityScrollToChild(View child)
2114         {
2115             if (child == null)
2116             {
2117                 return false;
2118             }
2119
2120             if (ScrollingDirection == Direction.Horizontal)
2121             {
2122                 if (child.ScreenPosition.X + child.Size.Width <= this.ScreenPosition.X)
2123                 {
2124                     if (SnapToPage)
2125                     {
2126                         PageSnap(PageFlickThreshold + 1);
2127                     }
2128                     else
2129                     {
2130                         ScrollTo((float)(child.ScreenPosition.X - ContentContainer.ScreenPosition.X), false);
2131                     }
2132                 }
2133                 else if (child.ScreenPosition.X >= this.ScreenPosition.X + this.Size.Width)
2134                 {
2135                     if (SnapToPage)
2136                     {
2137                         PageSnap(-(PageFlickThreshold + 1));
2138                     }
2139                     else
2140                     {
2141                         ScrollTo((float)(child.ScreenPosition.X + child.Size.Width - ContentContainer.ScreenPosition.X - this.Size.Width), false);
2142                     }
2143                 }
2144             }
2145             else
2146             {
2147                 if (child.ScreenPosition.Y + child.Size.Height <= this.ScreenPosition.Y)
2148                 {
2149                     if (SnapToPage)
2150                     {
2151                         PageSnap(PageFlickThreshold + 1);
2152                     }
2153                     else
2154                     {
2155                         ScrollTo((float)(child.ScreenPosition.Y - ContentContainer.ScreenPosition.Y), false);
2156                     }
2157                 }
2158                 else if (child.ScreenPosition.Y >= this.ScreenPosition.Y + this.Size.Height)
2159                 {
2160                     if (SnapToPage)
2161                     {
2162                         PageSnap(-(PageFlickThreshold + 1));
2163                     }
2164                     else
2165                     {
2166                         ScrollTo((float)(child.ScreenPosition.Y + child.Size.Height - ContentContainer.ScreenPosition.Y - this.Size.Height), false);
2167                     }
2168                 }
2169             }
2170
2171             return true;
2172         }
2173
2174         /// <inheritdoc/>
2175         [EditorBrowsable(EditorBrowsableState.Never)]
2176         public override bool OnWheel(Wheel wheel)
2177         {
2178             if (wheel == null)
2179             {
2180                 return false;
2181             }
2182
2183             float currentScrollPosition = -(ScrollingDirection == Direction.Horizontal ? ContentContainer.CurrentPosition.X : ContentContainer.CurrentPosition.Y);
2184             ScrollTo(currentScrollPosition + (wheelScrollDistance * wheel.Z), false);
2185
2186             return true;
2187         }
2188
2189         private bool OnWheelEvent(object o, WheelEventArgs e)
2190         {
2191             return OnWheel(e?.Wheel);
2192         }
2193     }
2194
2195 } // namespace