src/Tizen.NUI.Components/Controls/ScrollableBase.cs

   1 /* Copyright (c) 2020 Samsung Electronics Co., Ltd.
   2  *
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at
   6  *
   7  * http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  *
  15  */
  16 using System;
  17 using Tizen.NUI.BaseComponents;
  18 using System.ComponentModel;
  19 using System.Diagnostics;
  20
  21 namespace Tizen.NUI.Components
  22 {
  23     /// <summary>
  24     /// [Draft] This class provides a View that can scroll a single View with a layout. This View can be a nest of Views.
  25     /// </summary>
  26     /// This may be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API.
  27     [EditorBrowsable(EditorBrowsableState.Never)]
  28     public class ScrollableBase : Control
  29     {
  30         static bool LayoutDebugScrollableBase = false; // Debug flag
  31         private Direction mScrollingDirection = Direction.Vertical;
  32         private bool mScrollEnabled = true;
  33         private int mPageWidth = 0;
  34
  35         private class ScrollableBaseCustomLayout : LayoutGroup
  36         {
  37             protected override void OnMeasure(MeasureSpecification widthMeasureSpec, MeasureSpecification heightMeasureSpec)
  38             {
  39                 Extents padding = Padding;
  40                 float totalHeight = padding.Top + padding.Bottom;
  41                 float totalWidth = padding.Start + padding.End;
  42
  43                 MeasuredSize.StateType childWidthState = MeasuredSize.StateType.MeasuredSizeOK;
  44                 MeasuredSize.StateType childHeightState = MeasuredSize.StateType.MeasuredSizeOK;
  45
  46                 Direction scrollingDirection = Direction.Vertical;
  47                 ScrollableBase scrollableBase = this.Owner as ScrollableBase;
  48                 if (scrollableBase)
  49                 {
  50                     scrollingDirection = scrollableBase.ScrollingDirection;
  51                 }
  52
  53                 // measure child, should be a single scrolling child
  54                 foreach (LayoutItem childLayout in LayoutChildren)
  55                 {
  56                     if (childLayout != null)
  57                     {
  58                         // Get size of child
  59                         // Use an Unspecified MeasureSpecification mode so scrolling child is not restricted to it's parents size in Height (for vertical scrolling)
  60                         // or Width for horizontal scrolling
  61                         MeasureSpecification unrestrictedMeasureSpec = new MeasureSpecification(heightMeasureSpec.Size, MeasureSpecification.ModeType.Unspecified);
  62
  63                         if (scrollingDirection == Direction.Vertical)
  64                         {
  65                             MeasureChildWithMargins(childLayout, widthMeasureSpec, new LayoutLength(0), unrestrictedMeasureSpec, new LayoutLength(0));  // Height unrestricted by parent
  66                         }
  67                         else
  68                         {
  69                             MeasureChildWithMargins(childLayout, unrestrictedMeasureSpec, new LayoutLength(0), heightMeasureSpec, new LayoutLength(0));  // Width unrestricted by parent
  70                         }
  71
  72                         float childWidth = childLayout.MeasuredWidth.Size.AsDecimal();
  73                         float childHeight = childLayout.MeasuredHeight.Size.AsDecimal();
  74
  75                         // Determine the width and height needed by the children using their given position and size.
  76                         // Children could overlap so find the left most and right most child.
  77                         Position2D childPosition = childLayout.Owner.Position2D;
  78                         float childLeft = childPosition.X;
  79                         float childTop = childPosition.Y;
  80
  81                         // Store current width and height needed to contain all children.
  82                         Extents childMargin = childLayout.Margin;
  83                         totalWidth = childWidth + childMargin.Start + childMargin.End;
  84                         totalHeight = childHeight + childMargin.Top + childMargin.Bottom;
  85
  86                         if (childLayout.MeasuredWidth.State == MeasuredSize.StateType.MeasuredSizeTooSmall)
  87                         {
  88                             childWidthState = MeasuredSize.StateType.MeasuredSizeTooSmall;
  89                         }
  90                         if (childLayout.MeasuredWidth.State == MeasuredSize.StateType.MeasuredSizeTooSmall)
  91                         {
  92                             childHeightState = MeasuredSize.StateType.MeasuredSizeTooSmall;
  93                         }
  94                     }
  95                 }
  96
  97
  98                 MeasuredSize widthSizeAndState = ResolveSizeAndState(new LayoutLength(totalWidth + Padding.Start + Padding.End), widthMeasureSpec, MeasuredSize.StateType.MeasuredSizeOK);
  99                 MeasuredSize heightSizeAndState = ResolveSizeAndState(new LayoutLength(totalHeight + Padding.Top + Padding.Bottom), heightMeasureSpec, MeasuredSize.StateType.MeasuredSizeOK);
 100                 totalWidth = widthSizeAndState.Size.AsDecimal();
 101                 totalHeight = heightSizeAndState.Size.AsDecimal();
 102
 103                 // Ensure layout respects it's given minimum size
 104                 totalWidth = Math.Max(totalWidth, SuggestedMinimumWidth.AsDecimal());
 105                 totalHeight = Math.Max(totalHeight, SuggestedMinimumHeight.AsDecimal());
 106
 107                 widthSizeAndState.State = childWidthState;
 108                 heightSizeAndState.State = childHeightState;
 109
 110                 SetMeasuredDimensions(ResolveSizeAndState(new LayoutLength(totalWidth + Padding.Start + Padding.End), widthMeasureSpec, childWidthState),
 111                                        ResolveSizeAndState(new LayoutLength(totalHeight + Padding.Top + Padding.Bottom), heightMeasureSpec, childHeightState));
 112
 113                 // Size of ScrollableBase is changed. Change Page width too.
 114                 scrollableBase.mPageWidth = (int)MeasuredWidth.Size.AsRoundedValue();
 115             }
 116
 117             protected override void OnLayout(bool changed, LayoutLength left, LayoutLength top, LayoutLength right, LayoutLength bottom)
 118             {
 119                 foreach (LayoutItem childLayout in LayoutChildren)
 120                 {
 121                     if (childLayout != null)
 122                     {
 123                         LayoutLength childWidth = childLayout.MeasuredWidth.Size;
 124                         LayoutLength childHeight = childLayout.MeasuredHeight.Size;
 125
 126                         Position2D childPosition = childLayout.Owner.Position2D;
 127                         Extents padding = Padding;
 128                         Extents childMargin = childLayout.Margin;
 129
 130                         LayoutLength childLeft = new LayoutLength(childPosition.X + childMargin.Start + padding.Start);
 131                         LayoutLength childTop = new LayoutLength(childPosition.Y + childMargin.Top + padding.Top);
 132
 133                         childLayout.Layout(childLeft, childTop, childLeft + childWidth, childTop + childHeight);
 134                     }
 135                 }
 136             }
 137         } //  ScrollableBaseCustomLayout
 138
 139         /// <summary>
 140         /// The direction axis to scroll.
 141         /// </summary>
 142         /// <since_tizen> 6 </since_tizen>
 143         /// This may be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API.
 144         [EditorBrowsable(EditorBrowsableState.Never)]
 145         public enum Direction
 146         {
 147             /// <summary>
 148             /// Horizontal axis.
 149             /// </summary>
 150             /// <since_tizen> 6 </since_tizen>
 151             Horizontal,
 152
 153             /// <summary>
 154             /// Vertical axis.
 155             /// </summary>
 156             /// <since_tizen> 6 </since_tizen>
 157             Vertical
 158         }
 159
 160         /// <summary>
 161         /// [Draft] Configurable speed threshold that register the gestures as a flick.
 162         /// If the flick speed less than the threshold then will not be considered a flick.
 163         /// </summary>
 164         /// This may be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API.
 165         [EditorBrowsable(EditorBrowsableState.Never)]
 166         public float FlickThreshold { get; set; } = 0.2f;
 167
 168         /// <summary>
 169         /// [Draft] Configurable duration modifer for the flick animation.
 170         /// Determines the speed of the scroll, large value results in a longer flick animation. Range (0.1 - 1.0)
 171         /// </summary>
 172         /// This may be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API
 173         [EditorBrowsable(EditorBrowsableState.Never)]
 174         public float FlickAnimationSpeed { get; set; } = 0.4f;
 175
 176         /// <summary>
 177         /// [Draft] Configurable modifer for the distance to be scrolled when flicked detected.
 178         /// It a ratio of the ScrollableBase's length. (not child's length).
 179         /// First value is the ratio of the distance to scroll with the weakest flick.
 180         /// Second value is the ratio of the distance to scroll with the strongest flick.
 181         /// Second > First.
 182         /// </summary>
 183         /// This may be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API
 184         [EditorBrowsable(EditorBrowsableState.Never)]
 185         public Vector2 FlickDistanceMultiplierRange { get; set; } = new Vector2(0.6f, 1.8f);
 186
 187         /// <summary>
 188         /// [Draft] Scrolling direction mode.
 189         /// Default is Vertical scrolling.
 190         /// </summary>
 191         /// This may be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API
 192         [EditorBrowsable(EditorBrowsableState.Never)]
 193         public Direction ScrollingDirection
 194         {
 195             get
 196             {
 197                 return mScrollingDirection;
 198             }
 199             set
 200             {
 201                 if (value != mScrollingDirection)
 202                 {
 203                     mScrollingDirection = value;
 204                     mPanGestureDetector.RemoveDirection(value == Direction.Horizontal ? PanGestureDetector.DirectionVertical : PanGestureDetector.DirectionHorizontal);
 205                     mPanGestureDetector.AddDirection(value == Direction.Horizontal ? PanGestureDetector.DirectionHorizontal : PanGestureDetector.DirectionVertical);
 206                 }
 207             }
 208         }
 209
 210         /// <summary>
 211         /// [Draft] Enable or disable scrolling.
 212         /// </summary>
 213         /// This may be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API
 214         [EditorBrowsable(EditorBrowsableState.Never)]
 215         public bool ScrollEnabled
 216         {
 217             get
 218             {
 219                 return mScrollEnabled;
 220             }
 221             set
 222             {
 223                 if (value != mScrollEnabled)
 224                 {
 225                     mScrollEnabled = value;
 226                     if (mScrollEnabled)
 227                     {
 228                         mPanGestureDetector.Detected += OnPanGestureDetected;
 229                         mTapGestureDetector.Detected += OnTapGestureDetected;
 230                     }
 231                     else
 232                     {
 233                         mPanGestureDetector.Detected -= OnPanGestureDetected;
 234                         mTapGestureDetector.Detected -= OnTapGestureDetected;
 235                     }
 236                 }
 237             }
 238         }
 239
 240         /// <summary>
 241         /// [Draft] Pages mode, enables moving to the next or return to current page depending on pan displacement.
 242         /// Default is false.
 243         /// </summary>
 244         /// This may be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API
 245         [EditorBrowsable(EditorBrowsableState.Never)]
 246         public bool SnapToPage { set; get; } = false;
 247
 248         /// <summary>
 249         /// [Draft] Get current page.
 250         /// Working propery with SnapToPage property.
 251         /// </summary>
 252         /// This may be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API
 253         [EditorBrowsable(EditorBrowsableState.Never)]
 254         public int CurrentPage { get; private set; } = 0;
 255
 256         /// <summary>
 257         /// [Draft] Duration of scroll animation.
 258         /// </summary>
 259         /// This may be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API
 260         [EditorBrowsable(EditorBrowsableState.Never)]
 261
 262         public int ScrollDuration { set; get; } = 125;
 263         /// <summary>
 264         /// [Draft] Scroll Available area.
 265         /// </summary>
 266         /// This may be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API
 267         [EditorBrowsable(EditorBrowsableState.Never)]
 268         public Vector2 ScrollAvailableArea { set; get; }
 269
 270         /// <summary>
 271         /// ScrollEventArgs is a class to record scroll event arguments which will sent to user.
 272         /// </summary>
 273         /// <since_tizen> 6 </since_tizen>
 274         /// This may be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API
 275         [EditorBrowsable(EditorBrowsableState.Never)]
 276         public class ScrollEventArgs : EventArgs
 277         {
 278             Position position;
 279
 280             /// <summary>
 281             /// Default constructor.
 282             /// </summary>
 283             /// <param name="position">Current scroll position</param>
 284             /// <since_tizen> 6 </since_tizen>
 285             /// This may be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API
 286             public ScrollEventArgs(Position position)
 287             {
 288                 this.position = position;
 289             }
 290
 291             /// <summary>
 292             /// [Draft] Current scroll position.
 293             /// </summary>
 294             /// This may be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API
 295             [EditorBrowsable(EditorBrowsableState.Never)]
 296             public Position Position
 297             {
 298                 get
 299                 {
 300                     return position;
 301                 }
 302             }
 303         }
 304
 305         /// <summary>
 306         /// An event emitted when user starts dragging ScrollableBase, user can subscribe or unsubscribe to this event handler.<br />
 307         /// </summary>
 308         /// <since_tizen> 6 </since_tizen>
 309         /// This may be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API
 310         [EditorBrowsable(EditorBrowsableState.Never)]
 311         public event EventHandler<ScrollEventArgs> ScrollDragStartEvent;
 312
 313         /// <summary>
 314         /// An event emitted when user stops dragging ScrollableBase, user can subscribe or unsubscribe to this event handler.<br />
 315         /// </summary>
 316         /// <since_tizen> 6 </since_tizen>
 317         /// This may be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API
 318         [EditorBrowsable(EditorBrowsableState.Never)]
 319         public event EventHandler<ScrollEventArgs> ScrollDragEndEvent;
 320
 321
 322         /// <summary>
 323         /// An event emitted when the scrolling slide animation starts, user can subscribe or unsubscribe to this event handler.<br />
 324         /// </summary>
 325         /// <since_tizen> 6 </since_tizen>
 326         /// This may be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API
 327         [EditorBrowsable(EditorBrowsableState.Never)]
 328         public event EventHandler<ScrollEventArgs> ScrollAnimationStartEvent;
 329
 330         /// <summary>
 331         /// An event emitted when the scrolling slide animation ends, user can subscribe or unsubscribe to this event handler.<br />
 332         /// </summary>
 333         /// <since_tizen> 6 </since_tizen>
 334         /// This may be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API
 335         [EditorBrowsable(EditorBrowsableState.Never)]
 336         public event EventHandler<ScrollEventArgs> ScrollAnimationEndEvent;
 337
 338
 339         /// <summary>
 340         /// An event emitted when scrolling, user can subscribe or unsubscribe to this event handler.<br />
 341         /// </summary>
 342         /// <since_tizen> 6 </since_tizen>
 343         /// This may be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API
 344         [EditorBrowsable(EditorBrowsableState.Never)]
 345         public event EventHandler<ScrollEventArgs> ScrollEvent;
 346
 347         private Animation scrollAnimation;
 348         private float maxScrollDistance;
 349         private float childTargetPosition = 0.0f;
 350         private PanGestureDetector mPanGestureDetector;
 351         private TapGestureDetector mTapGestureDetector;
 352         private View mScrollingChild;
 353         private View mInterruptTouchingChild;
 354         private float multiplier = 1.0f;
 355         private bool scrolling = false;
 356         private float ratioOfScreenWidthToCompleteScroll = 0.5f;
 357         private float totalDisplacementForPan = 0.0f;
 358
 359         // If false then can only flick pages when the current animation/scroll as ended.
 360         private bool flickWhenAnimating = false;
 361         private PropertyNotification propertyNotification;
 362         protected float finalTargetPosition;
 363
 364         /// <summary>
 365         /// [Draft] Constructor
 366         /// </summary>
 367         /// <since_tizen> 6 </since_tizen>
 368         /// This may be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API
 369         [EditorBrowsable(EditorBrowsableState.Never)]
 370         public ScrollableBase() : base()
 371         {
 372             mPanGestureDetector = new PanGestureDetector();
 373             mPanGestureDetector.Attach(this);
 374             mPanGestureDetector.AddDirection(PanGestureDetector.DirectionVertical);
 375             mPanGestureDetector.Detected += OnPanGestureDetected;
 376
 377             mTapGestureDetector = new TapGestureDetector();
 378             mTapGestureDetector.Attach(this);
 379             mTapGestureDetector.Detected += OnTapGestureDetected;
 380
 381             ClippingMode = ClippingModeType.ClipChildren;
 382
 383             mScrollingChild = new View();
 384             mScrollingChild.Name = "DefaultScrollingChild";
 385
 386             //Interrupt touching when panning is started;
 387             mInterruptTouchingChild = new View()
 388             {
 389                 Name = "InterruptTouchingChild",
 390                 Size = new Size(Window.Instance.WindowSize),
 391                 BackgroundColor = Color.Transparent,
 392             };
 393
 394             mInterruptTouchingChild.TouchEvent += OnIterruptTouchingChildTouched;
 395
 396             Layout = new ScrollableBaseCustomLayout();
 397         }
 398
 399         private bool OnIterruptTouchingChildTouched(object source, View.TouchEventArgs args)
 400         {
 401             return true;
 402         }
 403
 404         private void OnPropertyChanged(object source, PropertyNotification.NotifyEventArgs args)
 405         {
 406             OnScroll();
 407         }
 408
 409         /// <summary>
 410         /// Called after a child has been added to the owning view.
 411         /// </summary>
 412         /// <param name="view">The child which has been added.</param>
 413         /// <since_tizen> 6 </since_tizen>
 414         /// This may be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API
 415         [EditorBrowsable(EditorBrowsableState.Never)]
 416         public override void OnChildAdd(View view)
 417         {
 418             if (view.Name != "InterruptTouchingChild")
 419             {
 420                 if (mScrollingChild.Name != "DefaultScrollingChild")
 421                 {
 422                     propertyNotification.Notified -= OnPropertyChanged;
 423                     mScrollingChild.RemovePropertyNotification(propertyNotification);
 424                     mScrollingChild.Relayout -= OnScrollingChildRelayout;
 425                 }
 426
 427                 mScrollingChild = view;
 428                 mScrollingChild.Layout.SetPositionByLayout = false;
 429                 propertyNotification = mScrollingChild?.AddPropertyNotification("position", PropertyCondition.Step(1.0f));
 430                 propertyNotification.Notified += OnPropertyChanged;
 431                 mScrollingChild.Relayout += OnScrollingChildRelayout;
 432             }
 433         }
 434
 435         /// <summary>
 436         /// Called after a child has been removed from the owning view.
 437         /// </summary>
 438         /// <param name="view">The child which has been removed.</param>
 439         /// <since_tizen> 6 </since_tizen>
 440         /// This may be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API
 441         [EditorBrowsable(EditorBrowsableState.Never)]
 442         public override void OnChildRemove(View view)
 443         {
 444             if (view.Name != "InterruptTouchingChild")
 445             {
 446                 propertyNotification.Notified -= OnPropertyChanged;
 447                 mScrollingChild.RemovePropertyNotification(propertyNotification);
 448                 mScrollingChild.Relayout -= OnScrollingChildRelayout;
 449
 450                 mScrollingChild.Layout.SetPositionByLayout = true;
 451                 mScrollingChild = new View();
 452             }
 453         }
 454
 455         private void OnScrollingChildRelayout(object source, EventArgs args)
 456         {
 457             // Size is changed. Calculate maxScrollDistance.
 458             maxScrollDistance = CalculateMaximumScrollDistance();
 459         }
 460
 461         /// <summary>
 462         /// Scrolls to the item at the specified index.
 463         /// </summary>
 464         /// <param name="index">Index of item.</param>
 465         /// <since_tizen> 6 </since_tizen>
 466         /// This may be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API
 467         [EditorBrowsable(EditorBrowsableState.Never)]
 468         public void ScrollToIndex(int index)
 469         {
 470             if (mScrollingChild.ChildCount - 1 < index || index < 0)
 471             {
 472                 return;
 473             }
 474
 475             if (SnapToPage)
 476             {
 477                 CurrentPage = index;
 478             }
 479
 480             float targetPosition = Math.Min(ScrollingDirection == Direction.Vertical ? mScrollingChild.Children[index].Position.Y : mScrollingChild.Children[index].Position.X, maxScrollDistance);
 481             AnimateChildTo(ScrollDuration, -targetPosition);
 482         }
 483
 484         private void OnScrollDragStart()
 485         {
 486             ScrollEventArgs eventArgs = new ScrollEventArgs(mScrollingChild.CurrentPosition);
 487             ScrollDragStartEvent?.Invoke(this, eventArgs);
 488         }
 489
 490         private void OnScrollDragEnd()
 491         {
 492             ScrollEventArgs eventArgs = new ScrollEventArgs(mScrollingChild.CurrentPosition);
 493             ScrollDragEndEvent?.Invoke(this, eventArgs);
 494         }
 495
 496         private void OnScrollAnimationStart()
 497         {
 498             ScrollEventArgs eventArgs = new ScrollEventArgs(mScrollingChild.CurrentPosition);
 499             ScrollAnimationStartEvent?.Invoke(this, eventArgs);
 500         }
 501
 502         private void OnScrollAnimationEnd()
 503         {
 504             ScrollEventArgs eventArgs = new ScrollEventArgs(mScrollingChild.CurrentPosition);
 505             ScrollAnimationEndEvent?.Invoke(this, eventArgs);
 506         }
 507
 508         private bool readyToNotice = false;
 509
 510         protected float noticeAnimationEndBeforePosition = 0.0f;
 511
 512         private void OnScroll()
 513         {
 514             ScrollEventArgs eventArgs = new ScrollEventArgs(mScrollingChild.CurrentPosition);
 515             ScrollEvent?.Invoke(this, eventArgs);
 516
 517             CheckPreReachedTargetPosition();
 518         }
 519
 520         private void CheckPreReachedTargetPosition()
 521         {
 522             // Check whether we reached pre-reached target position
 523             if (readyToNotice &&
 524                 mScrollingChild.CurrentPosition.Y <= finalTargetPosition + noticeAnimationEndBeforePosition &&
 525                 mScrollingChild.CurrentPosition.Y >= finalTargetPosition - noticeAnimationEndBeforePosition)
 526             {
 527                 //Notice first
 528                 readyToNotice = false;
 529                 OnPreReachedTargetPosition(finalTargetPosition);
 530             }
 531         }
 532
 533         /// <summary>
 534         /// This helps developer who wants to know before scroll is reaching target position.
 535         /// </summary>
 536         /// <param name="targetPosition">Index of item.</param>
 537         /// <since_tizen> 6 </since_tizen>
 538         /// This may be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API
 539         [EditorBrowsable(EditorBrowsableState.Never)]
 540         protected virtual void OnPreReachedTargetPosition(float targetPosition)
 541         {
 542
 543         }
 544
 545         private void StopScroll()
 546         {
 547             if (scrollAnimation != null)
 548             {
 549                 if (scrollAnimation.State == Animation.States.Playing)
 550                 {
 551                     Debug.WriteLineIf(LayoutDebugScrollableBase, "StopScroll Animation Playing");
 552                     scrollAnimation.Stop(Animation.EndActions.Cancel);
 553                     OnScrollAnimationEnd();
 554                 }
 555                 scrollAnimation.Clear();
 556             }
 557         }
 558
 559         // static constructor registers the control type
 560         static ScrollableBase()
 561         {
 562             // ViewRegistry registers control type with DALi type registry
 563             // also uses introspection to find any properties that need to be registered with type registry
 564             CustomViewRegistry.Instance.Register(CreateInstance, typeof(ScrollableBase));
 565         }
 566
 567         internal static CustomView CreateInstance()
 568         {
 569             return new ScrollableBase();
 570         }
 571
 572         private void AnimateChildTo(int duration, float axisPosition)
 573         {
 574             Debug.WriteLineIf(LayoutDebugScrollableBase, "AnimationTo Animation Duration:" + duration + " Destination:" + axisPosition);
 575             finalTargetPosition = axisPosition;
 576
 577             StopScroll(); // Will replace previous animation so will stop existing one.
 578
 579             if (scrollAnimation == null)
 580             {
 581                 scrollAnimation = new Animation();
 582                 scrollAnimation.Finished += ScrollAnimationFinished;
 583             }
 584
 585             scrollAnimation.Duration = duration;
 586             scrollAnimation.DefaultAlphaFunction = new AlphaFunction(AlphaFunction.BuiltinFunctions.EaseOutSine);
 587             scrollAnimation.AnimateTo(mScrollingChild, (ScrollingDirection == Direction.Horizontal) ? "PositionX" : "PositionY", axisPosition);
 588             scrolling = true;
 589             OnScrollAnimationStart();
 590             scrollAnimation.Play();
 591         }
 592
 593         /// <summary>
 594         /// Scroll to specific position with or without animation.
 595         /// </summary>
 596         /// <param name="position">Destination.</param>
 597         /// <param name="animate">Scroll with or without animation</param>
 598         [EditorBrowsable(EditorBrowsableState.Never)]
 599         public void ScrollTo(float position, bool animate)
 600         {
 601             float currentPositionX = mScrollingChild.CurrentPosition.X != 0 ? mScrollingChild.CurrentPosition.X : mScrollingChild.Position.X;
 602             float currentPositionY = mScrollingChild.CurrentPosition.Y != 0 ? mScrollingChild.CurrentPosition.Y : mScrollingChild.Position.Y;
 603             float delta = ScrollingDirection == Direction.Horizontal ? currentPositionX : currentPositionY;
 604             // The argument position is the new pan position. So the new position of ScrollableBase becomes (-position).
 605             // To move ScrollableBase's position to (-position), it moves by (-position - currentPosition).
 606             delta = -position - delta;
 607
 608             ScrollBy(delta, animate);
 609         }
 610
 611         private float BoundScrollPosition(float targetPosition)
 612         {
 613             if (ScrollAvailableArea != null)
 614             {
 615                 float minScrollPosition = ScrollAvailableArea.X;
 616                 float maxScrollPosition = ScrollAvailableArea.Y;
 617
 618                 targetPosition = Math.Min(-minScrollPosition, targetPosition);
 619                 targetPosition = Math.Max(-maxScrollPosition, targetPosition);
 620             }
 621             else
 622             {
 623                 targetPosition = Math.Min(0, targetPosition);
 624                 targetPosition = Math.Max(-maxScrollDistance, targetPosition);
 625             }
 626
 627             return targetPosition;
 628         }
 629
 630         private void ScrollBy(float displacement, bool animate)
 631         {
 632             if (GetChildCount() == 0 || maxScrollDistance < 0)
 633             {
 634                 return;
 635             }
 636
 637             float childCurrentPosition = (ScrollingDirection == Direction.Horizontal) ? mScrollingChild.PositionX : mScrollingChild.PositionY;
 638
 639             Debug.WriteLineIf(LayoutDebugScrollableBase, "ScrollBy childCurrentPosition:" + childCurrentPosition +
 640                                                    " displacement:" + displacement,
 641                                                    " maxScrollDistance:" + maxScrollDistance);
 642
 643             childTargetPosition = childCurrentPosition + displacement; // child current position + gesture displacement
 644
 645
 646             Debug.WriteLineIf(LayoutDebugScrollableBase, "ScrollBy currentAxisPosition:" + childCurrentPosition + "childTargetPosition:" + childTargetPosition);
 647
 648             if (animate)
 649             {
 650                 // Calculate scroll animaton duration
 651                 float scrollDistance = Math.Abs(displacement);
 652                 int duration = (int)((320 * FlickAnimationSpeed) + (scrollDistance * FlickAnimationSpeed));
 653                 Debug.WriteLineIf(LayoutDebugScrollableBase, "Scroll Animation Duration:" + duration + " Distance:" + scrollDistance);
 654
 655                 readyToNotice = true;
 656
 657                 AnimateChildTo(duration, BoundScrollPosition(AdjustTargetPositionOfScrollAnimation(BoundScrollPosition(childTargetPosition))));
 658             }
 659             else
 660             {
 661                 finalTargetPosition = BoundScrollPosition(childTargetPosition);
 662
 663                 // Set position of scrolling child without an animation
 664                 if (ScrollingDirection == Direction.Horizontal)
 665                 {
 666                     mScrollingChild.PositionX = finalTargetPosition;
 667                 }
 668                 else
 669                 {
 670                     mScrollingChild.PositionY = finalTargetPosition;
 671                 }
 672
 673             }
 674         }
 675
 676         /// <summary>
 677         /// you can override it to clean-up your own resources.
 678         /// </summary>
 679         /// <param name="type">DisposeTypes</param>
 680         /// <since_tizen> 6 </since_tizen>
 681         /// This will be public opened in tizen_5.5 after ACR done. Before ACR, need to be hidden as inhouse API.
 682         [EditorBrowsable(EditorBrowsableState.Never)]
 683         protected override void Dispose(DisposeTypes type)
 684         {
 685             if (disposed)
 686             {
 687                 return;
 688             }
 689
 690             if (type == DisposeTypes.Explicit)
 691             {
 692                 StopScroll();
 693
 694                 if (mPanGestureDetector != null)
 695                 {
 696                     mPanGestureDetector.Detected -= OnPanGestureDetected;
 697                     mPanGestureDetector.Dispose();
 698                     mPanGestureDetector = null;
 699                 }
 700
 701                 if (mTapGestureDetector != null)
 702                 {
 703                     mTapGestureDetector.Detected -= OnTapGestureDetected;
 704                     mTapGestureDetector.Dispose();
 705                     mTapGestureDetector = null;
 706                 }
 707             }
 708             base.Dispose(type);
 709         }
 710
 711         private float CalculateDisplacementFromVelocity(float axisVelocity)
 712         {
 713             // Map: flick speed of range (2.0 - 6.0) to flick multiplier of range (0.7 - 1.6)
 714             float speedMinimum = FlickThreshold;
 715             float speedMaximum = FlickThreshold + 6.0f;
 716             float multiplierMinimum = FlickDistanceMultiplierRange.X;
 717             float multiplierMaximum = FlickDistanceMultiplierRange.Y;
 718
 719             float flickDisplacement = 0.0f;
 720
 721             float speed = Math.Min(4.0f, Math.Abs(axisVelocity));
 722
 723             Debug.WriteLineIf(LayoutDebugScrollableBase, "ScrollableBase Candidate Flick speed:" + speed);
 724
 725             if (speed > FlickThreshold)
 726             {
 727                 // Flick length is the length of the ScrollableBase.
 728                 float flickLength = (ScrollingDirection == Direction.Horizontal) ? CurrentSize.Width : CurrentSize.Height;
 729
 730                 // Calculate multiplier by mapping speed between the multiplier minimum and maximum.
 731                 multiplier = ((speed - speedMinimum) / ((speedMaximum - speedMinimum) * (multiplierMaximum - multiplierMinimum))) + multiplierMinimum;
 732
 733                 // flick displacement is the product of the flick length and multiplier
 734                 flickDisplacement = ((flickLength * multiplier) * speed) / axisVelocity;  // *speed and /velocity to perserve sign.
 735
 736                 Debug.WriteLineIf(LayoutDebugScrollableBase, "Calculated FlickDisplacement[" + flickDisplacement + "] from speed[" + speed + "] multiplier:"
 737                                                         + multiplier);
 738             }
 739             return flickDisplacement;
 740         }
 741
 742         private float CalculateMaximumScrollDistance()
 743         {
 744             int scrollingChildLength = 0;
 745             int scrollerLength = 0;
 746             if (ScrollingDirection == Direction.Horizontal)
 747             {
 748                 Debug.WriteLineIf(LayoutDebugScrollableBase, "Horizontal");
 749
 750                 scrollingChildLength = (int)mScrollingChild.Layout.MeasuredWidth.Size.AsRoundedValue();
 751                 scrollerLength = CurrentSize.Width;
 752             }
 753             else
 754             {
 755                 Debug.WriteLineIf(LayoutDebugScrollableBase, "Vertical");
 756                 scrollingChildLength = (int)mScrollingChild.Layout.MeasuredHeight.Size.AsRoundedValue();
 757                 scrollerLength = CurrentSize.Height;
 758             }
 759
 760             Debug.WriteLineIf(LayoutDebugScrollableBase, "ScrollBy maxScrollDistance:" + (scrollingChildLength - scrollerLength) +
 761                                                    " parent length:" + scrollerLength +
 762                                                    " scrolling child length:" + scrollingChildLength);
 763
 764             return Math.Max(scrollingChildLength - scrollerLength, 0);
 765         }
 766
 767         private void PageSnap()
 768         {
 769             Debug.WriteLineIf(LayoutDebugScrollableBase, "PageSnap with pan candidate totalDisplacement:" + totalDisplacementForPan +
 770                                                                 " currentPage[" + CurrentPage + "]");
 771
 772             //Increment current page if total displacement enough to warrant a page change.
 773             if (Math.Abs(totalDisplacementForPan) > (mPageWidth * ratioOfScreenWidthToCompleteScroll))
 774             {
 775                 if (totalDisplacementForPan < 0)
 776                 {
 777                     CurrentPage = Math.Min(Math.Max(mScrollingChild.Children.Count - 1, 0), ++CurrentPage);
 778                 }
 779                 else
 780                 {
 781                     CurrentPage = Math.Max(0, --CurrentPage);
 782                 }
 783             }
 784
 785             // Animate to new page or reposition to current page
 786             float destinationX = -(mScrollingChild.Children[CurrentPage].Position.X + mScrollingChild.Children[CurrentPage].CurrentSize.Width / 2 - CurrentSize.Width / 2); // set to middle of current page
 787             Debug.WriteLineIf(LayoutDebugScrollableBase, "Snapping to page[" + CurrentPage + "] to:" + destinationX + " from:" + mScrollingChild.PositionX);
 788             AnimateChildTo(ScrollDuration, destinationX);
 789         }
 790
 791         private void Flick(float flickDisplacement)
 792         {
 793             if (SnapToPage)
 794             {
 795                 if ((flickWhenAnimating && scrolling == true) || (scrolling == false))
 796                 {
 797                     if (flickDisplacement < 0)
 798                     {
 799                         CurrentPage = Math.Min(Math.Max(mScrollingChild.Children.Count - 1, 0), CurrentPage + 1);
 800                         Debug.WriteLineIf(LayoutDebugScrollableBase, "Snap - to page:" + CurrentPage);
 801                     }
 802                     else
 803                     {
 804                         CurrentPage = Math.Max(0, CurrentPage - 1);
 805                         Debug.WriteLineIf(LayoutDebugScrollableBase, "Snap + to page:" + CurrentPage);
 806                     }
 807
 808                     float destinationX = -(mScrollingChild.Children[CurrentPage].Position.X + mScrollingChild.Children[CurrentPage].CurrentSize.Width / 2.0f - CurrentSize.Width / 2.0f); // set to middle of current page
 809                     Debug.WriteLineIf(LayoutDebugScrollableBase, "Snapping to :" + destinationX);
 810                     AnimateChildTo(ScrollDuration, destinationX);
 811                 }
 812             }
 813             else
 814             {
 815                 ScrollBy(flickDisplacement, true); // Animate flickDisplacement.
 816             }
 817         }
 818
 819         private void OnPanGestureDetected(object source, PanGestureDetector.DetectedEventArgs e)
 820         {
 821             if (e.PanGesture.State == Gesture.StateType.Started)
 822             {
 823                 Add(mInterruptTouchingChild);
 824                 Debug.WriteLineIf(LayoutDebugScrollableBase, "Gesture Start");
 825                 if (scrolling && !SnapToPage)
 826                 {
 827                     StopScroll();
 828                 }
 829                 totalDisplacementForPan = 0.0f;
 830                 OnScrollDragStart();
 831             }
 832             else if (e.PanGesture.State == Gesture.StateType.Continuing)
 833             {
 834                 if (ScrollingDirection == Direction.Horizontal)
 835                 {
 836                     ScrollBy(e.PanGesture.Displacement.X, false);
 837                     totalDisplacementForPan += e.PanGesture.Displacement.X;
 838                 }
 839                 else
 840                 {
 841                     ScrollBy(e.PanGesture.Displacement.Y, false);
 842                     totalDisplacementForPan += e.PanGesture.Displacement.Y;
 843                 }
 844                 Debug.WriteLineIf(LayoutDebugScrollableBase, "OnPanGestureDetected Continue totalDisplacementForPan:" + totalDisplacementForPan);
 845             }
 846             else if (e.PanGesture.State == Gesture.StateType.Finished)
 847             {
 848                 float axisVelocity = (ScrollingDirection == Direction.Horizontal) ? e.PanGesture.Velocity.X : e.PanGesture.Velocity.Y;
 849                 float flickDisplacement = CalculateDisplacementFromVelocity(axisVelocity);
 850
 851                 Debug.WriteLineIf(LayoutDebugScrollableBase, "FlickDisplacement:" + flickDisplacement + "TotalDisplacementForPan:" + totalDisplacementForPan);
 852                 OnScrollDragEnd();
 853
 854                 if (flickDisplacement > 0 | flickDisplacement < 0)// Flick detected
 855                 {
 856                     Flick(flickDisplacement);
 857                 }
 858                 else
 859                 {
 860                     // End of panning gesture but was not a flick
 861                     if (SnapToPage)
 862                     {
 863                         PageSnap();
 864                     }
 865                     else
 866                     {
 867                         ScrollBy(0, true);
 868                     }
 869                 }
 870                 totalDisplacementForPan = 0;
 871
 872                 Remove(mInterruptTouchingChild);
 873             }
 874         }
 875
 876         private new void OnTapGestureDetected(object source, TapGestureDetector.DetectedEventArgs e)
 877         {
 878             if (e.TapGesture.Type == Gesture.GestureType.Tap)
 879             {
 880                 // Stop scrolling if tap detected (press then relase).
 881                 // Unless in Pages mode, do not want a page change to stop part way.
 882                 if (scrolling && !SnapToPage)
 883                 {
 884                     StopScroll();
 885                 }
 886             }
 887         }
 888
 889         private void ScrollAnimationFinished(object sender, EventArgs e)
 890         {
 891             scrolling = false;
 892             CheckPreReachedTargetPosition();
 893             OnScrollAnimationEnd();
 894         }
 895
 896         /// <summary>
 897         /// Adjust scrolling position by own scrolling rules.
 898         /// Override this function when developer wants to change destination of flicking.(e.g. always snap to center of item)
 899         /// </summary>
 900         /// <since_tizen> 6 </since_tizen>
 901         /// This may be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API
 902         [EditorBrowsable(EditorBrowsableState.Never)]
 903         protected virtual float AdjustTargetPositionOfScrollAnimation(float position)
 904         {
 905             return position;
 906         }
 907
 908     }
 909
 910 } // namespace