[NUI] Scrollbar inherits VisualView instead of Control (#1846)
[platform/core/csapi/tizenfx.git] / src / Tizen.NUI.Components / Controls / ScrollbarBase.cs
1 /*
2  * Copyright(c) 2020 Samsung Electronics Co., Ltd.
3  *
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
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
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.
15  *
16  */
17 using System.ComponentModel;
18 using Tizen.NUI.BaseComponents;
19
20 namespace Tizen.NUI.Components
21 {
22     /// <summary>
23     /// The ScrollbarBase is an abstract class that can be linked to the scrollable objects
24     /// indicating the current scrolled position of the scrollable object.
25     /// This only contains non-graphical functionalities of basic scrollbar.
26     /// </summary>
27     [EditorBrowsable(EditorBrowsableState.Never)]
28     public abstract class ScrollbarBase : VisualView
29     {
30         private bool mScrollEnabled = true;
31
32         #region Constructors
33
34         /// <summary>
35         /// Create an empty ScrollbarBase.
36         /// </summary>
37         public ScrollbarBase() : base(CustomViewBehaviour.ViewBehaviourDefault)
38         {
39         }
40
41         /// <summary>
42         /// Create an empty Scrollbar with a ViewStyle instance to set style properties.
43         /// </summary>
44         [EditorBrowsable(EditorBrowsableState.Never)]
45         public ScrollbarBase(ViewStyle style) : base(CustomViewBehaviour.ViewBehaviourDefault, style)
46         {
47         }
48
49         /// <summary>
50         /// Static constructor to initialize bindable properties when loading.
51         /// </summary>
52         static ScrollbarBase()
53         {
54         }
55
56         #endregion Constructors
57
58
59         #region Methods
60
61         /// <summary>
62         /// Update content length and position at once.
63         /// </summary>
64         /// <param name="contentLength">The total length of the content.</param>
65         /// <param name="position">The destination position of the View in content length. This is the View's top position if the scroller is vertical, otherwise, View's left position.</param>
66         /// <param name="durationMs">The time it takes to scroll in milliseconds.</param>
67         /// <param name="alphaFunction">The timing function used in animation. It describes the rate of change of the animation parameter over time. (e.g. EaseOut)</param>
68         [EditorBrowsable(EditorBrowsableState.Never)]
69         public abstract void Update(float contentLength, float position, uint durationMs = 0, AlphaFunction alphaFunction = null);
70
71         /// <summary>
72         /// Scroll content to a specific position.
73         /// </summary>
74         /// <param name="position">The destination to scroll.</param>
75         /// <param name="durationMs">The time it takes to scroll in milliseconds.</param>
76         /// <param name="alphaFunction">The timing function used in animation. It describes the rate of change of the animation parameter over time. (e.g. EaseOut)</param>
77         [EditorBrowsable(EditorBrowsableState.Never)]
78         public abstract void ScrollTo(float position, uint durationMs = 0, AlphaFunction alphaFunction = null);
79
80         /// <summary>
81         /// Initialize the scroll bar.
82         /// </summary>
83         /// <param name="contentLength">The length of the scrollable content area.</param>
84         /// <param name="viewportLength">The length of the viewport representing the amount of visible content.</param>
85         /// <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>
86         /// <param name="isHorizontal">Whether the direction of scrolling is horizontal or not. It is vertical by default.</param>
87         [EditorBrowsable(EditorBrowsableState.Never)]
88         public abstract void Initialize(float contentLength, float viewportLength, float currentPosition, bool isHorizontal = false);
89
90         /// <summary>
91         /// Enable or disable scrolling.
92         /// </summary>
93         [EditorBrowsable(EditorBrowsableState.Never)]
94         public abstract bool ScrollEnabled { get; set; }
95
96         #endregion Methods
97     }
98 }