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.scrollbarStyle.TrackThickness = thickness;
40 instance.UpdateTrackThickness(thickness ?? 0);
42 defaultValueCreator: (bindable) =>
44 return ((Scrollbar)bindable).scrollbarStyle.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.scrollbarStyle.ThumbThickness = thickness;
55 instance.UpdateThumbThickness(thickness ?? 0);
57 defaultValueCreator: (bindable) =>
59 return ((Scrollbar)bindable).scrollbarStyle.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.scrollbarStyle.TrackColor = color;
70 instance.UpdateTrackColor(color);
72 defaultValueCreator: (bindable) =>
74 return ((Scrollbar)bindable).scrollbarStyle.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.scrollbarStyle.ThumbColor = color;
85 instance.UpdateThumbColor(color);
87 defaultValueCreator: (bindable) =>
89 return ((Scrollbar)bindable).scrollbarStyle.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.scrollbarStyle.TrackPadding = trackPadding;
100 instance.UpdateTrackPadding(trackPadding);
102 defaultValueCreator: (bindable) =>
104 return ((Scrollbar)bindable).scrollbarStyle.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);
113 private ScrollbarStyle scrollbarStyle => ViewStyle as ScrollbarStyle;
121 /// Create an empty Scrollbar.
123 public Scrollbar() : base(new ScrollbarStyle())
128 /// Create a Scrollbar and initialize with properties.
130 /// <param name="contentLength">The length of the scrollable content area.</param>
131 /// <param name="viewportLength">The length of the viewport representing the amount of visible content.</param>
132 /// <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>
133 /// <param name="isHorizontal">Whether the direction of scrolling is horizontal or not. It is vertical by default.</param>
134 [EditorBrowsable(EditorBrowsableState.Never)]
135 public Scrollbar(float contentLength, float viewportLength, float currentPosition, bool isHorizontal = false) : base(new ScrollbarStyle())
137 Initialize(contentLength, viewportLength, currentPosition, isHorizontal);
141 /// Create an empty Scrollbar with a ScrollbarStyle instance to set style properties.
143 [EditorBrowsable(EditorBrowsableState.Never)]
144 public Scrollbar(ScrollbarStyle style) : base(style)
149 /// Static constructor to initialize bindable properties when loading.
155 #endregion Constructors
161 /// Return a copied Style instance of Scrollbar
164 /// It returns copied Style instance and changing it does not effect to the Scrollbar.
165 /// Style setting is possible by using constructor or the function of ApplyStyle(ViewStyle viewStyle)
167 [EditorBrowsable(EditorBrowsableState.Never)]
168 public new ScrollbarStyle Style
172 var result = new ScrollbarStyle(scrollbarStyle);
173 result.CopyPropertiesFromView(this);
179 /// The thickness of the track.
181 [EditorBrowsable(EditorBrowsableState.Never)]
182 public float TrackThickness
184 get => (float)GetValue(TrackThicknessProperty);
185 set => SetValue(TrackThicknessProperty, value);
189 /// The thickness of the thumb.
191 [EditorBrowsable(EditorBrowsableState.Never)]
192 public float ThumbThickness
194 get => (float)GetValue(ThumbThicknessProperty);
195 set => SetValue(ThumbThicknessProperty, value);
199 /// The color of the track part.
201 [EditorBrowsable(EditorBrowsableState.Never)]
202 public Color TrackColor
204 get => (Color)GetValue(TrackColorProperty);
205 set => SetValue(TrackColorProperty, value);
209 /// The color of the thumb part.
211 [EditorBrowsable(EditorBrowsableState.Never)]
212 public Color ThumbColor
214 get => (Color)GetValue(ThumbColorProperty);
215 set => SetValue(ThumbColorProperty, value);
219 /// The padding value of the track.
221 [EditorBrowsable(EditorBrowsableState.Never)]
222 public Extents TrackPadding
224 get => (Extents)GetValue(TrackPaddingProperty);
225 set => SetValue(TrackPaddingProperty, value);
228 #endregion Properties
234 [EditorBrowsable(EditorBrowsableState.Never)]
235 public override void Initialize(float contentLength, float viewportLength, float currentPosition, bool isHorizontal = false)
239 calculator = new HorizontalCalculator(contentLength > 0.0f ? contentLength : 0.0f, viewportLength, currentPosition);
243 calculator = new VerticalCalculator(contentLength > 0.0f ? contentLength : 0.0f, viewportLength, currentPosition);
246 thumbPositionAnimation?.Stop();
247 thumbPositionAnimation = null;
249 thumbSizeAnimation?.Stop();
250 thumbSizeAnimation = null;
252 Size trackSize = calculator.CalculateTrackSize(TrackThickness, containerSize, TrackPadding);
253 Vector2 trackPosition = calculator.CalculateTrackPosition(TrackPadding);
254 Size thumbSize = calculator.CalculateThumbSize(ThumbThickness, trackSize);
255 Vector2 thumbPosition = calculator.CalculateThumbPosition(trackSize, thumbSize, TrackPadding);
257 if (trackVisual == null)
259 trackVisual = new ColorVisual
261 SuppressUpdateVisual = true,
263 SizePolicy = VisualTransformPolicyType.Absolute,
264 Origin = calculator.CalculatorTrackAlign(),
265 AnchorPoint = calculator.CalculatorTrackAlign(),
267 Position = trackPosition,
270 AddVisual("Track", trackVisual);
274 trackVisual.Size = trackSize;
275 trackVisual.Position = trackPosition;
276 trackVisual.UpdateVisual(true);
279 if (thumbVisual == null)
281 thumbVisual = new ColorVisual
283 SuppressUpdateVisual = true,
284 MixColor = ThumbColor,
285 SizePolicy = VisualTransformPolicyType.Absolute,
286 Origin = calculator.CalculatorThumbAlign(),
287 AnchorPoint = calculator.CalculatorThumbAlign(),
288 Opacity = calculator.CalculateThumbVisibility() ? 1.0f : 0.0f,
290 Position = thumbPosition,
293 AddVisual("Thumb", thumbVisual);
297 thumbVisual.Size = thumbSize;
298 thumbVisual.Position = thumbPosition;
299 thumbVisual.UpdateVisual(true);
304 /// <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>
305 [EditorBrowsable(EditorBrowsableState.Never)]
306 public override void Update(float contentLength, float position, uint durationMs = 0, AlphaFunction alphaFunction = null)
308 if (calculator == null)
313 calculator.contentLength = contentLength > 0.0f ? contentLength : 0.0f;
314 calculator.currentPosition = position;
316 thumbVisual.Size = calculator.CalculateThumbSize(ThumbThickness, trackVisual.Size);
317 thumbVisual.Position = calculator.CalculateThumbScrollPosition(trackVisual.Size, thumbVisual.Position, TrackPadding);
318 thumbVisual.Opacity = calculator.CalculateThumbVisibility() ? 1.0f : 0.0f;
322 thumbVisual.UpdateVisual(true);
327 // TODO Support non built-in alpha function for visual trainsition in DALi.
328 AlphaFunction.BuiltinFunctions builtinAlphaFunction = alphaFunction?.GetBuiltinFunction() ?? AlphaFunction.BuiltinFunctions.Default;
330 thumbPositionAnimation?.Stop();
331 thumbPositionAnimation = AnimateVisual(thumbVisual, "position", thumbVisual.Position, 0, (int)durationMs, builtinAlphaFunction);
332 thumbPositionAnimation.Play();
334 thumbSizeAnimation?.Stop();
335 thumbSizeAnimation = AnimateVisual(thumbVisual, "size", thumbVisual.Size, 0, (int)durationMs, builtinAlphaFunction);
336 thumbSizeAnimation.Play();
340 /// <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>
341 [EditorBrowsable(EditorBrowsableState.Never)]
342 public override void ScrollTo(float position, uint durationMs = 0, AlphaFunction alphaFunction = null)
344 if (calculator == null)
349 calculator.currentPosition = position;
350 thumbVisual.Position = calculator.CalculateThumbScrollPosition(trackVisual.Size, thumbVisual.Position, TrackPadding);
354 thumbVisual.UpdateVisual(true);
359 // TODO Support non built-in alpha function for visual trainsition in DALi.
360 AlphaFunction.BuiltinFunctions builtinAlphaFunction = alphaFunction?.GetBuiltinFunction() ?? AlphaFunction.BuiltinFunctions.Default;
362 thumbPositionAnimation?.Stop();
363 thumbPositionAnimation = AnimateVisual(thumbVisual, "position", thumbVisual.Position, 0, (int)durationMs, builtinAlphaFunction);
364 thumbPositionAnimation.Play();
368 [EditorBrowsable(EditorBrowsableState.Never)]
369 public override void OnRelayout(Vector2 size, RelayoutContainer container)
371 base.OnRelayout(size, container);
373 if (size.Width == containerSize.Width && size.Height == containerSize.Height)
378 containerSize = new Size(size.Width, size.Height);
380 if (calculator == null)
385 trackVisual.Size = calculator.CalculateTrackSize(TrackThickness, containerSize, TrackPadding);
386 trackVisual.Position = calculator.CalculateTrackPosition(TrackPadding);
387 thumbVisual.Size = calculator.CalculateThumbSize(ThumbThickness, trackVisual.Size);
388 thumbVisual.Position = calculator.CalculateThumbPosition(trackVisual.Size, thumbVisual.Size, TrackPadding);
390 trackVisual.UpdateVisual(true);
391 thumbVisual.UpdateVisual(true);
395 [EditorBrowsable(EditorBrowsableState.Never)]
396 protected override ViewStyle CreateViewStyle()
398 return new ScrollbarStyle();
402 /// Update TrackThickness property of the scrollbar.
404 /// <param name="thickness">The width of the track.</param>
405 [EditorBrowsable(EditorBrowsableState.Never)]
406 protected virtual void UpdateTrackThickness(float thickness)
408 if (trackVisual == null)
413 trackVisual.Size = calculator.CalculateTrackSize(thickness, containerSize, TrackPadding);
414 trackVisual.UpdateVisual(true);
418 /// Update ThumbThickness property of the scrollbar.
420 /// <param name="thickness">The width of the track.</param>
421 [EditorBrowsable(EditorBrowsableState.Never)]
422 protected virtual void UpdateThumbThickness(float thickness)
424 if (thumbVisual == null)
429 thumbVisual.Size = calculator.CalculateThumbSize(thickness, trackVisual.Size);
430 thumbVisual.UpdateVisual(true);
434 /// Update TrackColor property of the scrollbar.
436 /// <param name="color">The color of the track.</param>
437 [EditorBrowsable(EditorBrowsableState.Never)]
438 protected virtual void UpdateTrackColor(Color color)
440 if (trackVisual == null)
445 trackVisual.MixColor = color;
446 trackVisual.UpdateVisual(true);
450 /// Update ThumbColor property of the scrollbar.
452 /// <param name="color">The color of the thumb.</param>
453 [EditorBrowsable(EditorBrowsableState.Never)]
454 protected virtual void UpdateThumbColor(Color color)
456 if (thumbVisual == null)
461 thumbVisual.MixColor = color;
462 thumbVisual.UpdateVisual(true);
466 /// Update TrackPadding property of the scrollbar.
468 /// <param name="trackPadding">The padding of the track.</param>
469 protected virtual void UpdateTrackPadding(Extents trackPadding)
471 if (calculator == null)
476 trackVisual.Size = calculator.CalculateTrackSize(TrackThickness, containerSize, trackPadding);
477 trackVisual.Position = calculator.CalculateTrackPosition(trackPadding);
478 thumbVisual.Size = calculator.CalculateThumbSize(ThumbThickness, trackVisual.Size);
479 thumbVisual.Position = calculator.CalculateThumbPaddingPosition(trackVisual.Size, thumbVisual.Size, thumbVisual.Position, trackPadding);
481 trackVisual.UpdateVisual(true);
482 thumbVisual.UpdateVisual(true);
490 private abstract class Calculator
492 public float contentLength;
493 public float visibleLength;
494 public float currentPosition;
496 public Calculator(float contentLength, float visibleLength, float currentPosition)
498 this.contentLength = contentLength;
499 this.visibleLength = visibleLength;
500 this.currentPosition = currentPosition;
503 public bool CalculateThumbVisibility()
505 return contentLength > visibleLength;
508 public abstract Visual.AlignType CalculatorTrackAlign();
509 public abstract Visual.AlignType CalculatorThumbAlign();
510 public abstract Size CalculateTrackSize(float thickness, Size containerSize, Extents trackPadding);
511 public abstract Vector2 CalculateTrackPosition(Extents trackPadding);
512 public abstract Size CalculateThumbSize(float thickness, Size trackSize);
513 public abstract Vector2 CalculateThumbPosition(Size trackSize, Size thumbSize, Extents trackPadding);
514 public abstract Vector2 CalculateThumbPaddingPosition(Size trackSize, Size thumbSize, Vector2 thumbCurrentPosition, Extents trackPadding);
515 public abstract Vector2 CalculateThumbScrollPosition(Size trackSize, Vector2 thumbCurrentPosition, Extents trackPadding);
518 private class HorizontalCalculator : Calculator
520 public HorizontalCalculator(float contentLength, float visibleLength, float currentPosition) : base(contentLength, visibleLength, currentPosition)
524 public override Visual.AlignType CalculatorTrackAlign()
526 return Visual.AlignType.BottomCenter;
529 public override Visual.AlignType CalculatorThumbAlign()
531 return Visual.AlignType.BottomBegin;
534 public override Size CalculateTrackSize(float thickness, Size containerSize, Extents trackPadding)
536 return new Size(containerSize.Width - trackPadding.Start - trackPadding.End, thickness);
539 public override Vector2 CalculateTrackPosition(Extents trackPadding)
541 return new Vector2(0, -trackPadding.Bottom);
544 public override Size CalculateThumbSize(float thickness, Size trackSize)
546 return new Size(trackSize.Width * visibleLength / contentLength, thickness);
549 public override Vector2 CalculateThumbPosition(Size trackSize, Size thumbSize, Extents trackPadding)
551 float padding = ((trackSize.Height - thumbSize.Height) / 2.0f) + trackPadding.Bottom;
552 float pos = Math.Min(Math.Max(currentPosition, 0.0f), contentLength - visibleLength);
553 return new Vector2(trackPadding.Start + trackSize.Width * pos / contentLength, -padding);
556 public override Vector2 CalculateThumbPaddingPosition(Size trackSize, Size thumbSize, Vector2 thumbCurrentPosition, Extents trackPadding)
558 float padding = ((trackSize.Height - thumbSize.Height) / 2.0f) + trackPadding.Bottom;
559 return new Vector2(thumbCurrentPosition.X, -padding);
562 public override Vector2 CalculateThumbScrollPosition(Size trackSize, Vector2 thumbCurrentPosition, Extents trackPadding)
564 float pos = Math.Min(Math.Max(currentPosition, 0.0f), contentLength - visibleLength);
565 return new Vector2(trackPadding.Start + trackSize.Width * pos / contentLength, thumbCurrentPosition.Y);
569 private class VerticalCalculator : Calculator
571 public VerticalCalculator(float contentLength, float visibleLength, float currentPosition) : base(contentLength, visibleLength, currentPosition)
575 public override Visual.AlignType CalculatorTrackAlign()
577 return Visual.AlignType.CenterEnd;
580 public override Visual.AlignType CalculatorThumbAlign()
582 return Visual.AlignType.TopEnd;
585 public override Size CalculateTrackSize(float thickness, Size containerSize, Extents trackPadding)
587 return new Size(thickness, containerSize.Height - trackPadding.Top - trackPadding.Bottom);
590 public override Vector2 CalculateTrackPosition(Extents trackPadding)
592 return new Vector2(-trackPadding.End, 0);
595 public override Size CalculateThumbSize(float thickness, Size trackSize)
597 return new Size(thickness, trackSize.Height * visibleLength / contentLength);
600 public override Vector2 CalculateThumbPosition(Size trackSize, Size thumbSize, Extents trackPadding)
602 float padding = ((trackSize.Width - thumbSize.Width) / 2.0f) + trackPadding.End;
603 float pos = Math.Min(Math.Max(currentPosition, 0.0f), contentLength - visibleLength);
604 return new Vector2(-padding, trackPadding.Top + trackSize.Height * pos / contentLength);
607 public override Vector2 CalculateThumbPaddingPosition(Size trackSize, Size thumbSize, Vector2 thumbCurrentPosition, Extents trackPadding)
609 float padding = ((trackSize.Width - thumbSize.Width) / 2.0f) + trackPadding.End;
610 return new Vector2(-padding, thumbCurrentPosition.Y);
613 public override Vector2 CalculateThumbScrollPosition(Size trackSize, Vector2 thumbPosition, Extents trackPadding)
615 float pos = Math.Min(Math.Max(currentPosition, 0.0f), contentLength - visibleLength);
616 return new Vector2(thumbPosition.X, trackPadding.Top + trackSize.Height * pos / contentLength);