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 : Control
  29     {
  30         private bool mScrollEnabled = true;
  31
  32         #region Constructors
  33
  34         /// <summary>
  35         /// Create an empty ScrollbarBase.
  36         /// </summary>
  37         protected ScrollbarBase()
  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         protected ScrollbarBase(ControlStyle style) : base(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         /// Removes a view from its parent ScrollableBase. If a view has no parent, this method does nothing.
  63         /// </summary>
  64         public new void Unparent()
  65         {
  66             (GetParent() as ScrollableBase)?.BaseRemove(this);
  67         }
  68
  69         /// <summary>
  70         /// Update content length and position at once.
  71         /// </summary>
  72         /// <param name="contentLength">The total length of the content.</param>
  73         /// <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>
  74         /// <param name="durationMs">The time it takes to scroll in milliseconds.</param>
  75         /// <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>
  76         [EditorBrowsable(EditorBrowsableState.Never)]
  77         public abstract void Update(float contentLength, float position, uint durationMs = 0, AlphaFunction alphaFunction = null);
  78
  79         /// <summary>
  80         /// Scroll content to a specific position.
  81         /// </summary>
  82         /// <param name="position">The destination to scroll.</param>
  83         /// <param name="durationMs">The time it takes to scroll in milliseconds.</param>
  84         /// <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>
  85         [EditorBrowsable(EditorBrowsableState.Never)]
  86         public abstract void ScrollTo(float position, uint durationMs = 0, AlphaFunction alphaFunction = null);
  87
  88         /// <summary>
  89         /// Initialize the scroll bar.
  90         /// </summary>
  91         /// <param name="contentLength">The length of the scrollable content area.</param>
  92         /// <param name="viewportLength">The length of the viewport representing the amount of visible content.</param>
  93         /// <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>
  94         /// <param name="isHorizontal">Whether the direction of scrolling is horizontal or not. It is vertical by default.</param>
  95         [EditorBrowsable(EditorBrowsableState.Never)]
  96         public abstract void Initialize(float contentLength, float viewportLength, float currentPosition, bool isHorizontal = false);
  97
  98         /// <summary>
  99         /// Enable or disable scrolling.
 100         /// </summary>
 101         [EditorBrowsable(EditorBrowsableState.Never)]
 102         public abstract bool ScrollEnabled { get; set; }
 103
 104         /// <summary>
 105         /// Scroll position given to ScrollTo or Update.
 106         /// </summary>
 107         [EditorBrowsable(EditorBrowsableState.Never)]
 108         public abstract Position ScrollPosition { get; }
 109
 110         /// <summary>
 111         /// Current scroll position in the middle of ScrollTo or Update animation.
 112         /// </summary>
 113         [EditorBrowsable(EditorBrowsableState.Never)]
 114         public abstract Position ScrollCurrentPosition { get; }
 115
 116         #endregion Methods
 117     }
 118 }