2 * Copyright(c) 2020 Samsung Electronics Co., Ltd.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
18 using System.ComponentModel;
19 using Tizen.NUI.BaseComponents;
20 using Tizen.NUI.Binding;
22 namespace Tizen.NUI.Components
25 /// The Scrollbar is a component that contains track and thumb to indicate the current scrolled position of a scrollable object.
27 [EditorBrowsable(EditorBrowsableState.Never)]
28 public class Scrollbar : ScrollbarBase
32 /// <summary>Bindable property of TrackThickness</summary>
33 [EditorBrowsable(EditorBrowsableState.Never)]
34 public static readonly BindableProperty TrackThicknessProperty = BindableProperty.Create(nameof(TrackThickness), typeof(float), typeof(Scrollbar), default(float), propertyChanged: (bindable, oldValue, newValue) =>
36 var instance = ((Scrollbar)bindable);
37 var thickness = (float?)newValue;
39 instance.Style.TrackThickness = thickness;
40 instance.UpdateTrackThickness(thickness ?? 0);
42 defaultValueCreator: (bindable) =>
44 return ((Scrollbar)bindable).Style.TrackThickness ?? 0;
47 /// <summary>Bindable property of ThumbThickness</summary>
48 [EditorBrowsable(EditorBrowsableState.Never)]
49 public static readonly BindableProperty ThumbThicknessProperty = BindableProperty.Create(nameof(ThumbThickness), typeof(float), typeof(Scrollbar), default(float), propertyChanged: (bindable, oldValue, newValue) =>
51 var instance = ((Scrollbar)bindable);
52 var thickness = (float?)newValue;
54 instance.Style.ThumbThickness = thickness;
55 instance.UpdateThumbThickness(thickness ?? 0);
57 defaultValueCreator: (bindable) =>
59 return ((Scrollbar)bindable).Style.ThumbThickness ?? 0;
62 /// <summary>Bindable property of TrackColor</summary>
63 [EditorBrowsable(EditorBrowsableState.Never)]
64 public static readonly BindableProperty TrackColorProperty = BindableProperty.Create(nameof(TrackColor), typeof(Color), typeof(Scrollbar), null, propertyChanged: (bindable, oldValue, newValue) =>
66 var instance = ((Scrollbar)bindable);
67 var color = (Color)newValue;
69 instance.Style.TrackColor = color;
70 instance.UpdateTrackColor(color);
72 defaultValueCreator: (bindable) =>
74 return ((Scrollbar)bindable).Style.TrackColor;
77 /// <summary>Bindable property of ThumbColor</summary>
78 [EditorBrowsable(EditorBrowsableState.Never)]
79 public static readonly BindableProperty ThumbColorProperty = BindableProperty.Create(nameof(ThumbColor), typeof(Color), typeof(Scrollbar), null, propertyChanged: (bindable, oldValue, newValue) =>
81 var instance = ((Scrollbar)bindable);
82 var color = (Color)newValue;
84 instance.Style.ThumbColor = color;
85 instance.UpdateThumbColor(color);
87 defaultValueCreator: (bindable) =>
89 return ((Scrollbar)bindable).Style.ThumbColor;
92 /// <summary>Bindable property of TrackPadding</summary>
93 [EditorBrowsable(EditorBrowsableState.Never)]
94 public static readonly BindableProperty TrackPaddingProperty = BindableProperty.Create(nameof(TrackPadding), typeof(Extents), typeof(Scrollbar), null, propertyChanged: (bindable, oldValue, newValue) =>
96 var instance = ((Scrollbar)bindable);
97 var trackPadding = (Extents)newValue;
99 instance.Style.TrackPadding = trackPadding;
100 instance.UpdateTrackPadding(trackPadding);
102 defaultValueCreator: (bindable) =>
104 return ((Scrollbar)bindable).Style.TrackPadding;
107 private ColorVisual trackVisual;
108 private ColorVisual thumbVisual;
109 private Animation thumbPositionAnimation;
110 private Animation thumbSizeAnimation;
111 private Calculator calculator;
112 private Size containerSize = new Size(0, 0);
120 /// Create an empty Scrollbar.
122 public Scrollbar() : base(new ScrollbarStyle())
127 /// Create a Scrollbar and initialize with properties.
129 /// <param name="contentLength">The length of the scrollable content area.</param>
130 /// <param name="viewportLength">The length of the viewport representing the amount of visible content.</param>
131 /// <param name="currentPosition">The current position of the viewport in scrollable content area. This is the viewport's top position if the scroller is vertical, otherwise, left.</param>
132 /// <param name="isHorizontal">Whether the direction of scrolling is horizontal or not. It is vertical by default.</param>
133 [EditorBrowsable(EditorBrowsableState.Never)]
134 public Scrollbar(float contentLength, float viewportLength, float currentPosition, bool isHorizontal = false) : base(new ScrollbarStyle())
136 Initialize(contentLength, viewportLength, currentPosition, isHorizontal);
140 /// Create an empty Scrollbar with a ScrollbarStyle instance to set style properties.
142 [EditorBrowsable(EditorBrowsableState.Never)]
143 public Scrollbar(ScrollbarStyle style) : base(style)
148 /// Static constructor to initialize bindable properties when loading.
154 #endregion Constructors
160 /// Return a copied Style instance of Scrollbar
163 /// It returns copied Style instance and changing it does not effect to the Scrollbar.
164 /// Style setting is possible by using constructor or the function of ApplyStyle(ViewStyle viewStyle)
166 [EditorBrowsable(EditorBrowsableState.Never)]
167 public new ScrollbarStyle Style => ViewStyle as ScrollbarStyle;
170 /// The thickness of the track.
172 [EditorBrowsable(EditorBrowsableState.Never)]
173 public float TrackThickness
175 get => (float)GetValue(TrackThicknessProperty);
176 set => SetValue(TrackThicknessProperty, value);
180 /// The thickness of the thumb.
182 [EditorBrowsable(EditorBrowsableState.Never)]
183 public float ThumbThickness
185 get => (float)GetValue(ThumbThicknessProperty);
186 set => SetValue(ThumbThicknessProperty, value);
190 /// The color of the track part.
192 [EditorBrowsable(EditorBrowsableState.Never)]
193 public Color TrackColor
195 get => (Color)GetValue(TrackColorProperty);
196 set => SetValue(TrackColorProperty, value);
200 /// The color of the thumb part.
202 [EditorBrowsable(EditorBrowsableState.Never)]
203 public Color ThumbColor
205 get => (Color)GetValue(ThumbColorProperty);
206 set => SetValue(ThumbColorProperty, value);
210 /// The padding value of the track.
212 [EditorBrowsable(EditorBrowsableState.Never)]
213 public Extents TrackPadding
215 get => (Extents)GetValue(TrackPaddingProperty);
216 set => SetValue(TrackPaddingProperty, value);
219 #endregion Properties
225 [EditorBrowsable(EditorBrowsableState.Never)]
226 public override void Initialize(float contentLength, float viewportLength, float currentPosition, bool isHorizontal = false)
230 calculator = new HorizontalCalculator(contentLength > 0.0f ? contentLength : 0.0f, viewportLength, currentPosition);
234 calculator = new VerticalCalculator(contentLength > 0.0f ? contentLength : 0.0f, viewportLength, currentPosition);
237 thumbPositionAnimation?.Stop();
238 thumbPositionAnimation = null;
240 thumbSizeAnimation?.Stop();
241 thumbSizeAnimation = null;
243 Size trackSize = calculator.CalculateTrackSize(TrackThickness, containerSize, TrackPadding);
244 Vector2 trackPosition = calculator.CalculateTrackPosition(TrackPadding);
245 Size thumbSize = calculator.CalculateThumbSize(ThumbThickness, trackSize);
246 Vector2 thumbPosition = calculator.CalculateThumbPosition(trackSize, thumbSize, TrackPadding);
248 if (trackVisual == null)
250 trackVisual = new ColorVisual
252 SuppressUpdateVisual = true,
254 SizePolicy = VisualTransformPolicyType.Absolute,
255 Origin = calculator.CalculatorTrackAlign(),
256 AnchorPoint = calculator.CalculatorTrackAlign(),
258 Position = trackPosition,
261 AddVisual("Track", trackVisual);
265 trackVisual.Size = trackSize;
266 trackVisual.Position = trackPosition;
267 trackVisual.UpdateVisual(true);
270 if (thumbVisual == null)
272 thumbVisual = new ColorVisual
274 SuppressUpdateVisual = true,
275 MixColor = ThumbColor,
276 SizePolicy = VisualTransformPolicyType.Absolute,
277 Origin = calculator.CalculatorThumbAlign(),
278 AnchorPoint = calculator.CalculatorThumbAlign(),
279 Opacity = calculator.CalculateThumbVisibility() ? 1.0f : 0.0f,
281 Position = thumbPosition,
284 AddVisual("Thumb", thumbVisual);
288 thumbVisual.Size = thumbSize;
289 thumbVisual.Position = thumbPosition;
290 thumbVisual.UpdateVisual(true);
295 /// <remarks>Please note that, for now, only alpha functions created with BuiltinFunctions are valid when animating. Otherwise, it will be treated as a linear alpha function. </remarks>
296 [EditorBrowsable(EditorBrowsableState.Never)]
297 public override void Update(float contentLength, float position, uint durationMs = 0, AlphaFunction alphaFunction = null)
299 if (calculator == null)
304 calculator.contentLength = contentLength > 0.0f ? contentLength : 0.0f;
305 calculator.currentPosition = position;
307 thumbVisual.Size = calculator.CalculateThumbSize(ThumbThickness, trackVisual.Size);
308 thumbVisual.Position = calculator.CalculateThumbScrollPosition(trackVisual.Size, thumbVisual.Position, TrackPadding);
309 thumbVisual.Opacity = calculator.CalculateThumbVisibility() ? 1.0f : 0.0f;
313 thumbVisual.UpdateVisual(true);
318 // TODO Support non built-in alpha function for visual trainsition in DALi.
319 AlphaFunction.BuiltinFunctions builtinAlphaFunction = alphaFunction?.GetBuiltinFunction() ?? AlphaFunction.BuiltinFunctions.Default;
321 thumbPositionAnimation?.Stop();
322 thumbPositionAnimation = AnimateVisual(thumbVisual, "position", thumbVisual.Position, 0, (int)durationMs, builtinAlphaFunction);
323 thumbPositionAnimation.Play();
325 thumbSizeAnimation?.Stop();
326 thumbSizeAnimation = AnimateVisual(thumbVisual, "size", thumbVisual.Size, 0, (int)durationMs, builtinAlphaFunction);
327 thumbSizeAnimation.Play();
331 /// <remarks>Please note that, for now, only alpha functions created with BuiltinFunctions are valid when animating. Otherwise, it will be treated as a linear alpha function. </remarks>
332 [EditorBrowsable(EditorBrowsableState.Never)]
333 public override void ScrollTo(float position, uint durationMs = 0, AlphaFunction alphaFunction = null)
335 if (calculator == null)
340 calculator.currentPosition = position;
341 thumbVisual.Position = calculator.CalculateThumbScrollPosition(trackVisual.Size, thumbVisual.Position, TrackPadding);
345 thumbVisual.UpdateVisual(true);
350 // TODO Support non built-in alpha function for visual trainsition in DALi.
351 AlphaFunction.BuiltinFunctions builtinAlphaFunction = alphaFunction?.GetBuiltinFunction() ?? AlphaFunction.BuiltinFunctions.Default;
353 thumbPositionAnimation?.Stop();
354 thumbPositionAnimation = AnimateVisual(thumbVisual, "position", thumbVisual.Position, 0, (int)durationMs, builtinAlphaFunction);
355 thumbPositionAnimation.Play();
359 [EditorBrowsable(EditorBrowsableState.Never)]
360 public override void OnRelayout(Vector2 size, RelayoutContainer container)
362 base.OnRelayout(size, container);
364 if (size.Width == containerSize.Width && size.Height == containerSize.Height)
369 containerSize = new Size(size.Width, size.Height);
371 if (calculator == null)
376 trackVisual.Size = calculator.CalculateTrackSize(TrackThickness, containerSize, TrackPadding);
377 trackVisual.Position = calculator.CalculateTrackPosition(TrackPadding);
378 thumbVisual.Size = calculator.CalculateThumbSize(ThumbThickness, trackVisual.Size);
379 thumbVisual.Position = calculator.CalculateThumbPosition(trackVisual.Size, thumbVisual.Size, TrackPadding);
381 trackVisual.UpdateVisual(true);
382 thumbVisual.UpdateVisual(true);
386 [EditorBrowsable(EditorBrowsableState.Never)]
387 protected override ViewStyle CreateViewStyle()
389 return new ScrollbarStyle();
393 /// Update TrackThickness property of the scrollbar.
395 /// <param name="thickness">The width of the track.</param>
396 [EditorBrowsable(EditorBrowsableState.Never)]
397 protected virtual void UpdateTrackThickness(float thickness)
399 if (trackVisual == null)
404 trackVisual.Size = calculator.CalculateTrackSize(thickness, containerSize, TrackPadding);
405 trackVisual.UpdateVisual(true);
409 /// Update ThumbThickness property of the scrollbar.
411 /// <param name="thickness">The width of the track.</param>
412 [EditorBrowsable(EditorBrowsableState.Never)]
413 protected virtual void UpdateThumbThickness(float thickness)
415 if (thumbVisual == null)
420 thumbVisual.Size = calculator.CalculateThumbSize(thickness, trackVisual.Size);
421 thumbVisual.UpdateVisual(true);
425 /// Update TrackColor property of the scrollbar.
427 /// <param name="color">The color of the track.</param>
428 [EditorBrowsable(EditorBrowsableState.Never)]
429 protected virtual void UpdateTrackColor(Color color)
431 if (trackVisual == null)
436 trackVisual.MixColor = color;
437 trackVisual.UpdateVisual(true);
441 /// Update ThumbColor property of the scrollbar.
443 /// <param name="color">The color of the thumb.</param>
444 [EditorBrowsable(EditorBrowsableState.Never)]
445 protected virtual void UpdateThumbColor(Color color)
447 if (thumbVisual == null)
452 thumbVisual.MixColor = color;
453 thumbVisual.UpdateVisual(true);
457 /// Update TrackPadding property of the scrollbar.
459 /// <param name="trackPadding">The padding of the track.</param>
460 protected virtual void UpdateTrackPadding(Extents trackPadding)
462 if (calculator == null)
467 trackVisual.Size = calculator.CalculateTrackSize(TrackThickness, containerSize, trackPadding);
468 trackVisual.Position = calculator.CalculateTrackPosition(trackPadding);
469 thumbVisual.Size = calculator.CalculateThumbSize(ThumbThickness, trackVisual.Size);
470 thumbVisual.Position = calculator.CalculateThumbPaddingPosition(trackVisual.Size, thumbVisual.Size, thumbVisual.Position, trackPadding);
472 trackVisual.UpdateVisual(true);
473 thumbVisual.UpdateVisual(true);
481 private abstract class Calculator
483 public float contentLength;
484 public float visibleLength;
485 public float currentPosition;
487 public Calculator(float contentLength, float visibleLength, float currentPosition)
489 this.contentLength = contentLength;
490 this.visibleLength = visibleLength;
491 this.currentPosition = currentPosition;
494 public bool CalculateThumbVisibility()
496 return contentLength > visibleLength;
499 public abstract Visual.AlignType CalculatorTrackAlign();
500 public abstract Visual.AlignType CalculatorThumbAlign();
501 public abstract Size CalculateTrackSize(float thickness, Size containerSize, Extents trackPadding);
502 public abstract Vector2 CalculateTrackPosition(Extents trackPadding);
503 public abstract Size CalculateThumbSize(float thickness, Size trackSize);
504 public abstract Vector2 CalculateThumbPosition(Size trackSize, Size thumbSize, Extents trackPadding);
505 public abstract Vector2 CalculateThumbPaddingPosition(Size trackSize, Size thumbSize, Vector2 thumbCurrentPosition, Extents trackPadding);
506 public abstract Vector2 CalculateThumbScrollPosition(Size trackSize, Vector2 thumbCurrentPosition, Extents trackPadding);
509 private class HorizontalCalculator : Calculator
511 public HorizontalCalculator(float contentLength, float visibleLength, float currentPosition) : base(contentLength, visibleLength, currentPosition)
515 public override Visual.AlignType CalculatorTrackAlign()
517 return Visual.AlignType.BottomCenter;
520 public override Visual.AlignType CalculatorThumbAlign()
522 return Visual.AlignType.BottomBegin;
525 public override Size CalculateTrackSize(float thickness, Size containerSize, Extents trackPadding)
527 return new Size(containerSize.Width - trackPadding.Start - trackPadding.End, thickness);
530 public override Vector2 CalculateTrackPosition(Extents trackPadding)
532 return new Vector2(0, -trackPadding.Bottom);
535 public override Size CalculateThumbSize(float thickness, Size trackSize)
537 return new Size(trackSize.Width * visibleLength / contentLength, thickness);
540 public override Vector2 CalculateThumbPosition(Size trackSize, Size thumbSize, Extents trackPadding)
542 float padding = ((trackSize.Height - thumbSize.Height) / 2.0f) + trackPadding.Bottom;
543 float pos = Math.Min(Math.Max(currentPosition, 0.0f), contentLength - visibleLength);
544 return new Vector2(trackPadding.Start + trackSize.Width * pos / contentLength, -padding);
547 public override Vector2 CalculateThumbPaddingPosition(Size trackSize, Size thumbSize, Vector2 thumbCurrentPosition, Extents trackPadding)
549 float padding = ((trackSize.Height - thumbSize.Height) / 2.0f) + trackPadding.Bottom;
550 return new Vector2(thumbCurrentPosition.X, -padding);
553 public override Vector2 CalculateThumbScrollPosition(Size trackSize, Vector2 thumbCurrentPosition, Extents trackPadding)
555 float pos = Math.Min(Math.Max(currentPosition, 0.0f), contentLength - visibleLength);
556 return new Vector2(trackPadding.Start + trackSize.Width * pos / contentLength, thumbCurrentPosition.Y);
560 private class VerticalCalculator : Calculator
562 public VerticalCalculator(float contentLength, float visibleLength, float currentPosition) : base(contentLength, visibleLength, currentPosition)
566 public override Visual.AlignType CalculatorTrackAlign()
568 return Visual.AlignType.CenterEnd;
571 public override Visual.AlignType CalculatorThumbAlign()
573 return Visual.AlignType.TopEnd;
576 public override Size CalculateTrackSize(float thickness, Size containerSize, Extents trackPadding)
578 return new Size(thickness, containerSize.Height - trackPadding.Top - trackPadding.Bottom);
581 public override Vector2 CalculateTrackPosition(Extents trackPadding)
583 return new Vector2(-trackPadding.End, 0);
586 public override Size CalculateThumbSize(float thickness, Size trackSize)
588 return new Size(thickness, trackSize.Height * visibleLength / contentLength);
591 public override Vector2 CalculateThumbPosition(Size trackSize, Size thumbSize, Extents trackPadding)
593 float padding = ((trackSize.Width - thumbSize.Width) / 2.0f) + trackPadding.End;
594 float pos = Math.Min(Math.Max(currentPosition, 0.0f), contentLength - visibleLength);
595 return new Vector2(-padding, trackPadding.Top + trackSize.Height * pos / contentLength);
598 public override Vector2 CalculateThumbPaddingPosition(Size trackSize, Size thumbSize, Vector2 thumbCurrentPosition, Extents trackPadding)
600 float padding = ((trackSize.Width - thumbSize.Width) / 2.0f) + trackPadding.End;
601 return new Vector2(-padding, thumbCurrentPosition.Y);
604 public override Vector2 CalculateThumbScrollPosition(Size trackSize, Vector2 thumbPosition, Extents trackPadding)
606 float pos = Math.Min(Math.Max(currentPosition, 0.0f), contentLength - visibleLength);
607 return new Vector2(thumbPosition.X, trackPadding.Top + trackSize.Height * pos / contentLength);