Class DefaultBorder

Definition

Namespace:

Tizen.NUI

Assembly:

Tizen.NUI.dll

This class creates a border UI.

public class DefaultBorder : BindableObject, IDynamicResourceHandler, IBorderInterface, IDisposable

Inheritance

object

BindableObject

DefaultBorder

Implements

IDynamicResourceHandler

IBorderInterface

IDisposable

Constructors

DefaultBorder()

Creates a default border

Declaration

public DefaultBorder()

Fields

BorderLineThicknessProperty

Declaration

public static readonly BindableProperty BorderLineThicknessProperty

Field Value

Type	Description
BindableProperty

MaxSizeProperty

Declaration

public static readonly BindableProperty MaxSizeProperty

Field Value

Type	Description
BindableProperty

MinSizeProperty

Declaration

public static readonly BindableProperty MinSizeProperty

Field Value

Type	Description
BindableProperty

ResizePolicyProperty

Declaration

public static readonly BindableProperty ResizePolicyProperty

Field Value

Type	Description
BindableProperty

Properties

BorderHeight

The height of the border. This value is the initial value used when creating borders.

Declaration

public float BorderHeight { get; set; }

Property Value

Type	Description
float

BorderLineThickness

The thickness of the border.

Declaration

public uint BorderLineThickness { get; set; }

Property Value

Type	Description
uint

BorderWindow

The window with borders added.

Declaration

public Window BorderWindow { get; set; }

Property Value

Type	Description
Window

MaxSize

The maximum size by which the window will big.

Declaration

public Size2D MaxSize { get; set; }

Property Value

Type	Description
Size2D

MinSize

The minimum size by which the window will small.

Declaration

public Size2D MinSize { get; set; }

Property Value

Type	Description
Size2D

OverlayMode

Whether overlay mode. If overlay mode is true, the border area is hidden when the window is maximized. And if you touched at screen, the border area is shown on the screen. Default value is false;

Declaration

public bool OverlayMode { get; set; }

Property Value

Type	Description
bool

ResizePolicy

Set the window resizing policy. Default value is BorderResizePolicyType.Free;

Declaration

public Window.BorderResizePolicyType ResizePolicy { get; set; }

Property Value

Type	Description
Window.BorderResizePolicyType

TouchThickness

The thickness of the border's touch area.

Declaration

public uint TouchThickness { get; set; }

Property Value

Type	Description
uint

Methods

CloseBorderWindow()

Close border window.

Declaration

protected void CloseBorderWindow()

CreateBorderView(View)

Create border UI. User can override this method to draw border UI. A top border and a bottom border are added to this view.

Declaration

public virtual void CreateBorderView(View borderView)

Parameters

Type	Name	Description
View	borderView	The root view on which the border.

CreateBottomBorderView(View)

Create bottom border UI. User can override this method to draw bottom border UI.

Declaration

public virtual bool CreateBottomBorderView(View bottomView)

Parameters

Type	Name	Description
View	bottomView	The bottom view on which the border.

Returns

Type	Description
bool

CreateTopBorderView(View)

Create top border UI. User can override this method to draw top border UI.

Declaration

public virtual bool CreateTopBorderView(View topView)

Parameters

Type	Name	Description
View	topView	The top view on which the border.

Returns

Type	Description
bool

Dispose()

Declaration

public void Dispose()

Dispose(bool)

Declaration

protected virtual void Dispose(bool disposing)

Parameters

Type	Name	Description
bool	disposing

MaximizeBorderWindow()

Maximize border window.

Declaration

protected void MaximizeBorderWindow()

MinimizeBorderWindow()

Minimize border window.

Declaration

protected void MinimizeBorderWindow()

OnCloseIconTouched(object, TouchEventArgs)

This is an event callback when the close icon is touched.

Declaration

public virtual bool OnCloseIconTouched(object sender, View.TouchEventArgs e)

Parameters

Type	Name	Description
object	sender
View.TouchEventArgs	e

Returns

Type	Description
bool

OnCreated(View)

Called after the border UI is created.

Declaration

public virtual void OnCreated(View borderView)

Parameters

Type	Name	Description
View	borderView	The border view on which the border.

OnLeftBottomCornerIconTouched(object, TouchEventArgs)

This is an event callback when the left bottom corner icon is touched.

Declaration

public virtual bool OnLeftBottomCornerIconTouched(object sender, View.TouchEventArgs e)

Parameters

Type	Name	Description
object	sender
View.TouchEventArgs	e

Returns

Type	Description
bool

