Class DefaultBorder

Definition

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

This class creates a border UI.

C#
Copy
public class DefaultBorder : BindableObject, IDynamicResourceHandler, IBorderInterface, IDisposable
Inheritance
DefaultBorder
Implements
IDisposable

Constructors

View Source

DefaultBorder()

Creates a default border

Declaration
C#
Copy
public DefaultBorder()

Fields

View Source

BorderLineThicknessProperty

Declaration
C#
Copy
public static readonly BindableProperty BorderLineThicknessProperty
Field Value
Type Description
BindableProperty
View Source

MaxSizeProperty

Declaration
C#
Copy
public static readonly BindableProperty MaxSizeProperty
Field Value
Type Description
BindableProperty
View Source

MinSizeProperty

Declaration
C#
Copy
public static readonly BindableProperty MinSizeProperty
Field Value
Type Description
BindableProperty
View Source

ResizePolicyProperty

Declaration
C#
Copy
public static readonly BindableProperty ResizePolicyProperty
Field Value
Type Description
BindableProperty

Properties

View Source

BorderHeight

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

Declaration
C#
Copy
public float BorderHeight { get; set; }
Property Value
Type Description
Single
View Source

BorderLineThickness

The thickness of the border.

Declaration
C#
Copy
public uint BorderLineThickness { get; set; }
Property Value
Type Description
UInt32
View Source

BorderWindow

The window with borders added.

Declaration
C#
Copy
public Window BorderWindow { get; set; }
Property Value
Type Description
Window
View Source

MaxSize

The maximum size by which the window will big.

Declaration
C#
Copy
public Size2D MaxSize { get; set; }
Property Value
Type Description
Size2D
View Source

MinSize

The minimum size by which the window will small.

Declaration
C#
Copy
public Size2D MinSize { get; set; }
Property Value
Type Description
Size2D
View Source

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
C#
Copy
public bool OverlayMode { get; set; }
Property Value
Type Description
Boolean
View Source

ResizePolicy

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

Declaration
C#
Copy
public Window.BorderResizePolicyType ResizePolicy { get; set; }
Property Value
Type Description
Window.BorderResizePolicyType
View Source

TouchThickness

The thickness of the border's touch area.

Declaration
C#
Copy
public uint TouchThickness { get; set; }
Property Value
Type Description
UInt32

Methods

View Source

CloseBorderWindow()

Close border window.

Declaration
C#
Copy
protected void CloseBorderWindow()
View Source

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
C#
Copy
public virtual void CreateBorderView(View borderView)
Parameters
Type Name Description
View borderView

The root view on which the border.

View Source

CreateBottomBorderView(View)

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

Declaration
C#
Copy
public virtual bool CreateBottomBorderView(View bottomView)
Parameters
Type Name Description
View bottomView

The bottom view on which the border.

Returns
Type Description
Boolean
View Source

CreateTopBorderView(View)

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

Declaration
C#
Copy
public virtual bool CreateTopBorderView(View topView)
Parameters
Type Name Description
View topView

The top view on which the border.

Returns
Type Description
Boolean
View Source

Dispose()

Declaration
C#
Copy
public void Dispose()
View Source

Dispose(Boolean)

Declaration
C#
Copy
protected virtual void Dispose(bool disposing)
Parameters
Type Name Description
Boolean disposing
View Source

MaximizeBorderWindow()

Maximize border window.

Declaration
C#
Copy
protected void MaximizeBorderWindow()
View Source

MinimizeBorderWindow()

Minimize border window.

Declaration
C#
Copy
protected void MinimizeBorderWindow()
View Source

OnCloseIconTouched(Object, View.TouchEventArgs)

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

Declaration
C#
Copy
public virtual bool OnCloseIconTouched(object sender, View.TouchEventArgs e)
Parameters
Type Name Description
Object sender
View.TouchEventArgs e
Returns
Type Description
Boolean
View Source

OnCreated(View)

Called after the border UI is created.

Declaration
C#
Copy
public virtual void OnCreated(View borderView)
Parameters
Type Name Description
View borderView

The border view on which the border.

View Source

OnLeftBottomCornerIconTouched(Object, View.TouchEventArgs)

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

Declaration
C#
Copy
public virtual bool OnLeftBottomCornerIconTouched(object sender, View.TouchEventArgs e)
Parameters
Type Name Description
Object sender
View.TouchEventArgs e
Returns
Type Description
Boolean
View Source

