TreeGridElement
Playwright element wrapper for Vaadin Tree Grid, extending GridElement with tree-specific APIs for expanding/collapsing rows, querying hierarchy levels, and performing bulk operations by level.
Component Tag
vaadin-grid (same as Grid, with tree-specific features)
Inheritance
Extends GridElement - all Grid methods are available plus tree-specific methods.
Constructor
Playwright locator for the <vaadin-grid> element backed by a TreeGrid
Static Factory Methods
get
Get the first tree grid on the page or within a parent locator.
TreeGridElement.get(Page page)
TreeGridElement.get(Locator parent)
Parent locator to search within
getById
Get a tree grid by its id attribute.
TreeGridElement.getById(Page page, String id)
Tree Row Query Methods
findTreeRow
Find the tree row at the given index, returning a TreeRowElement.
Optional<TreeRowElement> findTreeRow(int rowIndex)
TreeRowElement that exposes tree-specific state and actions.
isRowExpanded
Whether the row at the given index is expanded.
boolean isRowExpanded(int rowIndex)
isRowCollapsed
Whether the row is collapsed (has children but is not expanded).
boolean isRowCollapsed(int rowIndex)
isRowLeaf
Whether the row is a leaf node (has no children).
boolean isRowLeaf(int rowIndex)
getRowLevel
Get the hierarchy level of the row (0-based; root items are level 0).
int getRowLevel(int rowIndex)
getExpandedRowCount
Get the number of currently visible expanded rows.
int getExpandedRowCount()
Expand/Collapse Methods
expandRow
Expand the row at the given index. Does nothing if already expanded or is a leaf.
void expandRow(int rowIndex)
collapseRow
Collapse the row at the given index. Does nothing if already collapsed or is a leaf.
void collapseRow(int rowIndex)
toggleRow
Toggle the expand/collapse state. Does nothing if the row is a leaf.
void toggleRow(int rowIndex)
Inner Class: TreeRowElement
Extends GridElement.RowElement with tree-specific state queries and actions.
Methods
Locator getTreeToggleLocator() - Get the tree toggle locatorboolean isExpanded() - Whether the row is expandedboolean isLeaf() - Whether the row is a leafboolean isCollapsed() - Whether the row is collapsedint getLevel() - Get the hierarchy levelvoid expand() - Expand the rowvoid collapse() - Collapse the rowvoid toggle() - Toggle expand/collapse state
Usage Examples
Basic Tree Operations
TreeGridElement treeGrid = TreeGridElement.get(page);
// Check row state
true(treeGrid.isRowExpanded(0));
assertFalse(treeGrid.isRowLeaf(0));
assertEquals(0, treeGrid.getRowLevel(0));
Expand and Collapse Rows
TreeGridElement treeGrid = TreeGridElement.getById(page, "tree-grid");
// Expand parent row
treeGrid.expandRow(0);
true(treeGrid.isRowExpanded(0));
// Collapse parent row
treeGrid.collapseRow(0);
assertFalse(treeGrid.isRowExpanded(0));
Work with TreeRowElement
TreeGridElement treeGrid = TreeGridElement.get(page);
var treeRow = treeGrid.findTreeRow(0);
if (treeRow.isPresent()) {
TreeRowElement row = treeRow.get();
assertFalse(row.isLeaf());
assertEquals(0, row.getLevel());
row.expand();
assertTrue(row.isExpanded());
// Access cell content
CellElement cell = row.getCell(0);
assertThat(cell.getCellContentLocator()).hasText("Parent Item");
}
Check Hierarchy Levels
TreeGridElement treeGrid = TreeGridElement.get(page);
// Root level
assertEquals(0, treeGrid.getRowLevel(0));
// Expand and check child level
treeGrid.expandRow(0);
assertEquals(1, treeGrid.getRowLevel(1));
Count Expanded Rows
TreeGridElement treeGrid = TreeGridElement.get(page);
treeGrid.expandRow(0);
treeGrid.expandRow(2);
int expandedCount = treeGrid.getExpandedRowCount();
assertEquals(2, expandedCount);
Toggle Row State
TreeGridElement treeGrid = TreeGridElement.get(page);
if (treeGrid.isRowExpanded(0)) {
treeGrid.toggleRow(0); // Will collapse
} else {
treeGrid.toggleRow(0); // Will expand
}
Check Leaf Nodes
TreeGridElement treeGrid = TreeGridElement.get(page);
// Root is not a leaf
assertFalse(treeGrid.isRowLeaf(0));
// Expand to see children
treeGrid.expandRow(0);
// Child might be a leaf
if (treeGrid.isRowLeaf(1)) {
System.out.println("Row 1 is a leaf node");
}
Work with Multi-select
// TreeGrid supports all Grid selection methods
TreeGridElement treeGrid = TreeGridElement.get(page);
treeGrid.expandRow(0);
treeGrid.select(0);
treeGrid.select(1);
assertEquals(2, treeGrid.getSelectedItemCount());