OnLeftTopCornerIconTouched(object, TouchEventArgs)

This is an event callback when the left top corner icon is touched.

Declaration

public virtual bool OnLeftTopCornerIconTouched(object sender, View.TouchEventArgs e)

Parameters

Type	Name	Description
object	sender
View.TouchEventArgs	e

Returns

Type	Description
bool

OnMaximize(bool)

Called when the window is maximized.

Declaration

public virtual void OnMaximize(bool isMaximized)

Parameters

Type	Name	Description
bool	isMaximized	If window is maximized or unmaximized.

OnMaximizeIconTouched(object, TouchEventArgs)

This is an event callback when the maximum icon is touched.

Declaration

public virtual bool OnMaximizeIconTouched(object sender, View.TouchEventArgs e)

Parameters

Type	Name	Description
object	sender
View.TouchEventArgs	e

Returns

Type	Description
bool

OnMinimize(bool)

Called when the window is minimized.

Declaration

public virtual void OnMinimize(bool isMinimized)

Parameters

Type	Name	Description
bool	isMinimized	If window is mnimized or unminimized.

OnMinimizeIconTouched(object, TouchEventArgs)

This is an event callback when the minimize icon is touched.

Declaration

public virtual bool OnMinimizeIconTouched(object sender, View.TouchEventArgs e)

Parameters

Type	Name	Description
object	sender
View.TouchEventArgs	e

Returns

Type	Description
bool

OnMoveCompleted(int, int)

Called when window has been moved the display server.

Declaration

public virtual void OnMoveCompleted(int x, int y)

Parameters

Type	Name	Description
int	x	The x of the has been moved window
int	y	The y of the has been moved window

OnMoved(int, int)

Called when the window is moved.

Declaration

public virtual void OnMoved(int x, int y)

Parameters

Type	Name	Description
int	x	The x of the moved window
int	y	The y of the moved window

OnOverlayMode(bool)

Called when there is a change in overlay mode.

Declaration

public virtual void OnOverlayMode(bool enabled)

Parameters

Type	Name	Description
bool	enabled	If true, borderView has entered overlayMode.

OnRequestMove()

Called when requesting a move

Declaration

public virtual void OnRequestMove()

OnRequestResize()

Called when requesting a resize

Declaration

public virtual void OnRequestResize()

OnResizeCompleted(int, int)

Called when window has been resized the display server.

Declaration

public virtual void OnResizeCompleted(int width, int height)

Parameters

Type	Name	Description
int	width	The width of the resized window
int	height	The height of the resized window

OnResized(int, int)

Called when the window is resized.

Declaration

public virtual void OnResized(int width, int height)

Parameters

Type	Name	Description
int	width	The width of the resized window
int	height	The height of the resized window

OnRightBottomCornerIconTouched(object, TouchEventArgs)

This is an event callback when the right bottom corner icon is touched.

Declaration

public virtual bool OnRightBottomCornerIconTouched(object sender, View.TouchEventArgs e)

Parameters

Type	Name	Description
object	sender
View.TouchEventArgs	e

Returns

Type	Description
bool

OnRightTopCornerIconTouched(object, TouchEventArgs)

This is an event callback when the right bottom corner icon is touched.

Declaration

public virtual bool OnRightTopCornerIconTouched(object sender, View.TouchEventArgs e)

Parameters

Type	Name	Description
object	sender
View.TouchEventArgs	e

Returns

Type	Description
bool

OverlayBorderHide()

Hide the border when OverlayMode is true and the window is now Maximize.

Declaration

public virtual bool OverlayBorderHide()

Returns

Type	Description
bool	True if border became hide, false otherwise

OverlayBorderShow(uint)

Show the border when OverlayMode is true and the window is now Maximize.

Declaration

public virtual bool OverlayBorderShow(uint time = null)

Parameters

Type	Name	Description
uint	time	Time(ms) for borders to disappear again

Returns

Type	Description
bool	True if border became show, false otherwise

UpdateProperty()

Update properties

Declaration

public void UpdateProperty()

Implements

IDynamicResourceHandler

IBorderInterface

IDisposable

Extension Methods

BindableObjectExtensions.SetBinding(BindableObject, BindableProperty, string, BindingMode, IValueConverter, string)

EXamlExtensions.LoadFromEXamlByRelativePath<T>(T, string)

Extensions.LoadFromXaml<TXaml>(TXaml, string)

Extensions.LoadFromXaml<TXaml>(TXaml, Type)

Extensions.LoadFromXamlFile<TXaml>(TXaml, string)