Class TableView
Definition
- Namespace:
- Tizen.NUI.BaseComponents
- Assembly:
- Tizen.NUI.dll
TableView is a layout container for aligning child actors in a grid like layout.
TableView constraints the X and the Y position and the width and the height of the child actors.
The Z position and depth are left intact so that the 3D model actors can also be laid out
in a grid without loosing their depth scaling.
public class TableView : View, INotifyPropertyChanged, IDisposable
- Inheritance
- Implements
-
System.ComponentModel.INotifyPropertyChangedSystem.IDisposable
Constructors
View SourceTableView()
Creates the default TableView view.
Declaration
public TableView()
TableView(uint, uint)
Creates the TableView view.
Declaration
public TableView(uint initialRows, uint initialColumns)
Parameters
Type | Name | Description |
---|---|---|
uint | initialRows | Initial rows for the table. |
uint | initialColumns | Initial columns for the table. |
TableView(TableView)
The Copy constructor. Creates another handle that points to the same real object.
Declaration
public TableView(TableView handle)
Parameters
Type | Name | Description |
---|---|---|
TableView | handle | Handle to copy from. |
Properties
View SourceCellPadding
Gets or sets the padding between cells in the TableView. The padding vector specifying the horizontal and vertical padding.
Declaration
public Vector2 CellPadding { get; set; }
Property Value
Type | Description |
---|---|
Vector2 |
Columns
The amount of columns in the table.
Declaration
public int Columns { get; set; }
Property Value
Type | Description |
---|---|
int |
LayoutColumns
Gets or sets the number of layout columns.
Declaration
public PropertyMap LayoutColumns { get; set; }
Property Value
Type | Description |
---|---|
PropertyMap |
LayoutRows
This property allows setting the number of rows in the table view layout, which can affect how child views are arranged within the table.
Declaration
public PropertyMap LayoutRows { get; set; }
Property Value
Type | Description |
---|---|
PropertyMap |
Rows
The amount of rows in the table.
Declaration
public int Rows { get; set; }
Property Value
Type | Description |
---|---|
int |
Methods
View SourceAddChild(View, CellPosition)
Adds a child to the table.
If the row or column index is outside the table, the table gets resized bigger.
Declaration
public bool AddChild(View child, TableView.CellPosition position)
Parameters
Type | Name | Description |
---|---|---|
View | child | The child to add. |
TableView.CellPosition | position | The position for the child. |
Returns
Type | Description |
---|---|
bool | True if the addition succeeded, and false if the cell is already occupied. |
DeleteColumn(uint)
Deletes a column from the given index.
Removed elements are deleted.
Declaration
public void DeleteColumn(uint columnIndex)
Parameters
Type | Name | Description |
---|---|---|
uint | columnIndex | The columnIndex of the column to delete. |
DeleteRow(uint)
Deletes a row from the given index.
Removed elements are deleted.
Declaration
public void DeleteRow(uint rowIndex)
Parameters
Type | Name | Description |
---|---|---|
uint | rowIndex | The rowIndex of the row to delete. |
FindChildPosition(View, CellPosition)
Finds the child's layout position.
Declaration
public bool FindChildPosition(View child, TableView.CellPosition position)
Parameters
Type | Name | Description |
---|---|---|
View | child | The child to search for. |
TableView.CellPosition | position | The position for the child. |
Returns
Type | Description |
---|---|
bool | True if the child was included in this TableView. |
GetCellPadding()
Gets the current padding as width and height.
Declaration
[Obsolete("This has been deprecated in API9 and will be removed in API11. Use CellPadding property instead.")]
public Vector2 GetCellPadding()
Returns
Type | Description |
---|---|
Vector2 | The current padding as width and height. |
GetChildAt(CellPosition)
Returns a child from the given layout position.
Declaration
public View GetChildAt(TableView.CellPosition position)
Parameters
Type | Name | Description |
---|---|---|
TableView.CellPosition | position | The position in the table. |
Returns
Type | Description |
---|---|
View | Child that was in the cell or an uninitialized handle. |
GetFixedHeight(uint)
Gets a row's fixed height.
Declaration
public float GetFixedHeight(uint rowIndex)
Parameters
Type | Name | Description |
---|---|---|
uint | rowIndex | The row index with a fixed height. |
Returns
Type | Description |
---|---|
float | height The height in world coordinate units. |
GetFixedWidth(uint)
Gets a column's fixed width.
Declaration
public float GetFixedWidth(uint columnIndex)
Parameters
Type | Name | Description |
---|---|---|
uint | columnIndex | The column index with a fixed width. |
Returns
Type | Description |
---|---|
float | Width in world coordinate units. |
GetRelativeHeight(uint)
Gets a row's relative height.
Declaration
public float GetRelativeHeight(uint rowIndex)
Parameters
Type | Name | Description |
---|---|---|
uint | rowIndex | The row index with a relative height. |
Returns
Type | Description |
---|---|
float | Height in percentage units, between 0.0f and 1.0f. |
GetRelativeWidth(uint)
Gets a column's relative width.
Declaration
public float GetRelativeWidth(uint columnIndex)
Parameters
Type | Name | Description |
---|---|---|
uint | columnIndex | The column index with a relative width. |
Returns
Type | Description |
---|---|
float | Width in percentage units, between 0.0f and 1.0f. |
InsertColumn(uint)
Inserts a new column to the given index.
Declaration
public void InsertColumn(uint columnIndex)
Parameters
Type | Name | Description |
---|---|---|
uint | columnIndex | The columnIndex of the new column. |
InsertRow(uint)
Inserts a new row to the given index.
Declaration
public void InsertRow(uint rowIndex)
Parameters
Type | Name | Description |
---|---|---|
uint | rowIndex | The rowIndex of the new row. |
IsFitHeight(uint)
Checks if the row is a fit row.
Declaration
public bool IsFitHeight(uint rowIndex)
Parameters
Type | Name | Description |
---|---|---|
uint | rowIndex | The row to check. |
Returns
Type | Description |
---|---|
bool | True if the row is fit. |
IsFitWidth(uint)
Checks if the column is a fit column.
Declaration
public bool IsFitWidth(uint columnIndex)
Parameters
Type | Name | Description |
---|---|---|
uint | columnIndex | The column to check. |
Returns
Type | Description |
---|---|
bool | True if the column is fit. |
RemoveChildAt(CellPosition)
Removes a child from the given layout position.
Declaration
public View RemoveChildAt(TableView.CellPosition position)
Parameters
Type | Name | Description |
---|---|---|
TableView.CellPosition | position | The position for the child to remove. |
Returns
Type | Description |
---|---|
View | Child that was removed or an uninitialized handle. |
Resize(uint, uint)
Resizes the TableView.
Declaration
public void Resize(uint rows, uint columns)
Parameters
Type | Name | Description |
---|---|---|
uint | rows | The rows for the table. |
uint | columns | The columns for the table. |
SetCellAlignment(CellPosition, HorizontalAlignmentType, VerticalAlignmentType)
Sets the alignment on a cell.
Cells without calling this function have the default values of left and top respectively.
Declaration
public void SetCellAlignment(TableView.CellPosition position, HorizontalAlignmentType horizontal, VerticalAlignmentType vertical)
Parameters
Type | Name | Description |
---|---|---|
TableView.CellPosition | position | The cell to set alignment on. |
HorizontalAlignmentType | horizontal | The horizontal alignment. |
VerticalAlignmentType | vertical | The vertical alignment. |
SetCellPadding(Size2D)
Sets the horizontal and the vertical padding between cells.
Declaration
[Obsolete("This has been deprecated in API9 and will be removed in API11. Use CellPadding property instead.")]
public void SetCellPadding(Size2D padding)
Parameters
Type | Name | Description |
---|---|---|
Size2D | padding | Width and height. |
SetFitHeight(uint)
Specifies this row as fitting its height to its children.
Declaration
public void SetFitHeight(uint rowIndex)
Parameters
Type | Name | Description |
---|---|---|
uint | rowIndex | The row to set. |
SetFitWidth(uint)
Specifies this column as fitting its width to its children.
Declaration
public void SetFitWidth(uint columnIndex)
Parameters
Type | Name | Description |
---|---|---|
uint | columnIndex | The column to set. |
SetFixedHeight(uint, float)
Sets a row to have a fixed height.
Setting a fixed height of 0 has no effect.
Declaration
public void SetFixedHeight(uint rowIndex, float height)
Parameters
Type | Name | Description |
---|---|---|
uint | rowIndex | The rowIndex for row with a fixed height. |
float | height | The height in world coordinate units. |
SetFixedWidth(uint, float)
Sets a column to have a fixed width.
Setting a fixed width of 0 has no effect.
Declaration
public void SetFixedWidth(uint columnIndex, float width)
Parameters
Type | Name | Description |
---|---|---|
uint | columnIndex | The columnIndex for column with a fixed width. |
float | width | The width in world coordinate units. |
SetRelativeHeight(uint, float)
Sets a row to have a relative height. Relative height means percentage of
the remainder of the table height after subtracting padding and fixed height rows.
Setting a relative height of 0 has no effect.
Declaration
public void SetRelativeHeight(uint rowIndex, float heightPercentage)
Parameters
Type | Name | Description |
---|---|---|
uint | rowIndex | The rowIndex for row with a relative height. |
float | heightPercentage | The height percentage between 0.0f and 1.0f. |
SetRelativeWidth(uint, float)
Sets a column to have a relative width. Relative width means percentage of
the remainder of the table width after subtracting padding and fixed width columns.
Setting a relative width of 0 has no effect.
Declaration
public void SetRelativeWidth(uint columnIndex, float widthPercentage)
Parameters
Type | Name | Description |
---|---|---|
uint | columnIndex | The columnIndex for column with a fixed width. |
float | widthPercentage | The widthPercentage between 0.0f and 1.0f. |