OnLeftTopCornerIconTouched(Object, View.TouchEventArgs)

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

Declaration
C#
Copy
public virtual bool OnLeftTopCornerIconTouched(object sender, View.TouchEventArgs e)
Parameters
Type Name Description
Object sender
View.TouchEventArgs e
Returns
Type Description
Boolean
View Source

OnMaximize(Boolean)

Called when the window is maximized.

Declaration
C#
Copy
public virtual void OnMaximize(bool isMaximized)
Parameters
Type Name Description
Boolean isMaximized

If window is maximized or unmaximized.

View Source

OnMaximizeIconTouched(Object, View.TouchEventArgs)

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

Declaration
C#
Copy
public virtual bool OnMaximizeIconTouched(object sender, View.TouchEventArgs e)
Parameters
Type Name Description
Object sender
View.TouchEventArgs e
Returns
Type Description
Boolean
View Source

OnMinimize(Boolean)

Called when the window is minimized.

Declaration
C#
Copy
public virtual void OnMinimize(bool isMinimized)
Parameters
Type Name Description
Boolean isMinimized

If window is mnimized or unminimized.

View Source

OnMinimizeIconTouched(Object, View.TouchEventArgs)

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

Declaration
C#
Copy
public virtual bool OnMinimizeIconTouched(object sender, View.TouchEventArgs e)
Parameters
Type Name Description
Object sender
View.TouchEventArgs e
Returns
Type Description
Boolean
View Source

OnMoveCompleted(Int32, Int32)

Called when window has been moved the display server.

Declaration
C#
Copy
public virtual void OnMoveCompleted(int x, int y)
Parameters
Type Name Description
Int32 x

The x of the has been moved window

Int32 y

The y of the has been moved window

View Source

OnMoved(Int32, Int32)

Called when the window is moved.

Declaration
C#
Copy
public virtual void OnMoved(int x, int y)
Parameters
Type Name Description
Int32 x

The x of the moved window

Int32 y

The y of the moved window

View Source

OnOverlayMode(Boolean)

Called when there is a change in overlay mode.

Declaration
C#
Copy
public virtual void OnOverlayMode(bool enabled)
Parameters
Type Name Description
Boolean enabled

If true, borderView has entered overlayMode.

View Source

OnRequestMove()

Called when requesting a move

Declaration
C#
Copy
public virtual void OnRequestMove()
View Source

OnRequestResize()

Called when requesting a resize

Declaration
C#
Copy
public virtual void OnRequestResize()
View Source

OnResizeCompleted(Int32, Int32)

Called when window has been resized the display server.

Declaration
C#
Copy
public virtual void OnResizeCompleted(int width, int height)
Parameters
Type Name Description
Int32 width

The width of the resized window

Int32 height

The height of the resized window

View Source

OnResized(Int32, Int32)

Called when the window is resized.

Declaration
C#
Copy
public virtual void OnResized(int width, int height)
Parameters
Type Name Description
Int32 width

The width of the resized window

Int32 height

The height of the resized window

View Source

OnRightBottomCornerIconTouched(Object, View.TouchEventArgs)

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

Declaration
C#
Copy
public virtual bool OnRightBottomCornerIconTouched(object sender, View.TouchEventArgs e)
Parameters
Type Name Description
Object sender
View.TouchEventArgs e
Returns
Type Description
Boolean
View Source

OnRightTopCornerIconTouched(Object, View.TouchEventArgs)

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

Declaration
C#
Copy
public virtual bool OnRightTopCornerIconTouched(object sender, View.TouchEventArgs e)
Parameters
Type Name Description
Object sender
View.TouchEventArgs e
Returns
Type Description
Boolean
View Source

OverlayBorderHide()

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

Declaration
C#
Copy
public virtual bool OverlayBorderHide()
Returns
Type Description
Boolean

True if border became hide, false otherwise

View Source

OverlayBorderShow(UInt32)

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

Declaration
C#
Copy
public virtual bool OverlayBorderShow(uint time = null)
Parameters
Type Name Description
UInt32 time

Time(ms) for borders to disappear again

Returns
Type Description
Boolean

True if border became show, false otherwise

View Source

UpdateProperty()

Update properties

Declaration
C#
Copy
public void UpdateProperty()

Implements

IDisposable

Extension Methods