1 /* Copyright (c) 2020 Samsung Electronics Co., Ltd.
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
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
17 using Tizen.NUI.BaseComponents;
18 using System.ComponentModel;
19 using System.Diagnostics;
21 namespace Tizen.NUI.Components
24 /// [Draft] This class provides a View that can scroll a single View with a layout. This View can be a nest of Views.
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
30 static bool LayoutDebugScrollableBase = false; // Debug flag
31 private Direction mScrollingDirection = Direction.Vertical;
32 private bool mScrollEnabled = true;
33 private int mPageWidth = 0;
35 private class ScrollableBaseCustomLayout : LayoutGroup
37 protected override void OnMeasure(MeasureSpecification widthMeasureSpec, MeasureSpecification heightMeasureSpec)
39 Extents padding = Padding;
40 float totalHeight = padding.Top + padding.Bottom;
41 float totalWidth = padding.Start + padding.End;
43 MeasuredSize.StateType childWidthState = MeasuredSize.StateType.MeasuredSizeOK;
44 MeasuredSize.StateType childHeightState = MeasuredSize.StateType.MeasuredSizeOK;
46 Direction scrollingDirection = Direction.Vertical;
47 ScrollableBase scrollableBase = this.Owner as ScrollableBase;
50 scrollingDirection = scrollableBase.ScrollingDirection;
53 // measure child, should be a single scrolling child
54 foreach (LayoutItem childLayout in LayoutChildren)
56 if (childLayout != null)
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);
63 if (scrollingDirection == Direction.Vertical)
65 MeasureChild(childLayout, widthMeasureSpec, unrestrictedMeasureSpec); // Height unrestricted by parent
69 MeasureChild(childLayout, unrestrictedMeasureSpec, heightMeasureSpec); // Width unrestricted by parent
72 float childWidth = childLayout.MeasuredWidth.Size.AsDecimal();
73 float childHeight = childLayout.MeasuredHeight.Size.AsDecimal();
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;
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;
86 if (childLayout.MeasuredWidth.State == MeasuredSize.StateType.MeasuredSizeTooSmall)
88 childWidthState = MeasuredSize.StateType.MeasuredSizeTooSmall;
90 if (childLayout.MeasuredWidth.State == MeasuredSize.StateType.MeasuredSizeTooSmall)
92 childHeightState = MeasuredSize.StateType.MeasuredSizeTooSmall;
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();
103 // Ensure layout respects it's given minimum size
104 totalWidth = Math.Max(totalWidth, SuggestedMinimumWidth.AsDecimal());
105 totalHeight = Math.Max(totalHeight, SuggestedMinimumHeight.AsDecimal());
107 widthSizeAndState.State = childWidthState;
108 heightSizeAndState.State = childHeightState;
110 SetMeasuredDimensions(ResolveSizeAndState(new LayoutLength(totalWidth + Padding.Start + Padding.End), widthMeasureSpec, childWidthState),
111 ResolveSizeAndState(new LayoutLength(totalHeight + Padding.Top + Padding.Bottom), heightMeasureSpec, childHeightState));
113 // Size of ScrollableBase is changed. Change Page width too.
114 scrollableBase.mPageWidth = (int)MeasuredWidth.Size.AsRoundedValue();
117 protected override void OnLayout(bool changed, LayoutLength left, LayoutLength top, LayoutLength right, LayoutLength bottom)
119 foreach (LayoutItem childLayout in LayoutChildren)
121 if (childLayout != null)
123 LayoutLength childWidth = childLayout.MeasuredWidth.Size;
124 LayoutLength childHeight = childLayout.MeasuredHeight.Size;
126 Position2D childPosition = childLayout.Owner.Position2D;
127 Extents padding = Padding;
128 Extents childMargin = childLayout.Margin;
130 LayoutLength childLeft = new LayoutLength(childPosition.X + childMargin.Start + padding.Start);
131 LayoutLength childTop = new LayoutLength(childPosition.Y + childMargin.Top + padding.Top);
133 childLayout.Layout(childLeft, childTop, childLeft + childWidth, childTop + childHeight);
137 } // ScrollableBaseCustomLayout
140 /// The direction axis to scroll.
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
150 /// <since_tizen> 6 </since_tizen>
156 /// <since_tizen> 6 </since_tizen>
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.
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;
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)
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;
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.
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);
188 /// [Draft] Scrolling direction mode.
189 /// Default is Vertical scrolling.
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
197 return mScrollingDirection;
201 if (value != mScrollingDirection)
203 mScrollingDirection = value;
204 mPanGestureDetector.RemoveDirection(value == Direction.Horizontal ? PanGestureDetector.DirectionVertical : PanGestureDetector.DirectionHorizontal);
205 mPanGestureDetector.AddDirection(value == Direction.Horizontal ? PanGestureDetector.DirectionHorizontal : PanGestureDetector.DirectionVertical);
211 /// [Draft] Enable or disable scrolling.
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
219 return mScrollEnabled;
223 if (value != mScrollEnabled)
225 mScrollEnabled = value;
228 mPanGestureDetector.Detected += OnPanGestureDetected;
229 mTapGestureDetector.Detected += OnTapGestureDetected;
233 mPanGestureDetector.Detected -= OnPanGestureDetected;
234 mTapGestureDetector.Detected -= OnTapGestureDetected;
241 /// [Draft] Pages mode, enables moving to the next or return to current page depending on pan displacement.
242 /// Default is false.
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;
249 /// [Draft] Get current page.
250 /// Working propery with SnapToPage property.
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;
257 /// [Draft] Duration of scroll animation.
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)]
262 public int ScrollDuration { set; get; } = 125;
264 /// [Draft] Scroll Available area.
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; }
271 /// ScrollEventArgs is a class to record scroll event arguments which will sent to user.
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
281 /// Default constructor.
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)
288 this.position = position;
292 /// [Draft] Current scroll position.
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
306 /// An event emitted when user starts dragging ScrollableBase, user can subscribe or unsubscribe to this event handler.<br />
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;
314 /// An event emitted when user stops dragging ScrollableBase, user can subscribe or unsubscribe to this event handler.<br />
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;
323 /// An event emitted when the scrolling slide animation starts, user can subscribe or unsubscribe to this event handler.<br />
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;
331 /// An event emitted when the scrolling slide animation ends, user can subscribe or unsubscribe to this event handler.<br />
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;
340 /// An event emitted when scrolling, user can subscribe or unsubscribe to this event handler.<br />
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;
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;
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;
365 /// [Draft] Constructor
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()
372 mPanGestureDetector = new PanGestureDetector();
373 mPanGestureDetector.Attach(this);
374 mPanGestureDetector.AddDirection(PanGestureDetector.DirectionVertical);
375 mPanGestureDetector.Detected += OnPanGestureDetected;
377 mTapGestureDetector = new TapGestureDetector();
378 mTapGestureDetector.Attach(this);
379 mTapGestureDetector.Detected += OnTapGestureDetected;
382 ClippingMode = ClippingModeType.ClipToBoundingBox;
384 mScrollingChild = new View();
385 mScrollingChild.Name = "DefaultScrollingChild";
387 //Interrupt touching when panning is started;
388 mInterruptTouchingChild = new View()
390 Name = "InterruptTouchingChild",
391 Size = new Size(Window.Instance.WindowSize),
392 BackgroundColor = Color.Transparent,
395 mInterruptTouchingChild.TouchEvent += (object source, View.TouchEventArgs args) =>
400 Layout = new ScrollableBaseCustomLayout();
403 private void OnPropertyChanged(object source, PropertyNotification.NotifyEventArgs args)
409 /// Called after a child has been added to the owning view.
411 /// <param name="view">The child which has been added.</param>
412 /// <since_tizen> 6 </since_tizen>
413 /// This may be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API
414 [EditorBrowsable(EditorBrowsableState.Never)]
415 public override void OnChildAdd(View view)
417 if (view.Name != "InterruptTouchingChild")
419 if (mScrollingChild.Name != "DefaultScrollingChild")
421 propertyNotification.Notified -= OnPropertyChanged;
422 mScrollingChild.RemovePropertyNotification(propertyNotification);
425 mScrollingChild = view;
426 propertyNotification = mScrollingChild?.AddPropertyNotification("position", PropertyCondition.Step(1.0f));
427 propertyNotification.Notified += OnPropertyChanged;
432 /// Called after a child has been removed from the owning view.
434 /// <param name="view">The child which has been removed.</param>
435 /// <since_tizen> 6 </since_tizen>
436 /// This may be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API
437 [EditorBrowsable(EditorBrowsableState.Never)]
438 public override void OnChildRemove(View view)
440 if (view.Name != "InterruptTouchingChild")
442 propertyNotification.Notified -= OnPropertyChanged;
443 mScrollingChild.RemovePropertyNotification(propertyNotification);
445 mScrollingChild = new View();
450 /// Scrolls to the item at the specified index.
452 /// <param name="index">Index of item.</param>
453 /// <since_tizen> 6 </since_tizen>
454 /// This may be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API
455 [EditorBrowsable(EditorBrowsableState.Never)]
456 public void ScrollToIndex(int index)
458 if (mScrollingChild.ChildCount - 1 < index || index < 0)
468 maxScrollDistance = CalculateMaximumScrollDistance();
470 float targetPosition = Math.Min(ScrollingDirection == Direction.Vertical ? mScrollingChild.Children[index].Position.Y : mScrollingChild.Children[index].Position.X, maxScrollDistance);
471 AnimateChildTo(ScrollDuration, -targetPosition);
474 private void OnScrollDragStart()
476 ScrollEventArgs eventArgs = new ScrollEventArgs(mScrollingChild.CurrentPosition);
477 ScrollDragStartEvent?.Invoke(this, eventArgs);
480 private void OnScrollDragEnd()
482 ScrollEventArgs eventArgs = new ScrollEventArgs(mScrollingChild.CurrentPosition);
483 ScrollDragEndEvent?.Invoke(this, eventArgs);
486 private void OnScrollAnimationStart()
488 ScrollEventArgs eventArgs = new ScrollEventArgs(mScrollingChild.CurrentPosition);
489 ScrollAnimationStartEvent?.Invoke(this, eventArgs);
492 private void OnScrollAnimationEnd()
494 ScrollEventArgs eventArgs = new ScrollEventArgs(mScrollingChild.CurrentPosition);
495 ScrollAnimationEndEvent?.Invoke(this, eventArgs);
498 private bool readyToNotice = false;
500 protected float noticeAnimationEndBeforePosition = 0.0f;
502 private void OnScroll()
504 ScrollEventArgs eventArgs = new ScrollEventArgs(mScrollingChild.CurrentPosition);
505 ScrollEvent?.Invoke(this, eventArgs);
507 CheckPreReachedTargetPosition();
510 private void CheckPreReachedTargetPosition()
512 // Check whether we reached pre-reached target position
514 mScrollingChild.CurrentPosition.Y <= finalTargetPosition + noticeAnimationEndBeforePosition &&
515 mScrollingChild.CurrentPosition.Y >= finalTargetPosition - noticeAnimationEndBeforePosition)
518 readyToNotice = false;
519 OnPreReachedTargetPosition(finalTargetPosition);
524 /// This helps developer who wants to know before scroll is reaching target position.
526 /// <param name="targetPosition">Index of item.</param>
527 /// <since_tizen> 6 </since_tizen>
528 /// This may be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API
529 [EditorBrowsable(EditorBrowsableState.Never)]
530 protected virtual void OnPreReachedTargetPosition(float targetPosition)
535 private void StopScroll()
537 if (scrollAnimation != null)
539 if (scrollAnimation.State == Animation.States.Playing)
541 Debug.WriteLineIf(LayoutDebugScrollableBase, "StopScroll Animation Playing");
542 scrollAnimation.Stop(Animation.EndActions.Cancel);
543 OnScrollAnimationEnd();
545 scrollAnimation.Clear();
549 // static constructor registers the control type
550 static ScrollableBase()
552 // ViewRegistry registers control type with DALi type registry
553 // also uses introspection to find any properties that need to be registered with type registry
554 CustomViewRegistry.Instance.Register(CreateInstance, typeof(ScrollableBase));
557 internal static CustomView CreateInstance()
559 return new ScrollableBase();
562 private void AnimateChildTo(int duration, float axisPosition)
564 Debug.WriteLineIf(LayoutDebugScrollableBase, "AnimationTo Animation Duration:" + duration + " Destination:" + axisPosition);
565 finalTargetPosition = axisPosition;
567 StopScroll(); // Will replace previous animation so will stop existing one.
569 if (scrollAnimation == null)
571 scrollAnimation = new Animation();
572 scrollAnimation.Finished += ScrollAnimationFinished;
575 scrollAnimation.Duration = duration;
576 scrollAnimation.DefaultAlphaFunction = new AlphaFunction(AlphaFunction.BuiltinFunctions.EaseOutSine);
577 scrollAnimation.AnimateTo(mScrollingChild, (ScrollingDirection == Direction.Horizontal) ? "PositionX" : "PositionY", axisPosition);
579 OnScrollAnimationStart();
580 scrollAnimation.Play();
584 /// Scroll to specific position with or without animation.
586 /// <param name="position">Destination.</param>
587 /// <param name="animate">Scroll with or without animation</param>
588 [EditorBrowsable(EditorBrowsableState.Never)]
589 public void ScrollTo(float position, bool animate)
591 float currentPositionX = mScrollingChild.CurrentPosition.X != 0 ? mScrollingChild.CurrentPosition.X : mScrollingChild.Position.X;
592 float currentPositionY = mScrollingChild.CurrentPosition.Y != 0 ? mScrollingChild.CurrentPosition.Y : mScrollingChild.Position.Y;
593 float delta = ScrollingDirection == Direction.Horizontal ? currentPositionX : currentPositionY;
594 // The argument position is the new pan position. So the new position of ScrollableBase becomes (-position).
595 // To move ScrollableBase's position to (-position), it moves by (-position - currentPosition).
596 delta = -position - delta;
598 ScrollBy(delta, animate);
601 private float BoundScrollPosition(float targetPosition)
603 if (ScrollAvailableArea != null)
605 float minScrollPosition = ScrollAvailableArea.X;
606 float maxScrollPosition = ScrollAvailableArea.Y;
608 targetPosition = Math.Min(-minScrollPosition, targetPosition);
609 targetPosition = Math.Max(-maxScrollPosition, targetPosition);
613 targetPosition = Math.Min(0, targetPosition);
614 targetPosition = Math.Max(-maxScrollDistance, targetPosition);
617 return targetPosition;
620 private void ScrollBy(float displacement, bool animate)
622 if (GetChildCount() == 0 || maxScrollDistance < 0)
627 float childCurrentPosition = (ScrollingDirection == Direction.Horizontal) ? mScrollingChild.PositionX : mScrollingChild.PositionY;
629 Debug.WriteLineIf(LayoutDebugScrollableBase, "ScrollBy childCurrentPosition:" + childCurrentPosition +
630 " displacement:" + displacement,
631 " maxScrollDistance:" + maxScrollDistance);
633 childTargetPosition = childCurrentPosition + displacement; // child current position + gesture displacement
636 Debug.WriteLineIf(LayoutDebugScrollableBase, "ScrollBy currentAxisPosition:" + childCurrentPosition + "childTargetPosition:" + childTargetPosition);
640 // Calculate scroll animaton duration
641 float scrollDistance = Math.Abs(displacement);
642 int duration = (int)((320 * FlickAnimationSpeed) + (scrollDistance * FlickAnimationSpeed));
643 Debug.WriteLineIf(LayoutDebugScrollableBase, "Scroll Animation Duration:" + duration + " Distance:" + scrollDistance);
645 readyToNotice = true;
647 AnimateChildTo(duration, BoundScrollPosition(AdjustTargetPositionOfScrollAnimation(BoundScrollPosition(childTargetPosition))));
651 finalTargetPosition = BoundScrollPosition(childTargetPosition);
653 // Set position of scrolling child without an animation
654 if (ScrollingDirection == Direction.Horizontal)
656 mScrollingChild.PositionX = finalTargetPosition;
660 mScrollingChild.PositionY = finalTargetPosition;
667 /// you can override it to clean-up your own resources.
669 /// <param name="type">DisposeTypes</param>
670 /// <since_tizen> 6 </since_tizen>
671 /// This will be public opened in tizen_5.5 after ACR done. Before ACR, need to be hidden as inhouse API.
672 [EditorBrowsable(EditorBrowsableState.Never)]
673 protected override void Dispose(DisposeTypes type)
680 if (type == DisposeTypes.Explicit)
684 if (mPanGestureDetector != null)
686 mPanGestureDetector.Detected -= OnPanGestureDetected;
687 mPanGestureDetector.Dispose();
688 mPanGestureDetector = null;
691 if (mTapGestureDetector != null)
693 mTapGestureDetector.Detected -= OnTapGestureDetected;
694 mTapGestureDetector.Dispose();
695 mTapGestureDetector = null;
701 private float CalculateDisplacementFromVelocity(float axisVelocity)
703 // Map: flick speed of range (2.0 - 6.0) to flick multiplier of range (0.7 - 1.6)
704 float speedMinimum = FlickThreshold;
705 float speedMaximum = FlickThreshold + 6.0f;
706 float multiplierMinimum = FlickDistanceMultiplierRange.X;
707 float multiplierMaximum = FlickDistanceMultiplierRange.Y;
709 float flickDisplacement = 0.0f;
711 float speed = Math.Min(4.0f, Math.Abs(axisVelocity));
713 Debug.WriteLineIf(LayoutDebugScrollableBase, "ScrollableBase Candidate Flick speed:" + speed);
715 if (speed > FlickThreshold)
717 // Flick length is the length of the ScrollableBase.
718 float flickLength = (ScrollingDirection == Direction.Horizontal) ? CurrentSize.Width : CurrentSize.Height;
720 // Calculate multiplier by mapping speed between the multiplier minimum and maximum.
721 multiplier = ((speed - speedMinimum) / ((speedMaximum - speedMinimum) * (multiplierMaximum - multiplierMinimum))) + multiplierMinimum;
723 // flick displacement is the product of the flick length and multiplier
724 flickDisplacement = ((flickLength * multiplier) * speed) / axisVelocity; // *speed and /velocity to perserve sign.
726 Debug.WriteLineIf(LayoutDebugScrollableBase, "Calculated FlickDisplacement[" + flickDisplacement + "] from speed[" + speed + "] multiplier:"
729 return flickDisplacement;
732 private float CalculateMaximumScrollDistance()
734 int scrollingChildLength = 0;
735 int scrollerLength = 0;
736 if (ScrollingDirection == Direction.Horizontal)
738 Debug.WriteLineIf(LayoutDebugScrollableBase, "Horizontal");
740 scrollingChildLength = (int)mScrollingChild.Layout.MeasuredWidth.Size.AsRoundedValue();
741 scrollerLength = CurrentSize.Width;
745 Debug.WriteLineIf(LayoutDebugScrollableBase, "Vertical");
746 scrollingChildLength = (int)mScrollingChild.Layout.MeasuredHeight.Size.AsRoundedValue();
747 scrollerLength = CurrentSize.Height;
750 Debug.WriteLineIf(LayoutDebugScrollableBase, "ScrollBy maxScrollDistance:" + (scrollingChildLength - scrollerLength) +
751 " parent length:" + scrollerLength +
752 " scrolling child length:" + scrollingChildLength);
754 return Math.Max(scrollingChildLength - scrollerLength, 0);
757 private void PageSnap()
759 Debug.WriteLineIf(LayoutDebugScrollableBase, "PageSnap with pan candidate totalDisplacement:" + totalDisplacementForPan +
760 " currentPage[" + CurrentPage + "]");
762 //Increment current page if total displacement enough to warrant a page change.
763 if (Math.Abs(totalDisplacementForPan) > (mPageWidth * ratioOfScreenWidthToCompleteScroll))
765 if (totalDisplacementForPan < 0)
767 CurrentPage = Math.Min(Math.Max(mScrollingChild.Children.Count - 1, 0), ++CurrentPage);
771 CurrentPage = Math.Max(0, --CurrentPage);
775 // Animate to new page or reposition to current page
776 float destinationX = -(mScrollingChild.Children[CurrentPage].Position.X + mScrollingChild.Children[CurrentPage].CurrentSize.Width / 2 - CurrentSize.Width / 2); // set to middle of current page
777 Debug.WriteLineIf(LayoutDebugScrollableBase, "Snapping to page[" + CurrentPage + "] to:" + destinationX + " from:" + mScrollingChild.PositionX);
778 AnimateChildTo(ScrollDuration, destinationX);
781 private void Flick(float flickDisplacement)
785 if ((flickWhenAnimating && scrolling == true) || (scrolling == false))
787 if (flickDisplacement < 0)
789 CurrentPage = Math.Min(Math.Max(mScrollingChild.Children.Count - 1, 0), CurrentPage + 1);
790 Debug.WriteLineIf(LayoutDebugScrollableBase, "Snap - to page:" + CurrentPage);
794 CurrentPage = Math.Max(0, CurrentPage - 1);
795 Debug.WriteLineIf(LayoutDebugScrollableBase, "Snap + to page:" + CurrentPage);
798 float destinationX = -(mScrollingChild.Children[CurrentPage].Position.X + mScrollingChild.Children[CurrentPage].CurrentSize.Width / 2.0f - CurrentSize.Width / 2.0f); // set to middle of current page
799 Debug.WriteLineIf(LayoutDebugScrollableBase, "Snapping to :" + destinationX);
800 AnimateChildTo(ScrollDuration, destinationX);
805 ScrollBy(flickDisplacement, true); // Animate flickDisplacement.
809 private void OnPanGestureDetected(object source, PanGestureDetector.DetectedEventArgs e)
811 if (e.PanGesture.State == Gesture.StateType.Started)
813 Add(mInterruptTouchingChild);
814 Debug.WriteLineIf(LayoutDebugScrollableBase, "Gesture Start");
815 if (scrolling && !SnapToPage)
819 maxScrollDistance = CalculateMaximumScrollDistance();
820 totalDisplacementForPan = 0.0f;
823 else if (e.PanGesture.State == Gesture.StateType.Continuing)
825 if (ScrollingDirection == Direction.Horizontal)
827 ScrollBy(e.PanGesture.Displacement.X, false);
828 totalDisplacementForPan += e.PanGesture.Displacement.X;
832 ScrollBy(e.PanGesture.Displacement.Y, false);
833 totalDisplacementForPan += e.PanGesture.Displacement.Y;
835 Debug.WriteLineIf(LayoutDebugScrollableBase, "OnPanGestureDetected Continue totalDisplacementForPan:" + totalDisplacementForPan);
837 else if (e.PanGesture.State == Gesture.StateType.Finished)
839 float axisVelocity = (ScrollingDirection == Direction.Horizontal) ? e.PanGesture.Velocity.X : e.PanGesture.Velocity.Y;
840 float flickDisplacement = CalculateDisplacementFromVelocity(axisVelocity);
842 Debug.WriteLineIf(LayoutDebugScrollableBase, "FlickDisplacement:" + flickDisplacement + "TotalDisplacementForPan:" + totalDisplacementForPan);
845 if (flickDisplacement > 0 | flickDisplacement < 0)// Flick detected
847 Flick(flickDisplacement);
851 // End of panning gesture but was not a flick
861 totalDisplacementForPan = 0;
863 Remove(mInterruptTouchingChild);
867 private new void OnTapGestureDetected(object source, TapGestureDetector.DetectedEventArgs e)
869 if (e.TapGesture.Type == Gesture.GestureType.Tap)
871 // Stop scrolling if tap detected (press then relase).
872 // Unless in Pages mode, do not want a page change to stop part way.
873 if (scrolling && !SnapToPage)
880 private void ScrollAnimationFinished(object sender, EventArgs e)
883 CheckPreReachedTargetPosition();
884 OnScrollAnimationEnd();
888 /// Adjust scrolling position by own scrolling rules.
889 /// Override this function when developer wants to change destination of flicking.(e.g. always snap to center of item)
891 /// <since_tizen> 6 </since_tizen>
892 /// This may be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API
893 [EditorBrowsable(EditorBrowsableState.Never)]
894 protected virtual float AdjustTargetPositionOfScrollAnimation(float position)