IDataGridPane

Description

interface Tinman.Engine.GUI.Components.IDataGridPane

A visual grid pane in a DataGrid that displays a IDataModel.

Public / Methods

Child​Node

public method ChildNode → (1)

row opt : int32 = -1

[-1..IDataGridPane.Rows-1]
The row index or -1 to use the selected row.

returns → IDataGridPane

The child node or null if not expanded.

Returns an expanded child node.

Collapse

public method Collapse → (1)

row opt : int32 = -1

[-1..IDataGridPane.Rows-1]
The row index or -1 to use the selected row.

Collapses the given row.

Expand

public method Expand → (1)

row opt : int32 = -1

[-1..IDataGridPane.Rows-1]
The row index or -1 to use the selected row.

Expands the given row.

Index​Of

public method IndexOf → (1)

child in : IDataGridPane

The child node.

returns → int32

The row index of child in or -1 iff child in is not a child node of this node.

Returns the row index of the given child node.

Is​Expanded

public method IsExpanded → (1)

row opt : int32 = -1

[-1..IDataGridPane.Rows-1]
The row index or -1 to use the selected row.

returns → bool

true if the row is expanded, false if not.

Checks if the given row is expanded.

Parent​Node

public method ParentNode → ()

returns → IDataGridPane

The parent node or null if this is the root node.

Returns the parent node of this node.

Path​For

public method PathFor → (1)

row opt : int32 = -1

[-1..IDataGridPane.Rows-1]
The row index or -1 to use the selected row.

returns → DataGridPath

The path or null iff row opt is -1 and there is no selection.

Returns a path to the given row.

Public / Attributes

Model

public attribute Model → (get)

value : IDataModel

[not-null]
The displayed data model.

The displayed data model.

Rows

public attribute Rows → (get)

value : int32

[>0]
The number of model rows.

Returns the number of model rows.

See also

IDataModel.Rows

Selected​Row

public attribute SelectedRow → (get,set)

value : int32

Index of currently selected row or -1 if none.

The currently selected row.

Extensions

Json​Deserialize​Expanded

public static method JsonDeserializeExpanded → (1)

value in : IJsonValue

[not-null]
The input JSON value.

Restores the expanded/collapsed states of the pane rows from the given JSON value.

Json​Serialize​Expanded

public static method JsonSerializeExpanded → (1)

value in : JsonValue

[not-null]
The output JSON value.

Serializes the expanded/collapsed states of the pane rows to a JSON value.

Pane​For

public static method PaneFor → (2)

path in : DataGridPath

The data grid path or null.

expand opt : bool = true

Use IDataGridPane.Expand to create missing sub-models?

returns → IDataGridPane

The data grid pane that has the same model as path in or null if not found.

Follows the given data grid path and returns the IDataGridPane so that IDataGridPane.Model and DataGridPath.Model are the same.

This method assumes that the DataGridPath.Model of DataGridPath.Root if the same as the IDataGridPane.Model of this pane.

Path​For

public static method PathFor → (1)

child in : IDataGridPane

[not-null]
The child pane.

returns → DataGridPath

The data grid path or null if child in is not a child pane of this pane.

Returns the data grid path to the given child node.

Select​Last​Descendant

public static method SelectLastDescendant → (1)

row opt : int32 = -1

[>=-1]
The row index. If -1, the selected row will be used.

Selects the last expanded descendant of the given row.

Select​Next

public static method SelectNext → (2)

row opt : int32 = -1

[>=-1]
The row index. If -1, the selected row will be used.

expanded opt : bool = true

Return first expanded child as next item?

Selects item that follows the given row, i.e. the next item.

Select​Parent

public static method SelectParent → ()

Selects the parent item.

Select​Previous

public static method SelectPrevious → (1)

row opt : int32 = -1

[>=-1]
The row index. If -1, the selected row will be used.

Selects item that precedes the given row, i.e. the previous item.