Class Layer

Definition

Namespace:
Tizen.NUI
Assembly:
Tizen.NUI.dll
API Level:
3

Layers provide a mechanism for overlaying groups of actors on top of each other.

public class Layer : Container, INotifyPropertyChanged, IDynamicResourceHandler, IElement, INameScope, IElementController, IDisposable, IResourcesProvider
Inheritance
System.Object
BindableObject
Tizen.NUI.Binding.Element
BaseHandle
Animatable
Container
Layer
Implements
System.ComponentModel.INotifyPropertyChanged
System.IDisposable

Constructors

View Source

Layer()

Creates a Layer object.

Declaration
public Layer()
API Level: 3

Properties

View Source

Behavior

Layer behavior, type String (Layer.LayerBehavior).

Declaration
public Layer.LayerBehavior Behavior { get; set; }
Property Value
Type Description
Layer.LayerBehavior
API Level: 3
View Source

ChildCount

Get the number of children held by the layer.

Declaration
public uint ChildCount { get; }
Property Value
Type Description
System.UInt32
API Level: 3
View Source

Depth

Queries the depth of the layer.
0 is the bottommost layer, higher number is on the top.

Declaration
public uint Depth { get; }
Property Value
Type Description
System.UInt32
API Level: 3
View Source

Name

Gets or sets the layer's name.

Declaration
public string Name { get; set; }
Property Value
Type Description
System.String
API Level: 3
View Source

Opacity

Retrieves and sets the layer's opacity.

Declaration
public float Opacity { get; set; }
Property Value
Type Description
System.Single
API Level: 3
View Source

Viewport

Sets the viewport (in window coordinates), type rectangle. The contents of the layer will not be visible outside this box, when ViewportEnabled is true.

Declaration
public Rectangle Viewport { get; set; }
Property Value
Type Description
Rectangle
API Level: 4
View Source

Visibility

Retrieves and sets the layer's visibility.

Declaration
public bool Visibility { get; set; }
Property Value
Type Description
System.Boolean
API Level: 3

Methods

View Source

Add(View)

Adds a child view to this layer.

Declaration
public override void Add(View child)
Parameters
Type Name Description
View child
Overrides
Exceptions
Type Condition
System.ArgumentNullException

Thrown when child is null.

See Also
API Level: 4
View Source

FindChildById(UInt32)

Search through this layer's hierarchy for a view with the given unique ID.

Declaration
public View FindChildById(uint id)
Parameters
Type Name Description
System.UInt32 id

The id of the child to find
Returns
Type Description
View

A handle to the view if found, or an empty handle if not.

Remarks

The actor itself is also considered in the search.

API Level: 3
Precondition: This layer (the parent) has been initialized.
View Source

GetChildAt(UInt32)

Retrieves a child view by the index.

Declaration
public override View GetChildAt(uint index)
Parameters
Type Name Description
System.UInt32 index

The index of the child to retrieve.
Returns
Type Description
View

The view for the given index or empty handle if children not initialized.
Overrides
API Level: 4
Precondition: The view has been initialized.
View Source

GetChildCount()

This has been deprecated in API9 and will be removed in API11. Use ChildCount property instead

Get the child count of the layer.

Declaration
[Obsolete("This has been deprecated in API9 and will be removed in API11. Use ChildCount property instead")]
public override uint GetChildCount()
Returns
Type Description
System.UInt32

The child count of the layer.
Overrides
API Level: 4
View Source

GetParent()

Get parent of the layer.

Declaration
public override Container GetParent()
Returns
Type Description
Container

The view's container
Overrides
API Level: 4
View Source

Lower()

Decrements the depth of the layer.

Declaration
public void Lower()
API Level: 3
View Source

LowerToBottom()

Lowers the layer to the bottom.

Declaration
public void LowerToBottom()
API Level: 3
View Source

MoveAbove(Layer)

Moves the layer directly above the given layer.
After the call, this layer's depth will be immediately above target.

Declaration
public void MoveAbove(Layer target)
Parameters
Type Name Description
Layer target

The layer to get on top of.
API Level: 3
View Source

MoveBelow(Layer)

Moves the layer directly below the given layer.
After the call, this layer's depth will be immediately below target.

Declaration
public void MoveBelow(Layer target)
Parameters
Type Name Description
Layer target

The layer to get below of.
API Level: 3
View Source

Raise()

Increments the depth of the layer.

Declaration
public void Raise()
API Level: 3
View Source

RaiseToTop()

Raises the layer to the top.

Declaration
public void RaiseToTop()
API Level: 3
View Source

Remove(View)

Removes a child view from this layer. If the view was not a child of this layer, this is a no-op.

Declaration
public override void Remove(View child)
Parameters
Type Name Description
View child
Overrides
Exceptions
Type Condition
System.ArgumentNullException

Thrown when child is null.

See Also
API Level: 4

Implements

System.ComponentModel.INotifyPropertyChanged
System.IDisposable