Class CircularScrollbar

Definition

Namespace:
Tizen.NUI.Wearable
Assembly:
Tizen.NUI.Wearable.dll

The CircualrScrollbar is a wearable NUI component that can be linked to the scrollable objects indicating the current scroll position of the scrollable object.

public class CircularScrollbar : ScrollbarBase, IDynamicResourceHandler, INameScope, System.IDisposable, IResourcesProvider
Inheritance
object
BindableObject
Element
BaseHandle
Animatable
Container
View
ViewWrapper
CustomView
VisualView
Control
ScrollbarBase
CircularScrollbar
Implements
IDynamicResourceHandler
INameScope
System.IDisposable
IResourcesProvider

Constructors

View Source

CircularScrollbar()

Create an empty CircularScrollbar.

Declaration
public CircularScrollbar()
View Source

CircularScrollbar(float, float, float, bool)

Create a CircularScrollbar and initialize with properties.

Declaration
public CircularScrollbar(float contentLength, float viewportLength, float currentPosition, bool isHorizontal = false)
Parameters
Type Name Description
float contentLength

The length of the scrollable content area.
float viewportLength

The length of the viewport representing the amount of visible content.
float 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.
bool isHorizontal

Whether the direction of scrolling is horizontal or not. It is vertical by default.
View Source

CircularScrollbar(CircularScrollbarStyle)

Create an empty CircularScrollbar with a CircularScrollbarStyle instance to set style properties.

Declaration
public CircularScrollbar(CircularScrollbarStyle style)
Parameters
Type Name Description
CircularScrollbarStyle style

Fields

View Source

ThicknessProperty

Bindable property of Thickness

Declaration
public static readonly BindableProperty ThicknessProperty
Field Value
Type Description
BindableProperty
View Source

ThumbColorProperty

Bindable property of ThumbColor

Declaration
public static readonly BindableProperty ThumbColorProperty
Field Value
Type Description
BindableProperty
View Source

TrackColorProperty

Bindable property of TrackColor

Declaration
public static readonly BindableProperty TrackColorProperty
Field Value
Type Description
BindableProperty
View Source

TrackSweepAngleProperty

Bindable property of TrackSweepAngle

Declaration
public static readonly BindableProperty TrackSweepAngleProperty
Field Value
Type Description
BindableProperty

Properties

View Source

ScrollCurrentPosition

Current scroll position in the middle of ScrollTo or Update animation.

Declaration
public override float ScrollCurrentPosition { get; }
Property Value
Type Description
float
Overrides
View Source

ScrollPosition

Scroll position given to ScrollTo or Update.

Declaration
public override float ScrollPosition { get; }
Property Value
Type Description
float
Overrides
View Source

Thickness

The thickness of the scrollbar and track.

Declaration
public float Thickness { get; set; }
Property Value
Type Description
float
View Source

ThumbColor

The color of the thumb part.

Declaration
public Color ThumbColor { get; set; }
Property Value
Type Description
Color
View Source

TrackColor

The color of the track part.

Declaration
public Color TrackColor { get; set; }
Property Value
Type Description
Color
View Source

TrackSweepAngle

The sweep angle of track area in degrees.

Declaration
public float TrackSweepAngle { get; set; }
Property Value
Type Description
float
Remarks

Values below 6 degrees are treated as 6 degrees. Values exceeding 180 degrees are treated as 180 degrees.

Methods

View Source

ApplyStyle(ViewStyle)

Apply style instance to the view. Basically it sets the bindable property to the value of the bindable property with same name in the style.

Declaration
public override void ApplyStyle(ViewStyle viewStyle)
Parameters
Type Name Description
ViewStyle viewStyle
Overrides
View Source

CreateViewStyle()

Declaration
protected override ViewStyle CreateViewStyle()
Returns
Type Description
ViewStyle
Overrides
View Source

Initialize(float, float, float, bool)

Initialize the scroll bar.

Declaration
public override void Initialize(float contentLength, float viewportLenth, float currentPosition, bool isHorizontal = false)
Parameters
Type Name Description
float contentLength

The length of the scrollable content area.
float viewportLenth
float 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.
bool isHorizontal

Whether the direction of scrolling is horizontal or not. It is vertical by default.
Overrides
View Source

OnRelayout(Vector2, RelayoutContainer)

Called after the size negotiation has been finished for this control.
The control is expected to assign this given size to itself or its children.
Should be overridden by derived classes if they need to layout views differently after certain operations like add or remove views, resize, or after changing specific properties.
As this function is called from inside the size negotiation algorithm, you cannot call RequestRelayout (the call would just be ignored).

Declaration
public override void OnRelayout(Vector2 size, RelayoutContainer container)
Parameters
Type Name Description
Vector2 size

The allocated size.
RelayoutContainer container

The control should add views to this container that it is not able to allocate a size for.
Overrides
View Source

ScrollTo(float, uint, AlphaFunction)

Scroll content to a specific position.

Declaration
public override void ScrollTo(float position, uint durationMs = null, AlphaFunction alphaFunction = null)
Parameters
Type Name Description
float position

The destination to scroll.
uint durationMs

The time it takes to scroll in milliseconds.
AlphaFunction alphaFunction

The timing function used in animation. It describes the rate of change of the animation parameter over time. (e.g. EaseOut)
Overrides
View Source

Update(float, float, float, uint, AlphaFunction)

Update content length and position at once.

Declaration
public override void Update(float contentLength, float viewportLength, float position, uint durationMs = null, AlphaFunction alphaFunction = null)
Parameters
Type Name Description
float contentLength

The total length of the content.
float viewportLength

The length of the viewport representing the amount of visible content.
float 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.
uint durationMs

The time it takes to scroll in milliseconds.
AlphaFunction alphaFunction

The timing function used in animation. It describes the rate of change of the animation parameter over time. (e.g. EaseOut)
Overrides
View Source

Update(float, float, uint, AlphaFunction)

Update content length and position at once.

Declaration
public override void Update(float contentLength, float position, uint durationMs = null, AlphaFunction alphaFunction = null)
Parameters
Type Name Description
float contentLength

The total length of the content.
float 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.
uint durationMs

The time it takes to scroll in milliseconds.
AlphaFunction alphaFunction

The timing function used in animation. It describes the rate of change of the animation parameter over time. (e.g. EaseOut)
Overrides

Implements

System.IDisposable

Extension Methods